final formatting fix

pull/7/head
Sacha Weatherstone 2021-01-17 17:50:35 +11:00
rodzic 71f425d5d1
commit fa9bb79f2a
4 zmienionych plików z 68 dodań i 39 usunięć

Wyświetl plik

@ -6,18 +6,24 @@ option optimize_for = LITE_RUNTIME;
import "mesh.proto"; import "mesh.proto";
/** /*
This message wraps a MeshPacket with extra metadata about the sender and how it arrived. * This message wraps a MeshPacket with extra metadata about the sender and how it arrived.
*/ */
message ServiceEnvelope { message ServiceEnvelope {
/** The (probably encrypted) packet */ /*
* The (probably encrypted) packet
*/
MeshPacket packet = 1; MeshPacket packet = 1;
/** The global channel ID it was sent on */ /*
* The global channel ID it was sent on
*/
string channel_id = 2; string channel_id = 2;
/** The sending gateway. Can we use this to authenticate/prevent fake /*
nodeid impersonation for senders? - i.e. use gateway/mesh id (which is authenticated) + local node id as * The sending gateway. Can we use this to authenticate/prevent fake
the globally trusted nodenum */ * nodeid impersonation for senders? - i.e. use gateway/mesh id (which is authenticated) + local node id as
* the globally trusted nodenum
*/
string gateway_id = 3; string gateway_id = 3;
} }

Wyświetl plik

@ -6,45 +6,62 @@ option optimize_for = LITE_RUNTIME;
import "mesh.proto"; import "mesh.proto";
// This message is never sent over the wire, but it is used for serializing DB /*
// state to flash in the device code * This message is never sent over the wire, but it is used for serializing DB
// FIXME, since we write this each time we enter deep sleep (and have infinite * state to flash in the device code
// flash) it would be better to use some sort of append only data structure for * FIXME, since we write this each time we enter deep sleep (and have infinite
// the receive queue and use the preferences store for the other stuff * flash) it would be better to use some sort of append only data structure for
* the receive queue and use the preferences store for the other stuff
*/
message DeviceState { message DeviceState {
RadioConfig radio = 1; RadioConfig radio = 1;
/// Read only settings/info about this node /*
* Read only settings/info about this node
*/
MyNodeInfo my_node = 2; MyNodeInfo my_node = 2;
/// My owner info /*
* My owner info
*/
User owner = 3; User owner = 3;
repeated NodeInfo node_db = 4; repeated NodeInfo node_db = 4;
/// Received packets saved for delivery to the phone /*
* Received packets saved for delivery to the phone
*/
repeated MeshPacket receive_queue = 5; repeated MeshPacket receive_queue = 5;
/** A version integer used to invalidate old save files when we make /*
incompatible changes This integer is set at build time and is private to * A version integer used to invalidate old save files when we make
NodeDB.cpp in the device code. */ * incompatible changes This integer is set at build time and is private to
* NodeDB.cpp in the device code.
*/
uint32 version = 8; uint32 version = 8;
// We keep the last received text message (only) stored in the device flash, /*
// so we can show it on the screen. Might be null * We keep the last received text message (only) stored in the device flash,
* so we can show it on the screen.
* Might be null
*/
MeshPacket rx_text_message = 7; MeshPacket rx_text_message = 7;
// Used only during development. Indicates developer is testing and changes /*
// should never be saved to flash. * Used only during development. Indicates developer is testing and changes
* should never be saved to flash.
*/
bool no_save = 9; bool no_save = 9;
// Some GPSes seem to have bogus settings from the factory, so we always do /*
// one factory reset * Some GPSes seem to have bogus settings from the factory, so we always do one factory reset.
*/
bool did_gps_reset = 11; bool did_gps_reset = 11;
/** Secondary channels are only used for encryption/decryption/authentication purposes. Their radio settings (freq etc) /*
are ignored, only psk is used. * Secondary channels are only used for encryption/decryption/authentication purposes. Their radio settings (freq etc)
Note: this is not kept inside of RadioConfig because that would make ToRadio/FromRadio worse case > 512 bytes (to big for BLE) * are ignored, only psk is used.
*/ * Note: this is not kept inside of RadioConfig because that would make ToRadio/FromRadio worse case > 512 bytes (to big for BLE)
*/
repeated ChannelSettings secondary_channels = 12; repeated ChannelSettings secondary_channels = 12;
} }

Wyświetl plik

@ -57,8 +57,10 @@ message Position {
fixed32 time = 9; fixed32 time = 9;
} }
// a data message to forward to an external app (or possibly also be consumed /*
// internally in the case of CLEAR_TEXT and CLEAR_READACK) * a data message to forward to an external app (or possibly also be consumed
* internally in the case of CLEAR_TEXT and CLEAR_READACK)
*/
message Data { message Data {
/* /*
@ -181,10 +183,14 @@ message SubPacket {
*/ */
RouteError route_error = 13; RouteError route_error = 13;
// Prior to 1.20 positions were communicated as a special payload type, now they are GPS_POSITION_APP Data /*
* Prior to 1.20 positions were communicated as a special payload type, now they are GPS_POSITION_APP Data
*/
Position position = 1 [deprecated = true]; Position position = 1 [deprecated = true];
// Prior to 1.20 positions were communicated as a special payload type, now they are MESH_USERINFO_APP /*
* Prior to 1.20 positions were communicated as a special payload type, now they are MESH_USERINFO_APP
*/
User user = 4 [deprecated = true]; User user = 4 [deprecated = true];
} }
@ -1184,10 +1190,10 @@ message ToRadio {
*/ */
User set_owner = 102; User set_owner = 102;
// Set channels (using the new API). The first sent channel is assumed to be channel /*
// index 0 the "primary channel". Following records are secondary channels. * Set channels (using the new API). The first sent channel is assumed to be channel
* index 0 the "primary channel". Following records are secondary channels.
*/
ChannelSettings set_channel = 103; ChannelSettings set_channel = 103;
} }
} }

Wyświetl plik

@ -65,4 +65,4 @@ message HardwareMessage {
* Not used for all MessageTypes, see MessageType for details * Not used for all MessageTypes, see MessageType for details
*/ */
uint64 gpio_value = 3; uint64 gpio_value = 3;
} }