sforkowany z mirror/meshtastic-firmware
mqtt design progress
Kevin Hester
rodzic
f80d357b77
commit
d6912cfd8e
|
|
@ -1,45 +1,31 @@
|
||||||
|
|
||||||
# 1. Table of Contents
|
# Table of Contents
|
||||||
- [1. Table of Contents](#1-table-of-contents)
|
- [Table of Contents](#table-of-contents)
|
||||||
- [1.1. Abstract](#11-abstract)
|
- [Abstract](#abstract)
|
||||||
- [1.2. Short term goals](#12-short-term-goals)
|
- [Short term goals](#short-term-goals)
|
||||||
- [1.3. Long term goals](#13-long-term-goals)
|
- [Long term goals](#long-term-goals)
|
||||||
- [1.4. Security](#14-security)
|
- [Multiple Channel support / Security](#multiple-channel-support--security)
|
||||||
- [1.5. On device API](#15-on-device-api)
|
- [On device API](#on-device-api)
|
||||||
- [1.6. Efficient MQTT](#16-efficient-mqtt)
|
- [Efficient MQTT](#efficient-mqtt)
|
||||||
- [1.6.1. Topics](#161-topics)
|
- [Topics](#topics)
|
||||||
- [1.6.1.1. MESHID](#1611-meshid)
|
- [Service Envelope](#service-envelope)
|
||||||
- [1.6.1.2. NODEID](#1612-nodeid)
|
- [NODEID](#nodeid)
|
||||||
- [1.6.1.3. DESTCLASS](#1613-destclass)
|
- [USERID](#userid)
|
||||||
- [1.6.1.4. DESTID](#1614-destid)
|
- [CHANNELID](#channelid)
|
||||||
- [1.6.1.5. USERID](#1615-userid)
|
- [Gateway nodes](#gateway-nodes)
|
||||||
- [1.6.2. Gateway nodes](#162-gateway-nodes)
|
- [Optional web services](#optional-web-services)
|
||||||
- [1.6.2.1. Default ToInternet filters](#1621-default-tointernet-filters)
|
- [Public MQTT broker service](#public-mqtt-broker-service)
|
||||||
- [1.6.2.2. Default FromInternet subscriptions](#1622-default-frominternet-subscriptions)
|
- [Riot.im messaging bridge](#riotim-messaging-bridge)
|
||||||
- [1.6.3. Optional web services](#163-optional-web-services)
|
- [Deprecated concepts](#deprecated-concepts)
|
||||||
- [1.6.3.1. Public MQTT broker service](#1631-public-mqtt-broker-service)
|
- [MESHID (deprecated)](#meshid-deprecated)
|
||||||
- [1.6.3.2. Riot.im messaging bridge](#1632-riotim-messaging-bridge)
|
- [DESTCLASS (deprecated)](#destclass-deprecated)
|
||||||
- [1.6.4. Named attribute API](#164-named-attribute-api)
|
- [DESTID (deprecated)](#destid-deprecated)
|
||||||
- [1.6.5. Name to ID mapping](#165-name-to-id-mapping)
|
- [Rejected idea: RAW UDP](#rejected-idea-raw-udp)
|
||||||
- [1.7. Development plan](#17-development-plan)
|
- [Development plan](#development-plan)
|
||||||
- [1.7.1. Cleanup/refactoring of existing codebase](#171-cleanuprefactoring-of-existing-codebase)
|
- [Cleanup/refactoring of existing codebase](#cleanuprefactoring-of-existing-codebase)
|
||||||
- [1.7.2. New 'no-code-IOT' mini-app](#172-new-no-code-iot-mini-app)
|
- [Enhancements in following releases](#enhancements-in-following-releases)
|
||||||
- [1.7.2.1. Supported operations in the initial release](#1721-supported-operations-in-the-initial-release)
|
|
||||||
- [1.7.2.2. Supported operations eventually](#1722-supported-operations-eventually)
|
|
||||||
- [1.7.3. Later release features (1.2)](#173-later-release-features-12)
|
|
||||||
|
|
||||||
## 1.1. Abstract
|
## Abstract
|
||||||
|
|
||||||
FIXME:
|
|
||||||
|
|
||||||
- add channels as security
|
|
||||||
- have a uplinkPolicy enum (none, up only, down only, updown, stay encrypted)
|
|
||||||
- add simpler mapping of channels/nodes/messages/portnums to mqtt topics
|
|
||||||
- leave payloads as raw packets/protobufs
|
|
||||||
- explain why not UDP
|
|
||||||
- need to have a server anyways so that nodes can reach each other from anywhere
|
|
||||||
- raw UDP is dropped **very** agressively by many cellular providers
|
|
||||||
- mqtt provides a nice/documented/standard security model to build upon
|
|
||||||
|
|
||||||
This is a mini-doc/RFC sketching out a development plan to satisfy a number of 1.1 goals.
|
This is a mini-doc/RFC sketching out a development plan to satisfy a number of 1.1 goals.
|
||||||
|
|
||||||
|
|
@ -49,7 +35,7 @@ This is a mini-doc/RFC sketching out a development plan to satisfy a number of 1
|
||||||
- An easy way to let desktop app developers remotely control GPIOs. Issue #[182](https://github.com/meshtastic/Meshtastic-device/issues/182)
|
- An easy way to let desktop app developers remotely control GPIOs. Issue #[182](https://github.com/meshtastic/Meshtastic-device/issues/182)
|
||||||
- Remote attribute access (to change settings of distant nodes). Issue #182
|
- Remote attribute access (to change settings of distant nodes). Issue #182
|
||||||
|
|
||||||
## 1.2. Short term goals
|
## Short term goals
|
||||||
|
|
||||||
- We want a clean API for novice developers to write mini "apps" that run **on the device** with the existing messaging/location "apps".
|
- We want a clean API for novice developers to write mini "apps" that run **on the device** with the existing messaging/location "apps".
|
||||||
- We want the ability to have a gateway web service, so that if any node in the mesh can connect to the internet (via its connected phone app or directly) then that node will provide bidirectional messaging between nodes and the internet.
|
- We want the ability to have a gateway web service, so that if any node in the mesh can connect to the internet (via its connected phone app or directly) then that node will provide bidirectional messaging between nodes and the internet.
|
||||||
|
|
@ -59,69 +45,97 @@ This is a mini-doc/RFC sketching out a development plan to satisfy a number of 1
|
||||||
- This work should be independent of our current (semi-custom) LoRa transport, so that in the future we can swap out that transport if we wish (to QMesh or Reticulum?)
|
- This work should be independent of our current (semi-custom) LoRa transport, so that in the future we can swap out that transport if we wish (to QMesh or Reticulum?)
|
||||||
- Our networks are (usually) very slow and low bandwidth, so the messaging must be very airtime efficient.
|
- Our networks are (usually) very slow and low bandwidth, so the messaging must be very airtime efficient.
|
||||||
|
|
||||||
## 1.3. Long term goals
|
## Long term goals
|
||||||
|
|
||||||
- Store and forward messaging should be supported, so apps can send messages that might be delivered to their destination in **hours** or **days** if a node/mesh was partitioned.
|
- Store and forward messaging should be supported, so apps can send messages that might be delivered to their destination in **hours** or **days** if a node/mesh was partitioned.
|
||||||
|
|
||||||
## 1.4. Security
|
## Multiple Channel support / Security
|
||||||
|
|
||||||
Mini-apps API can bind to particular channels. They will only see messages sent on that channel.
|
Mini-apps API can bind to particular channels. They will only see messages sent on that channel.
|
||||||
|
|
||||||
During the 1.1 timeframe only one channel is supported per node, but eventually we will do things like "remote admin operations / channel settings etc..." are on the "Control" channel and only especially trusted users should have the keys to access that channel.
|
During the 1.0 timeframe only one channel was supported per node. Starting in the 1.1 tree we will do things like "remote admin operations / channel settings etc..." are on the "Control" channel and only especially trusted users should have the keys to access that channel.
|
||||||
|
|
||||||
See "Named Attribute API" section for special access control to prevent remote access to device settings.
|
FIXME - explain this more, talk about how useful for users and security domains.
|
||||||
|
- add channels as security
|
||||||
|
- have a uplinkPolicy enum (none, up only, down only, updown, stay encrypted)
|
||||||
|
-
|
||||||
|
## On device API
|
||||||
|
|
||||||
## 1.5. On device API
|
For information on the related on-device API see [here](device-api.md).
|
||||||
|
|
||||||
FIXME - add an example of the on-device API. Possibly by showing the new position or texting code.
|
## Efficient MQTT
|
||||||
|
|
||||||
## 1.6. Efficient MQTT
|
Any gateway-device will contact the MQTT broker.
|
||||||
|
|
||||||
A gateway-device will contact the MQTT broker. For each operation it will use the meshtastic "MESHID/NODEID" tuple as the MQTT "client ID". MESHIDs will be (TBD somehow) tracked and authenticated out-of-band.
|
### Topics
|
||||||
|
|
||||||
### 1.6.1. Topics
|
|
||||||
|
|
||||||
A sample [topic](https://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices/) hierarchy for a complete functioning mesh:
|
A sample [topic](https://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices/) hierarchy for a complete functioning mesh:
|
||||||
|
|
||||||
| Topic | Description |
|
Gateway nodes will foward any MeshPacket from a local mesh channel with uplink_enabled. The packet (encapsulated in a ServiceEnvelope). The packets will remain encrypted with the key for the specified channel.
|
||||||
| --------------------------------------- | --------------------------------------------------- |
|
mesh/crypt/CHANNELID/NODEID/PORTID
|
||||||
| MESHID/NODEID/id/upd | A node ID update broadcast |
|
|
||||||
| MESHID/NODEID/pos/upd | A position update broadcast |
|
|
||||||
| MESHID/NODEID/pos/req | A position update request |
|
|
||||||
| MESHID/USERID/msg/text/DESTCLASS/DESTID | A text message from USERID to DESTCLASS/DESTID |
|
|
||||||
| MESHID/NODEID/msg/bin/DESTCLASS/DESTID | A binary message from NODEID to DESTCLASS/DESTCLASS |
|
|
||||||
| MESHID/NODEID/gpio/set/GPIONUM | Set a GPIO output |
|
|
||||||
| MESHID/NODEID/attr/ATTRNAME/req | Request a current attribute value |
|
|
||||||
| MESHID/NODEID/attr/ATTRNAME/set | Set an attribute value |
|
|
||||||
| MESHID/NODEID/app/APPNUM/# | An topic from an unregistered/unknown app |
|
|
||||||
|
|
||||||
for encrypted packets (consumer would need to have access to the specified channel to be able to parse)
|
For any channels in the local node with downlink_enabled, the gateway node will forward packets from MQTT to the local mesh. It will do this by subscribing to mesh/crypt/CHANNELID/# and forwarding relevant packets.
|
||||||
|
|
||||||
encrypted/CHANNELID/MESHID/NODEID/PORTID
|
If the channelid 'well known'/public it could be decrypted by a web service (if the web service was provided with the associated channel key), in which case it will be decrypted by a web service and appear at "mesh/clear/NODEID/PORTID". Note: This is not in the initial deliverable.
|
||||||
|
|
||||||
If the channelid 'well known'/public it can be decrypted by a web service, in which case it will be decrypted by a web service and appear at:
|
|
||||||
|
|
||||||
clear/MESHID/NODEID/PORTID
|
FIXME, discuss how text message global mirroring could scale (or not)
|
||||||
|
|
||||||
FIXME, remove concept of meshid for now? optionally add to envelope later?
|
|
||||||
|
|
||||||
FIXME, the payload published on the topic, will include the message, and full information about arrival time, who forwarded it, source channel etc... Use a ServiceEnvelope protobuf.
|
|
||||||
|
|
||||||
FIXME, use public mqtt servers, leave messages encrypted
|
|
||||||
FIXME, include testcase of trivial text message global mirroring
|
|
||||||
FIXME, possibly don't global mirror text messages - instead rely on matrix/riot?
|
FIXME, possibly don't global mirror text messages - instead rely on matrix/riot?
|
||||||
FIXME, figure out how channelids work
|
|
||||||
FIXME, figure out rules for store and forward
|
|
||||||
|
|
||||||
#### 1.6.1.1. MESHID
|
#### Service Envelope
|
||||||
|
|
||||||
A unique ID for this mesh. There will be some sort of key exchange process so that the mesh ID can not be impersonated by other meshes.
|
The payload published on mesh/... will always be wrapped in a ServiceEnvelope protobuf.
|
||||||
|
|
||||||
#### 1.6.1.2. NODEID
|
FIXME, the payload published on the topic, will include the message, and full information about arrival time, who forwarded it, source channel, source mesh id, etc...
|
||||||
|
|
||||||
|
#### NODEID
|
||||||
|
|
||||||
The unique ID for a node. A hex string that starts with a ! symbol.
|
The unique ID for a node. A hex string that starts with a ! symbol.
|
||||||
|
|
||||||
#### 1.6.1.3. DESTCLASS
|
#### USERID
|
||||||
|
|
||||||
|
A user ID string. This string is either a user ID if known or a nodeid to simply deliver the message to whoever the local user is of a particular device (i.e. person who might see the screen). FIXME, see what riot.im uses and perhaps use that convention? Or use the signal +phone number convention? Or the email addr?
|
||||||
|
|
||||||
|
#### CHANNELID
|
||||||
|
|
||||||
|
FIXME, figure out how channelids work
|
||||||
|
|
||||||
|
### Gateway nodes
|
||||||
|
|
||||||
|
Any meshtastic node that has a direct connection to the internet (either via a helper app or installed wifi/4G/satellite hardware) can function as a "Gateway node".
|
||||||
|
|
||||||
|
Gateway nodes (via code running in the phone) will contain two tables to whitelist particular traffic to either be delivered toward the internet, or down toward the mesh. Users that are developing custom apps will be able to customize these filters/subscriptions.
|
||||||
|
|
||||||
|
Since multiple gateway nodes might be connected to a single mesh, it is possible that duplicate messages will be published on any particular topic. Therefore subscribers to these topics should
|
||||||
|
deduplicate if needed by using the packet ID of each message.
|
||||||
|
|
||||||
|
### Optional web services
|
||||||
|
|
||||||
|
#### Public MQTT broker service
|
||||||
|
|
||||||
|
An existing public [MQTT broker](https://mosquitto.org/) will be the default for this service, but clients can use any MQTT broker they choose.
|
||||||
|
|
||||||
|
FIXME - figure out how to avoid impersonation (because we are initially using a public mqtt server with no special security options). FIXME, include some ideas on this in the ServiceEnvelope documentation.
|
||||||
|
|
||||||
|
#### Riot.im messaging bridge
|
||||||
|
|
||||||
|
@Geeksville will run a riot.im bridge that talks to the public MQTT broker and sends/receives into the riot.im network.
|
||||||
|
|
||||||
|
There is apparently [already](https://github.com/derEisele/tuple) a riot.im [bridge](https://matrix.org/bridges/) for MQTT. That will possibly need to be customized a bit. But by doing this, we should be able to let random riot.im users send/receive messages to/from any meshtastic device. (FIXME ponder security). See this [issue](https://github.com/meshtastic/Meshtastic-Android/issues/2#issuecomment-645660990) with discussion with the dev.
|
||||||
|
|
||||||
|
### Deprecated concepts
|
||||||
|
|
||||||
|
You can ignore these for now...
|
||||||
|
|
||||||
|
#### MESHID (deprecated)
|
||||||
|
|
||||||
|
Earlier drafts of this document included the concept of a MESHID. That concept has been removed for now, but might be useful in the future. The old idea is listed below:
|
||||||
|
|
||||||
|
A unique ID for this mesh. There will be some sort of key exchange process so that the mesh ID can not be impersonated by other meshes.
|
||||||
|
|
||||||
|
#### DESTCLASS (deprecated)
|
||||||
|
|
||||||
|
Earlier drafts of this document included the concept of a DESTCLASS. That concept has been removed for now, but might be useful in the future. The old idea is listed below:
|
||||||
|
|
||||||
The type of DESTID this message should be delivered to. A short one letter sequence:
|
The type of DESTID this message should be delivered to. A short one letter sequence:
|
||||||
|
|
||||||
|
|
@ -133,7 +147,9 @@ The type of DESTID this message should be delivered to. A short one letter seque
|
||||||
| S | SMS gateway, DESTID is a phone number to reach via Twilio.com |
|
| S | SMS gateway, DESTID is a phone number to reach via Twilio.com |
|
||||||
| E | Emergency message, see bug #fixme for more context |
|
| E | Emergency message, see bug #fixme for more context |
|
||||||
|
|
||||||
#### 1.6.1.4. DESTID
|
#### DESTID (deprecated)
|
||||||
|
|
||||||
|
Earlier drafts of this document included the concept of a DESTCLASS. That concept has been removed for now, but might be useful in the future. The old idea is listed below:
|
||||||
|
|
||||||
Can be...
|
Can be...
|
||||||
|
|
||||||
|
|
@ -141,108 +157,28 @@ Can be...
|
||||||
- ^ALL for anyone
|
- ^ALL for anyone
|
||||||
- An app ID (to allow apps out in the web to receive arbitrary binary data from nodes or simply other apps using meshtastic as a transport). They would connect to the MQTT broker and subscribe to their topic
|
- An app ID (to allow apps out in the web to receive arbitrary binary data from nodes or simply other apps using meshtastic as a transport). They would connect to the MQTT broker and subscribe to their topic
|
||||||
|
|
||||||
#### 1.6.1.5. USERID
|
## Rejected idea: RAW UDP
|
||||||
|
- FIXME explain why not UDP
|
||||||
A user ID string. This string is either a user ID if known or a nodeid to simply deliver the message to whoever the local user is of a particular device (i.e. person who might see the screen). FIXME, see what riot.im uses and perhaps use that convention? Or use the signal +phone number convention? Or the email addr?
|
- need to have a server anyways so that nodes can reach each other from anywhere
|
||||||
|
- raw UDP is dropped **very** agressively by many cellular providers
|
||||||
### 1.6.2. Gateway nodes
|
- mqtt provides a nice/documented/standard security model to build upon
|
||||||
|
|
||||||
Any meshtastic node that has a direct connection to the internet (either via a helper app or installed wifi/4G/satellite hardware) can function as a "Gateway node".
|
## Development plan
|
||||||
|
|
||||||
Gateway nodes (via code running in the phone) will contain two tables to whitelist particular traffic to either be delivered toward the internet, or down toward the mesh. Users that are developing custom apps will be able to customize these filters/subscriptions.
|
|
||||||
|
|
||||||
#### 1.6.2.1. Default ToInternet filters
|
|
||||||
|
|
||||||
These filters are used to whitelist particular traffic - only traffic that matches a filter will be forwarded to the internet MQTT broker.
|
|
||||||
|
|
||||||
| Pattern | Description |
|
|
||||||
| ---------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| +/+/id/# | Only if set for 'no privacy' |
|
|
||||||
| +/+/pos/upd | Only if set for 'no privacy' - useful for showing all nodes on a world map |
|
|
||||||
| +/+/msg/text/W/+ | For internet messaging feature |
|
|
||||||
| +/+/app/APPNUM/# | Only if "send app APPNUM" has been set in gateway settings - for app developers who want their traffic routed to the world |
|
|
||||||
|
|
||||||
#### 1.6.2.2. Default FromInternet subscriptions
|
|
||||||
|
|
||||||
The gateway node will always subscribe to certain topics on the broker so that it can forward those topics into the mesh.
|
|
||||||
|
|
||||||
| Pattern | Description |
|
|
||||||
| --------------------- | ------------------------------------------------------------------------------- |
|
|
||||||
| MESHID/+/msg/text/W/+ | To receive text messages from the internet (where the sender knows our mesh ID) |
|
|
||||||
| +/+/msg/text/W/USERID | For each named user on the local mesh, to receive messages bound for that user |
|
|
||||||
|
|
||||||
### 1.6.3. Optional web services
|
|
||||||
|
|
||||||
#### 1.6.3.1. Public MQTT broker service
|
|
||||||
|
|
||||||
@Geeksville will provide a standard [MQTT broker](https://mosquitto.org/) on the web to facilitate use of this service, but clients can use any MQTT broker they choose. Geeksville will initially not charge for the use of this broker, but if it becomes a burden he might ask for donations or require a payment for the use of the server.
|
|
||||||
|
|
||||||
The provided public MQTT broker from geeksville.com will also have filters to ensure:
|
|
||||||
|
|
||||||
- only authenticated MESHIDs can publish under that ID
|
|
||||||
- messages sent/to from the riot.im text message bridge can only be seen by that bridge or the intended destination/source mesh
|
|
||||||
|
|
||||||
Is used to filter whole classes of destination IDs (DESTID). Can be...
|
|
||||||
|
|
||||||
- L - Local, for this mesh only.
|
|
||||||
- W - World, for this mesh and the broader internet
|
|
||||||
|
|
||||||
#### 1.6.3.2. Riot.im messaging bridge
|
|
||||||
|
|
||||||
@Geeksville will run a riot.im bridge that talks to the public MQTT broker and sends/receives into the riot.im network.
|
|
||||||
|
|
||||||
There is apparently [already](https://github.com/derEisele/tuple) a riot.im [bridge](https://matrix.org/bridges/) for MQTT. That will possibly need to be customized a bit. But by doing this, we should be able to let random riot.im users send/receive messages to/from any meshtastic device. (FIXME ponder security). See this [issue](https://github.com/meshtastic/Meshtastic-Android/issues/2#issuecomment-645660990) with discussion with the dev.
|
|
||||||
|
|
||||||
### 1.6.4. Named attribute API
|
|
||||||
|
|
||||||
The current channel and node settings are set/read using a special protobuf exchange between a local client and the meshtastic device. In version 1.1 that mechanism will be changed so that settings are set/read using MQTT (even when done locally). This will enable remote node adminstration (even conceivably through the internet).
|
|
||||||
|
|
||||||
To provide some basic security a new named attribute name "seckey" can be set. If set, any attribute operations must include that get with their operation request. Note: This mechanism still assumes that users you grant permission to access your local mesh are not 'adversaries'. A technically competent user could discover the remote attribute key needed for attribute reading/writing. In the 1.2ish timeframe we will add the concept of multiple channels and in that case, remote attribute operations will be on their own secured channel that regular 'users' can not see.
|
|
||||||
|
|
||||||
### 1.6.5. Name to ID mapping
|
|
||||||
|
|
||||||
MQTT topic strings are very long and potentially expensive over the slow LORA network. Also, we don't want to burden each (dumb) node in the mesh with having to regex match against them. For that reason, well known topics map to (small) "topic IDs". For portions of the topic that correspond to a wildcard, those strings are provided as "topic arguments". This means that only the phone app needs to consider full topic strings. Device nodes will only understand integer topic IDs and their arguments.
|
|
||||||
|
|
||||||
FIXME, add more details to this section and figure out how unassigned apps/topics work in this framework.
|
|
||||||
|
|
||||||
## 1.7. Development plan
|
|
||||||
|
|
||||||
Given the previous problem/goals statement, here's the initial thoughts on the work items required. As this idea becomes a bit more fully baked we should add details
|
Given the previous problem/goals statement, here's the initial thoughts on the work items required. As this idea becomes a bit more fully baked we should add details
|
||||||
on how this will be implemented and guesses at approximate work items.
|
on how this will be implemented and guesses at approximate work items.
|
||||||
|
|
||||||
### 1.7.1. Cleanup/refactoring of existing codebase
|
### Cleanup/refactoring of existing codebase
|
||||||
|
|
||||||
- Change nodeIDs to be base64 instead of eight hex digits.
|
- Change nodeIDs to be base64 instead of eight hex digits.
|
||||||
- Add the concept of topic IDs and topic arguments to the protobufs and the device code.
|
- DONE Refactor the position features into a position "mini-app". Use only the new public on-device API to implement this app.
|
||||||
- Refactor the position features into a position "mini-app". Use only the new public on-device API to implement this app.
|
- DONE Refactor the on device texting features into a messaging "mini-app". (Similar to the position mini-app)
|
||||||
- Refactor the on device texting features into a messaging "mini-app". (Similar to the position mini-app)
|
- Add new multi channel concept
|
||||||
- Add first cut of the "gateway node" code (i.e. MQTT broker client) to the python API (very little code needed for this component)
|
- Add first cut of the "gateway node" code (i.e. MQTT broker client) to the python API (very little code needed for this component)
|
||||||
- Confirm that texting works to/from the internet
|
- Confirm that texting works to/from the internet
|
||||||
- Confirm that positions are optionally sent to the internet
|
- Confirm that positions are optionally sent to the internet
|
||||||
- Add the first cut of the "gateway node" code to the android app (very little code needed for this component)
|
- Add the first cut of the "gateway node" code to the android app (very little code needed for this component)
|
||||||
|
|
||||||
### 1.7.2. New 'no-code-IOT' mini-app
|
### Enhancements in following releases
|
||||||
|
|
||||||
Add a new 'remote GPIO/serial port/SPI/I2C access' mini-app. This new standard app would use the MQTT messaging layer to let users (developers that don't need to write device code) do basic (potentially dangerous) operations remotely.
|
|
||||||
|
|
||||||
#### 1.7.2.1. Supported operations in the initial release
|
|
||||||
|
|
||||||
Initially supported features for no-code-IOT.
|
|
||||||
|
|
||||||
- Set any GPIO
|
|
||||||
- Read any GPIO
|
|
||||||
|
|
||||||
#### 1.7.2.2. Supported operations eventually
|
|
||||||
|
|
||||||
General ideas for no-code IOT.
|
|
||||||
|
|
||||||
- Subscribe for notification of GPIO input status change (i.e. when pin goes low, send my app a message)
|
|
||||||
- Write/read N bytes over I2C/SPI bus Y (as one atomic I2C/SPI transaction)
|
|
||||||
- Send N bytes out serial port Z
|
|
||||||
- Subscribe for notification for when regex X matches the bytes that were received on serial port Z
|
|
||||||
|
|
||||||
### 1.7.3. Later release features (1.2)
|
|
||||||
|
|
||||||
- Allow radios to be on multiple channels at once. Each channel will have its own encryption keys.
|
|
||||||
|
|
||||||
|
|
||||||
|
FIXME, figure out rules for store and forward
|
||||||
|
|
@ -0,0 +1,23 @@
|
||||||
|
# Remote Hardware Service
|
||||||
|
|
||||||
|
FIXME - the following are a collection of notes moved from elsewhere. We need to refactor these notes into actual documentation on the remote-hardware/gpio service.
|
||||||
|
|
||||||
|
### 1.7.2. New 'no-code-IOT' mini-app
|
||||||
|
|
||||||
|
Add a new 'remote GPIO/serial port/SPI/I2C access' mini-app. This new standard app would use the MQTT messaging layer to let users (developers that don't need to write device code) do basic (potentially dangerous) operations remotely.
|
||||||
|
|
||||||
|
#### 1.7.2.1. Supported operations in the initial release
|
||||||
|
|
||||||
|
Initially supported features for no-code-IOT.
|
||||||
|
|
||||||
|
- Set any GPIO
|
||||||
|
- Read any GPIO
|
||||||
|
|
||||||
|
#### 1.7.2.2. Supported operations eventually
|
||||||
|
|
||||||
|
General ideas for no-code IOT.
|
||||||
|
|
||||||
|
- Subscribe for notification of GPIO input status change (i.e. when pin goes low, send my app a message)
|
||||||
|
- Write/read N bytes over I2C/SPI bus Y (as one atomic I2C/SPI transaction)
|
||||||
|
- Send N bytes out serial port Z
|
||||||
|
- Subscribe for notification for when regex X matches the bytes that were received on serial port Z
|
||||||
2
proto
2
proto
|
|
@ -1 +1 @@
|
||||||
Subproject commit 323b814f4392ae0f9c42a0f14557c6b9333efce3
|
Subproject commit 5a23071d2363725ca954562f00bfca0d5717ca79
|
||||||
|
|
@ -0,0 +1,12 @@
|
||||||
|
/* Automatically generated nanopb constant definitions */
|
||||||
|
/* Generated by nanopb-0.4.4 */
|
||||||
|
|
||||||
|
#include "deviceonly.pb.h"
|
||||||
|
#if PB_PROTO_HEADER_VERSION != 40
|
||||||
|
#error Regenerate this file with the current version of nanopb generator.
|
||||||
|
#endif
|
||||||
|
|
||||||
|
PB_BIND(DeviceState, DeviceState, 2)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -0,0 +1,89 @@
|
||||||
|
/* Automatically generated nanopb header */
|
||||||
|
/* Generated by nanopb-0.4.4 */
|
||||||
|
|
||||||
|
#ifndef PB_DEVICEONLY_PB_H_INCLUDED
|
||||||
|
#define PB_DEVICEONLY_PB_H_INCLUDED
|
||||||
|
#include <pb.h>
|
||||||
|
#include "mesh.pb.h"
|
||||||
|
|
||||||
|
#if PB_PROTO_HEADER_VERSION != 40
|
||||||
|
#error Regenerate this file with the current version of nanopb generator.
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* Struct definitions */
|
||||||
|
typedef struct _DeviceState {
|
||||||
|
bool has_radio;
|
||||||
|
RadioConfig radio;
|
||||||
|
bool has_my_node;
|
||||||
|
MyNodeInfo my_node;
|
||||||
|
bool has_owner;
|
||||||
|
User owner;
|
||||||
|
pb_size_t node_db_count;
|
||||||
|
NodeInfo node_db[32];
|
||||||
|
pb_size_t receive_queue_count;
|
||||||
|
MeshPacket receive_queue[1];
|
||||||
|
bool has_rx_text_message;
|
||||||
|
MeshPacket rx_text_message;
|
||||||
|
uint32_t version;
|
||||||
|
bool no_save;
|
||||||
|
bool did_gps_reset;
|
||||||
|
pb_size_t secondary_channels_count;
|
||||||
|
ChannelSettings secondary_channels[4];
|
||||||
|
} DeviceState;
|
||||||
|
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* Initializer values for message structs */
|
||||||
|
#define DeviceState_init_default {false, RadioConfig_init_default, false, MyNodeInfo_init_default, false, User_init_default, 0, {NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default}, 0, {MeshPacket_init_default}, false, MeshPacket_init_default, 0, 0, 0, 0, {ChannelSettings_init_default, ChannelSettings_init_default, ChannelSettings_init_default, ChannelSettings_init_default}}
|
||||||
|
#define DeviceState_init_zero {false, RadioConfig_init_zero, false, MyNodeInfo_init_zero, false, User_init_zero, 0, {NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero}, 0, {MeshPacket_init_zero}, false, MeshPacket_init_zero, 0, 0, 0, 0, {ChannelSettings_init_zero, ChannelSettings_init_zero, ChannelSettings_init_zero, ChannelSettings_init_zero}}
|
||||||
|
|
||||||
|
/* Field tags (for use in manual encoding/decoding) */
|
||||||
|
#define DeviceState_radio_tag 1
|
||||||
|
#define DeviceState_my_node_tag 2
|
||||||
|
#define DeviceState_owner_tag 3
|
||||||
|
#define DeviceState_node_db_tag 4
|
||||||
|
#define DeviceState_receive_queue_tag 5
|
||||||
|
#define DeviceState_rx_text_message_tag 7
|
||||||
|
#define DeviceState_version_tag 8
|
||||||
|
#define DeviceState_no_save_tag 9
|
||||||
|
#define DeviceState_did_gps_reset_tag 11
|
||||||
|
#define DeviceState_secondary_channels_tag 12
|
||||||
|
|
||||||
|
/* Struct field encoding specification for nanopb */
|
||||||
|
#define DeviceState_FIELDLIST(X, a) \
|
||||||
|
X(a, STATIC, OPTIONAL, MESSAGE, radio, 1) \
|
||||||
|
X(a, STATIC, OPTIONAL, MESSAGE, my_node, 2) \
|
||||||
|
X(a, STATIC, OPTIONAL, MESSAGE, owner, 3) \
|
||||||
|
X(a, STATIC, REPEATED, MESSAGE, node_db, 4) \
|
||||||
|
X(a, STATIC, REPEATED, MESSAGE, receive_queue, 5) \
|
||||||
|
X(a, STATIC, OPTIONAL, MESSAGE, rx_text_message, 7) \
|
||||||
|
X(a, STATIC, SINGULAR, UINT32, version, 8) \
|
||||||
|
X(a, STATIC, SINGULAR, BOOL, no_save, 9) \
|
||||||
|
X(a, STATIC, SINGULAR, BOOL, did_gps_reset, 11) \
|
||||||
|
X(a, STATIC, REPEATED, MESSAGE, secondary_channels, 12)
|
||||||
|
#define DeviceState_CALLBACK NULL
|
||||||
|
#define DeviceState_DEFAULT NULL
|
||||||
|
#define DeviceState_radio_MSGTYPE RadioConfig
|
||||||
|
#define DeviceState_my_node_MSGTYPE MyNodeInfo
|
||||||
|
#define DeviceState_owner_MSGTYPE User
|
||||||
|
#define DeviceState_node_db_MSGTYPE NodeInfo
|
||||||
|
#define DeviceState_receive_queue_MSGTYPE MeshPacket
|
||||||
|
#define DeviceState_rx_text_message_MSGTYPE MeshPacket
|
||||||
|
#define DeviceState_secondary_channels_MSGTYPE ChannelSettings
|
||||||
|
|
||||||
|
extern const pb_msgdesc_t DeviceState_msg;
|
||||||
|
|
||||||
|
/* Defines for backwards compatibility with code written before nanopb-0.4.0 */
|
||||||
|
#define DeviceState_fields &DeviceState_msg
|
||||||
|
|
||||||
|
/* Maximum encoded size of messages (where known) */
|
||||||
|
#define DeviceState_size 5885
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
} /* extern "C" */
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#include "mesh.pb.h"
|
#include "mesh.pb.h"
|
||||||
|
#include "deviceonly.pb.h"
|
||||||
|
|
||||||
// this file defines constants which come from mesh.options
|
// this file defines constants which come from mesh.options
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -39,9 +39,6 @@ PB_BIND(NodeInfo, NodeInfo, AUTO)
|
||||||
PB_BIND(MyNodeInfo, MyNodeInfo, AUTO)
|
PB_BIND(MyNodeInfo, MyNodeInfo, AUTO)
|
||||||
|
|
||||||
|
|
||||||
PB_BIND(DeviceState, DeviceState, 2)
|
|
||||||
|
|
||||||
|
|
||||||
PB_BIND(LogRecord, LogRecord, AUTO)
|
PB_BIND(LogRecord, LogRecord, AUTO)
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -87,6 +87,9 @@ typedef struct _ChannelSettings {
|
||||||
uint32_t spread_factor;
|
uint32_t spread_factor;
|
||||||
uint32_t coding_rate;
|
uint32_t coding_rate;
|
||||||
uint32_t channel_num;
|
uint32_t channel_num;
|
||||||
|
uint32_t id;
|
||||||
|
bool uplink_enabled;
|
||||||
|
bool downlink_enabled;
|
||||||
} ChannelSettings;
|
} ChannelSettings;
|
||||||
|
|
||||||
typedef PB_BYTES_ARRAY_T(240) Data_payload_t;
|
typedef PB_BYTES_ARRAY_T(240) Data_payload_t;
|
||||||
|
|
@ -222,26 +225,6 @@ typedef struct _MeshPacket {
|
||||||
bool want_ack;
|
bool want_ack;
|
||||||
} MeshPacket;
|
} MeshPacket;
|
||||||
|
|
||||||
typedef struct _DeviceState {
|
|
||||||
bool has_radio;
|
|
||||||
RadioConfig radio;
|
|
||||||
bool has_my_node;
|
|
||||||
MyNodeInfo my_node;
|
|
||||||
bool has_owner;
|
|
||||||
User owner;
|
|
||||||
pb_size_t node_db_count;
|
|
||||||
NodeInfo node_db[32];
|
|
||||||
pb_size_t receive_queue_count;
|
|
||||||
MeshPacket receive_queue[1];
|
|
||||||
bool has_rx_text_message;
|
|
||||||
MeshPacket rx_text_message;
|
|
||||||
uint32_t version;
|
|
||||||
bool no_save;
|
|
||||||
bool did_gps_reset;
|
|
||||||
pb_size_t secondary_channels_count;
|
|
||||||
ChannelSettings secondary_channels[4];
|
|
||||||
} DeviceState;
|
|
||||||
|
|
||||||
typedef struct _FromRadio {
|
typedef struct _FromRadio {
|
||||||
uint32_t num;
|
uint32_t num;
|
||||||
pb_size_t which_variant;
|
pb_size_t which_variant;
|
||||||
|
|
@ -253,7 +236,7 @@ typedef struct _FromRadio {
|
||||||
LogRecord log_record;
|
LogRecord log_record;
|
||||||
uint32_t config_complete_id;
|
uint32_t config_complete_id;
|
||||||
bool rebooted;
|
bool rebooted;
|
||||||
ChannelSettings secondary_channel;
|
ChannelSettings channel;
|
||||||
} variant;
|
} variant;
|
||||||
} FromRadio;
|
} FromRadio;
|
||||||
|
|
||||||
|
|
@ -264,6 +247,7 @@ typedef struct _ToRadio {
|
||||||
uint32_t want_config_id;
|
uint32_t want_config_id;
|
||||||
RadioConfig set_radio;
|
RadioConfig set_radio;
|
||||||
User set_owner;
|
User set_owner;
|
||||||
|
ChannelSettings set_channel;
|
||||||
} variant;
|
} variant;
|
||||||
} ToRadio;
|
} ToRadio;
|
||||||
|
|
||||||
|
|
@ -313,12 +297,11 @@ extern "C" {
|
||||||
#define RouteDiscovery_init_default {0, {0, 0, 0, 0, 0, 0, 0, 0}}
|
#define RouteDiscovery_init_default {0, {0, 0, 0, 0, 0, 0, 0, 0}}
|
||||||
#define SubPacket_init_default {0, {Position_init_default}, 0, 0, 0, 0, {0}, 0}
|
#define SubPacket_init_default {0, {Position_init_default}, 0, 0, 0, 0, {0}, 0}
|
||||||
#define MeshPacket_init_default {0, 0, 0, {SubPacket_init_default}, 0, 0, 0, 0, 0, 0}
|
#define MeshPacket_init_default {0, 0, 0, {SubPacket_init_default}, 0, 0, 0, 0, 0, 0}
|
||||||
#define ChannelSettings_init_default {0, _ChannelSettings_ModemConfig_MIN, {0, {0}}, "", 0, 0, 0, 0}
|
#define ChannelSettings_init_default {0, _ChannelSettings_ModemConfig_MIN, {0, {0}}, "", 0, 0, 0, 0, 0, 0, 0}
|
||||||
#define RadioConfig_init_default {false, RadioConfig_UserPreferences_init_default, false, ChannelSettings_init_default}
|
#define RadioConfig_init_default {false, RadioConfig_UserPreferences_init_default, false, ChannelSettings_init_default}
|
||||||
#define RadioConfig_UserPreferences_init_default {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, "", "", 0, _RegionCode_MIN, _LocationSharing_MIN, _GpsOperation_MIN, 0, 0, 0, 0, 0, 0, 0, 0, {0, 0, 0}}
|
#define RadioConfig_UserPreferences_init_default {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, "", "", 0, _RegionCode_MIN, _LocationSharing_MIN, _GpsOperation_MIN, 0, 0, 0, 0, 0, 0, 0, 0, {0, 0, 0}}
|
||||||
#define NodeInfo_init_default {0, false, User_init_default, false, Position_init_default, 0, 0}
|
#define NodeInfo_init_default {0, false, User_init_default, false, Position_init_default, 0, 0}
|
||||||
#define MyNodeInfo_init_default {0, 0, 0, "", "", "", _CriticalErrorCode_MIN, 0, 0, 0, 0, 0, 0, 0}
|
#define MyNodeInfo_init_default {0, 0, 0, "", "", "", _CriticalErrorCode_MIN, 0, 0, 0, 0, 0, 0, 0}
|
||||||
#define DeviceState_init_default {false, RadioConfig_init_default, false, MyNodeInfo_init_default, false, User_init_default, 0, {NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default, NodeInfo_init_default}, 0, {MeshPacket_init_default}, false, MeshPacket_init_default, 0, 0, 0, 0, {ChannelSettings_init_default, ChannelSettings_init_default, ChannelSettings_init_default, ChannelSettings_init_default}}
|
|
||||||
#define LogRecord_init_default {"", 0, "", _LogRecord_Level_MIN}
|
#define LogRecord_init_default {"", 0, "", _LogRecord_Level_MIN}
|
||||||
#define FromRadio_init_default {0, 0, {MeshPacket_init_default}}
|
#define FromRadio_init_default {0, 0, {MeshPacket_init_default}}
|
||||||
#define ToRadio_init_default {0, {MeshPacket_init_default}}
|
#define ToRadio_init_default {0, {MeshPacket_init_default}}
|
||||||
|
|
@ -328,12 +311,11 @@ extern "C" {
|
||||||
#define RouteDiscovery_init_zero {0, {0, 0, 0, 0, 0, 0, 0, 0}}
|
#define RouteDiscovery_init_zero {0, {0, 0, 0, 0, 0, 0, 0, 0}}
|
||||||
#define SubPacket_init_zero {0, {Position_init_zero}, 0, 0, 0, 0, {0}, 0}
|
#define SubPacket_init_zero {0, {Position_init_zero}, 0, 0, 0, 0, {0}, 0}
|
||||||
#define MeshPacket_init_zero {0, 0, 0, {SubPacket_init_zero}, 0, 0, 0, 0, 0, 0}
|
#define MeshPacket_init_zero {0, 0, 0, {SubPacket_init_zero}, 0, 0, 0, 0, 0, 0}
|
||||||
#define ChannelSettings_init_zero {0, _ChannelSettings_ModemConfig_MIN, {0, {0}}, "", 0, 0, 0, 0}
|
#define ChannelSettings_init_zero {0, _ChannelSettings_ModemConfig_MIN, {0, {0}}, "", 0, 0, 0, 0, 0, 0, 0}
|
||||||
#define RadioConfig_init_zero {false, RadioConfig_UserPreferences_init_zero, false, ChannelSettings_init_zero}
|
#define RadioConfig_init_zero {false, RadioConfig_UserPreferences_init_zero, false, ChannelSettings_init_zero}
|
||||||
#define RadioConfig_UserPreferences_init_zero {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, "", "", 0, _RegionCode_MIN, _LocationSharing_MIN, _GpsOperation_MIN, 0, 0, 0, 0, 0, 0, 0, 0, {0, 0, 0}}
|
#define RadioConfig_UserPreferences_init_zero {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, "", "", 0, _RegionCode_MIN, _LocationSharing_MIN, _GpsOperation_MIN, 0, 0, 0, 0, 0, 0, 0, 0, {0, 0, 0}}
|
||||||
#define NodeInfo_init_zero {0, false, User_init_zero, false, Position_init_zero, 0, 0}
|
#define NodeInfo_init_zero {0, false, User_init_zero, false, Position_init_zero, 0, 0}
|
||||||
#define MyNodeInfo_init_zero {0, 0, 0, "", "", "", _CriticalErrorCode_MIN, 0, 0, 0, 0, 0, 0, 0}
|
#define MyNodeInfo_init_zero {0, 0, 0, "", "", "", _CriticalErrorCode_MIN, 0, 0, 0, 0, 0, 0, 0}
|
||||||
#define DeviceState_init_zero {false, RadioConfig_init_zero, false, MyNodeInfo_init_zero, false, User_init_zero, 0, {NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero, NodeInfo_init_zero}, 0, {MeshPacket_init_zero}, false, MeshPacket_init_zero, 0, 0, 0, 0, {ChannelSettings_init_zero, ChannelSettings_init_zero, ChannelSettings_init_zero, ChannelSettings_init_zero}}
|
|
||||||
#define LogRecord_init_zero {"", 0, "", _LogRecord_Level_MIN}
|
#define LogRecord_init_zero {"", 0, "", _LogRecord_Level_MIN}
|
||||||
#define FromRadio_init_zero {0, 0, {MeshPacket_init_zero}}
|
#define FromRadio_init_zero {0, 0, {MeshPacket_init_zero}}
|
||||||
#define ToRadio_init_zero {0, {MeshPacket_init_zero}}
|
#define ToRadio_init_zero {0, {MeshPacket_init_zero}}
|
||||||
|
|
@ -347,6 +329,9 @@ extern "C" {
|
||||||
#define ChannelSettings_spread_factor_tag 7
|
#define ChannelSettings_spread_factor_tag 7
|
||||||
#define ChannelSettings_coding_rate_tag 8
|
#define ChannelSettings_coding_rate_tag 8
|
||||||
#define ChannelSettings_channel_num_tag 9
|
#define ChannelSettings_channel_num_tag 9
|
||||||
|
#define ChannelSettings_id_tag 10
|
||||||
|
#define ChannelSettings_uplink_enabled_tag 16
|
||||||
|
#define ChannelSettings_downlink_enabled_tag 17
|
||||||
#define Data_portnum_tag 1
|
#define Data_portnum_tag 1
|
||||||
#define Data_payload_tag 2
|
#define Data_payload_tag 2
|
||||||
#define LogRecord_message_tag 1
|
#define LogRecord_message_tag 1
|
||||||
|
|
@ -430,16 +415,6 @@ extern "C" {
|
||||||
#define MeshPacket_rx_time_tag 9
|
#define MeshPacket_rx_time_tag 9
|
||||||
#define MeshPacket_hop_limit_tag 10
|
#define MeshPacket_hop_limit_tag 10
|
||||||
#define MeshPacket_want_ack_tag 11
|
#define MeshPacket_want_ack_tag 11
|
||||||
#define DeviceState_radio_tag 1
|
|
||||||
#define DeviceState_my_node_tag 2
|
|
||||||
#define DeviceState_owner_tag 3
|
|
||||||
#define DeviceState_node_db_tag 4
|
|
||||||
#define DeviceState_receive_queue_tag 5
|
|
||||||
#define DeviceState_rx_text_message_tag 7
|
|
||||||
#define DeviceState_version_tag 8
|
|
||||||
#define DeviceState_no_save_tag 9
|
|
||||||
#define DeviceState_did_gps_reset_tag 11
|
|
||||||
#define DeviceState_secondary_channels_tag 12
|
|
||||||
#define FromRadio_num_tag 1
|
#define FromRadio_num_tag 1
|
||||||
#define FromRadio_packet_tag 2
|
#define FromRadio_packet_tag 2
|
||||||
#define FromRadio_my_info_tag 3
|
#define FromRadio_my_info_tag 3
|
||||||
|
|
@ -448,11 +423,12 @@ extern "C" {
|
||||||
#define FromRadio_log_record_tag 7
|
#define FromRadio_log_record_tag 7
|
||||||
#define FromRadio_config_complete_id_tag 8
|
#define FromRadio_config_complete_id_tag 8
|
||||||
#define FromRadio_rebooted_tag 9
|
#define FromRadio_rebooted_tag 9
|
||||||
#define FromRadio_secondary_channel_tag 10
|
#define FromRadio_channel_tag 10
|
||||||
#define ToRadio_packet_tag 1
|
#define ToRadio_packet_tag 1
|
||||||
#define ToRadio_want_config_id_tag 100
|
#define ToRadio_want_config_id_tag 100
|
||||||
#define ToRadio_set_radio_tag 101
|
#define ToRadio_set_radio_tag 101
|
||||||
#define ToRadio_set_owner_tag 102
|
#define ToRadio_set_owner_tag 102
|
||||||
|
#define ToRadio_set_channel_tag 103
|
||||||
|
|
||||||
/* Struct field encoding specification for nanopb */
|
/* Struct field encoding specification for nanopb */
|
||||||
#define Position_FIELDLIST(X, a) \
|
#define Position_FIELDLIST(X, a) \
|
||||||
|
|
@ -527,7 +503,10 @@ X(a, STATIC, SINGULAR, STRING, name, 5) \
|
||||||
X(a, STATIC, SINGULAR, UINT32, bandwidth, 6) \
|
X(a, STATIC, SINGULAR, UINT32, bandwidth, 6) \
|
||||||
X(a, STATIC, SINGULAR, UINT32, spread_factor, 7) \
|
X(a, STATIC, SINGULAR, UINT32, spread_factor, 7) \
|
||||||
X(a, STATIC, SINGULAR, UINT32, coding_rate, 8) \
|
X(a, STATIC, SINGULAR, UINT32, coding_rate, 8) \
|
||||||
X(a, STATIC, SINGULAR, UINT32, channel_num, 9)
|
X(a, STATIC, SINGULAR, UINT32, channel_num, 9) \
|
||||||
|
X(a, STATIC, SINGULAR, FIXED32, id, 10) \
|
||||||
|
X(a, STATIC, SINGULAR, BOOL, uplink_enabled, 16) \
|
||||||
|
X(a, STATIC, SINGULAR, BOOL, downlink_enabled, 17)
|
||||||
#define ChannelSettings_CALLBACK NULL
|
#define ChannelSettings_CALLBACK NULL
|
||||||
#define ChannelSettings_DEFAULT NULL
|
#define ChannelSettings_DEFAULT NULL
|
||||||
|
|
||||||
|
|
@ -596,27 +575,6 @@ X(a, STATIC, SINGULAR, UINT32, min_app_version, 14)
|
||||||
#define MyNodeInfo_CALLBACK NULL
|
#define MyNodeInfo_CALLBACK NULL
|
||||||
#define MyNodeInfo_DEFAULT NULL
|
#define MyNodeInfo_DEFAULT NULL
|
||||||
|
|
||||||
#define DeviceState_FIELDLIST(X, a) \
|
|
||||||
X(a, STATIC, OPTIONAL, MESSAGE, radio, 1) \
|
|
||||||
X(a, STATIC, OPTIONAL, MESSAGE, my_node, 2) \
|
|
||||||
X(a, STATIC, OPTIONAL, MESSAGE, owner, 3) \
|
|
||||||
X(a, STATIC, REPEATED, MESSAGE, node_db, 4) \
|
|
||||||
X(a, STATIC, REPEATED, MESSAGE, receive_queue, 5) \
|
|
||||||
X(a, STATIC, OPTIONAL, MESSAGE, rx_text_message, 7) \
|
|
||||||
X(a, STATIC, SINGULAR, UINT32, version, 8) \
|
|
||||||
X(a, STATIC, SINGULAR, BOOL, no_save, 9) \
|
|
||||||
X(a, STATIC, SINGULAR, BOOL, did_gps_reset, 11) \
|
|
||||||
X(a, STATIC, REPEATED, MESSAGE, secondary_channels, 12)
|
|
||||||
#define DeviceState_CALLBACK NULL
|
|
||||||
#define DeviceState_DEFAULT NULL
|
|
||||||
#define DeviceState_radio_MSGTYPE RadioConfig
|
|
||||||
#define DeviceState_my_node_MSGTYPE MyNodeInfo
|
|
||||||
#define DeviceState_owner_MSGTYPE User
|
|
||||||
#define DeviceState_node_db_MSGTYPE NodeInfo
|
|
||||||
#define DeviceState_receive_queue_MSGTYPE MeshPacket
|
|
||||||
#define DeviceState_rx_text_message_MSGTYPE MeshPacket
|
|
||||||
#define DeviceState_secondary_channels_MSGTYPE ChannelSettings
|
|
||||||
|
|
||||||
#define LogRecord_FIELDLIST(X, a) \
|
#define LogRecord_FIELDLIST(X, a) \
|
||||||
X(a, STATIC, SINGULAR, STRING, message, 1) \
|
X(a, STATIC, SINGULAR, STRING, message, 1) \
|
||||||
X(a, STATIC, SINGULAR, FIXED32, time, 2) \
|
X(a, STATIC, SINGULAR, FIXED32, time, 2) \
|
||||||
|
|
@ -634,7 +592,7 @@ X(a, STATIC, ONEOF, MESSAGE, (variant,radio,variant.radio), 6) \
|
||||||
X(a, STATIC, ONEOF, MESSAGE, (variant,log_record,variant.log_record), 7) \
|
X(a, STATIC, ONEOF, MESSAGE, (variant,log_record,variant.log_record), 7) \
|
||||||
X(a, STATIC, ONEOF, UINT32, (variant,config_complete_id,variant.config_complete_id), 8) \
|
X(a, STATIC, ONEOF, UINT32, (variant,config_complete_id,variant.config_complete_id), 8) \
|
||||||
X(a, STATIC, ONEOF, BOOL, (variant,rebooted,variant.rebooted), 9) \
|
X(a, STATIC, ONEOF, BOOL, (variant,rebooted,variant.rebooted), 9) \
|
||||||
X(a, STATIC, ONEOF, MESSAGE, (variant,secondary_channel,variant.secondary_channel), 10)
|
X(a, STATIC, ONEOF, MESSAGE, (variant,channel,variant.channel), 10)
|
||||||
#define FromRadio_CALLBACK NULL
|
#define FromRadio_CALLBACK NULL
|
||||||
#define FromRadio_DEFAULT NULL
|
#define FromRadio_DEFAULT NULL
|
||||||
#define FromRadio_variant_packet_MSGTYPE MeshPacket
|
#define FromRadio_variant_packet_MSGTYPE MeshPacket
|
||||||
|
|
@ -642,18 +600,20 @@ X(a, STATIC, ONEOF, MESSAGE, (variant,secondary_channel,variant.secondary_
|
||||||
#define FromRadio_variant_node_info_MSGTYPE NodeInfo
|
#define FromRadio_variant_node_info_MSGTYPE NodeInfo
|
||||||
#define FromRadio_variant_radio_MSGTYPE RadioConfig
|
#define FromRadio_variant_radio_MSGTYPE RadioConfig
|
||||||
#define FromRadio_variant_log_record_MSGTYPE LogRecord
|
#define FromRadio_variant_log_record_MSGTYPE LogRecord
|
||||||
#define FromRadio_variant_secondary_channel_MSGTYPE ChannelSettings
|
#define FromRadio_variant_channel_MSGTYPE ChannelSettings
|
||||||
|
|
||||||
#define ToRadio_FIELDLIST(X, a) \
|
#define ToRadio_FIELDLIST(X, a) \
|
||||||
X(a, STATIC, ONEOF, MESSAGE, (variant,packet,variant.packet), 1) \
|
X(a, STATIC, ONEOF, MESSAGE, (variant,packet,variant.packet), 1) \
|
||||||
X(a, STATIC, ONEOF, UINT32, (variant,want_config_id,variant.want_config_id), 100) \
|
X(a, STATIC, ONEOF, UINT32, (variant,want_config_id,variant.want_config_id), 100) \
|
||||||
X(a, STATIC, ONEOF, MESSAGE, (variant,set_radio,variant.set_radio), 101) \
|
X(a, STATIC, ONEOF, MESSAGE, (variant,set_radio,variant.set_radio), 101) \
|
||||||
X(a, STATIC, ONEOF, MESSAGE, (variant,set_owner,variant.set_owner), 102)
|
X(a, STATIC, ONEOF, MESSAGE, (variant,set_owner,variant.set_owner), 102) \
|
||||||
|
X(a, STATIC, ONEOF, MESSAGE, (variant,set_channel,variant.set_channel), 103)
|
||||||
#define ToRadio_CALLBACK NULL
|
#define ToRadio_CALLBACK NULL
|
||||||
#define ToRadio_DEFAULT NULL
|
#define ToRadio_DEFAULT NULL
|
||||||
#define ToRadio_variant_packet_MSGTYPE MeshPacket
|
#define ToRadio_variant_packet_MSGTYPE MeshPacket
|
||||||
#define ToRadio_variant_set_radio_MSGTYPE RadioConfig
|
#define ToRadio_variant_set_radio_MSGTYPE RadioConfig
|
||||||
#define ToRadio_variant_set_owner_MSGTYPE User
|
#define ToRadio_variant_set_owner_MSGTYPE User
|
||||||
|
#define ToRadio_variant_set_channel_MSGTYPE ChannelSettings
|
||||||
|
|
||||||
extern const pb_msgdesc_t Position_msg;
|
extern const pb_msgdesc_t Position_msg;
|
||||||
extern const pb_msgdesc_t Data_msg;
|
extern const pb_msgdesc_t Data_msg;
|
||||||
|
|
@ -666,7 +626,6 @@ extern const pb_msgdesc_t RadioConfig_msg;
|
||||||
extern const pb_msgdesc_t RadioConfig_UserPreferences_msg;
|
extern const pb_msgdesc_t RadioConfig_UserPreferences_msg;
|
||||||
extern const pb_msgdesc_t NodeInfo_msg;
|
extern const pb_msgdesc_t NodeInfo_msg;
|
||||||
extern const pb_msgdesc_t MyNodeInfo_msg;
|
extern const pb_msgdesc_t MyNodeInfo_msg;
|
||||||
extern const pb_msgdesc_t DeviceState_msg;
|
|
||||||
extern const pb_msgdesc_t LogRecord_msg;
|
extern const pb_msgdesc_t LogRecord_msg;
|
||||||
extern const pb_msgdesc_t FromRadio_msg;
|
extern const pb_msgdesc_t FromRadio_msg;
|
||||||
extern const pb_msgdesc_t ToRadio_msg;
|
extern const pb_msgdesc_t ToRadio_msg;
|
||||||
|
|
@ -683,7 +642,6 @@ extern const pb_msgdesc_t ToRadio_msg;
|
||||||
#define RadioConfig_UserPreferences_fields &RadioConfig_UserPreferences_msg
|
#define RadioConfig_UserPreferences_fields &RadioConfig_UserPreferences_msg
|
||||||
#define NodeInfo_fields &NodeInfo_msg
|
#define NodeInfo_fields &NodeInfo_msg
|
||||||
#define MyNodeInfo_fields &MyNodeInfo_msg
|
#define MyNodeInfo_fields &MyNodeInfo_msg
|
||||||
#define DeviceState_fields &DeviceState_msg
|
|
||||||
#define LogRecord_fields &LogRecord_msg
|
#define LogRecord_fields &LogRecord_msg
|
||||||
#define FromRadio_fields &FromRadio_msg
|
#define FromRadio_fields &FromRadio_msg
|
||||||
#define ToRadio_fields &ToRadio_msg
|
#define ToRadio_fields &ToRadio_msg
|
||||||
|
|
@ -695,12 +653,11 @@ extern const pb_msgdesc_t ToRadio_msg;
|
||||||
#define RouteDiscovery_size 88
|
#define RouteDiscovery_size 88
|
||||||
#define SubPacket_size 275
|
#define SubPacket_size 275
|
||||||
#define MeshPacket_size 320
|
#define MeshPacket_size 320
|
||||||
#define ChannelSettings_size 84
|
#define ChannelSettings_size 95
|
||||||
#define RadioConfig_size 308
|
#define RadioConfig_size 319
|
||||||
#define RadioConfig_UserPreferences_size 219
|
#define RadioConfig_UserPreferences_size 219
|
||||||
#define NodeInfo_size 132
|
#define NodeInfo_size 132
|
||||||
#define MyNodeInfo_size 106
|
#define MyNodeInfo_size 106
|
||||||
#define DeviceState_size 5814
|
|
||||||
#define LogRecord_size 81
|
#define LogRecord_size 81
|
||||||
#define FromRadio_size 329
|
#define FromRadio_size 329
|
||||||
#define ToRadio_size 323
|
#define ToRadio_size 323
|
||||||
|
|
|
||||||
Ładowanie…
Reference in New Issue