diff --git a/docs/docs.md b/docs/docs.md index c2d39bc..ffa956b 100644 --- a/docs/docs.md +++ b/docs/docs.md @@ -41,9 +41,9 @@ - [Constants](#.Constants) - [CriticalErrorCode](#.CriticalErrorCode) + - [HardwareModel](#.HardwareModel) - [LogRecord.Level](#.LogRecord.Level) - [MeshPacket.Priority](#.MeshPacket.Priority) - - [NodeInfo.HardwareModel](#.NodeInfo.HardwareModel) - [Routing.Error](#.Routing.Error) - [portnums.proto](#portnums.proto) @@ -589,7 +589,6 @@ Full information about a node on the mesh | user | [User](#User) | | The user info for this node | | position | [Position](#Position) | | This position data will also contain a time last seen | | snr | [float](#float) | | Returns the Signal-to-noise ratio (SNR) of the last received message, as measured by the receiver. Return SNR of the last received message in dB | -| hw_model | [NodeInfo.HardwareModel](#NodeInfo.HardwareModel) | | TBEAM, HELTEC, etc... Starting in 1.2.11 moved to hw_model enum in the NodeInfo object. Apps will still need the string here for older builds (so OTA update can find the right image), but if the enum is available it will be used instead. | @@ -699,6 +698,7 @@ A few nodenums are reserved and will never be requested: | long_name | [string](#string) | | A full name for this user, i.e. "Kevin Hester" | | short_name | [string](#string) | | A VERY short name, ideally two characters. Suitable for a tiny OLED screen | | macaddr | [bytes](#bytes) | | This is the addr of the radio. Not populated by the phone, but added by the esp32 when broadcasting | +| hw_model | [HardwareModel](#HardwareModel) | | TBEAM, HELTEC, etc... Starting in 1.2.11 moved to hw_model enum in the NodeInfo object. Apps will still need the string here for older builds (so OTA update can find the right image), but if the enum is available it will be used instead. | @@ -743,6 +743,34 @@ and we'll try to help. + + +### HardwareModel +Note: these enum names must EXACTLY match the string used in the device +bin/build-all.sh script. Because they will be used to find firmware filenames +in the android app for OTA updates. +To match the old style filenames, _ is converted to -, p is converted to . + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNSET | 0 | | +| TLORA_V2 | 1 | | +| TLORA_V1 | 2 | | +| TLORA_V2_1_1p6 | 3 | | +| TBEAM | 4 | | +| HELTEC | 5 | | +| TBEAM0p7 | 6 | | +| T_ECHO | 7 | | +| TLORA_V1_1p3 | 8 | | +| LORA_RELAY_V1 | 32 | Less common/prototype boards listed here (needs one more byte over the air) | +| NRF52840DK | 33 | | +| PPR | 34 | | +| GENIEBLOCKS | 35 | | +| NRF52_UNKNOWN | 36 | | +| PORTDUINO | 37 | | + + + ### LogRecord.Level @@ -798,34 +826,6 @@ And the transmission queue in the router object is now a priority queue. - - -### NodeInfo.HardwareModel -Note: these enum names must EXACTLY match the string used in the device -bin/build-all.sh script. Because they will be used to find firmware filenames -in the android app for OTA updates. -To match the old style filenames, _ is converted to -, p is converted to . - -| Name | Number | Description | -| ---- | ------ | ----------- | -| UNSET | 0 | | -| TLORA_V2 | 1 | | -| TLORA_V1 | 2 | | -| TLORA_V2_1_1p6 | 3 | | -| TBEAM | 4 | | -| HELTEC | 5 | | -| TBEAM0p7 | 6 | | -| T_ECHO | 7 | | -| TLORA_V1_1p3 | 8 | | -| LORA_RELAY_V1 | 32 | Less common/prototype boards listed here (needs one more byte over the air) | -| NRF52840DK | 33 | | -| PPR | 34 | | -| GENIEBLOCKS | 35 | | -| NRF52_UNKNOWN | 36 | | -| PORTDUINO | 37 | | - - - ### Routing.Error diff --git a/mesh.proto b/mesh.proto index bc63913..5a9c891 100644 --- a/mesh.proto +++ b/mesh.proto @@ -74,6 +74,32 @@ message Position { fixed32 time = 9; } +/** + * Note: these enum names must EXACTLY match the string used in the device + * bin/build-all.sh script. Because they will be used to find firmware filenames + * in the android app for OTA updates. + * To match the old style filenames, _ is converted to -, p is converted to . + */ + enum HardwareModel { + UNSET = 0; + TLORA_V2 = 1; + TLORA_V1 = 2; + TLORA_V2_1_1p6 = 3; + TBEAM = 4; + HELTEC = 5; + TBEAM0p7 = 6; + T_ECHO = 7; + TLORA_V1_1p3 = 8; + + // Less common/prototype boards listed here (needs one more byte over the air) + LORA_RELAY_V1 = 32; + NRF52840DK = 33; + PPR = 34; + GENIEBLOCKS = 35; + NRF52_UNKNOWN = 36; + PORTDUINO = 37; + } + /* * Broadcast when a newly powered mesh node wants to find a node num it can use * Sent from the phone over bluetooth to set the user id for the owner of this node. @@ -126,6 +152,13 @@ message User { * but added by the esp32 when broadcasting */ bytes macaddr = 4; + + /* + * TBEAM, HELTEC, etc... + * Starting in 1.2.11 moved to hw_model enum in the NodeInfo object. Apps will still need the string here for older builds + * (so OTA update can find the right image), but if the enum is available it will be used instead. + */ + HardwareModel hw_model = 6; } /* @@ -486,32 +519,6 @@ enum Constants { */ message NodeInfo { - /** - * Note: these enum names must EXACTLY match the string used in the device - * bin/build-all.sh script. Because they will be used to find firmware filenames - * in the android app for OTA updates. - * To match the old style filenames, _ is converted to -, p is converted to . - */ - enum HardwareModel { - UNSET = 0; - TLORA_V2 = 1; - TLORA_V1 = 2; - TLORA_V2_1_1p6 = 3; - TBEAM = 4; - HELTEC = 5; - TBEAM0p7 = 6; - T_ECHO = 7; - TLORA_V1_1p3 = 8; - - // Less common/prototype boards listed here (needs one more byte over the air) - LORA_RELAY_V1 = 32; - NRF52840DK = 33; - PPR = 34; - GENIEBLOCKS = 35; - NRF52_UNKNOWN = 36; - PORTDUINO = 37; - } - /* * the node number */ @@ -557,13 +564,6 @@ message NodeInfo { * we are adjacent Or zero if we don't yet know a route to this node. * fixed32 next_hop = 5; */ - - /* - * TBEAM, HELTEC, etc... - * Starting in 1.2.11 moved to hw_model enum in the NodeInfo object. Apps will still need the string here for older builds - * (so OTA update can find the right image), but if the enum is available it will be used instead. - */ - HardwareModel hw_model = 6; } /*