mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-09-19 23:57:31 -07:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

fix broken links

Browse source
This commit is contained in:
Sacha Weatherstone 2023-01-14 14:30:18 +10:00
parent 302b9258da
commit 37bfba675a
No known key found for this signature in database
GPG key ID: 7AB2D7E206124B31
8 changed files with 90 additions and 88 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/about/contributing.mdx
View file

@ -23,7 +23,7 @@ There are many technologies (and repositories) used in creating the Meshtastic e
### Protocol Buffers ### Protocol Buffers
Most communication and interactions happen with protocol buffers. The [Meshtastic Protobuf Definitions](https://github.com/meshtastic/protobufs) repo is where all of the protocol buffer changes happen. See the [Protobuf API Reference](/docs/developers/protobufs/api) for more details. Most communication and interactions happen with protocol buffers. The [Meshtastic Protobuf Definitions](https://github.com/meshtastic/protobufs) repo is where all of the protocol buffer changes happen. See the [Protobuf API Reference](https://buf.build/meshtastic/protobufs/) for more details.
### Device Firmware ### Device Firmware
@ -44,10 +44,10 @@ The [firmware](https://github.com/meshtastic/firmware) is where all of the firmw
@sachaw has been making tons of progress on the web app and would love help with: @sachaw has been making tons of progress on the web app and would love help with:
* Saving of preferences - Saving of preferences
* Better loading state indicators - Better loading state indicators
* Chat scroll lock - Chat scroll lock
* Various module support - Various module support
### Mobile Apps (Device Interface) ### Mobile Apps (Device Interface)
@ -59,4 +59,3 @@ There are two phone apps that interact with the Meshtastic devices:
### Documentation ### Documentation
This website is in the [Meshtastic](https://github.com/meshtastic/meshtastic) repository. This website is in the [Meshtastic](https://github.com/meshtastic/meshtastic) repository.

30
docs/about/overview/mesh-alg.mdx
View file

@ -25,23 +25,23 @@ This preamble allows receiving radios to synchronize clocks and start framing. W
This layer is conventional non-reliable LoRa packet transmission. The transmitted packet has the following representation before encoding for transmission: This layer is conventional non-reliable LoRa packet transmission. The transmitted packet has the following representation before encoding for transmission:
| Offset | Length | Type | Usage | | Offset | Length | Type | Usage |
|:------------:|:-----------------------------:|:-------:|:---------------------------------------------------------------------------------------- | | :----------: | :---------------------------: | :-----: | :--------------------------------------------------------------------------------------- |
| 0x00 | 1 byte | Integer | syncWord, always `0x2B`. | | 0x00 | 1 byte | Integer | syncWord, always `0x2B`. |
| 0x01 | 4 bytes | Integer | Packet header: Destination. The destination's unique NodeID. `0xFFFFFFFF` for broadcast. | | 0x01 | 4 bytes | Integer | Packet header: Destination. The destination's unique NodeID. `0xFFFFFFFF` for broadcast. |
| 0x05 | 4 bytes | Integer | Packet Header: Sender. The sender's unique NodeID. | | 0x05 | 4 bytes | Integer | Packet Header: Sender. The sender's unique NodeID. |
| 0x09 | 4 bytes | Integer | Packet Header: The sending node's unique packet ID for this packet. | | 0x09 | 4 bytes | Integer | Packet Header: The sending node's unique packet ID for this packet. |
| 0x0D | 32 bits | Bits | Packet Header: Flags. See the [header flags](#packet-header-flags) for usage. | | 0x0D | 32 bits | Bits | Packet Header: Flags. See the [header flags](#packet-header-flags) for usage. |
| 0x11 .. 0xFD | Varies, maximum of 237 bytes. | Bytes | Actual packet data. Unused bytes are not transmitted. | | 0x11 .. 0xFD | Varies, maximum of 237 bytes. | Bytes | Actual packet data. Unused bytes are not transmitted. |
| 0xFE .. 0xFF | 2 Bytes | Bytes | Unused. | | 0xFE .. 0xFF | 2 Bytes | Bytes | Unused. |
#### Packet Header Flags #### Packet Header Flags
| Index | # of Bits | Usage | | Index | # of Bits | Usage |
|:-------:|:---------:|:------------------------------| | :-----: | :-------: | :----------------------------- |
| 0 | 3 | HopLimit (see note in Layer 3) | | 0 | 3 | HopLimit (see note in Layer 3) |
| 3 | 1 | WantAck | | 3 | 1 | WantAck |
| 4 .. 32 | 28 | Currently unused | | 4 .. 32 | 28 | Currently unused |
#### Usage Details #### Usage Details
@ -51,7 +51,7 @@ This layer is conventional non-reliable LoRa packet transmission. The transmitte
- **Packet Header - Unique ID:** The ID is a large, 32 bit ID to ensure there is enough unique state to protect an encrypted payload from attack. - **Packet Header - Unique ID:** The ID is a large, 32 bit ID to ensure there is enough unique state to protect an encrypted payload from attack.
- **Payload:** An encrypted and packed protobuf encoding of the SubPacket protobuf. Only the SubPacket is encrypted, while headers are not. This allows the option of eventually allowing nodes to route packets without knowing anything about the encrypted payload. For more information, see the [encryption](/docs/overview/encryption) and [protobufs](/docs/developers/protobufs/api) documentation. Any data past the maximum length is truncated. - **Payload:** An encrypted and packed protobuf encoding of the SubPacket protobuf. Only the SubPacket is encrypted, while headers are not. This allows the option of eventually allowing nodes to route packets without knowing anything about the encrypted payload. For more information, see the [encryption](/docs/overview/encryption) and [Protobuf API Reference](https://buf.build/meshtastic/protobufs/). Any data past the maximum length is truncated.
#### Carrier-Sense Multiple Access with Collision Avoidance (CSMA/CA) #### Carrier-Sense Multiple Access with Collision Avoidance (CSMA/CA)

22
docs/configuration/module-config/range-test.mdx
View file

@ -5,12 +5,12 @@ slug: /settings/moduleconfig/range-test
sidebar_label: Range Test sidebar_label: Range Test
--- ---
import Tabs from '@theme/Tabs'; import Tabs from "@theme/Tabs";
import TabItem from '@theme/TabItem'; import TabItem from "@theme/TabItem";
This module allows you to test the range of your Meshtastic nodes. It requires at least two nodes, a sender and a receiver. The receiving node then saves the messages along with the GPS coordinates at which they were received into a .csv file. This .csv file can then be integrated into [Google Earth](https://earth.google.com), [Google Maps - My Maps](https://mymaps.google.com), or any other program capable of processing .csv files. This can enable you to visualize your mesh. This module allows you to test the range of your Meshtastic nodes. It requires at least two nodes, a sender and a receiver. The receiving node then saves the messages along with the GPS coordinates at which they were received into a .csv file. This .csv file can then be integrated into [Google Earth](https://earth.google.com), [Google Maps - My Maps](https://mymaps.google.com), or any other program capable of processing .csv files. This can enable you to visualize your mesh.
The range test module config options are: Enabled, Save, and Sender. Range Test Module config uses an admin message sending a `ConfigModule.RangeTest` protobuf. The range test module config options are: Enabled, Save, and Sender. Range Test Module config uses an admin message sending a `ConfigModule.RangeTest` protobuf.
## Range Test Module Config Values ## Range Test Module Config Values
@ -66,8 +66,8 @@ Range Test module config options are available in the python CLI. Example comman
::: :::
| Setting | Acceptable Values | Default | | Setting | Acceptable Values | Default |
| :-----------------------: | :-----------------: | :-----: | | :----------------: | :-----------------: | :-----: |
| range_test.enabled | `true`, `false` | `false` | | range_test.enabled | `true`, `false` | `false` |
| range_test.save | `true`, `false` | `false` | | range_test.save | `true`, `false` | `false` |
| range_test.sender | `integer` (Seconds) | `0` | | range_test.sender | `integer` (Seconds) | `0` |
@ -121,7 +121,7 @@ Be sure to turn off either the module configured as a sender or the device where
Also be mindful of your space usage on the file system. It has protections from filling up the space but it's best to delete old range test results. Also be mindful of your space usage on the file system. It has protections from filling up the space but it's best to delete old range test results.
:::note :::note
Leaving this module on can slow down your mesh. Currently, the messages are sent using the same `TEXT_MESSAGE_APP` [port that all other messages](/docs/developers/protobufs/api#portnumsproto) are sent on. Leaving this module on can slow down your mesh. Currently, the messages are sent using the same `TEXT_MESSAGE_APP` [port that all other messages](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.PortNum) are sent on.
::: :::
### Accessing your CSV ### Accessing your CSV
@ -137,12 +137,10 @@ http://198.168.0.15
| Radio Setting | `range_test.sender` | | Radio Setting | `range_test.sender` |
| :-----------: | :-----------------: | | :-----------: | :-----------------: |
| Long Slow | 60 | | Long Slow | 60 |
| Long Alt | 30 | | Long Alt | 30 |
| Medium | 15 | | Medium | 15 |
| Short Fast | 15 | | Short Fast | 15 |
## Application Examples ## Application Examples

2
docs/configuration/remote-admin.mdx
View file

@ -151,7 +151,7 @@ Completed getting preferences
For further reading, I recommend starting out with [Meshtastic-python](/docs/software/python/cli/) if you haven't already gone through this (hopefully you have since you are reading this). But for a full reference to the settings you can change, please see: For further reading, I recommend starting out with [Meshtastic-python](/docs/software/python/cli/) if you haven't already gone through this (hopefully you have since you are reading this). But for a full reference to the settings you can change, please see:
[Settings Overview](/docs/settings) and [Settings Overview](/docs/settings) and
[Complete list of user settings in Protobufs](/docs/developers/protobufs/api#radioconfiguserpreferences) [Complete list of user settings in Protobufs](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.User)
## Areas for future development ## Areas for future development

28
docs/development/device/error-codes.mdx
View file

@ -8,19 +8,19 @@ sidebar_position: 4
The device might report these fault codes on the screen, but it will also be outputted on the device serial output. If you encounter a fault code, please post on the forum and we'll try to help. The device might report these fault codes on the screen, but it will also be outputted on the device serial output. If you encounter a fault code, please post on the forum and we'll try to help.
:::note :::note
This table is derived from the [protobufs](/docs/developers/protobufs/api#criticalerrorcode) This table is derived from the [protobufs](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.CriticalErrorCode)
::: :::
| Name | Number | Description | | Name | Number | Description |
|:------------------- :|:------:|:----------------------------------------------------------------------------------------------------------------------- | | :-----------------: | :----: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| TxWatchdog | 1 | A software bug was detected while trying to send LoRa | | TxWatchdog | 1 | A software bug was detected while trying to send LoRa |
| SleepEnterWait | 2 | A software bug was detected on entry to sleep | | SleepEnterWait | 2 | A software bug was detected on entry to sleep |
| NoRadio | 3 | No LoRa radio hardware could be found | | NoRadio | 3 | No LoRa radio hardware could be found |
| Unspecified | 4 | Not normally used | | Unspecified | 4 | Not normally used |
| UBloxInitFailed | 5 | We failed while configuring a UBlox GPS | | UBloxInitFailed | 5 | We failed while configuring a UBlox GPS |
| NoAXP192 | 6 | This board was expected to have a power management chip and it is missing or broken | | NoAXP192 | 6 | This board was expected to have a power management chip and it is missing or broken |
| InvalidRadioSetting | 7 | The channel tried to set a radio setting which is not supported by this chipset, radio comms settings are now undefined | | InvalidRadioSetting | 7 | The channel tried to set a radio setting which is not supported by this chipset, radio comms settings are now undefined |
| TransmitFailed | 8 | Radio transmit hardware failure. We sent data to the radio chip, but it did not reply with an interrupt | | TransmitFailed | 8 | Radio transmit hardware failure. We sent data to the radio chip, but it did not reply with an interrupt |
| Brownout | 9 | We detected that the main CPU voltage dropped below the minimum acceptable value | | Brownout | 9 | We detected that the main CPU voltage dropped below the minimum acceptable value |
| SX1262Failure | 10 | Selftest of SX1262 radio chip failed | | SX1262Failure | 10 | Selftest of SX1262 radio chip failed |
| RadioSpiBug | 11 | A (likely software but possibly hardware) failure was detected while trying to send packets. If this occurs on your board, please post in the forum so that we can ask you to collect some information to allow fixing this bug | | RadioSpiBug | 11 | A (likely software but possibly hardware) failure was detected while trying to send packets. If this occurs on your board, please post in the forum so that we can ask you to collect some information to allow fixing this bug |

8
docs/development/firmware/port-numbers.mdx
View file

@ -6,15 +6,15 @@ sidebar_label: Port Numbers
Any new app that runs on the device or via sister apps on phones/PCs should pick and use a unique "portnum" for their applications use. Any new app that runs on the device or via sister apps on phones/PCs should pick and use a unique "portnum" for their applications use.
The current list of port numbers can be found listed in the [protobufs](/docs/developers/protobufs/api#portnumsproto) The current list of port numbers can be found listed in the [protobufs](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.CriticalErrorCode)
## Assignment ## Assignment
PortNums should be assigned by the following ranges: PortNums should be assigned by the following ranges:
| Portnum | Usage | | Portnum | Usage |
|:-------:|:---------------------------------------------------------------------------------------------------------------------- | | :-----: | :--------------------------------------------------------------------------------------------------------------------- |
| 0-63 | Core Meshtastic use, do not use for third party apps. | | 0-63 | Core Meshtastic use, do not use for third party apps. |
| 64-127 | Registered 3rd party apps, send in a pull request that adds a new entry to portnums.proto to register your application | | 64-127 | Registered 3rd party apps, send in a pull request that adds a new entry to portnums.proto to register your application |
| 256-511 | Use one of these portnums for your private applications that you do not want to register publicly | | 256-511 | Use one of these portnums for your private applications that you do not want to register publicly |
@ -22,4 +22,4 @@ All other values are reserved.
## Integration ## Integration
If you are making a new app using Meshtastic, please send a pull request to add your chosen "portnum" to this master table. If you are making a new app using Meshtastic, please send a pull request to add your chosen "portnum" to this master table.

58
docs/software/mqtt/index.mdx
View file

File diff suppressed because one or more lines are too long

19
docs/software/python-cli/usage.mdx
View file

@ -46,7 +46,7 @@ meshtastic --set network.wifi_ssid mywifissid --set network.wifi_psk mywifipsw -
``` ```
:::note :::note
For a full list of preferences which can be set (and their documentation) can be found in the [protobufs](/docs/developers/protobufs/api#radioconfiguserpreferences). For a full list of preferences which can be set (and their documentation) can be found in the [protobufs](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.User).
::: :::
### Changing channel settings ### Changing channel settings
@ -54,7 +54,7 @@ For a full list of preferences which can be set (and their documentation) can be
The channel settings can also be changed, either by using a standard (shareable) meshtastic URL or you can set particular channel parameter (for advanced users). The channel settings can also be changed, either by using a standard (shareable) meshtastic URL or you can set particular channel parameter (for advanced users).
:::warning :::warning
Meshtastic encodes the radio channel and PSK in the channel's URL. All nodes must connect to the channel again by using the URL provided after a change in this section by performing the `--info` switch. Meshtastic encodes the radio channel and PSK in the channel's URL. All nodes must connect to the channel again by using the URL provided after a change in this section by performing the `--info` switch.
::: :::
```shell ```shell
@ -93,12 +93,12 @@ Writing modified channels to device
Toggling `set-ham` changes your device settings in the following ways. Toggling `set-ham` changes your device settings in the following ways.
| Setting | `set-ham` Default | Normal Default | | Setting | `set-ham` Default | Normal Default |
| :----------------------: | :---------------: | :---------------------------------------: | | :----------: | :---------------: | :------------------------------------------------------------------------: |
| `IsLicensed` | `true` | See [User Config - IsLicensed](/docs/settings/config/user#is-licensed-ham) | | `IsLicensed` | `true` | See [User Config - IsLicensed](/docs/settings/config/user#is-licensed-ham) |
| `LongName` | _Your CallSign_ | See [User Config - LongName](/docs/settings/config/user#long-name) | | `LongName` | _Your CallSign_ | See [User Config - LongName](/docs/settings/config/user#long-name) |
| `ShortName` | _Abrv CallSign_ | See [User Config - ShortName](/docs/settings/config/user#short-name) | | `ShortName` | _Abrv CallSign_ | See [User Config - ShortName](/docs/settings/config/user#short-name) |
| `PSK` | `""` | See [Channel Settings - PSK](#changing-the-preshared-key) | | `PSK` | `""` | See [Channel Settings - PSK](#changing-the-preshared-key) |
## Changing the preshared key: ## Changing the preshared key:
@ -130,8 +130,9 @@ This indicates an OS permission problem for access by your user to the USB seria
sudo usermod -a -G dialout <username> sudo usermod -a -G dialout <username>
``` ```
If the adding the user to the dialout group does not work, you can use the following command to find out which group to add your user to. If the adding the user to the dialout group does not work, you can use the following command to find out which group to add your user to.
In this example (from Arch Linux) the group was "uucp" In this example (from Arch Linux) the group was "uucp"
```shell ```shell
❯ ls -al /dev/ttyACM0 ❯ ls -al /dev/ttyACM0
crw-rw---- 1 root uucp 166, 0 Jul 20 21:52 /dev/ttyACM0 crw-rw---- 1 root uucp 166, 0 Jul 20 21:52 /dev/ttyACM0