mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-24 21:24:44 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

fixed protobuf api links

Browse source
This commit is contained in:
sigmahour 2022-11-03 22:24:31 -04:00
parent 7b2d73859d
commit c9e932bb8a
11 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/1.2-End-of-life/software/mqtt.mdx
View file

@ -147,7 +147,7 @@ FIXME - explain this more, talk about how useful for users and security domains.
## On device API
For information on the related on-device API see [here](/docs/protobufs/api).
For information on the related on-device API see [here](/docs/developers/protobufs/api).
## MQTT transport
@ -169,7 +169,7 @@ FIXME, discuss possible attacks by griefers and how they can be prevented
#### Service Envelope
The payload published on mesh/... will always be wrapped in a [ServiceEnvelope protobuf](/docs/protobufs/api#serviceenvelope).
The payload published on mesh/... will always be wrapped in a [ServiceEnvelope protobuf](/docs/developers/protobufs/api#serviceenvelope).
ServiceEnvelope will include the message, and full information about arrival time, who forwarded it, source channel, source mesh id, etc...

2
docs/about/contributing.mdx
View file

@ -21,7 +21,7 @@ There are many technologies (and repositories) used in creating the Meshtastic e
## 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/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](/docs/developers/protobufs/api) for more details.
## Firmware

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

@ -50,7 +50,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.
- **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/about/overview/encryption) and [protobufs](/docs/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/about/overview/encryption) and [protobufs](/docs/developers/protobufs/api) documentation. Any data past the maximum length is truncated.
#### Carrier-Sense Multiple Access with Collision Avoidance (CSMA/CA)

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

@ -108,7 +108,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.
:::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/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](/docs/developers/protobufs/api#portnumsproto) are sent on.
:::
### Accessing your CSV

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

@ -139,7 +139,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:
[Settings Overview](/docs/settings) and
[Complete list of user settings in Protobufs](/docs/protobufs/api#radioconfiguserpreferences)
[Complete list of user settings in Protobufs](/docs/developers/protobufs/api#radioconfiguserpreferences)
## Areas for future development

2
docs/development/device/critical-faults.mdx
View file

@ -7,7 +7,7 @@ sidebar_label: Error Codes
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
This table is derived from the [protobufs](/docs/protobufs/api#criticalerrorcode)
This table is derived from the [protobufs](/docs/developers/protobufs/api#criticalerrorcode)
:::
| Name | Number | Description |

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

@ -20,4 +20,4 @@ Note: This was formerly a Type enum named `typ` with the same id #
We have changed to this 'portnum' based scheme for specifying app handlers for particular payloads. This change is backwards compatible by treating the legacy OPAQUE/CLEAR_TEXT values identically.
The current list of port numbers can be found listed in the [protobufs](/docs/protobufs/api#portnumsproto)
The current list of port numbers can be found listed in the [protobufs](/docs/developers/protobufs/api#portnumsproto)

12
docs/development/reference/protobuf-api.mdx
View file

@ -1,7 +1,7 @@
---
id: protobuf-api
title: Protobuf API Reference
slug: /protobufs/api
slug: /developers/protobufs/api
sidebar_label: Protobufs
sidebar_position: 20
---
@ -1605,12 +1605,12 @@ This change is backwards compatible by treating the legacy OPAQUE/CLEAR_TEXT val
| `UNKNOWN_APP` | `0` | Deprecated: do not use in new code (formerly called OPAQUE) A message sent from a device outside of the mesh, in a form the mesh does not understand NOTE: This must be 0, because it is documented in IMeshService.aidl to be so |
| `TEXT_MESSAGE_APP` | `1` | A simple UTF-8 text message, which even the little micros in the mesh can understand and show on their screen eventually in some circumstances even signal might send messages in this form (see below) |
| `REMOTE_HARDWARE_APP` | `2` | Reserved for built-in GPIO/example app. See remote_hardware.proto/HardwareMessage for details on the message sent/received to this port number |
| `POSITION_APP` | `3` | The built-in position messaging app. Payload is a [Position](/docs/protobufs/api#position) message |
| `NODEINFO_APP` | `4` | The built-in user info app. Payload is a [User](/docs/protobufs/api#user) message |
| `ROUTING_APP` | `5` | Protocol control packets for mesh protocol use. Payload is a [Routing](/docs/protobufs/api#routing) message |
| `ADMIN_APP` | `6` | Admin control packets. Payload is a [AdminMessage](/docs/protobufs/api#adminmessage) message |
| `POSITION_APP` | `3` | The built-in position messaging app. Payload is a [Position](/docs/developers/protobufs/api#position) message |
| `NODEINFO_APP` | `4` | The built-in user info app. Payload is a [User](/docs/developers/protobufs/api#user) message |
| `ROUTING_APP` | `5` | Protocol control packets for mesh protocol use. Payload is a [Routing](/docs/developers/protobufs/api#routing) message |
| `ADMIN_APP` | `6` | Admin control packets. Payload is a [AdminMessage](/docs/developers/protobufs/api#adminmessage) message |
| `TEXT_MESSAGE_COMPRESSED_APP` | `7` | Compressed TEXT_MESSAGE payloads. |
| `WAYPOINT_APP` | `8` | Waypoint payloads. Payload is a [Waypoint](/docs/protobufs/api#waypoint) message |
| `WAYPOINT_APP` | `8` | Waypoint payloads. Payload is a [Waypoint](/docs/developers/protobufs/api#waypoint) message |
| `REPLY_APP` | `32` | Provides a 'ping' service that replies to any packet it receives. Also serves as a small example module. |
| `IP_TUNNEL_APP` | `33` | Used for the python IP tunnel feature |
| `SERIAL_APP` | `64` | Provides a hardware serial interface to send and receive from the Meshtastic network. Connect to the RX/TX pins of a device with 38400 8N1. Packets received from the Meshtastic network is forwarded to the RX pin while sending a packet to TX will go out to the Mesh network. Maximum packet size of 240 bytes. Module is disabled by default can be turned on by setting SERIAL_MODULE_ENABLED = 1 in SerialPlugh.cpp. |

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

@ -102,7 +102,7 @@ If the channelid 'well known'/public it could be decrypted by a web service (if
#### Service Envelope
The payload published on mesh/... will always be wrapped in a [ServiceEnvelope protobuf](/docs/protobufs/api#serviceenvelope).
The payload published on mesh/... will always be wrapped in a [ServiceEnvelope protobuf](/docs/developers/protobufs/api#serviceenvelope).
ServiceEnvelope will include the message, and full information about arrival time, who forwarded it, source channel, source mesh id, etc...

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

@ -46,7 +46,7 @@ meshtastic --set network.wifi_ssid mywifissid --set network.wifi_psk mywifipsw -
```
:::note
For a full list of preferences which can be set (and their documentation) can be found in the [protobufs](/docs/protobufs/api#radioconfiguserpreferences).
For a full list of preferences which can be set (and their documentation) can be found in the [protobufs](/docs/developers/protobufs/api#radioconfiguserpreferences).
:::
### Changing channel settings

2
protobuf.tmpl
View file

@ -1,7 +1,7 @@
---
id: protobuf-api
title: Protobuf API Reference
slug: /protobufs/api
slug: /developers/protobufs/api
sidebar_label: Protobufs
sidebar_position: 20
---