Regen messages from spec 2025-10-17

Author: addshore

src/messages/m10008_base_page_gen.toit

@@ -7,6 +7,15 @@ class BasePage extends protocol.Data:
   static MT_NAME := "BasePage"
 
   static PAGE-ID := 3
+  static PAGE-ID_HOME-PAGE := 1
+
+  static PAGE-ID_STRINGS := {
+    1: "Home Page",
+  }
+
+  static page-id-from-int value/int -> string:
+    return PAGE-ID_STRINGS.get value --if-absent=(: "unknown")
+
   static STATUS-BAR-ENABLE := 5
   static REDRAW-TYPE := 6
   static REDRAW-TYPE_AUTO := 0
@@ -65,9 +74,11 @@ class BasePage extends protocol.Data:
     return protocol.Message.with-data MT data
 
   /**
-   * The page to draw or update.
-   * Page ids 0-10 are reserved for system use.
-   * If no page id is provided, page id 11 will be assumed.
+   * The page to draw.
+   *
+   *
+   * Valid values:
+   * - PAGE-ID_HOME-PAGE (1): The preset home page programmed into the device
    */
   page-id -> int:
     return get-data-uint PAGE-ID

src/messages/m10010_menu_page_gen.toit

@@ -89,18 +89,20 @@ class MenuPage extends protocol.Data:
    * The page to draw or update.
    * Page ids 0-10 are reserved for system use.
    * If no page id is provided, page id 11 will be assumed.
+   * You can provide the same page id as last time to update the menu, or a new page id to create a new menu.
    */
   page-id -> int:
     return get-data-uint PAGE-ID
 
   /**
-   * Number of items in the menu. Max 20.
+   * Number of items in the menu (max 20). Required.
    */
   item-count -> int:
     return get-data-uint ITEM-COUNT
 
   /**
-   * Optionally select a specific item, else the first will be used. 0 indexed.
+   * Optionally select a specific item, else the first will be unsubscribed.
+   * Zero indexed.
    */
   selected-item -> int:
     return get-data-uint SELECTED-ITEM

src/messages/m1004_lora_gen.toit

@@ -58,14 +58,6 @@ class LORA extends protocol.Data:
   static msg --data/protocol.Data?=protocol.Data -> protocol.Message:
     return protocol.Message.with-data MT data
 
-  /**
-   * Creates a DO Request message for LORA.
-   *
-   * Returns: A Message ready to be sent
-   */
-  static do-msg --base-data/protocol.Data?=protocol.Data -> protocol.Message:
-    return protocol.Message.with-method MT protocol.Header.METHOD-DO base-data
-
   /**
    * Creates a GET Request message for LORA.
    *

src/messages/m11_open_gen.toit

@@ -6,6 +6,7 @@ class Open extends protocol.Data:
   static MT := 11
   static MT_NAME := "Open"
 
+  static FLAGS := 1
   static DEVICE-TYPE := 10
 
   constructor:
@@ -22,8 +23,9 @@ class Open extends protocol.Data:
    *
    * Returns: A protocol.Data object with the specified field values
    */
-  static data --device-type/int?=null --base-data/protocol.Data?=protocol.Data -> protocol.Data:
+  static data --flags/int?=null --device-type/int?=null --base-data/protocol.Data?=protocol.Data -> protocol.Data:
     data := base-data
+    if flags != null: data.add-data-uint FLAGS flags
     if device-type != null: data.add-data-uint DEVICE-TYPE device-type
     return data
 
@@ -42,13 +44,19 @@ class Open extends protocol.Data:
     return protocol.Message.with-data MT data
 
   /**
-   * Type of device, relates to the serial number prefix.
-   * Primarily used by inter processor communication to identify the type of device.
+   * For future use, if used should currently always be 0
+   */
+  flags -> int:
+    return get-data-uint FLAGS
+
+  /**
+   * Type of device, relates to the SN prefix
    */
   device-type -> int:
     return get-data-uint DEVICE-TYPE
 
   stringify -> string:
     return {
+      "Flags": flags,
       "Device Type": device-type,
     }.stringify

src/messages/m13_heartbeat_gen.toit

@@ -6,6 +6,8 @@ class Heartbeat extends protocol.Data:
   static MT := 13
   static MT_NAME := "Heartbeat"
 
+  static BATTERY-PERCENT := 6
+
   constructor:
     super
 
@@ -20,7 +22,10 @@ class Heartbeat extends protocol.Data:
    *
    * Returns: A protocol.Data object with the specified field values
    */
-  static data --base-data/protocol.Data?=protocol.Data -> protocol.Data: return base-data
+  static data --battery-percent/int?=null --base-data/protocol.Data?=protocol.Data -> protocol.Data:
+    data := base-data
+    if battery-percent != null: data.add-data-uint BATTERY-PERCENT battery-percent
+    return data
 
   /**
    * Creates a Heartbeat message without a specific method.
@@ -36,6 +41,13 @@ class Heartbeat extends protocol.Data:
   static msg --data/protocol.Data?=protocol.Data -> protocol.Message:
     return protocol.Message.with-data MT data
 
+  /**
+   * Devices send battery percentage in heartbeats
+   */
+  battery-percent -> int:
+    return get-data-uint BATTERY-PERCENT
+
   stringify -> string:
     return {
+      "Battery Percent": battery-percent,
     }.stringify

src/messages/m15_position_gen.toit

@@ -19,15 +19,15 @@ class Position extends protocol.Data:
   static TYPE_INVALID := 0
   static TYPE_FIXED := 1
   static TYPE_RESERVED := 2
-  static TYPE_3D := 3
+  static TYPE_STANDALONE := 3
   static TYPE_RTK-FLOAT := 4
   static TYPE_RTK-FIX := 5
 
   static TYPE_STRINGS := {
     0: "invalid",
     1: "fixed",
     2: "reserved",
-    3: "3d",
+    3: "standalone",
     4: "rtk-float",
     5: "rtk-fix",
   }
@@ -173,7 +173,7 @@ class Position extends protocol.Data:
    * - TYPE_INVALID (0): invalid
    * - TYPE_FIXED (1): fixed
    * - TYPE_RESERVED (2): Can indicate a 2D fix, low accuracy, should be treated as invalid
-   * - TYPE_3D (3): standalone 3d fix
+   * - TYPE_STANDALONE (3): standalone 3d fix
    * - TYPE_RTK-FLOAT (4): rtk-float
    * - TYPE_RTK-FIX (5): rtk-fix
    */

src/messages/m30_transmit_now_gen.toit

@@ -34,27 +34,35 @@ class TransmitNow extends protocol.Data:
     return data
 
   /**
-   * Creates a DO Request message for Transmit Now.
+   * Creates a Transmit Now message without a specific method.
+   *
+   * This is used for messages that don't require a specific method type
+   * (like GET, SET, SUBSCRIBE) but still need to carry data.
+   *
+   * Parameters:
+   * - data: Optional protocol.Data object containing message payload
    *
    * Returns: A Message ready to be sent
    */
-  static do-msg --base-data/protocol.Data?=protocol.Data -> protocol.Message:
-    return protocol.Message.with-method MT protocol.Header.METHOD-DO base-data
+  static msg --data/protocol.Data?=protocol.Data -> protocol.Message:
+    return protocol.Message.with-data MT data
 
   /**
-   * GPS Search
+   * 0 = no gps fix required
+   * 1 = wait for GPS lock (or timeout) before send
    */
   gps-search -> bool:
     return get-data-bool GPS-SEARCH
 
   /**
-   * Data to send, can be up to 200 bytes
+   * Data to send, can be up to 200 bytes.
+   * Only supported by devices that support uart_blob sensorReading type. (Currently only Vipers)
    */
   payload -> ByteArray:
     return get-data PAYLOAD
 
   /**
-   * 0 - 10
+   * Number of retries [0-10]. Exponential backoff (10 = 25h)
    */
   retries -> int:
     return get-data-uint RETRIES

src/messages/m33_sim_settings_gen.toit

@@ -0,0 +1,108 @@
+import ..protocol as protocol
+
+// Auto generated class for protocol message
+class SIMsettings extends protocol.Data:
+
+  static MT := 33
+  static MT_NAME := "SIMsettings"
+
+  static ACTIVE-SIM := 1
+  static ACTIVE-SIM_SIM1 := 0
+  static ACTIVE-SIM_SIM2 := 1
+
+  static ACTIVE-SIM_STRINGS := {
+    0: "SIM1",
+    1: "SIM2",
+  }
+
+  static active-sim-from-int value/int -> string:
+    return ACTIVE-SIM_STRINGS.get value --if-absent=(: "unknown")
+
+  static SIM2-APN := 2
+  static SIM2-APN-USERNAME := 3
+  static SIM2-APN-PASSWORD := 4
+  static SIM2-ICCID := 8
+
+  constructor:
+    super
+
+  constructor.from-data data/protocol.Data:
+    super.from-data data
+
+  /**
+   * Creates a protocol.Data object with all available fields for this message type.
+   *
+   * This is a comprehensive helper that accepts all possible fields.
+   * For method-specific usage, consider using the dedicated request/response methods.
+   *
+   * Returns: A protocol.Data object with the specified field values
+   */
+  static data --active-sim/int?=null --sim2-apn/string?=null --sim2-apn-username/string?=null --sim2-apn-password/string?=null --sim2-iccid/string?=null --base-data/protocol.Data?=protocol.Data -> protocol.Data:
+    data := base-data
+    if active-sim != null: data.add-data-uint ACTIVE-SIM active-sim
+    if sim2-apn != null: data.add-data-ascii SIM2-APN sim2-apn
+    if sim2-apn-username != null: data.add-data-ascii SIM2-APN-USERNAME sim2-apn-username
+    if sim2-apn-password != null: data.add-data-ascii SIM2-APN-PASSWORD sim2-apn-password
+    if sim2-iccid != null: data.add-data-ascii SIM2-ICCID sim2-iccid
+    return data
+
+  /**
+   * Creates a GET Request message for SIM settings.
+   *
+   * Returns: A Message ready to be sent
+   */
+  static get-msg --base-data/protocol.Data?=protocol.Data -> protocol.Message:
+    return protocol.Message.with-method MT protocol.Header.METHOD-GET base-data
+
+  /**
+   * Creates a SET Request message for SIM settings.
+   *
+   * Returns: A Message ready to be sent
+   */
+  static set-msg --base-data/protocol.Data?=protocol.Data -> protocol.Message:
+    return protocol.Message.with-method MT protocol.Header.METHOD-SET base-data
+
+  /**
+   * Activate the specified SIM
+   * If SIM2 is selected, sending the APN settings is required
+   *
+   *
+   * Valid values:
+   * - ACTIVE-SIM_SIM1 (0): SIM1
+   * - ACTIVE-SIM_SIM2 (1): SIM2
+   */
+  active-sim -> int:
+    return get-data-uint ACTIVE-SIM
+
+  /**
+   * SIM2 APN
+   */
+  sim2-apn -> string:
+    return get-data-ascii SIM2-APN
+
+  /**
+   * SIM2 APN Username
+   */
+  sim2-apn-username -> string:
+    return get-data-ascii SIM2-APN-USERNAME
+
+  /**
+   * SIM2 APN Password
+   */
+  sim2-apn-password -> string:
+    return get-data-ascii SIM2-APN-PASSWORD
+
+  /**
+   * SIM2 ICCID if known, read-only
+   */
+  sim2-iccid -> string:
+    return get-data-ascii SIM2-ICCID
+
+  stringify -> string:
+    return {
+      "Active SIM": active-sim,
+      "SIM2 APN": sim2-apn,
+      "SIM2 APN Username": sim2-apn-username,
+      "SIM2 APN Password": sim2-apn-password,
+      "SIM2 ICCID": sim2-iccid,
+    }.stringify

src/messages/m34_device_status_gen.toit

@@ -114,25 +114,30 @@ class DeviceStatus extends protocol.Data:
     return get-data-uint NETWORK-TYPE
 
   /**
-   * Network MNC
+   * MNC of the currently connected network.
+   * Can be 0 if not connected.
+   * See <a href="https://mcc-mnc.net/" target="_blank">mcc-mnc.net</a>
    */
   network-mnc -> int:
     return get-data-uint NETWORK-MNC
 
   /**
-   * Network MCC
+   * MCC of the currently connected network.
+   * Can be 0 if not connected.
+   * See <a href="https://mcc-mnc.net/" target="_blank">mcc-mnc.net</a>
    */
   network-mcc -> int:
     return get-data-uint NETWORK-MCC
 
   /**
-   * Firmware Version
+   * Firmware version as a single integer, e.g. 2287
    */
   firmware-version -> int:
     return get-data-uint FIRMWARE-VERSION
 
   /**
-   * Type of device, relates to the SN prefix
+   * Type of device, relates to the SN prefix.
+   * For devices released from 2025 onwards, this is documented on the device specification page.
    */
   device-type -> int:
     return get-data-uint DEVICE-TYPE

src/messages/m35_device_ids_gen.toit

@@ -40,7 +40,8 @@ class DeviceIDs extends protocol.Data:
     return protocol.Message.with-method MT protocol.Header.METHOD-GET base-data
 
   /**
-   * Unique ID for the device which is used in the cloud API. uint32 or uint64 only
+   * Unique ID for the device which is used in the cloud API.
+   * uint32 or uint64 only
    */
   id -> int:
     return get-data-uint ID