Lightbug Documentation

Appearance

14: Config ​

🧪 Alpha

Config interactions are currently in an experimental phase, and the API may change in future, and documentation may be incomplete.

Configuration storage and maintenance message. GET behaviour: - If Key (data field 7 / `key`) is omitted, the response returns a config summary payload (data field 5 / `summary16`). - If Key is provided, the response returns the value for that specific key in Payload (data field 9).

Payload ​

FieldNameDescriptionTypeUnit
3CommandPossible values:
  • 1: Partial Wipe— Wipe some config values, such as WiFi credentials, but not all config Same as reset=1 in old lightbug device config.
  • 2: Full Wipe— Wipe all config values, returning the device to a factory new state. Same as reset=2 in old lightbug device config.
uint
4Summary of uint8 keysA table of uint8 keys known, with the crc8 of the value.
eg: 123, 45, 124, 67 means key 123 has a value with crc8 of 45, and key 124 has a value with crc8 of 67.
May be sent, with the expectation of receiving config messages with the listed keys and values that need changing
uint8[]
5Summary of uint16 keysA table of uint16 keys known, with the crc8 of the value.
eg: 123, 0, 45, means key 123 has a value with crc8 of 45.
May be sent, with the expectation of receiving config messages with the listed keys and values that need changing
bytes
7KeyConfig key identifier.
Required for SET.
Optional for GET: when omitted, GET returns a key summary instead of an individual key value.

Possible values:
  • 1: BaseSettings— 24 bytes of basic device settings (intervals, modes, etc.)
  • 2: HomeWifi
  • 5: TimedSettings
  • 6: UnixAlarms
  • 19: RtkMinUsableSatDb— Minimum usable satellite db
  • 20: RtkMinElevation— RtkMinElevation
  • 27: Secondary Server— FQDN or IP address of the server for L2 (Cloud link 2).
  • 28: Primary Server— FQDN or IP address of the server for L1 (Cloud link 1).
  • 30: Link 2 Timeout— Timeout in seconds for L2 (Cloud link 2) before it is considered dropped. Triggers the "No Connection" screen and alerts.
  • 31: Quiet Mode— When non-zero, suppresses notifications (buzzer, LEDs, etc.).
  • 32: USB Lock— When non-zero, USB access is locked (usb pins are switched to i2c bus).
  • 33: LED Resting Armed Color— RGB color when armed = true (3 bytes RGB + 1 mode). [m,R,G,B] for the status LED when armed. m=2 enables breathing
  • 34: BLE Name Filter Prefix— Collection of null terminated strings. Expected format is [prefix1]\0[prefix2]\0[prefix3]\0
  • 35: Menu Config— Controls the built-in device menu. Value 0 shows the default menu and default e-ink home "Menu" / "Actions" buttons. Value 1 disables the default menu and removes those default home buttons. Currently, any non-zero value disables the default menu and shows only "Menu disabled by admin" if the menu is opened, but all values above 1 are reserved for future use.
  • 50: Arming Mode— Bitmask controlling device behaviour when armed. Value 0x00 = default (active when armed).
  • 100: P2 Firmware MD5 Cache— Cached 16-byte MD5 digest reported by the ESP32 ROM after the most recent OTA verification. Allows the server to decide whether the device already has the expected firmware and whether the previous update succeeded.
uint16
9PayloadPayload for the config.
Setting a key to a 0 length value may be used to clear the config value for that key.
bytes

Examples ​

Set ArmingMode - keep modem on and GPS on (highest power, fastest reconnect)
Sets ArmingMode (key 50) to 0x84 (bits 2+7): keep GPS on in standby and keep modem connection open. Flipping to active requires a command to toggle armed state. GPS stays on but RTK only connects when actively armed.
Protocol
3
3
Length
210
21 bytes
Type
140
14 (Config)
Header Count
10
1
Header Types
5
5
Method
11
1 (SET)
Payload Count
20
2
Payload Types
79
7, 9
Key
2500
50 (Arming Mode)
Payload
1132
132
Checksum
10199
25445
Set ArmingMode - keep modem on, GPS on, wake on move
Sets ArmingMode (key 50) to 0x85 (bits 0+2+7): keep GPS on, keep modem on, and automatically wake when moving.
Protocol
3
3
Length
210
21 bytes
Type
140
14 (Config)
Header Count
10
1
Header Types
5
5
Method
11
1 (SET)
Payload Count
20
2
Payload Types
79
7, 9
Key
2500
50 (Arming Mode)
Payload
1133
133
Checksum
68115
29508
Set ArmingMode - low power (GPS off until moved, modem stays on)
Sets ArmingMode (key 50) to 0x81 (bits 0+7): GPS turns on only when moving, modem stays connected. Lower power than above as GPS is off at rest.
Protocol
3
3
Length
210
21 bytes
Type
140
14 (Config)
Header Count
10
1
Header Types
5
5
Method
11
1 (SET)
Payload Count
20
2
Payload Types
79
7, 9
Key
2500
50 (Arming Mode)
Payload
1129
129
Checksum
19251
13248
Set Menu Config - disable default menu
Sets Menu Config (key 35) to 1: disables the default device menu and shows only "Menu disabled by admin".
Protocol
3
3
Length
220
22 bytes
Type
140
14 (Config)
Header Count
10
1
Header Types
5
5
Method
11
1 (SET)
Payload Count
20
2
Payload Types
79
7, 9
Key
2350
35 (Menu Config)
Payload
210
1,0
Checksum
24388
22771

Code ​

For convenience, the following constants can be used to reference this message type.