Skip to content

Commit

Permalink
Merge pull request meshtastic#7 from sachaw/master
Browse files Browse the repository at this point in the history
Fix comment formatting
  • Loading branch information
mc-hamster authored Jan 21, 2021
2 parents 855da87 + fa9bb79 commit f9ebc9b
Show file tree
Hide file tree
Showing 6 changed files with 1,029 additions and 753 deletions.
22 changes: 14 additions & 8 deletions apponly.proto
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,24 @@ option optimize_for = LITE_RUNTIME;

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 {
/** The (probably encrypted) packet */
/*
* The (probably encrypted) packet
*/
MeshPacket packet = 1;

/** The global channel ID it was sent on */
/*
* The global channel ID it was sent on
*/
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 globally trusted nodenum */
/*
* 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 globally trusted nodenum
*/
string gateway_id = 3;
}
59 changes: 38 additions & 21 deletions deviceonly.proto
Original file line number Diff line number Diff line change
Expand Up @@ -6,45 +6,62 @@ option optimize_for = LITE_RUNTIME;

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
// FIXME, since we write this each time we enter deep sleep (and have infinite
// 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
/*
* This message is never sent over the wire, but it is used for serializing DB
* state to flash in the device code
* FIXME, since we write this each time we enter deep sleep (and have infinite
* 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 {
RadioConfig radio = 1;

/// Read only settings/info about this node
/*
* Read only settings/info about this node
*/
MyNodeInfo my_node = 2;

/// My owner info
/*
* My owner info
*/
User owner = 3;

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;

/** 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
NodeDB.cpp in the device code. */
/*
* 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
* NodeDB.cpp in the device code.
*/
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;

// 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;

// 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;

/** Secondary channels are only used for encryption/decryption/authentication purposes. Their radio settings (freq etc)
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)
*/
/*
* Secondary channels are only used for encryption/decryption/authentication purposes. Their radio settings (freq etc)
* 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;
}
Loading

0 comments on commit f9ebc9b

Please sign in to comment.