package meshtastic

Get desktop application:
View/edit binary Protocol Buffers messages

This message is handled by the Admin module and is responsible for all settings/channel read/write operations. This message is used to do settings operations to both remote AND local nodes. (Prior to 1.2 these operations were done via special ToRadio operations)

• bytes session_passkey = 101

  The node generates this key and sends it with any get_x_response packets. The client MUST include the same key with any set_x commands. Key expires after 300 seconds. Prevents replay attacks for admin messages.

• oneof payload_variant

  TODO: REPLACE

  • uint32 get_channel_request = 1

    Send the specified channel in the response to this message NOTE: This field is sent with the channel index + 1 (to ensure we never try to send 'zero' - which protobufs treats as not present)

  • Channel get_channel_response = 2

    TODO: REPLACE

  • bool get_owner_request = 3

    Send the current owner data in the response to this message.

  • User get_owner_response = 4

    TODO: REPLACE

  • AdminMessage.ConfigType get_config_request = 5

    Ask for the following config data to be sent

  • Config get_config_response = 6

    Send the current Config in the response to this message.

  • AdminMessage.ModuleConfigType get_module_config_request = 7

    Ask for the following config data to be sent

  • ModuleConfig get_module_config_response = 8

    Send the current Config in the response to this message.

  • bool get_canned_message_module_messages_request = 10

    Get the Canned Message Module messages in the response to this message.

  • string get_canned_message_module_messages_response = 11

    Get the Canned Message Module messages in the response to this message.

  • bool get_device_metadata_request = 12

    Request the node to send device metadata (firmware, protobuf version, etc)

  • DeviceMetadata get_device_metadata_response = 13

    Device metadata response

  • bool get_ringtone_request = 14

    Get the Ringtone in the response to this message.

  • string get_ringtone_response = 15

    Get the Ringtone in the response to this message.

  • bool get_device_connection_status_request = 16

    Request the node to send it's connection status

  • DeviceConnectionStatus get_device_connection_status_response = 17

    Device connection status response

  • HamParameters set_ham_mode = 18

    Setup a node for licensed amateur (ham) radio operation

  • bool get_node_remote_hardware_pins_request = 19

    Get the mesh's nodes with their available gpio pins for RemoteHardware module use

  • NodeRemoteHardwarePinsResponse get_node_remote_hardware_pins_response = 20

    Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use

  • bool enter_dfu_mode_request = 21

    Enter (UF2) DFU mode Only implemented on NRF52 currently

  • string delete_file_request = 22

    Delete the file by the specified path from the device

  • uint32 set_scale = 23

    Set zero and offset for scale chips

  • AdminMessage.BackupLocation backup_preferences = 24

    Backup the node's preferences

  • AdminMessage.BackupLocation restore_preferences = 25

    Restore the node's preferences

  • AdminMessage.BackupLocation remove_backup_preferences = 26

    Remove backups of the node's preferences

  • AdminMessage.InputEvent send_input_event = 27

    Send an input event to the node. This is used to trigger physical input events like button presses, touch events, etc.

  • User set_owner = 32

    Set the owner for this node

  • Channel set_channel = 33

    Set channels (using the new API). A special channel is the "primary channel". The other records are secondary channels. Note: only one channel can be marked as primary. If the client sets a particular channel to be primary, the previous channel will be set to SECONDARY automatically.

  • Config set_config = 34

    Set the current Config

  • ModuleConfig set_module_config = 35

    Set the current Config

  • string set_canned_message_module_messages = 36

    Set the Canned Message Module messages text.

  • string set_ringtone_message = 37

    Set the ringtone for ExternalNotification.

  • uint32 remove_by_nodenum = 38

    Remove the node by the specified node-num from the NodeDB on the device

  • uint32 set_favorite_node = 39

    Set specified node-num to be favorited on the NodeDB on the device

  • uint32 remove_favorite_node = 40

    Set specified node-num to be un-favorited on the NodeDB on the device

  • Position set_fixed_position = 41

    Set fixed position data on the node and then set the position.fixed_position = true

  • bool remove_fixed_position = 42

    Clear fixed position coordinates and then set position.fixed_position = false

  • fixed32 set_time_only = 43

    Set time only on the node Convenience method to set the time on the node (as Net quality) without any other position data

  • bool get_ui_config_request = 44

    Tell the node to send the stored ui data.

  • DeviceUIConfig get_ui_config_response = 45

    Reply stored device ui data.

  • DeviceUIConfig store_ui_config = 46

    Tell the node to store UI data persistently.

  • uint32 set_ignored_node = 47

    Set specified node-num to be ignored on the NodeDB on the device

  • uint32 remove_ignored_node = 48

    Set specified node-num to be un-ignored on the NodeDB on the device

  • bool begin_edit_settings = 64

    Begins an edit transaction for config, module config, owner, and channel settings changes This will delay the standard *implicit* save to the file system and subsequent reboot behavior until committed (commit_edit_settings)

  • bool commit_edit_settings = 65

    Commits an open transaction for any edits made to config, module config, owner, and channel settings

  • SharedContact add_contact = 66

    Add a contact (User) to the nodedb

  • KeyVerificationAdmin key_verification = 67

    Initiate or respond to a key verification request

  • int32 factory_reset_device = 94

    Tell the node to factory reset config everything; all device state and configuration will be returned to factory defaults and BLE bonds will be cleared.

  • int32 reboot_ota_seconds = 95

    Tell the node to reboot into the OTA Firmware in this many seconds (or <0 to cancel reboot) Only Implemented for ESP32 Devices. This needs to be issued to send a new main firmware via bluetooth.

  • bool exit_simulator = 96

    This message is only supported for the simulator Portduino build. If received the simulator will exit successfully.

  • int32 reboot_seconds = 97

    Tell the node to reboot in this many seconds (or <0 to cancel reboot)

  • int32 shutdown_seconds = 98

    Tell the node to shutdown in this many seconds (or <0 to cancel shutdown)

  • int32 factory_reset_config = 99

    Tell the node to factory reset config; all device state and configuration will be returned to factory defaults; BLE bonds will be preserved.

  • int32 nodedb_reset = 100

    Tell the node to reset the nodedb.

Used in: AdminMessage

• FLASH = 0

  Backup to the internal flash

• SD = 1

  Backup to the SD card

TODO: REPLACE

Used in: AdminMessage

• DEVICE_CONFIG = 0

  TODO: REPLACE

• POSITION_CONFIG = 1

  TODO: REPLACE

• POWER_CONFIG = 2

  TODO: REPLACE

• NETWORK_CONFIG = 3

  TODO: REPLACE

• DISPLAY_CONFIG = 4

  TODO: REPLACE

• LORA_CONFIG = 5

  TODO: REPLACE

• BLUETOOTH_CONFIG = 6

  TODO: REPLACE

• SECURITY_CONFIG = 7

  TODO: REPLACE

• SESSIONKEY_CONFIG = 8

  Session key config

• DEVICEUI_CONFIG = 9

  device-ui config

Input event message to be sent to the node.

Used in: AdminMessage

• uint32 event_code = 1

  The input event code

• uint32 kb_char = 2

  Keyboard character code

• uint32 touch_x = 3

  The touch X coordinate

• uint32 touch_y = 4

  The touch Y coordinate

TODO: REPLACE

Used in: AdminMessage

• MQTT_CONFIG = 0

  TODO: REPLACE

• SERIAL_CONFIG = 1

  TODO: REPLACE

• EXTNOTIF_CONFIG = 2

  TODO: REPLACE

• STOREFORWARD_CONFIG = 3

  TODO: REPLACE

• RANGETEST_CONFIG = 4

  TODO: REPLACE

• TELEMETRY_CONFIG = 5

  TODO: REPLACE

• CANNEDMSG_CONFIG = 6

  TODO: REPLACE

• AUDIO_CONFIG = 7

  TODO: REPLACE

• REMOTEHARDWARE_CONFIG = 8

  TODO: REPLACE

• NEIGHBORINFO_CONFIG = 9

  TODO: REPLACE

• AMBIENTLIGHTING_CONFIG = 10

  TODO: REPLACE

• DETECTIONSENSOR_CONFIG = 11

  TODO: REPLACE

• PAXCOUNTER_CONFIG = 12

  TODO: REPLACE

Air quality metrics

Used in: Telemetry

• optional uint32 pm10_standard = 1

  Concentration Units Standard PM1.0 in ug/m3

• optional uint32 pm25_standard = 2

  Concentration Units Standard PM2.5 in ug/m3

• optional uint32 pm100_standard = 3

  Concentration Units Standard PM10.0 in ug/m3

• optional uint32 pm10_environmental = 4

  Concentration Units Environmental PM1.0 in ug/m3

• optional uint32 pm25_environmental = 5

  Concentration Units Environmental PM2.5 in ug/m3

• optional uint32 pm100_environmental = 6

  Concentration Units Environmental PM10.0 in ug/m3

• optional uint32 particles_03um = 7

  0.3um Particle Count in #/0.1l

• optional uint32 particles_05um = 8

  0.5um Particle Count in #/0.1l

• optional uint32 particles_10um = 9

  1.0um Particle Count in #/0.1l

• optional uint32 particles_25um = 10

  2.5um Particle Count in #/0.1l

• optional uint32 particles_50um = 11

  5.0um Particle Count in #/0.1l

• optional uint32 particles_100um = 12

  10.0um Particle Count in #/0.1l

• optional uint32 co2 = 13

  CO2 concentration in ppm

• optional float co2_temperature = 14

  CO2 sensor temperature in degC

• optional float co2_humidity = 15

  CO2 sensor relative humidity in %

• optional float form_formaldehyde = 16

  Formaldehyde sensor formaldehyde concentration in ppb

• optional float form_humidity = 17

  Formaldehyde sensor relative humidity in %RH

• optional float form_temperature = 18

  Formaldehyde sensor temperature in degrees Celsius

• optional uint32 pm40_standard = 19

  Concentration Units Standard PM4.0 in ug/m3

• optional uint32 particles_40um = 20

  4.0um Particle Count in #/0.1l

• optional float pm_temperature = 21

  PM Sensor Temperature

• optional float pm_humidity = 22

  PM Sensor humidity

• optional float pm_voc_idx = 23

  PM Sensor VOC Index

• optional float pm_nox_idx = 24

  PM Sensor NOx Index

• optional float particles_tps = 25

  Typical Particle Size in um

The on-disk backup of the node's preferences

• uint32 version = 1

  The version of the backup

• fixed32 timestamp = 2

  The timestamp of the backup (if node has time)

• optional LocalConfig config = 3

  The node's configuration

• optional LocalModuleConfig module_config = 4

  The node's module configuration

• optional ChannelFile channels = 5

  The node's channels

• optional User owner = 6

  The node's user (owner) information

Bluetooth connection status

Used in: DeviceConnectionStatus

• uint32 pin = 1

  The pairing PIN for bluetooth

• int32 rssi = 2

  RSSI of bluetooth connection

• bool is_connected = 3

  Whether the device has an active connection or not

Canned message module configuration.

• string messages = 1

  Predefined messages for canned message module separated by '|' characters.

A pair of a channel number, mode and the (sharable) settings for that channel

Used in: AdminMessage, ChannelFile, FromRadio

• int32 index = 1

  The index of this channel in the channel table (from 0 to MAX_NUM_CHANNELS-1) (Someday - not currently implemented) An index of -1 could be used to mean "set by name", in which case the target node will find and set the channel by settings.name.

• optional ChannelSettings settings = 2

  The new settings, or NULL to disable that channel

• Channel.Role role = 3

  TODO: REPLACE

How this channel is being used (or not). Note: this field is an enum to give us options for the future. In particular, someday we might make a 'SCANNING' option. SCANNING channels could have different frequencies and the radio would occasionally check that freq to see if anything is being transmitted. For devices that have multiple physical radios attached, we could keep multiple PRIMARY/SCANNING channels active at once to allow cross band routing as needed. If a device has only a single radio (the common case) only one channel can be PRIMARY at a time (but any number of SECONDARY channels can't be sent received on that common frequency)

Used in: Channel

• DISABLED = 0

  This channel is not in use right now

• PRIMARY = 1

  This channel is used to set the frequency for the radio - all other enabled channels must be SECONDARY

• SECONDARY = 2

  Secondary channels are only used for encryption/decryption/authentication purposes. Their radio settings (freq etc) are ignored, only psk is used.

The on-disk saved channels

Used in: BackupPreferences

• repeated Channel channels = 1

  The channels our node knows about

• uint32 version = 2

  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.

This is the most compact possible representation for a set of channels. It includes only one PRIMARY channel (which must be first) and any SECONDARY channels. No DISABLED channels are included. This abstraction is used only on the the 'app side' of the world (ie python, javascript and android etc) to show a group of Channels as a (long) URL

• repeated ChannelSettings settings = 1

  Channel list with settings

• optional Config.LoRaConfig lora_config = 2

  LoRa config

This information can be encoded as a QRcode/url so that other users can configure their radio to join the same channel. A note about how channel names are shown to users: channelname-X poundsymbol is a prefix used to indicate this is a channel name (idea from @professr). Where X is a letter from A-Z (base 26) representing a hash of the PSK for this channel - so that if the user changes anything about the channel (which does force a new PSK) this letter will also change. Thus preventing user confusion if two friends try to type in a channel name of "BobsChan" and then can't talk because their PSKs will be different. The PSK is hashed into this letter by "0x41 + [xor all bytes of the psk ] modulo 26" This also allows the option of someday if people have the PSK off (zero), the users COULD type in a channel name and be able to talk. FIXME: Add description of multi-channel support and how primary vs secondary channels are used. FIXME: explain how apps use channels for security. explain how remote settings and remote gpio are managed as an example

Used in: Channel, ChannelSet

• uint32 channel_num = 1

  Deprecated in favor of LoraConfig.channel_num

• bytes psk = 2

  A simple pre-shared key for now for crypto. Must be either 0 bytes (no crypto), 16 bytes (AES128), or 32 bytes (AES256). A special shorthand is used for 1 byte long psks. These psks should be treated as only minimally secure, because they are listed in this source code. Those bytes are mapped using the following scheme: `0` = No crypto `1` = The special "default" channel key: {0xd4, 0xf1, 0xbb, 0x3a, 0x20, 0x29, 0x07, 0x59, 0xf0, 0xbc, 0xff, 0xab, 0xcf, 0x4e, 0x69, 0x01} `2` through 10 = The default channel key, except with 1 through 9 added to the last byte. Shown to user as simple1 through 10

• string name = 3

  A SHORT name that will be packed into the URL. Less than 12 bytes. Something for end users to call the channel If this is the empty string it is assumed that this channel is the special (minimally secure) "Default"channel. In user interfaces it should be rendered as a local language translation of "X". For channel_num hashing empty string will be treated as "X". Where "X" is selected based on the English words listed above for ModemPreset

• fixed32 id = 4

  Used to construct a globally unique channel ID. The full globally unique ID will be: "name.id" where ID is shown as base36. Assuming that the number of meshtastic users is below 20K (true for a long time) the chance of this 64 bit random number colliding with anyone else is super low. And the penalty for collision is low as well, it just means that anyone trying to decrypt channel messages might need to try multiple candidate channels. Any time a non wire compatible change is made to a channel, this field should be regenerated. There are a small number of 'special' globally known (and fairly) insecure standard channels. Those channels do not have a numeric id included in the settings, but instead it is pulled from a table of well known IDs. (see Well Known Channels FIXME)

• bool uplink_enabled = 5

  If true, messages on the mesh will be sent to the *public* internet by any gateway ndoe

• bool downlink_enabled = 6

  If true, messages seen on the internet will be forwarded to the local mesh.

• optional ModuleSettings module_settings = 7

  Per-channel module settings.

• uint32 payload_id = 1

  The ID of the entire payload

• uint32 chunk_count = 2

  The total number of chunks in the payload

• uint32 chunk_index = 3

  The current chunk index in the total

• bytes payload_chunk = 4

  The binary data of the current chunk

Responses to a ChunkedPayload request

• uint32 payload_id = 1

  The ID of the entire payload

• oneof payload_variant

  • bool request_transfer = 2

    Request to transfer chunked payload

  • bool accept_transfer = 3

    Accept the transfer chunked payload

  • resend_chunks resend_chunks = 4

    Request missing indexes in the chunked payload

A notification message from the device to the client To be used for important messages that should to be displayed to the user in the form of push notifications or validation messages when saving invalid configuration.

Used in: FromRadio

• optional uint32 reply_id = 1

  The id of the packet we're notifying in response to

• fixed32 time = 2

  Seconds since 1970 - or 0 for unknown/unset

• LogRecord.Level level = 3

  The level type of notification

• string message = 4

  The message body of the notification

• oneof payload_variant

  • KeyVerificationNumberInform key_verification_number_inform = 11

  • KeyVerificationNumberRequest key_verification_number_request = 12

  • KeyVerificationFinal key_verification_final = 13

  • DuplicatedPublicKey duplicated_public_key = 14

  • LowEntropyKey low_entropy_key = 15

Used in: DeviceUIConfig

• DYNAMIC = 0

  Compass with dynamic ring and heading

• FIXED_RING = 1

  Compass with fixed ring and heading

• FREEZE_HEADING = 2

  Compass with heading and freeze option

Compressed message payload

• PortNum portnum = 1

  PortNum to determine the how to handle the compressed payload.

• bytes data = 2

  Compressed data.

Used in: AdminMessage, FromRadio

• oneof payload_variant

  Payload Variant

  • Config.DeviceConfig device = 1

  • Config.PositionConfig position = 2

  • Config.PowerConfig power = 3

  • Config.NetworkConfig network = 4

  • Config.DisplayConfig display = 5

  • Config.LoRaConfig lora = 6

  • Config.BluetoothConfig bluetooth = 7

  • Config.SecurityConfig security = 8

  • Config.SessionkeyConfig sessionkey = 9

  • DeviceUIConfig device_ui = 10

Used in: Config, LocalConfig

• bool enabled = 1

  Enable Bluetooth on the device

• BluetoothConfig.PairingMode mode = 2

  Determines the pairing strategy for the device

• uint32 fixed_pin = 3

  Specified PIN for PairingMode.FixedPin

Used in: BluetoothConfig

• RANDOM_PIN = 0

  Device generates a random PIN that will be shown on the screen of the device for pairing

• FIXED_PIN = 1

  Device requires a specified fixed PIN for pairing

• NO_PIN = 2

  Device requires no PIN for pairing

Configuration

Used in: Config, LocalConfig

• DeviceConfig.Role role = 1

  Sets the role of node

• bool serial_enabled = 2

  Disabling this will disable the SerialConsole by not initilizing the StreamAPI Moved to SecurityConfig

• uint32 button_gpio = 4

  For boards without a hard wired button, this is the pin number that will be used Boards that have more than one button can swap the function with this one. defaults to BUTTON_PIN if defined.

• uint32 buzzer_gpio = 5

  For boards without a PWM buzzer, this is the pin number that will be used Defaults to PIN_BUZZER if defined.

• DeviceConfig.RebroadcastMode rebroadcast_mode = 6

  Sets the role of node

• uint32 node_info_broadcast_secs = 7

  Send our nodeinfo this often Defaults to 900 Seconds (15 minutes)

• bool double_tap_as_button_press = 8

  Treat double tap interrupt on supported accelerometers as a button press if set to true

• bool is_managed = 9

  If true, device is considered to be "managed" by a mesh administrator Clients should then limit available configuration and administrative options inside the user interface Moved to SecurityConfig

• bool disable_triple_click = 10

  Disables the triple-press of user button to enable or disable GPS

• string tzdef = 11

  POSIX Timezone definition string from https://github.com/nayarsystems/posix_tz_db/blob/master/zones.csv.

• bool led_heartbeat_disabled = 12

  If true, disable the default blinking LED (LED_PIN) behavior on the device

• DeviceConfig.BuzzerMode buzzer_mode = 13

  Controls buzzer behavior for audio feedback Defaults to ENABLED

Defines buzzer behavior for audio feedback

Used in: DeviceConfig

• ALL_ENABLED = 0

  Default behavior. Buzzer is enabled for all audio feedback including button presses and alerts.

• DISABLED = 1

  Disabled. All buzzer audio feedback is disabled.

• NOTIFICATIONS_ONLY = 2

  Notifications Only. Buzzer is enabled only for notifications and alerts, but not for button presses. External notification config determines the specifics of the notification behavior.

• SYSTEM_ONLY = 3

  Non-notification system buzzer tones only. Buzzer is enabled only for non-notification tones such as button presses, startup, shutdown, but not for alerts.

• DIRECT_MSG_ONLY = 4

  Direct Message notifications only. Buzzer is enabled only for direct messages and alerts, but not for button presses. External notification config determines the specifics of the notification behavior.

Defines the device's behavior for how messages are rebroadcast

Used in: DeviceConfig

• ALL = 0

  Default behavior. Rebroadcast any observed message, if it was on our private channel or from another mesh with the same lora params.

• ALL_SKIP_DECODING = 1

  Same as behavior as ALL but skips packet decoding and simply rebroadcasts them. Only available in Repeater role. Setting this on any other roles will result in ALL behavior.

• LOCAL_ONLY = 2

  Ignores observed messages from foreign meshes that are open or those which it cannot decrypt. Only rebroadcasts message on the nodes local primary / secondary channels.

• KNOWN_ONLY = 3

  Ignores observed messages from foreign meshes like LOCAL_ONLY, but takes it step further by also ignoring messages from nodenums not in the node's known list (NodeDB)

• NONE = 4

  Only permitted for SENSOR, TRACKER and TAK_TRACKER roles, this will inhibit all rebroadcasts, not unlike CLIENT_MUTE role.

• CORE_PORTNUMS_ONLY = 5

  Ignores packets from non-standard portnums such as: TAK, RangeTest, PaxCounter, etc. Only rebroadcasts packets with standard portnums: NodeInfo, Text, Position, Telemetry, and Routing.

Defines the device's role on the Mesh network

Used in: DeviceConfig, DeviceMetadata, MapReport, User, UserLite

• CLIENT = 0

  Description: App connected or stand alone messaging device. Technical Details: Default Role

• CLIENT_MUTE = 1

  Description: Device that does not forward packets from other devices.

• ROUTER = 2

  Description: Infrastructure node for extending network coverage by relaying messages. Visible in Nodes list. Technical Details: Mesh packets will prefer to be routed over this node. This node will not be used by client apps. The wifi radio and the oled screen will be put to sleep. This mode may still potentially have higher power usage due to it's preference in message rebroadcasting on the mesh.

• ROUTER_CLIENT = 3

• REPEATER = 4

  Description: Infrastructure node for extending network coverage by relaying messages with minimal overhead. Not visible in Nodes list. Technical Details: Mesh packets will simply be rebroadcasted over this node. Nodes configured with this role will not originate NodeInfo, Position, Telemetry or any other packet type. They will simply rebroadcast any mesh packets on the same frequency, channel num, spread factor, and coding rate. Deprecated in v2.7.11 because it creates "holes" in the mesh rebroadcast chain.

• TRACKER = 5

  Description: Broadcasts GPS position packets as priority. Technical Details: Position Mesh packets will be prioritized higher and sent more frequently by default. When used in conjunction with power.is_power_saving = true, nodes will wake up, send position, and then sleep for position.position_broadcast_secs seconds.

• SENSOR = 6

  Description: Broadcasts telemetry packets as priority. Technical Details: Telemetry Mesh packets will be prioritized higher and sent more frequently by default. When used in conjunction with power.is_power_saving = true, nodes will wake up, send environment telemetry, and then sleep for telemetry.environment_update_interval seconds.

• TAK = 7

  Description: Optimized for ATAK system communication and reduces routine broadcasts. Technical Details: Used for nodes dedicated for connection to an ATAK EUD. Turns off many of the routine broadcasts to favor CoT packet stream from the Meshtastic ATAK plugin -> IMeshService -> Node

• CLIENT_HIDDEN = 8

  Description: Device that only broadcasts as needed for stealth or power savings. Technical Details: Used for nodes that "only speak when spoken to" Turns all of the routine broadcasts but allows for ad-hoc communication Still rebroadcasts, but with local only rebroadcast mode (known meshes only) Can be used for clandestine operation or to dramatically reduce airtime / power consumption

• LOST_AND_FOUND = 9

  Description: Broadcasts location as message to default channel regularly for to assist with device recovery. Technical Details: Used to automatically send a text message to the mesh with the current position of the device on a frequent interval: "I'm lost! Position: lat / long"

• TAK_TRACKER = 10

  Description: Enables automatic TAK PLI broadcasts and reduces routine broadcasts. Technical Details: Turns off many of the routine broadcasts to favor ATAK CoT packet stream and automatic TAK PLI (position location information) broadcasts. Uses position module configuration to determine TAK PLI broadcast interval.

• ROUTER_LATE = 11

  Description: Will always rebroadcast packets, but will do so after all other modes. Technical Details: Used for router nodes that are intended to provide additional coverage in areas not already covered by other routers, or to bridge around problematic terrain, but should not be given priority over other routers in order to avoid unnecessaraily consuming hops.

• CLIENT_BASE = 12

  Description: Treats packets from or to favorited nodes as ROUTER, and all other packets as CLIENT. Technical Details: Used for stronger attic/roof nodes to distribute messages more widely from weaker, indoor, or less-well-positioned nodes. Recommended for users with multiple nodes where one CLIENT_BASE acts as a more powerful base station, such as an attic/roof node.

Display Config

Used in: Config, LocalConfig

• uint32 screen_on_secs = 1

  Number of seconds the screen stays on after pressing the user button or receiving a message 0 for default of one minute MAXUINT for always on

• DisplayConfig.DeprecatedGpsCoordinateFormat gps_format = 2

  Deprecated in 2.7.4: Unused How the GPS coordinates are formatted on the OLED screen.

• uint32 auto_screen_carousel_secs = 3

  Automatically toggles to the next page on the screen like a carousel, based the specified interval in seconds. Potentially useful for devices without user buttons.

• bool compass_north_top = 4

  If this is set, the displayed compass will always point north. if unset, the old behaviour (top of display is heading direction) is used.

• bool flip_screen = 5

  Flip screen vertically, for cases that mount the screen upside down

• DisplayConfig.DisplayUnits units = 6

  Perferred display units

• DisplayConfig.OledType oled = 7

  Override auto-detect in screen

• DisplayConfig.DisplayMode displaymode = 8

  Display Mode

• bool heading_bold = 9

  Print first line in pseudo-bold? FALSE is original style, TRUE is bold

• bool wake_on_tap_or_motion = 10

  Should we wake the screen up on accelerometer detected motion or tap

• DisplayConfig.CompassOrientation compass_orientation = 11

  Indicates how to rotate or invert the compass output to accurate display on the display.

• bool use_12h_clock = 12

  If false (default), the device will display the time in 24-hour format on screen. If true, the device will display the time in 12-hour format on screen.

• bool use_long_node_name = 13

  If false (default), the device will use short names for various display screens. If true, node names will show in long format

Used in: DisplayConfig

• DEGREES_0 = 0

  The compass and the display are in the same orientation.

• DEGREES_90 = 1

  Rotate the compass by 90 degrees.

• DEGREES_180 = 2

  Rotate the compass by 180 degrees.

• DEGREES_270 = 3

  Rotate the compass by 270 degrees.

• DEGREES_0_INVERTED = 4

  Don't rotate the compass, but invert the result.

• DEGREES_90_INVERTED = 5

  Rotate the compass by 90 degrees and invert.

• DEGREES_180_INVERTED = 6

  Rotate the compass by 180 degrees and invert.

• DEGREES_270_INVERTED = 7

  Rotate the compass by 270 degrees and invert.

Deprecated in 2.7.4: Unused

Used in: DisplayConfig

• UNUSED = 0

Used in: DisplayConfig

• DEFAULT = 0

  Default. The old style for the 128x64 OLED screen

• TWOCOLOR = 1

  Rearrange display elements to cater for bicolor OLED displays

• INVERTED = 2

  Same as TwoColor, but with inverted top bar. Not so good for Epaper displays

• COLOR = 3

  TFT Full Color Displays (not implemented yet)

Unit display preference

Used in: DisplayConfig

• METRIC = 0

  Metric (Default)

• IMPERIAL = 1

  Imperial

Override OLED outo detect with this if it fails.

Used in: DisplayConfig

• OLED_AUTO = 0

  Default / Autodetect

• OLED_SSD1306 = 1

  Default / Autodetect

• OLED_SH1106 = 2

  Default / Autodetect

• OLED_SH1107 = 3

  Can not be auto detected but set by proto. Used for 128x64 screens

• OLED_SH1107_128_128 = 4

  Can not be auto detected but set by proto. Used for 128x128 screens

Lora Config

Used in: ChannelSet, Config, LocalConfig

• bool use_preset = 1

  When enabled, the `modem_preset` fields will be adhered to, else the `bandwidth`/`spread_factor`/`coding_rate` will be taked from their respective manually defined fields

• LoRaConfig.ModemPreset modem_preset = 2

  Either modem_config or bandwidth/spreading/coding will be specified - NOT BOTH. As a heuristic: If bandwidth is specified, do not use modem_config. Because protobufs take ZERO space when the value is zero this works out nicely. This value is replaced by bandwidth/spread_factor/coding_rate. If you'd like to experiment with other options add them to MeshRadio.cpp in the device code.

• uint32 bandwidth = 3

  Bandwidth in MHz Certain bandwidth numbers are 'special' and will be converted to the appropriate floating point value: 31 -> 31.25MHz

• uint32 spread_factor = 4

  A number from 7 to 12. Indicates number of chirps per symbol as 1<<spread_factor.

• uint32 coding_rate = 5

  The denominator of the coding rate. ie for 4/5, the value is 5. 4/8 the value is 8.

• float frequency_offset = 6

  This parameter is for advanced users with advanced test equipment, we do not recommend most users use it. A frequency offset that is added to to the calculated band center frequency. Used to correct for crystal calibration errors.

• LoRaConfig.RegionCode region = 7

  The region code for the radio (US, CN, EU433, etc...)

• uint32 hop_limit = 8

  Maximum number of hops. This can't be greater than 7. Default of 3 Attempting to set a value > 7 results in the default

• bool tx_enabled = 9

  Disable TX from the LoRa radio. Useful for hot-swapping antennas and other tests. Defaults to false

• int32 tx_power = 10

  If zero, then use default max legal continuous power (ie. something that won't burn out the radio hardware) In most cases you should use zero here. Units are in dBm.

• uint32 channel_num = 11

  This controls the actual hardware frequency the radio transmits on. Most users should never need to be exposed to this field/concept. A channel number between 1 and NUM_CHANNELS (whatever the max is in the current region). If ZERO then the rule is "use the old channel name hash based algorithm to derive the channel number") If using the hash algorithm the channel number will be: hash(channel_name) % NUM_CHANNELS (Where num channels depends on the regulatory region).

• bool override_duty_cycle = 12

  If true, duty cycle limits will be exceeded and thus you're possibly not following the local regulations if you're not a HAM. Has no effect if the duty cycle of the used region is 100%.

• bool sx126x_rx_boosted_gain = 13

  If true, sets RX boosted gain mode on SX126X based radios

• float override_frequency = 14

  This parameter is for advanced users and licensed HAM radio operators. Ignore Channel Calculation and use this frequency instead. The frequency_offset will still be applied. This will allow you to use out-of-band frequencies. Please respect your local laws and regulations. If you are a HAM, make sure you enable HAM mode and turn off encryption.

• bool pa_fan_disabled = 15

  If true, disable the build-in PA FAN using pin define in RF95_FAN_EN.

• repeated uint32 ignore_incoming = 103

  For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in ignore_incoming will have packets they send dropped on receive (by router.cpp)

• bool ignore_mqtt = 104

  If true, the device will not process any packets received via LoRa that passed via MQTT anywhere on the path towards it.

• bool config_ok_to_mqtt = 105

  Sets the ok_to_mqtt bit on outgoing packets

Standard predefined channel settings Note: these mappings must match ModemPreset Choice in the device code.

Used in: LoRaConfig, MapReport

• LONG_FAST = 0

  Long Range - Fast

• LONG_SLOW = 1

  Long Range - Slow

• VERY_LONG_SLOW = 2

  Very Long Range - Slow Deprecated in 2.5: Works only with txco and is unusably slow

• MEDIUM_SLOW = 3

  Medium Range - Slow

• MEDIUM_FAST = 4

  Medium Range - Fast

• SHORT_SLOW = 5

  Short Range - Slow

• SHORT_FAST = 6

  Short Range - Fast

• LONG_MODERATE = 7

  Long Range - Moderately Fast

• SHORT_TURBO = 8

  Short Range - Turbo This is the fastest preset and the only one with 500kHz bandwidth. It is not legal to use in all regions due to this wider bandwidth.

Used in: LoRaConfig, MapReport

• UNSET = 0

  Region is not set

• US = 1

  United States

• EU_433 = 2

  European Union 433mhz

• EU_868 = 3

  European Union 868mhz

• CN = 4

  China

• JP = 5

  Japan

• ANZ = 6

  Australia / New Zealand

• KR = 7

  Korea

• TW = 8

  Taiwan

• RU = 9

  Russia

• IN = 10

  India

• NZ_865 = 11

  New Zealand 865mhz

• TH = 12

  Thailand

• LORA_24 = 13

  WLAN Band

• UA_433 = 14

  Ukraine 433mhz

• UA_868 = 15

  Ukraine 868mhz

• MY_433 = 16

  Malaysia 433mhz

• MY_919 = 17

  Malaysia 919mhz

• SG_923 = 18

  Singapore 923mhz

• PH_433 = 19

  Philippines 433mhz

• PH_868 = 20

  Philippines 868mhz

• PH_915 = 21

  Philippines 915mhz

• ANZ_433 = 22

  Australia / New Zealand 433MHz

• KZ_433 = 23

  Kazakhstan 433MHz

• KZ_863 = 24

  Kazakhstan 863MHz

• NP_865 = 25

  Nepal 865MHz

• BR_902 = 26

  Brazil 902MHz

Network Config

Used in: Config, LocalConfig

• bool wifi_enabled = 1

  Enable WiFi (disables Bluetooth)

• string wifi_ssid = 3

  If set, this node will try to join the specified wifi network and acquire an address via DHCP

• string wifi_psk = 4

  If set, will be use to authenticate to the named wifi

• string ntp_server = 5

  NTP server to use if WiFi is conneced, defaults to `meshtastic.pool.ntp.org`

• bool eth_enabled = 6

  Enable Ethernet

• NetworkConfig.AddressMode address_mode = 7

  acquire an address via DHCP or assign static

• optional NetworkConfig.IpV4Config ipv4_config = 8

  struct to keep static address

• string rsyslog_server = 9

  rsyslog Server and Port

• uint32 enabled_protocols = 10

  Flags for enabling/disabling network protocols

• bool ipv6_enabled = 11

  Enable/Disable ipv6 support

Used in: NetworkConfig

• DHCP = 0

  obtain ip address via DHCP

• STATIC = 1

  use static ip address

Used in: NetworkConfig

• fixed32 ip = 1

  Static IP address

• fixed32 gateway = 2

  Static gateway address

• fixed32 subnet = 3

  Static subnet mask

• fixed32 dns = 4

  Static DNS server address

Available flags auxiliary network protocols

• NO_BROADCAST = 0

  Do not broadcast packets over any network protocol

• UDP_BROADCAST = 1

  Enable broadcasting packets via UDP over the local network

Position Config

Used in: Config, LocalConfig

• uint32 position_broadcast_secs = 1

  We should send our position this often (but only if it has changed significantly) Defaults to 15 minutes

• bool position_broadcast_smart_enabled = 2

  Adaptive position braoadcast, which is now the default.

• bool fixed_position = 3

  If set, this node is at a fixed position. We will generate GPS position updates at the regular interval, but use whatever the last lat/lon/alt we have for the node. The lat/lon/alt can be set by an internal GPS or with the help of the app.

• bool gps_enabled = 4

  Is GPS enabled for this node?

• uint32 gps_update_interval = 5

  How often should we try to get GPS position (in seconds) or zero for the default of once every 30 seconds or a very large value (maxint) to update only once at boot.

• uint32 gps_attempt_time = 6

  Deprecated in favor of using smart / regular broadcast intervals as implicit attempt time

• uint32 position_flags = 7

  Bit field of boolean configuration options for POSITION messages (bitwise OR of PositionFlags)

• uint32 rx_gpio = 8

  (Re)define GPS_RX_PIN for your board.

• uint32 tx_gpio = 9

  (Re)define GPS_TX_PIN for your board.

• uint32 broadcast_smart_minimum_distance = 10

  The minimum distance in meters traveled (since the last send) before we can send a position to the mesh if position_broadcast_smart_enabled

• uint32 broadcast_smart_minimum_interval_secs = 11

  The minimum number of seconds (since the last send) before we can send a position to the mesh if position_broadcast_smart_enabled

• uint32 gps_en_gpio = 12

  (Re)define PIN_GPS_EN for your board.

• PositionConfig.GpsMode gps_mode = 13

  Set where GPS is enabled, disabled, or not present

Used in: PositionConfig

• DISABLED = 0

  GPS is present but disabled

• ENABLED = 1

  GPS is present and enabled

• NOT_PRESENT = 2

  GPS is not present on the device

Bit field of boolean configuration options, indicating which optional fields to include when assembling POSITION messages. Longitude, latitude, altitude, speed, heading, and DOP are always included (also time if GPS-synced) NOTE: the more fields are included, the larger the message will be - leading to longer airtime and a higher risk of packet loss

• UNSET = 0

  Required for compilation

• ALTITUDE = 1

  Include an altitude value (if available)

• ALTITUDE_MSL = 2

  Altitude value is MSL

• GEOIDAL_SEPARATION = 4

  Include geoidal separation

• DOP = 8

  Include the DOP value ; PDOP used by default, see below

• HVDOP = 16

  If POS_DOP set, send separate HDOP / VDOP values instead of PDOP

• SATINVIEW = 32

  Include number of "satellites in view"

• SEQ_NO = 64

  Include a sequence number incremented per packet

• TIMESTAMP = 128

  Include positional timestamp (from GPS solution)

• HEADING = 256

  Include positional heading Intended for use with vehicle not walking speeds walking speeds are likely to be error prone like the compass

• SPEED = 512

  Include positional speed Intended for use with vehicle not walking speeds walking speeds are likely to be error prone like the compass

Power Config\ See [Power Config](/docs/settings/config/power) for additional power config details.

Used in: Config, LocalConfig

• bool is_power_saving = 1

  Description: Will sleep everything as much as possible, for the tracker and sensor role this will also include the lora radio. Don't use this setting if you want to use your device with the phone apps or are using a device without a user button. Technical Details: Works for ESP32 devices and NRF52 devices in the Sensor or Tracker roles

• uint32 on_battery_shutdown_after_secs = 2

  Description: If non-zero, the device will fully power off this many seconds after external power is removed.

• float adc_multiplier_override = 3

  Ratio of voltage divider for battery pin eg. 3.20 (R1=100k, R2=220k) Overrides the ADC_MULTIPLIER defined in variant for battery voltage calculation. https://meshtastic.org/docs/configuration/radio/power/#adc-multiplier-override Should be set to floating point value between 2 and 6

• uint32 wait_bluetooth_secs = 4

  Description: The number of seconds for to wait before turning off BLE in No Bluetooth states Technical Details: ESP32 Only 0 for default of 1 minute

• uint32 sds_secs = 6

  Super Deep Sleep Seconds While in Light Sleep if mesh_sds_timeout_secs is exceeded we will lower into super deep sleep for this value (default 1 year) or a button press 0 for default of one year

• uint32 ls_secs = 7

  Description: In light sleep the CPU is suspended, LoRa radio is on, BLE is off an GPS is on Technical Details: ESP32 Only 0 for default of 300

• uint32 min_wake_secs = 8

  Description: While in light sleep when we receive packets on the LoRa radio we will wake and handle them and stay awake in no BLE mode for this value Technical Details: ESP32 Only 0 for default of 10 seconds

• uint32 device_battery_ina_address = 9

  I2C address of INA_2XX to use for reading device battery voltage

• uint64 powermon_enables = 32

  If non-zero, we want powermon log outputs. With the particular (bitfield) sources enabled. Note: we picked an ID of 32 so that lower more efficient IDs can be used for more frequently used options.

Used in: Config, LocalConfig

• bytes public_key = 1

  The public key of the user's device. Sent out to other nodes on the mesh to allow them to compute a shared secret key.

• bytes private_key = 2

  The private key of the device. Used to create a shared key with a remote device.

• repeated bytes admin_key = 3

  The public key authorized to send admin messages to this node.

• bool is_managed = 4

  If true, device is considered to be "managed" by a mesh administrator via admin messages Device is managed by a mesh administrator.

• bool serial_enabled = 5

  Serial Console over the Stream API."

• bool debug_log_api_enabled = 6

  By default we turn off logging as soon as an API client connects (to keep shared serial link quiet). Output live debug logging over serial or bluetooth is set to true.

• bool admin_channel_enabled = 8

  Allow incoming device control over the insecure legacy admin channel.

Blank config request, strictly for getting the session key

Used in: Config

(message has no fields)

Shared constants between device and phone

• ZERO = 0

  First enum must be zero, and we are just using this enum to pass int constants between two very different environments

• DATA_PAYLOAD_LEN = 233

  From mesh.options note: this payload length is ONLY the bytes that are sent inside of the Data protobuf (excluding protobuf overhead). The 16 byte header is outside of this envelope

ATAK Contact <contact endpoint='0.0.0.0:4242:tcp' phone='+12345678' callsign='FALKE'/>

Used in: TAKPacket

• string callsign = 1

  Callsign

• string device_callsign = 2

  Device callsign

  IP address of endpoint in integer form (0.0.0.0 default)

Error codes for critical errors The device might report these fault codes on the screen. If you encounter a fault code, please post on the meshtastic.discourse.group and we'll try to help.

• NONE = 0

  TODO: REPLACE

• TX_WATCHDOG = 1

  A software bug was detected while trying to send lora

• SLEEP_ENTER_WAIT = 2

  A software bug was detected on entry to sleep

• NO_RADIO = 3

  No Lora radio hardware could be found

• UNSPECIFIED = 4

  Not normally used

• UBLOX_UNIT_FAILED = 5

  We failed while configuring a UBlox GPS

• NO_AXP192 = 6

  This board was expected to have a power management chip and it is missing or broken

• INVALID_RADIO_SETTING = 7

  The channel tried to set a radio setting which is not supported by this chipset, radio comms settings are now undefined.

• TRANSMIT_FAILED = 8

  Radio transmit hardware failure. We sent data to the radio chip, but it didn't reply with an interrupt.

• BROWNOUT = 9

  We detected that the main CPU voltage dropped below the minimum acceptable value

• SX1262_FAILURE = 10

  Selftest of SX1262 radio chip failed

• RADIO_SPI_BUG = 11

  A (likely software but possibly hardware) failure was detected while trying to send packets. If this occurs on your board, please post in the forum so that we can ask you to collect some information to allow fixing this bug

• FLASH_CORRUPTION_RECOVERABLE = 12

  Corruption was detected on the flash filesystem but we were able to repair things. If you see this failure in the field please post in the forum because we are interested in seeing if this is occurring in the field.

• FLASH_CORRUPTION_UNRECOVERABLE = 13

  Corruption was detected on the flash filesystem but we were unable to repair things. NOTE: Your node will probably need to be reconfigured the next time it reboots (it will lose the region code etc...) If you see this failure in the field please post in the forum because we are interested in seeing if this is occurring in the field.

(Formerly called SubPacket) The payload portion fo a packet, this is the actual bytes that are sent inside a radio packet (because from/to are broken out by the comms library)

Used in: MeshPacket

• PortNum portnum = 1

  Formerly named typ and of type Type

• bytes payload = 2

  TODO: REPLACE

• bool want_response = 3

  Not normally used, but for testing a sender can request that recipient responds in kind (i.e. if it received a position, it should unicast back it's position). Note: that if you set this on a broadcast you will receive many replies.

• fixed32 dest = 4

  The address of the destination node. This field is is filled in by the mesh radio device software, application layer software should never need it. RouteDiscovery messages _must_ populate this. Other message types might need to if they are doing multihop routing.

• fixed32 source = 5

  The address of the original sender for this message. This field should _only_ be populated for reliable multihop packets (to keep packets small).

• fixed32 request_id = 6

  Only used in routing or response messages. Indicates the original message ID that this message is reporting failure on. (formerly called original_id)

• fixed32 reply_id = 7

  If set, this message is intened to be a reply to a previously sent message with the defined id.

• fixed32 emoji = 8

  Defaults to false. If true, then what is in the payload should be treated as an emoji like giving a message a heart or poop emoji.

• optional uint32 bitfield = 9

  Bitfield for extra flags. First use is to indicate that user approves the packet being uploaded to MQTT.

Used in: AdminMessage

• optional WifiConnectionStatus wifi = 1

  WiFi Status

• optional EthernetConnectionStatus ethernet = 2

  WiFi Status

• optional BluetoothConnectionStatus bluetooth = 3

  Bluetooth Status

• optional SerialConnectionStatus serial = 4

  Serial Status

Device metadata response

Used in: AdminMessage, FromRadio

• string firmware_version = 1

  Device firmware version string

• uint32 device_state_version = 2

  Device state version

• bool canShutdown = 3

  Indicates whether the device can shutdown CPU natively or via power management chip

• bool hasWifi = 4

  Indicates that the device has native wifi capability

• bool hasBluetooth = 5

  Indicates that the device has native bluetooth capability

• bool hasEthernet = 6

  Indicates that the device has an ethernet peripheral

• Config.DeviceConfig.Role role = 7

  Indicates that the device's role in the mesh

• uint32 position_flags = 8

  Indicates the device's current enabled position flags

• HardwareModel hw_model = 9

  Device hardware model

• bool hasRemoteHardware = 10

  Has Remote Hardware enabled

• bool hasPKC = 11

  Has PKC capabilities

• uint32 excluded_modules = 12

  Bit field of boolean for excluded modules (bitwise OR of ExcludedModules)

Key native device metrics such as battery level

Used in: NodeInfo, NodeInfoLite, Telemetry

• optional uint32 battery_level = 1

  0-100 (>100 means powered)

• optional float voltage = 2

  Voltage measured

• optional float channel_utilization = 3

  Utilization for the current channel, including well formed TX, RX and malformed RX (aka noise).

• optional float air_util_tx = 4

  Percent of airtime for transmission used within the last hour.

• optional uint32 uptime_seconds = 5

  How long the device has been running since the last reboot (in seconds)

This abstraction is used to contain any configuration for provisioning a node on any client. It is useful for importing and exporting configurations.

• optional string long_name = 1

  Long name for the node

• optional string short_name = 2

  Short name of the node

• optional string channel_url = 3

  The url of the channels from our node

• optional LocalConfig config = 4

  The Config of the node

• optional LocalModuleConfig module_config = 5

  The ModuleConfig of the node

• optional Position fixed_position = 6

  Fixed position data

• optional string ringtone = 7

  Ringtone for ExternalNotification

• optional string canned_messages = 8

  Predefined messages for CannedMessage

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

• optional MyNodeInfo my_node = 2

  Read only settings/info about this node

• optional User owner = 3

  My owner info

• repeated MeshPacket receive_queue = 5

  Received packets saved for delivery to the phone

• uint32 version = 8

  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.

• optional MeshPacket rx_text_message = 7

  We keep the last received text message (only) stored in the device flash, so we can show it on the screen. Might be null

• bool no_save = 9

  Used only during development. Indicates developer is testing and changes should never be saved to flash. Deprecated in 2.3.1

• bool did_gps_reset = 11

  Previously used to manage GPS factory resets. Deprecated in 2.5.23

• optional MeshPacket rx_waypoint = 12

  We keep the last received waypoint stored in the device flash, so we can show it on the screen. Might be null

• repeated NodeRemoteHardwarePin node_remote_hardware_pins = 13

  The mesh's nodes with their available gpio pins for RemoteHardware module

Used in: AdminMessage, Config, FromRadio

• uint32 version = 1

  A version integer used to invalidate saved files when we make incompatible changes.

• uint32 screen_brightness = 2

  TFT display brightness 1..255

• uint32 screen_timeout = 3

  Screen timeout 0..900

• bool screen_lock = 4

  Screen/Settings lock enabled

• bool settings_lock = 5

• uint32 pin_code = 6

• Theme theme = 7

  Color theme

• bool alert_enabled = 8

  Audible message, banner and ring tone

• bool banner_enabled = 9

• uint32 ring_tone_id = 10

• Language language = 11

  Localization

• optional NodeFilter node_filter = 12

  Node list filter

• optional NodeHighlight node_highlight = 13

  Node list highlightening

• bytes calibration_data = 14

  8 integers for screen calibration data

• optional Map map_data = 15

  Map related data

• CompassMode compass_mode = 16

  Compass mode

• uint32 screen_rgb_color = 17

  RGB color for BaseUI 0xRRGGBB format, e.g. 0xFF0000 for red

• bool is_clockface_analog = 18

  Clockface analog style true for analog clockface, false for digital clockface

• DeviceUIConfig.GpsCoordinateFormat gps_format = 19

  How the GPS coordinates are formatted on the OLED screen.

How the GPS coordinates are displayed on the OLED screen.

Used in: DeviceUIConfig

• DEC = 0

  GPS coordinates are displayed in the normal decimal degrees format: DD.DDDDDD DDD.DDDDDD

• DMS = 1

  GPS coordinates are displayed in the degrees minutes seconds format: DD°MM'SS"C DDD°MM'SS"C, where C is the compass point representing the locations quadrant

• UTM = 2

  Universal Transverse Mercator format: ZZB EEEEEE NNNNNNN, where Z is zone, B is band, E is easting, N is northing

• MGRS = 3

  Military Grid Reference System format: ZZB CD EEEEE NNNNN, where Z is zone, B is band, C is the east 100k square, D is the north 100k square, E is easting, N is northing

• OLC = 4

  Open Location Code (aka Plus Codes).

• OSGR = 5

  Ordnance Survey Grid Reference (the National Grid System of the UK). Format: AB EEEEE NNNNN, where A is the east 100k square, B is the north 100k square, E is the easting, N is the northing

• MLS = 6

  Maidenhead Locator System Described here: https://en.wikipedia.org/wiki/Maidenhead_Locator_System

Used in: ClientNotification

(message has no fields)

Weather station or other environmental metrics

Used in: Telemetry

• optional float temperature = 1

  Temperature measured

• optional float relative_humidity = 2

  Relative humidity percent measured

• optional float barometric_pressure = 3

  Barometric pressure in hPA measured

• optional float gas_resistance = 4

  Gas resistance in MOhm measured

• optional float voltage = 5

  Voltage measured (To be depreciated in favor of PowerMetrics in Meshtastic 3.x)

• optional float current = 6

  Current measured (To be depreciated in favor of PowerMetrics in Meshtastic 3.x)

• optional uint32 iaq = 7

  relative scale IAQ value as measured by Bosch BME680 . value 0-500. Belongs to Air Quality but is not particle but VOC measurement. Other VOC values can also be put in here.

• optional float distance = 8

  RCWL9620 Doppler Radar Distance Sensor, used for water level detection. Float value in mm.

• optional float lux = 9

  VEML7700 high accuracy ambient light(Lux) digital 16-bit resolution sensor.

• optional float white_lux = 10

  VEML7700 high accuracy white light(irradiance) not calibrated digital 16-bit resolution sensor.

• optional float ir_lux = 11

  Infrared lux

• optional float uv_lux = 12

  Ultraviolet lux

• optional uint32 wind_direction = 13

  Wind direction in degrees 0 degrees = North, 90 = East, etc...

• optional float wind_speed = 14

  Wind speed in m/s

• optional float weight = 15

  Weight in KG

• optional float wind_gust = 16

  Wind gust in m/s

• optional float wind_lull = 17

  Wind lull in m/s

• optional float radiation = 18

  Radiation in µR/h

• optional float rainfall_1h = 19

  Rainfall in the last hour in mm

• optional float rainfall_24h = 20

  Rainfall in the last 24 hours in mm

• optional uint32 soil_moisture = 21

  Soil moisture measured (% 1-100)

• optional float soil_temperature = 22

  Soil temperature measured (*C)

Ethernet connection status

Used in: DeviceConnectionStatus

• optional NetworkConnectionStatus status = 1

  Connection status

Enum for modules excluded from a device's configuration. Each value represents a ModuleConfigType that can be toggled as excluded by setting its corresponding bit in the `excluded_modules` bitmask field.

• EXCLUDED_NONE = 0

  Default value of 0 indicates no modules are excluded.

• MQTT_CONFIG = 1

  MQTT module

• SERIAL_CONFIG = 2

  Serial module

• EXTNOTIF_CONFIG = 4

  External Notification module

• STOREFORWARD_CONFIG = 8

  Store and Forward module

• RANGETEST_CONFIG = 16

  Range Test module

• TELEMETRY_CONFIG = 32

  Telemetry module

• CANNEDMSG_CONFIG = 64

  Canned Message module

• AUDIO_CONFIG = 128

  Audio module

• REMOTEHARDWARE_CONFIG = 256

  Remote Hardware module

• NEIGHBORINFO_CONFIG = 512

  Neighbor Info module

• AMBIENTLIGHTING_CONFIG = 1024

  Ambient Lighting module

• DETECTIONSENSOR_CONFIG = 2048

  Detection Sensor module

• PAXCOUNTER_CONFIG = 4096

  Paxcounter module

• BLUETOOTH_CONFIG = 8192

  Bluetooth config (not technically a module, but used to indicate bluetooth capabilities)

• NETWORK_CONFIG = 16384

  Network config (not technically a module, but used to indicate network capabilities)

Individual File info for the device

Used in: FromRadio

• string file_name = 1

  The fully qualified path of the file

• uint32 size_bytes = 2

  The size of the file in bytes

Enum to indicate to clients whether this firmware is a special firmware build, like an event. The first 16 values are reserved for non-event special firmwares, like the Smart Citizen use case.

Used in: MyNodeInfo

• VANILLA = 0

  Vanilla firmware

• SMART_CITIZEN = 1

  Firmware for use in the Smart Citizen environmental monitoring network

• OPEN_SAUCE = 16

  Open Sauce, the maker conference held yearly in CA

• DEFCON = 17

  DEFCON, the yearly hacker conference

• BURNING_MAN = 18

  Burning Man, the yearly hippie gathering in the desert

• HAMVENTION = 19

  Hamvention, the Dayton amateur radio convention

• DIY_EDITION = 127

  Placeholder for DIY and unofficial events

Packets from the radio to the phone will appear on the fromRadio characteristic. It will support READ and NOTIFY. When a new packet arrives the device will BLE notify? It will sit in that descriptor until consumed by the phone, at which point the next item in the FIFO will be populated.

• uint32 id = 1

  The packet id, used to allow the phone to request missing read packets from the FIFO, see our bluetooth docs

• oneof payload_variant

  Log levels, chosen to match python logging conventions.

  • MeshPacket packet = 2

    Log levels, chosen to match python logging conventions.

  • MyNodeInfo my_info = 3

    Tells the phone what our node number is, can be -1 if we've not yet joined a mesh. NOTE: This ID must not change - to keep (minimal) compatibility with <1.2 version of android apps.

  • NodeInfo node_info = 4

    One packet is sent for each node in the on radio DB starts over with the first node in our DB

  • Config config = 5

    Include a part of the config (was: RadioConfig radio)

  • LogRecord log_record = 6

    Set to send debug console output over our protobuf stream

  • uint32 config_complete_id = 7

    Sent as true once the device has finished sending all of the responses to want_config recipient should check if this ID matches our original request nonce, if not, it means your config responses haven't started yet. NOTE: This ID must not change - to keep (minimal) compatibility with <1.2 version of android apps.

  • bool rebooted = 8

    Sent to tell clients the radio has just rebooted. Set to true if present. Not used on all transports, currently just used for the serial console. NOTE: This ID must not change - to keep (minimal) compatibility with <1.2 version of android apps.

  • ModuleConfig moduleConfig = 9

    Include module config

  • Channel channel = 10

    One packet is sent for each channel

  • QueueStatus queueStatus = 11

    Queue status info

  • XModem xmodemPacket = 12

    File Transfer Chunk

  • DeviceMetadata metadata = 13

    Device metadata message

  • MqttClientProxyMessage mqttClientProxyMessage = 14

    MQTT Client Proxy Message (device sending to client / phone for publishing to MQTT)

  • FileInfo fileInfo = 15

    File system manifest messages

  • ClientNotification clientNotification = 16

    Notification message to the client

  • DeviceUIConfig deviceuiConfig = 17

    Persistent data for device-ui

ATAK GeoChat message

Used in: TAKPacket

• string message = 1

  The text message

• optional string to = 2

  Uid recipient of the message

• optional string to_callsign = 3

  Callsign of the recipient for the message

Used in: Map

• int32 zoom = 1

  Zoom level

• int32 latitude = 2

  Coordinate: latitude

• int32 longitude = 3

  Coordinate: longitude

ATAK Group <__group role='Team Member' name='Cyan'/>

Used in: TAKPacket

• MemberRole role = 1

  Role of the group member

• Team team = 2

  Team (color) Default Cyan

Parameters for setting up Meshtastic for ameteur radio usage

Used in: AdminMessage

• string call_sign = 1

  Amateur radio call sign, eg. KD2ABC

• int32 tx_power = 2

  Transmit power in dBm at the LoRA transceiver, not including any amplification

• float frequency = 3

  The selected frequency of LoRA operation Please respect your local laws, regulations, and band plans. Ensure your radio is capable of operating of the selected frequency before setting this.

• string short_name = 4

  Optional short name of user

An example app to show off the module system. This message is used for REMOTE_HARDWARE_APP PortNums. Also provides easy remote access to any GPIO. In the future other remote hardware operations can be added based on user interest (i.e. serial output, spi/i2c input/output). FIXME - currently this feature is turned on by default which is dangerous because no security yet (beyond the channel mechanism). It should be off by default and then protected based on some TBD mechanism (a special channel once multichannel support is included?)

• HardwareMessage.Type type = 1

  What type of HardwareMessage is this?

• uint64 gpio_mask = 2

  What gpios are we changing. Not used for all MessageTypes, see MessageType for details

• uint64 gpio_value = 3

  For gpios that were listed in gpio_mask as valid, what are the signal levels for those gpios. Not used for all MessageTypes, see MessageType for details

TODO: REPLACE

Used in: HardwareMessage

• UNSET = 0

  Unset/unused

• WRITE_GPIOS = 1

  Set gpio gpios based on gpio_mask/gpio_value

• WATCH_GPIOS = 2

  We are now interested in watching the gpio_mask gpios. If the selected gpios change, please broadcast GPIOS_CHANGED. Will implicitly change the gpios requested to be INPUT gpios.

• GPIOS_CHANGED = 3

  The gpios listed in gpio_mask have changed, the new values are listed in gpio_value

• READ_GPIOS = 4

  Read the gpios specified in gpio_mask, send back a READ_GPIOS_REPLY reply with gpio_value populated

• READ_GPIOS_REPLY = 5

  A reply to READ_GPIOS. gpio_mask and gpio_value will be populated

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 .

Used in: DeviceMetadata, MapReport, User, UserLite

• UNSET = 0

  TODO: REPLACE

• TLORA_V2 = 1

  TODO: REPLACE

• TLORA_V1 = 2

  TODO: REPLACE

• TLORA_V2_1_1P6 = 3

  TODO: REPLACE

• TBEAM = 4

  TODO: REPLACE

• HELTEC_V2_0 = 5

  The original heltec WiFi_Lora_32_V2, which had battery voltage sensing hooked to GPIO 13 (see HELTEC_V2 for the new version).

• TBEAM_V0P7 = 6

  TODO: REPLACE

• T_ECHO = 7

  TODO: REPLACE

• TLORA_V1_1P3 = 8

  TODO: REPLACE

• RAK4631 = 9

  TODO: REPLACE

• HELTEC_V2_1 = 10

  The new version of the heltec WiFi_Lora_32_V2 board that has battery sensing hooked to GPIO 37. Sadly they did not update anything on the silkscreen to identify this board

• HELTEC_V1 = 11

  Ancient heltec WiFi_Lora_32 board

• LILYGO_TBEAM_S3_CORE = 12

  New T-BEAM with ESP32-S3 CPU

• RAK11200 = 13

  RAK WisBlock ESP32 core: https://docs.rakwireless.com/Product-Categories/WisBlock/RAK11200/Overview/

• NANO_G1 = 14

  B&Q Consulting Nano Edition G1: https://uniteng.com/wiki/doku.php?id=meshtastic:nano

• TLORA_V2_1_1P8 = 15

  TODO: REPLACE

• TLORA_T3_S3 = 16

  TODO: REPLACE

• NANO_G1_EXPLORER = 17

  B&Q Consulting Nano G1 Explorer: https://wiki.uniteng.com/en/meshtastic/nano-g1-explorer

• NANO_G2_ULTRA = 18

  B&Q Consulting Nano G2 Ultra: https://wiki.uniteng.com/en/meshtastic/nano-g2-ultra

• LORA_TYPE = 19

  LoRAType device: https://loratype.org/

• WIPHONE = 20

  wiphone https://www.wiphone.io/

• WIO_WM1110 = 21

  WIO Tracker WM1110 family from Seeed Studio. Includes wio-1110-tracker and wio-1110-sdk

• RAK2560 = 22

  RAK2560 Solar base station based on RAK4630

• HELTEC_HRU_3601 = 23

  Heltec HRU-3601: https://heltec.org/project/hru-3601/

• HELTEC_WIRELESS_BRIDGE = 24

  Heltec Wireless Bridge

• STATION_G1 = 25

  B&Q Consulting Station Edition G1: https://uniteng.com/wiki/doku.php?id=meshtastic:station

• RAK11310 = 26

  RAK11310 (RP2040 + SX1262)

• SENSELORA_RP2040 = 27

  Makerfabs SenseLoRA Receiver (RP2040 + RFM96)

• SENSELORA_S3 = 28

  Makerfabs SenseLoRA Industrial Monitor (ESP32-S3 + RFM96)

• CANARYONE = 29

  Canary Radio Company - CanaryOne: https://canaryradio.io/products/canaryone

• RP2040_LORA = 30

  Waveshare RP2040 LoRa - https://www.waveshare.com/rp2040-lora.htm

• STATION_G2 = 31

  B&Q Consulting Station G2: https://wiki.uniteng.com/en/meshtastic/station-g2

• LORA_RELAY_V1 = 32

  --------------------------------------------------------------------------- Less common/prototype boards listed here (needs one more byte over the air) ---------------------------------------------------------------------------

• NRF52840DK = 33

  TODO: REPLACE

• PPR = 34

  TODO: REPLACE

• GENIEBLOCKS = 35

  TODO: REPLACE

• NRF52_UNKNOWN = 36

  TODO: REPLACE

• PORTDUINO = 37

  TODO: REPLACE

• ANDROID_SIM = 38

  The simulator built into the android app

• DIY_V1 = 39

  Custom DIY device based on @NanoVHF schematics: https://github.com/NanoVHF/Meshtastic-DIY/tree/main/Schematics

• NRF52840_PCA10059 = 40

  nRF52840 Dongle : https://www.nordicsemi.com/Products/Development-hardware/nrf52840-dongle/

• DR_DEV = 41

  Custom Disaster Radio esp32 v3 device https://github.com/sudomesh/disaster-radio/tree/master/hardware/board_esp32_v3

• M5STACK = 42

  M5 esp32 based MCU modules with enclosure, TFT and LORA Shields. All Variants (Basic, Core, Fire, Core2, CoreS3, Paper) https://m5stack.com/

• HELTEC_V3 = 43

  New Heltec LoRA32 with ESP32-S3 CPU

• HELTEC_WSL_V3 = 44

  New Heltec Wireless Stick Lite with ESP32-S3 CPU

• BETAFPV_2400_TX = 45

  New BETAFPV ELRS Micro TX Module 2.4G with ESP32 CPU

• BETAFPV_900_NANO_TX = 46

  BetaFPV ExpressLRS "Nano" TX Module 900MHz with ESP32 CPU

• RPI_PICO = 47

  Raspberry Pi Pico (W) with Waveshare SX1262 LoRa Node Module

• HELTEC_WIRELESS_TRACKER = 48

  Heltec Wireless Tracker with ESP32-S3 CPU, built-in GPS, and TFT Newer V1.1, version is written on the PCB near the display.

• HELTEC_WIRELESS_PAPER = 49

  Heltec Wireless Paper with ESP32-S3 CPU and E-Ink display

• T_DECK = 50

  LilyGo T-Deck with ESP32-S3 CPU, Keyboard and IPS display

• T_WATCH_S3 = 51

  LilyGo T-Watch S3 with ESP32-S3 CPU and IPS display

• PICOMPUTER_S3 = 52

  Bobricius Picomputer with ESP32-S3 CPU, Keyboard and IPS display

• HELTEC_HT62 = 53

  Heltec HT-CT62 with ESP32-C3 CPU and SX1262 LoRa

• EBYTE_ESP32_S3 = 54

  EBYTE SPI LoRa module and ESP32-S3

• ESP32_S3_PICO = 55

  Waveshare ESP32-S3-PICO with PICO LoRa HAT and 2.9inch e-Ink

• CHATTER_2 = 56

  CircuitMess Chatter 2 LLCC68 Lora Module and ESP32 Wroom Lora module can be swapped out for a Heltec RA-62 which is "almost" pin compatible with one cut and one jumper Meshtastic works

• HELTEC_WIRELESS_PAPER_V1_0 = 57

  Heltec Wireless Paper, With ESP32-S3 CPU and E-Ink display Older "V1.0" Variant, has no "version sticker" E-Ink model is DEPG0213BNS800 Tab on the screen protector is RED Flex connector marking is FPC-7528B

• HELTEC_WIRELESS_TRACKER_V1_0 = 58

  Heltec Wireless Tracker with ESP32-S3 CPU, built-in GPS, and TFT Older "V1.0" Variant

• UNPHONE = 59

  unPhone with ESP32-S3, TFT touchscreen, LSM6DS3TR-C accelerometer and gyroscope

• TD_LORAC = 60

  Teledatics TD-LORAC NRF52840 based M.2 LoRA module Compatible with the TD-WRLS development board

• CDEBYTE_EORA_S3 = 61

  CDEBYTE EoRa-S3 board using their own MM modules, clone of LILYGO T3S3

• TWC_MESH_V4 = 62

  TWC_MESH_V4 Adafruit NRF52840 feather express with SX1262, SSD1306 OLED and NEO6M GPS

• NRF52_PROMICRO_DIY = 63

  NRF52_PROMICRO_DIY Promicro NRF52840 with SX1262/LLCC68, SSD1306 OLED and NEO6M GPS

• RADIOMASTER_900_BANDIT_NANO = 64

  RadioMaster 900 Bandit Nano, https://www.radiomasterrc.com/products/bandit-nano-expresslrs-rf-module ESP32-D0WDQ6 With SX1276/SKY66122, SSD1306 OLED and No GPS

• HELTEC_CAPSULE_SENSOR_V3 = 65

  Heltec Capsule Sensor V3 with ESP32-S3 CPU, Portable LoRa device that can replace GNSS modules or sensors

• HELTEC_VISION_MASTER_T190 = 66

  Heltec Vision Master T190 with ESP32-S3 CPU, and a 1.90 inch TFT display

• HELTEC_VISION_MASTER_E213 = 67

  Heltec Vision Master E213 with ESP32-S3 CPU, and a 2.13 inch E-Ink display

• HELTEC_VISION_MASTER_E290 = 68

  Heltec Vision Master E290 with ESP32-S3 CPU, and a 2.9 inch E-Ink display

• HELTEC_MESH_NODE_T114 = 69

  Heltec Mesh Node T114 board with nRF52840 CPU, and a 1.14 inch TFT display, Ultimate low-power design, specifically adapted for the Meshtatic project

• SENSECAP_INDICATOR = 70

  Sensecap Indicator from Seeed Studio. ESP32-S3 device with TFT and RP2040 coprocessor

• TRACKER_T1000_E = 71

  Seeed studio T1000-E tracker card. NRF52840 w/ LR1110 radio, GPS, button, buzzer, and sensors.

• RAK3172 = 72

  RAK3172 STM32WLE5 Module (https://store.rakwireless.com/products/wisduo-lpwan-module-rak3172)

• WIO_E5 = 73

  Seeed Studio Wio-E5 (either mini or Dev kit) using STM32WL chip.

• RADIOMASTER_900_BANDIT = 74

  RadioMaster 900 Bandit, https://www.radiomasterrc.com/products/bandit-expresslrs-rf-module SSD1306 OLED and No GPS

• ME25LS01_4Y10TD = 75

  Minewsemi ME25LS01 (ME25LE01_V1.0). NRF52840 w/ LR1110 radio, buttons and leds and pins.

• RP2040_FEATHER_RFM95 = 76

  RP2040_FEATHER_RFM95 Adafruit Feather RP2040 with RFM95 LoRa Radio RFM95 with SX1272, SSD1306 OLED https://www.adafruit.com/product/5714 https://www.adafruit.com/product/326 https://www.adafruit.com/product/938 ^^^ short A0 to switch to I2C address 0x3C

• M5STACK_COREBASIC = 77

  M5 esp32 based MCU modules with enclosure, TFT and LORA Shields. All Variants (Basic, Core, Fire, Core2, CoreS3, Paper) https://m5stack.com/

• M5STACK_CORE2 = 78

• RPI_PICO2 = 79

  Pico2 with Waveshare Hat, same as Pico

• M5STACK_CORES3 = 80

  M5 esp32 based MCU modules with enclosure, TFT and LORA Shields. All Variants (Basic, Core, Fire, Core2, CoreS3, Paper) https://m5stack.com/

• SEEED_XIAO_S3 = 81

  Seeed XIAO S3 DK

• MS24SF1 = 82

  Nordic nRF52840+Semtech SX1262 LoRa BLE Combo Module. nRF52840+SX1262 MS24SF1

• TLORA_C6 = 83

  Lilygo TLora-C6 with the new ESP32-C6 MCU

• WISMESH_TAP = 84

  WisMesh Tap RAK-4631 w/ TFT in injection modled case

• ROUTASTIC = 85

  Similar to PORTDUINO but used by Routastic devices, this is not any particular device and does not run Meshtastic's code but supports the same frame format. Runs on linux, see https://github.com/Jorropo/routastic

• MESH_TAB = 86

  Mesh-Tab, esp32 based https://github.com/valzzu/Mesh-Tab

• MESHLINK = 87

  MeshLink board developed by LoraItalia. NRF52840, eByte E22900M22S (Will also come with other frequencies), 25w MPPT solar charger (5v,12v,18v selectable), support for gps, buzzer, oled or e-ink display, 10 gpios, hardware watchdog https://www.loraitalia.it

• XIAO_NRF52_KIT = 88

  Seeed XIAO nRF52840 + Wio SX1262 kit

• THINKNODE_M1 = 89

  Elecrow ThinkNode M1 & M2 https://www.elecrow.com/wiki/ThinkNode-M1_Transceiver_Device(Meshtastic)_Power_By_nRF52840.html https://www.elecrow.com/wiki/ThinkNode-M2_Transceiver_Device(Meshtastic)_Power_By_NRF52840.html (this actually uses ESP32-S3)

• THINKNODE_M2 = 90

• T_ETH_ELITE = 91

  Lilygo T-ETH-Elite

• HELTEC_SENSOR_HUB = 92

  Heltec HRI-3621 industrial probe

• RESERVED_FRIED_CHICKEN = 93

  Reserved Fried Chicken ID for future use

• HELTEC_MESH_POCKET = 94

  Heltec Magnetic Power Bank with Meshtastic compatible

• SEEED_SOLAR_NODE = 95

  Seeed Solar Node

• NOMADSTAR_METEOR_PRO = 96

  NomadStar Meteor Pro https://nomadstar.ch/

• CROWPANEL = 97

  Elecrow CrowPanel Advance models, ESP32-S3 and TFT with SX1262 radio plugin

• LINK_32 = 98

  Lilygo LINK32 board with sensors

• SEEED_WIO_TRACKER_L1 = 99

  Seeed Tracker L1

• SEEED_WIO_TRACKER_L1_EINK = 100

  Seeed Tracker L1 EINK driver

• MUZI_R1_NEO = 101

  Muzi Works R1 Neo

• T_DECK_PRO = 102

  Lilygo T-Deck Pro

• T_LORA_PAGER = 103

  Lilygo TLora Pager

• M5STACK_RESERVED = 104

  M5Stack Reserved

  0x68

• WISMESH_TAG = 105

  RAKwireless WisMesh Tag

• RAK3312 = 106

  RAKwireless WisBlock Core RAK3312 https://docs.rakwireless.com/product-categories/wisduo/rak3112-module/overview/

• THINKNODE_M5 = 107

  Elecrow ThinkNode M5 https://www.elecrow.com/wiki/ThinkNode_M5_Meshtastic_LoRa_Signal_Transceiver_ESP32-S3.html

• HELTEC_MESH_SOLAR = 108

  MeshSolar is an integrated power management and communication solution designed for outdoor low-power devices. https://heltec.org/project/meshsolar/

• T_ECHO_LITE = 109

  Lilygo T-Echo Lite

• HELTEC_V4 = 110

  New Heltec LoRA32 with ESP32-S3 CPU

• M5STACK_C6L = 111

  M5Stack C6L

• M5STACK_CARDPUTER_ADV = 112

  M5Stack Cardputer Adv

• HELTEC_WIRELESS_TRACKER_V2 = 113

  ESP32S3 main controller with GPS and TFT screen.

• T_WATCH_ULTRA = 114

  LilyGo T-Watch Ultra

• THINKNODE_M3 = 115

  Elecrow ThinkNode M3

• PRIVATE_HW = 255

  ------------------------------------------------------------------------------------------------------------------------------------------ Reserved ID For developing private Ports. These will show up in live traffic sparsely, so we can use a high number. Keep it within 8 bits. ------------------------------------------------------------------------------------------------------------------------------------------

Health telemetry metrics

Used in: Telemetry

• optional uint32 heart_bpm = 1

  Heart rate (beats per minute)

• optional uint32 spO2 = 2

  SpO2 (blood oxygen saturation) level

• optional float temperature = 3

  Body temperature in degrees Celsius

A heartbeat message is sent to the node from the client to keep the connection alive. This is currently only needed to keep serial connections alive, but can be used by any PhoneAPI.

Used in: ToRadio

• uint32 nonce = 1

  The nonce of the heartbeat message

Linux host metrics

Used in: Telemetry

• uint32 uptime_seconds = 1

  Host system uptime

• uint64 freemem_bytes = 2

  Host system free memory

• uint64 diskfree1_bytes = 3

  Host system disk space free for /

• optional uint64 diskfree2_bytes = 4

  Secondary system disk space free

• optional uint64 diskfree3_bytes = 5

  Tertiary disk space free

• uint32 load1 = 6

  Host system one minute load in 1/100ths

• uint32 load5 = 7

  Host system five minute load in 1/100ths

• uint32 load15 = 8

  Host system fifteen minute load in 1/100ths

• optional string user_string = 9

  Optional User-provided string for arbitrary host system information that doesn't make sense as a dedicated entry.

• oneof data

  The message data

  • string nmea = 1

  • SensorData sensor = 2

The actual over-the-mesh message doing KeyVerification

• uint64 nonce = 1

  random value Selected by the requesting node

• bytes hash1 = 2

  The final authoritative hash, only to be sent by NodeA at the end of the handshake

• bytes hash2 = 3

  The intermediary hash (actually derived from hash1), sent from NodeB to NodeA in response to the initial message.

This message is used by a client to initiate or complete a key verification

Used in: AdminMessage

• KeyVerificationAdmin.MessageType message_type = 1

• uint32 remote_nodenum = 2

  The nodenum we're requesting

• uint64 nonce = 3

  The nonce is used to track the connection

• optional uint32 security_number = 4

  The 4 digit code generated by the remote node, and communicated outside the mesh

Three stages of this request.

Used in: KeyVerificationAdmin

• INITIATE_VERIFICATION = 0

  This is the first stage, where a client initiates

• PROVIDE_SECURITY_NUMBER = 1

  After the nonce has been returned over the mesh, the client prompts for the security number And uses this message to provide it to the node.

• DO_VERIFY = 2

  Once the user has compared the verification message, this message notifies the node.

• DO_NOT_VERIFY = 3

  This is the cancel path, can be taken at any point

Used in: ClientNotification

• uint64 nonce = 1

• string remote_longname = 2

• bool isSender = 3

• string verification_characters = 4

Used in: ClientNotification

• uint64 nonce = 1

• string remote_longname = 2

• uint32 security_number = 3

Used in: ClientNotification

• uint64 nonce = 1

• string remote_longname = 2

Localization

Used in: DeviceUIConfig

• ENGLISH = 0

  English

• FRENCH = 1

  French

• GERMAN = 2

  German

• ITALIAN = 3

  Italian

• PORTUGUESE = 4

  Portuguese

• SPANISH = 5

  Spanish

• SWEDISH = 6

  Swedish

• FINNISH = 7

  Finnish

• POLISH = 8

  Polish

• TURKISH = 9

  Turkish

• SERBIAN = 10

  Serbian

• RUSSIAN = 11

  Russian

• DUTCH = 12

  Dutch

• GREEK = 13

  Greek

• NORWEGIAN = 14

  Norwegian

• SLOVENIAN = 15

  Slovenian

• UKRAINIAN = 16

  Ukrainian

• BULGARIAN = 17

  Bulgarian

• CZECH = 18

  Czech

• DANISH = 19

  Danish

• SIMPLIFIED_CHINESE = 30

  Simplified Chinese (experimental)

• TRADITIONAL_CHINESE = 31

  Traditional Chinese (experimental)

Used in: BackupPreferences, DeviceProfile

• optional Config.DeviceConfig device = 1

  The part of the config that is specific to the Device

• optional Config.PositionConfig position = 2

  The part of the config that is specific to the GPS Position

• optional Config.PowerConfig power = 3

  The part of the config that is specific to the Power settings

• optional Config.NetworkConfig network = 4

  The part of the config that is specific to the Wifi Settings

• optional Config.DisplayConfig display = 5

  The part of the config that is specific to the Display

• optional Config.LoRaConfig lora = 6

  The part of the config that is specific to the Lora Radio

• optional Config.BluetoothConfig bluetooth = 7

  The part of the config that is specific to the Bluetooth settings

• uint32 version = 8

  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.

• optional Config.SecurityConfig security = 9

  The part of the config that is specific to Security settings

Used in: BackupPreferences, DeviceProfile

• optional ModuleConfig.MQTTConfig mqtt = 1

  The part of the config that is specific to the MQTT module

• optional ModuleConfig.SerialConfig serial = 2

  The part of the config that is specific to the Serial module

• optional ModuleConfig.ExternalNotificationConfig external_notification = 3

  The part of the config that is specific to the ExternalNotification module

• optional ModuleConfig.StoreForwardConfig store_forward = 4

  The part of the config that is specific to the Store & Forward module

• optional ModuleConfig.RangeTestConfig range_test = 5

  The part of the config that is specific to the RangeTest module

• optional ModuleConfig.TelemetryConfig telemetry = 6

  The part of the config that is specific to the Telemetry module

• optional ModuleConfig.CannedMessageConfig canned_message = 7

  The part of the config that is specific to the Canned Message module

• optional ModuleConfig.AudioConfig audio = 9

  The part of the config that is specific to the Audio module

• optional ModuleConfig.RemoteHardwareConfig remote_hardware = 10

  The part of the config that is specific to the Remote Hardware module

• optional ModuleConfig.NeighborInfoConfig neighbor_info = 11

  The part of the config that is specific to the Neighbor Info module

• optional ModuleConfig.AmbientLightingConfig ambient_lighting = 12

  The part of the config that is specific to the Ambient Lighting module

• optional ModuleConfig.DetectionSensorConfig detection_sensor = 13

  The part of the config that is specific to the Detection Sensor module

• optional ModuleConfig.PaxcounterConfig paxcounter = 14

  Paxcounter Config

• uint32 version = 8

  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.

Local device mesh statistics

Used in: Telemetry

• uint32 uptime_seconds = 1

  How long the device has been running since the last reboot (in seconds)

• float channel_utilization = 2

  Utilization for the current channel, including well formed TX, RX and malformed RX (aka noise).

• float air_util_tx = 3

  Percent of airtime for transmission used within the last hour.

• uint32 num_packets_tx = 4

  Number of packets sent

• uint32 num_packets_rx = 5

  Number of packets received (both good and bad)

• uint32 num_packets_rx_bad = 6

  Number of packets received that are malformed or violate the protocol

• uint32 num_online_nodes = 7

  Number of nodes online (in the past 2 hours)

• uint32 num_total_nodes = 8

  Number of nodes total

• uint32 num_rx_dupe = 9

  Number of received packets that were duplicates (due to multiple nodes relaying). If this number is high, there are nodes in the mesh relaying packets when it's unnecessary, for example due to the ROUTER/REPEATER role.

• uint32 num_tx_relay = 10

  Number of packets we transmitted that were a relay for others (not originating from ourselves).

• uint32 num_tx_relay_canceled = 11

  Number of times we canceled a packet to be relayed, because someone else did it before us. This will always be zero for ROUTERs/REPEATERs. If this number is high, some other node(s) is/are relaying faster than you.

• uint32 heap_total_bytes = 12

  Number of bytes used in the heap

• uint32 heap_free_bytes = 13

  Number of bytes free in the heap

• uint32 num_tx_dropped = 14

  Number of packets that were dropped because the transmit queue was full.

Debug output from the device. To minimize the size of records inside the device code, if a time/source/level is not set on the message it is assumed to be a continuation of the previously sent message. This allows the device code to use fixed maxlen 64 byte strings for messages, and then extend as needed by emitting multiple records.

Used in: FromRadio

• string message = 1

  Log levels, chosen to match python logging conventions.

• fixed32 time = 2

  Seconds since 1970 - or 0 for unknown/unset

• string source = 3

  Usually based on thread name - if known

• LogRecord.Level level = 4

  Not yet set

Log levels, chosen to match python logging conventions.

Used in: ClientNotification, LogRecord

• UNSET = 0

  Log levels, chosen to match python logging conventions.

• CRITICAL = 50

  Log levels, chosen to match python logging conventions.

• ERROR = 40

  Log levels, chosen to match python logging conventions.

• WARNING = 30

  Log levels, chosen to match python logging conventions.

• INFO = 20

  Log levels, chosen to match python logging conventions.

• DEBUG = 10

  Log levels, chosen to match python logging conventions.

• TRACE = 5

  Log levels, chosen to match python logging conventions.

Used in: ClientNotification

(message has no fields)

Used in: DeviceUIConfig

• optional GeoPoint home = 1

  Home coordinates

• string style = 2

  Map tile style

• bool follow_gps = 3

  Map scroll follows GPS

Information about a node intended to be reported unencrypted to a map using MQTT.

• string long_name = 1

  A full name for this user, i.e. "Kevin Hester"

• string short_name = 2

  A VERY short name, ideally two characters. Suitable for a tiny OLED screen

• Config.DeviceConfig.Role role = 3

  Role of the node that applies specific settings for a particular use-case

• HardwareModel hw_model = 4

  Hardware model of the node, i.e. T-Beam, Heltec V3, etc...

• string firmware_version = 5

  Device firmware version string

• Config.LoRaConfig.RegionCode region = 6

  The region code for the radio (US, CN, EU433, etc...)

• Config.LoRaConfig.ModemPreset modem_preset = 7

  Modem preset used by the radio (LongFast, MediumSlow, etc...)

• bool has_default_channel = 8

  Whether the node has a channel with default PSK and name (LongFast, MediumSlow, etc...) and it uses the default frequency slot given the region and modem preset.

• sfixed32 latitude_i = 9

  Latitude: multiply by 1e-7 to get degrees in floating point

• sfixed32 longitude_i = 10

  Longitude: multiply by 1e-7 to get degrees in floating point

• int32 altitude = 11

  Altitude in meters above MSL

• uint32 position_precision = 12

  Indicates the bits of precision for latitude and longitude set by the sending node

• uint32 num_online_local_nodes = 13

  Number of online nodes (heard in the last 2 hours) this node has in its list that were received locally (not via MQTT)

• bool has_opted_report_location = 14

  User has opted in to share their location (map report) with the mqtt server Controlled by map_report.should_report_location

Role of the group member

Used in: Group

• Unspecifed = 0

  Unspecifed

• TeamMember = 1

  Team Member

• TeamLead = 2

  Team Lead

• HQ = 3

  Headquarters

• Sniper = 4

  Airsoft enthusiast

• Medic = 5

  Medic

• ForwardObserver = 6

  ForwardObserver

• RTO = 7

  Radio Telephone Operator

• K9 = 8

  Doggo

A packet envelope sent/received over the mesh only payload_variant is sent in the payload portion of the LORA packet. The other fields are either not sent at all, or sent in the special 16 byte LORA header.

Used in: DeviceState, FromRadio, ServiceEnvelope, ToRadio

• fixed32 from = 1

  The sending node number. Note: Our crypto implementation uses this field as well. See [crypto](/docs/overview/encryption) for details.

• fixed32 to = 2

  The (immediate) destination for this packet

• uint32 channel = 3

  (Usually) If set, this indicates the index in the secondary_channels table that this packet was sent/received on. If unset, packet was on the primary channel. A particular node might know only a subset of channels in use on the mesh. Therefore channel_index is inherently a local concept and meaningless to send between nodes. Very briefly, while sending and receiving deep inside the device Router code, this field instead contains the 'channel hash' instead of the index. This 'trick' is only used while the payload_variant is an 'encrypted'.

• oneof payload_variant

  • Data decoded = 4

    TODO: REPLACE

  • bytes encrypted = 5

    TODO: REPLACE

• fixed32 id = 6

  A unique ID for this packet. Always 0 for no-ack packets or non broadcast packets (and therefore take zero bytes of space). Otherwise a unique ID for this packet, useful for flooding algorithms. ID only needs to be unique on a _per sender_ basis, and it only needs to be unique for a few minutes (long enough to last for the length of any ACK or the completion of a mesh broadcast flood). Note: Our crypto implementation uses this id as well. See [crypto](/docs/overview/encryption) for details.

• fixed32 rx_time = 7

  The time this message was received by the esp32 (secs since 1970). Note: this field is _never_ sent on the radio link itself (to save space) Times are typically not sent over the mesh, but they will be added to any Packet (chain of SubPacket) sent to the phone (so the phone can know exact time of reception)

• float rx_snr = 8

  *Never* sent over the radio links. Set during reception to indicate the SNR of this packet. Used to collect statistics on current link quality.

• uint32 hop_limit = 9

  If unset treated as zero (no forwarding, send to direct neighbor nodes only) if 1, allow hopping through one node, etc... For our usecase real world topologies probably have a max of about 3. This field is normally placed into a few of bits in the header.

• bool want_ack = 10

  This packet is being sent as a reliable message, we would prefer it to arrive at the destination. We would like to receive a ack packet in response. Broadcasts messages treat this flag specially: Since acks for broadcasts would rapidly flood the channel, the normal ack behavior is suppressed. Instead, the original sender listens to see if at least one node is rebroadcasting this packet (because naive flooding algorithm). If it hears that the odds (given typical LoRa topologies) the odds are very high that every node should eventually receive the message. So FloodingRouter.cpp generates an implicit ack which is delivered to the original sender. If after some time we don't hear anyone rebroadcast our packet, we will timeout and retransmit, using the regular resend logic. Note: This flag is normally sent in a flag bit in the header when sent over the wire

• MeshPacket.Priority priority = 11

  The priority of this message for sending. See MeshPacket.Priority description for more details.

• int32 rx_rssi = 12

  rssi of received packet. Only sent to phone for dispay purposes.

• MeshPacket.Delayed delayed = 13

  Describe if this message is delayed

• bool via_mqtt = 14

  Describes whether this packet passed via MQTT somewhere along the path it currently took.

• uint32 hop_start = 15

  Hop limit with which the original packet started. Sent via LoRa using three bits in the unencrypted header. When receiving a packet, the difference between hop_start and hop_limit gives how many hops it traveled.

• bytes public_key = 16

  Records the public key the packet was encrypted with, if applicable.

• bool pki_encrypted = 17

  Indicates whether the packet was en/decrypted using PKI

• uint32 next_hop = 18

  Last byte of the node number of the node that should be used as the next hop in routing. Set by the firmware internally, clients are not supposed to set this.

• uint32 relay_node = 19

  Last byte of the node number of the node that will relay/relayed this packet. Set by the firmware internally, clients are not supposed to set this.

• uint32 tx_after = 20

  *Never* sent over the radio links. Timestamp after which this packet may be sent. Set by the firmware internally, clients are not supposed to set this.

• MeshPacket.TransportMechanism transport_mechanism = 21

  Indicates which transport mechanism this packet arrived over

Identify if this is a delayed packet

Used in: MeshPacket

• NO_DELAY = 0

  If unset, the message is being sent in real time.

• DELAYED_BROADCAST = 1

  The message is delayed and was originally a broadcast

• DELAYED_DIRECT = 2

  The message is delayed and was originally a direct message

The priority of this message for sending. Higher priorities are sent first (when managing the transmit queue). This field is never sent over the air, it is only used internally inside of a local device node. API clients (either on the local node or connected directly to the node) can set this parameter if necessary. (values must be <= 127 to keep protobuf field to one byte in size. Detailed background on this field: I noticed a funny side effect of lora being so slow: Usually when making a protocol there isn’t much need to use message priority to change the order of transmission (because interfaces are fairly fast). But for lora where packets can take a few seconds each, it is very important to make sure that critical packets are sent ASAP. In the case of meshtastic that means we want to send protocol acks as soon as possible (to prevent unneeded retransmissions), we want routing messages to be sent next, then messages marked as reliable and finally 'background' packets like periodic position updates. So I bit the bullet and implemented a new (internal - not sent over the air) field in MeshPacket called 'priority'. And the transmission queue in the router object is now a priority queue.

Used in: MeshPacket

• UNSET = 0

  Treated as Priority.DEFAULT

• MIN = 1

  TODO: REPLACE

• BACKGROUND = 10

  Background position updates are sent with very low priority - if the link is super congested they might not go out at all

• DEFAULT = 64

  This priority is used for most messages that don't have a priority set

• RELIABLE = 70

  If priority is unset but the message is marked as want_ack, assume it is important and use a slightly higher priority

• RESPONSE = 80

  If priority is unset but the packet is a response to a request, we want it to get there relatively quickly. Furthermore, responses stop relaying packets directed to a node early.

• HIGH = 100

  Higher priority for specific message types (portnums) to distinguish between other reliable packets.

• ALERT = 110

  Higher priority alert message used for critical alerts which take priority over other reliable packets.

• ACK = 120

  Ack/naks are sent with very high priority to ensure that retransmission stops as soon as possible

• MAX = 127

  TODO: REPLACE

Enum to identify which transport mechanism this packet arrived over

Used in: MeshPacket

• TRANSPORT_INTERNAL = 0

  The default case is that the node generated a packet itself

• TRANSPORT_LORA = 1

  Arrived via the primary LoRa radio

• TRANSPORT_LORA_ALT1 = 2

  Arrived via a secondary LoRa radio

• TRANSPORT_LORA_ALT2 = 3

  Arrived via a tertiary LoRa radio

• TRANSPORT_LORA_ALT3 = 4

  Arrived via a quaternary LoRa radio

• TRANSPORT_MQTT = 5

  Arrived via an MQTT connection

• TRANSPORT_MULTICAST_UDP = 6

  Arrived via Multicast UDP

• TRANSPORT_API = 7

  Arrived via API connection

Used in: SensorData

• ACK = 0

• COLLECT_INTERVAL = 160

  in ms

• BEEP_ON = 161

  duration ms

• BEEP_OFF = 162

  cancel prematurely

• SHUTDOWN = 163

• POWER_ON = 164

• SCD41_TEMP = 176

• SCD41_HUMIDITY = 177

• SCD41_CO2 = 178

• AHT20_TEMP = 179

• AHT20_HUMIDITY = 180

• TVOC_INDEX = 181

Module Config

Used in: AdminMessage, FromRadio

• oneof payload_variant

  TODO: REPLACE

  • ModuleConfig.MQTTConfig mqtt = 1

    TODO: REPLACE

  • ModuleConfig.SerialConfig serial = 2

    TODO: REPLACE

  • ModuleConfig.ExternalNotificationConfig external_notification = 3

    TODO: REPLACE

  • ModuleConfig.StoreForwardConfig store_forward = 4

    TODO: REPLACE

  • ModuleConfig.RangeTestConfig range_test = 5

    TODO: REPLACE

  • ModuleConfig.TelemetryConfig telemetry = 6

    TODO: REPLACE

  • ModuleConfig.CannedMessageConfig canned_message = 7

    TODO: REPLACE

  • ModuleConfig.AudioConfig audio = 8

    TODO: REPLACE

  • ModuleConfig.RemoteHardwareConfig remote_hardware = 9

    TODO: REPLACE

  • ModuleConfig.NeighborInfoConfig neighbor_info = 10

    TODO: REPLACE

  • ModuleConfig.AmbientLightingConfig ambient_lighting = 11

    TODO: REPLACE

  • ModuleConfig.DetectionSensorConfig detection_sensor = 12

    TODO: REPLACE

  • ModuleConfig.PaxcounterConfig paxcounter = 13

    TODO: REPLACE

Ambient Lighting Module - Settings for control of onboard LEDs to allow users to adjust the brightness levels and respective color levels. Initially created for the RAK14001 RGB LED module.

Used in: LocalModuleConfig, ModuleConfig

• bool led_state = 1

  Sets LED to on or off.

• uint32 current = 2

  Sets the current for the LED output. Default is 10.

• uint32 red = 3

  Sets the red LED level. Values are 0-255.

• uint32 green = 4

  Sets the green LED level. Values are 0-255.

• uint32 blue = 5

  Sets the blue LED level. Values are 0-255.

Audio Config for codec2 voice

Used in: LocalModuleConfig, ModuleConfig

• bool codec2_enabled = 1

  Whether Audio is enabled

• uint32 ptt_pin = 2

  PTT Pin

• AudioConfig.Audio_Baud bitrate = 3

  The audio sample rate to use for codec2

• uint32 i2s_ws = 4

  I2S Word Select

• uint32 i2s_sd = 5

  I2S Data IN

• uint32 i2s_din = 6

  I2S Data OUT

• uint32 i2s_sck = 7

  I2S Clock

Baudrate for codec2 voice

Used in: AudioConfig

• CODEC2_DEFAULT = 0

• CODEC2_3200 = 1

• CODEC2_2400 = 2

• CODEC2_1600 = 3

• CODEC2_1400 = 4

• CODEC2_1300 = 5

• CODEC2_1200 = 6

• CODEC2_700 = 7

• CODEC2_700B = 8

Canned Messages Module Config

Used in: LocalModuleConfig, ModuleConfig

• bool rotary1_enabled = 1

  Enable the rotary encoder #1. This is a 'dumb' encoder sending pulses on both A and B pins while rotating.

• uint32 inputbroker_pin_a = 2

  GPIO pin for rotary encoder A port.

• uint32 inputbroker_pin_b = 3

  GPIO pin for rotary encoder B port.

• uint32 inputbroker_pin_press = 4

  GPIO pin for rotary encoder Press port.

• CannedMessageConfig.InputEventChar inputbroker_event_cw = 5

  Generate input event on CW of this kind.

• CannedMessageConfig.InputEventChar inputbroker_event_ccw = 6

  Generate input event on CCW of this kind.

• CannedMessageConfig.InputEventChar inputbroker_event_press = 7

  Generate input event on Press of this kind.

• bool updown1_enabled = 8

  Enable the Up/Down/Select input device. Can be RAK rotary encoder or 3 buttons. Uses the a/b/press definitions from inputbroker.

• bool enabled = 9

  Enable/disable CannedMessageModule.

• string allow_input_source = 10

  Input event origin accepted by the canned message module. Can be e.g. "rotEnc1", "upDownEnc1", "scanAndSelect", "cardkb", "serialkb", or keyword "_any"

• bool send_bell = 11

  CannedMessageModule also sends a bell character with the messages. ExternalNotificationModule can benefit from this feature.

TODO: REPLACE

Used in: CannedMessageConfig

• NONE = 0

  TODO: REPLACE

• UP = 17

  TODO: REPLACE

• DOWN = 18

  TODO: REPLACE

• LEFT = 19

  TODO: REPLACE

• RIGHT = 20

  TODO: REPLACE

• SELECT = 10

  '\n'

• BACK = 27

  TODO: REPLACE

• CANCEL = 24

  TODO: REPLACE

Detection Sensor Module Config

Used in: LocalModuleConfig, ModuleConfig

• bool enabled = 1

  Whether the Module is enabled

• uint32 minimum_broadcast_secs = 2

  Interval in seconds of how often we can send a message to the mesh when a trigger event is detected

• uint32 state_broadcast_secs = 3

  Interval in seconds of how often we should send a message to the mesh with the current state regardless of trigger events When set to 0, only trigger events will be broadcasted Works as a sort of status heartbeat for peace of mind

• bool send_bell = 4

  Send ASCII bell with alert message Useful for triggering ext. notification on bell

• string name = 5

  Friendly name used to format message sent to mesh Example: A name "Motion" would result in a message "Motion detected" Maximum length of 20 characters

• uint32 monitor_pin = 6

  GPIO pin to monitor for state changes

• DetectionSensorConfig.TriggerType detection_trigger_type = 7

  The type of trigger event to be used

• bool use_pullup = 8

  Whether or not use INPUT_PULLUP mode for GPIO pin Only applicable if the board uses pull-up resistors on the pin

Used in: DetectionSensorConfig

• LOGIC_LOW = 0

  Event is triggered if pin is low

• LOGIC_HIGH = 1

  Event is triggered if pin is high

• FALLING_EDGE = 2

  Event is triggered when pin goes high to low

• RISING_EDGE = 3

  Event is triggered when pin goes low to high

• EITHER_EDGE_ACTIVE_LOW = 4

  Event is triggered on every pin state change, low is considered to be "active"

• EITHER_EDGE_ACTIVE_HIGH = 5

  Event is triggered on every pin state change, high is considered to be "active"

External Notifications Config

Used in: LocalModuleConfig, ModuleConfig

• bool enabled = 1

  Enable the ExternalNotificationModule

• uint32 output_ms = 2

  When using in On/Off mode, keep the output on for this many milliseconds. Default 1000ms (1 second).

• uint32 output = 3

  Define the output pin GPIO setting Defaults to EXT_NOTIFY_OUT if set for the board. In standalone devices this pin should drive the LED to match the UI.

• uint32 output_vibra = 8

  Optional: Define a secondary output pin for a vibra motor This is used in standalone devices to match the UI.

• uint32 output_buzzer = 9

  Optional: Define a tertiary output pin for an active buzzer This is used in standalone devices to to match the UI.

• bool active = 4

  IF this is true, the 'output' Pin will be pulled active high, false means active low.

• bool alert_message = 5

  True: Alert when a text message arrives (output)

• bool alert_message_vibra = 10

  True: Alert when a text message arrives (output_vibra)

• bool alert_message_buzzer = 11

  True: Alert when a text message arrives (output_buzzer)

• bool alert_bell = 6

  True: Alert when the bell character is received (output)

• bool alert_bell_vibra = 12

  True: Alert when the bell character is received (output_vibra)

• bool alert_bell_buzzer = 13

  True: Alert when the bell character is received (output_buzzer)

• bool use_pwm = 7

  use a PWM output instead of a simple on/off output. This will ignore the 'output', 'output_ms' and 'active' settings and use the device.buzzer_gpio instead.

• uint32 nag_timeout = 14

  The notification will toggle with 'output_ms' for this time of seconds. Default is 0 which means don't repeat at all. 60 would mean blink and/or beep for 60 seconds

• bool use_i2s_as_buzzer = 15

  When true, enables devices with native I2S audio output to use the RTTTL over speaker like a buzzer T-Watch S3 and T-Deck for example have this capability

MQTT Client Config

Used in: LocalModuleConfig, ModuleConfig

• bool enabled = 1

  If a meshtastic node is able to reach the internet it will normally attempt to gateway any channels that are marked as is_uplink_enabled or is_downlink_enabled.

• string address = 2

  The server to use for our MQTT global message gateway feature. If not set, the default server will be used

• string username = 3

  MQTT username to use (most useful for a custom MQTT server). If using a custom server, this will be honoured even if empty. If using the default server, this will only be honoured if set, otherwise the device will use the default username

• string password = 4

  MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honoured even if empty. If using the default server, this will only be honoured if set, otherwise the device will use the default password

• bool encryption_enabled = 5

  Whether to send encrypted or decrypted packets to MQTT. This parameter is only honoured if you also set server (the default official mqtt.meshtastic.org server can handle encrypted packets) Decrypted packets may be useful for external systems that want to consume meshtastic packets

• bool json_enabled = 6

  Whether to send / consume json packets on MQTT

• bool tls_enabled = 7

  If true, we attempt to establish a secure connection using TLS

• string root = 8

  The root topic to use for MQTT messages. Default is "msh". This is useful if you want to use a single MQTT server for multiple meshtastic networks and separate them via ACLs

• bool proxy_to_client_enabled = 9

  If true, we can use the connected phone / client to proxy messages to MQTT instead of a direct connection

• bool map_reporting_enabled = 10

  If true, we will periodically report unencrypted information about our node to a map via MQTT

• optional MapReportSettings map_report_settings = 11

  Settings for reporting information about our node to a map via MQTT

Settings for reporting unencrypted information about our node to a map via MQTT

Used in: MQTTConfig

• uint32 publish_interval_secs = 1

  How often we should report our info to the map (in seconds)

• uint32 position_precision = 2

  Bits of precision for the location sent (default of 32 is full precision).

• bool should_report_location = 3

  Whether we have opted-in to report our location to the map

NeighborInfoModule Config

Used in: LocalModuleConfig, ModuleConfig

• bool enabled = 1

  Whether the Module is enabled

• uint32 update_interval = 2

  Interval in seconds of how often we should try to send our Neighbor Info (minimum is 14400, i.e., 4 hours)

• bool transmit_over_lora = 3

  Whether in addition to sending it to MQTT and the PhoneAPI, our NeighborInfo should be transmitted over LoRa. Note that this is not available on a channel with default key and name.

Config for the Paxcounter Module

Used in: LocalModuleConfig, ModuleConfig

• bool enabled = 1

  Enable the Paxcounter Module

• uint32 paxcounter_update_interval = 2

• int32 wifi_threshold = 3

  WiFi RSSI threshold. Defaults to -80

• int32 ble_threshold = 4

  BLE RSSI threshold. Defaults to -80

Preferences for the RangeTestModule

Used in: LocalModuleConfig, ModuleConfig

• bool enabled = 1

  Enable the Range Test Module

• uint32 sender = 2

  Send out range test messages from this node

• bool save = 3

  Bool value indicating that this node should save a RangeTest.csv file. ESP32 Only

• bool clear_on_reboot = 4

  Bool indicating that the node should cleanup / destroy it's RangeTest.csv file. ESP32 Only

RemoteHardwareModule Config

Used in: LocalModuleConfig, ModuleConfig

• bool enabled = 1

  Whether the Module is enabled

• bool allow_undefined_pin_access = 2

  Whether the Module allows consumers to read / write to pins not defined in available_pins

• repeated RemoteHardwarePin available_pins = 3

  Exposes the available pins to the mesh for reading and writing

Serial Config

Used in: LocalModuleConfig, ModuleConfig

• bool enabled = 1

  Preferences for the SerialModule

• bool echo = 2

  TODO: REPLACE

• uint32 rxd = 3

  RX pin (should match Arduino gpio pin number)

• uint32 txd = 4

  TX pin (should match Arduino gpio pin number)

• SerialConfig.Serial_Baud baud = 5

  Serial baud rate

• uint32 timeout = 6

  TODO: REPLACE

• SerialConfig.Serial_Mode mode = 7

  Mode for serial module operation

• bool override_console_serial_port = 8

  Overrides the platform's defacto Serial port instance to use with Serial module config settings This is currently only usable in output modes like NMEA / CalTopo and may behave strangely or not work at all in other modes Existing logging over the Serial Console will still be present

TODO: REPLACE

Used in: SerialConfig

• BAUD_DEFAULT = 0

• BAUD_110 = 1

• BAUD_300 = 2

• BAUD_600 = 3

• BAUD_1200 = 4

• BAUD_2400 = 5

• BAUD_4800 = 6

• BAUD_9600 = 7

• BAUD_19200 = 8

• BAUD_38400 = 9

• BAUD_57600 = 10

• BAUD_115200 = 11

• BAUD_230400 = 12

• BAUD_460800 = 13

• BAUD_576000 = 14

• BAUD_921600 = 15

TODO: REPLACE

Used in: SerialConfig

• DEFAULT = 0

• SIMPLE = 1

• PROTO = 2

• TEXTMSG = 3

• NMEA = 4

• CALTOPO = 5

  NMEA messages specifically tailored for CalTopo

• WS85 = 6

  Ecowitt WS85 weather station

• VE_DIRECT = 7

  VE.Direct is a serial protocol used by Victron Energy products https://beta.ivc.no/wiki/index.php/Victron_VE_Direct_DIY_Cable

• MS_CONFIG = 8

  Used to configure and view some parameters of MeshSolar. https://heltec.org/project/meshsolar/

Store and Forward Module Config

Used in: LocalModuleConfig, ModuleConfig

• bool enabled = 1

  Enable the Store and Forward Module

• bool heartbeat = 2

  TODO: REPLACE

• uint32 records = 3

  TODO: REPLACE

• uint32 history_return_max = 4

  TODO: REPLACE

• uint32 history_return_window = 5

  TODO: REPLACE

• bool is_server = 6

  Set to true to let this node act as a server that stores received messages and resends them upon request.

Configuration for both device and environment metrics

Used in: LocalModuleConfig, ModuleConfig

• uint32 device_update_interval = 1

  Interval in seconds of how often we should try to send our device metrics to the mesh

• uint32 environment_update_interval = 2

• bool environment_measurement_enabled = 3

  Preferences for the Telemetry Module (Environment) Enable/Disable the telemetry measurement module measurement collection

• bool environment_screen_enabled = 4

  Enable/Disable the telemetry measurement module on-device display

• bool environment_display_fahrenheit = 5

  We'll always read the sensor in Celsius, but sometimes we might want to display the results in Fahrenheit as a "user preference".

• bool air_quality_enabled = 6

  Enable/Disable the air quality metrics

• uint32 air_quality_interval = 7

  Interval in seconds of how often we should try to send our air quality metrics to the mesh

• bool power_measurement_enabled = 8

  Enable/disable Power metrics

• uint32 power_update_interval = 9

  Interval in seconds of how often we should try to send our power metrics to the mesh

• bool power_screen_enabled = 10

  Enable/Disable the power measurement module on-device display

• bool health_measurement_enabled = 11

  Preferences for the (Health) Telemetry Module Enable/Disable the telemetry measurement module measurement collection

• uint32 health_update_interval = 12

  Interval in seconds of how often we should try to send our health metrics to the mesh

• bool health_screen_enabled = 13

  Enable/Disable the health telemetry module on-device display

• bool device_telemetry_enabled = 14

  Enable/Disable the device telemetry module to send metrics to the mesh Note: We will still send telemtry to the connected phone / client every minute over the API

This message is specifically for modules to store per-channel configuration data.

Used in: ChannelSettings

• uint32 position_precision = 1

  Bits of precision for the location sent in position packets.

• bool is_muted = 2

  Controls whether or not the client / device should mute the current channel Useful for noisy public channels you don't necessarily want to disable

This message will be proxied over the PhoneAPI for the client to deliver to the MQTT server

Used in: FromRadio, ToRadio

• string topic = 1

  The MQTT topic this message will be sent /received on

• oneof payload_variant

  The actual service envelope payload or text for mqtt pub / sub

  • bytes data = 2

    Bytes

  • string text = 3

    Text

• bool retained = 4

  Whether the message should be retained (or not)

Unique local debugging info for this node Note: we don't include position or the user info, because that will come in the Sent to the phone in response to WantNodes.

Used in: DeviceState, FromRadio

• uint32 my_node_num = 1

  Tells the phone what our node number is, default starting value is lowbyte of macaddr, but it will be fixed if that is already in use

• uint32 reboot_count = 8

  The total number of reboots this node has ever encountered (well - since the last time we discarded preferences)

• uint32 min_app_version = 11

  The minimum app version that can talk to this device. Phone/PC apps should compare this to their build number and if too low tell the user they must update their app

• bytes device_id = 12

  Unique hardware identifier for this device

• string pio_env = 13

  The PlatformIO environment used to build this firmware

• FirmwareEdition firmware_edition = 14

  The indicator for whether this device is running event firmware and which

• uint32 nodedb_count = 15

  The number of nodes in the nodedb. This is used by the phone to know how many NodeInfo packets to expect on want_config

NAU7802 Telemetry configuration, for saving to flash

• int32 zeroOffset = 1

  The offset setting for the NAU7802

• float calibrationFactor = 2

  The calibration factor for the NAU7802

A single edge in the mesh

Used in: NeighborInfo

• uint32 node_id = 1

  Node ID of neighbor

• float snr = 2

  SNR of last heard message

• fixed32 last_rx_time = 3

  Reception time (in secs since 1970) of last message that was last sent by this ID. Note: this is for local storage only and will not be sent out over the mesh.

• uint32 node_broadcast_interval_secs = 4

  Broadcast interval of this neighbor (in seconds). Note: this is for local storage only and will not be sent out over the mesh.

Full info on edges for a single node

• uint32 node_id = 1

  The node ID of the node sending info on its neighbors

• uint32 last_sent_by_id = 2

  Field to pass neighbor info for the next sending cycle

• uint32 node_broadcast_interval_secs = 3

  Broadcast interval of the represented node (in seconds)

• repeated Neighbor neighbors = 4

  The list of out edges from this node

Ethernet or WiFi connection status

Used in: EthernetConnectionStatus, WifiConnectionStatus

• fixed32 ip_address = 1

  IP address of device

• bool is_connected = 2

  Whether the device has an active connection or not

• bool is_mqtt_connected = 3

  Whether the device has an active connection to an MQTT broker or not

• bool is_syslog_connected = 4

  Whether the device is actively remote syslogging or not

• uint32 version = 1

  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.

• repeated NodeInfoLite nodes = 2

  New lite version of NodeDB to decrease memory footprint

Used in: DeviceUIConfig

• bool unknown_switch = 1

  Filter unknown nodes

• bool offline_switch = 2

  Filter offline nodes

• bool public_key_switch = 3

  Filter nodes w/o public key

• int32 hops_away = 4

  Filter based on hops away

• bool position_switch = 5

  Filter nodes w/o position

• string node_name = 6

  Filter nodes by matching name string

• int32 channel = 7

  Filter based on channel

Used in: DeviceUIConfig

• bool chat_switch = 1

  Hightlight nodes w/ active chat

• bool position_switch = 2

  Highlight nodes w/ position

• bool telemetry_switch = 3

  Highlight nodes w/ telemetry data

• bool iaq_switch = 4

  Highlight nodes w/ iaq data

• string node_name = 5

  Highlight nodes by matching name string

The bluetooth to device link: Old BTLE protocol docs from TODO, merge in above and make real docs... use protocol buffers, and NanoPB messages from device to phone: POSITION_UPDATE (..., time) TEXT_RECEIVED(from, text, time) OPAQUE_RECEIVED(from, payload, time) (for signal messages or other applications) messages from phone to device: SET_MYID(id, human readable long, human readable short) (send down the unique ID string used for this node, a human readable string shown for that id, and a very short human readable string suitable for oled screen) SEND_OPAQUE(dest, payload) (for signal messages or other applications) SEND_TEXT(dest, text) Get all nodes() (returns list of nodes, with full info, last time seen, loc, battery level etc) SET_CONFIG (switches device to a new set of radio params and preshared key, drops all existing nodes, force our node to rejoin this new group) Full information about a node on the mesh

Used in: FromRadio

• uint32 num = 1

  The node number

• optional User user = 2

  The user info for this node

• optional Position position = 3

  This position data. Note: before 1.2.14 we would also store the last time we've heard from this node in position.time, that is no longer true. Position.time now indicates the last time we received a POSITION from that node.

• float snr = 4

  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

• fixed32 last_heard = 5

  Set to indicate the last time we received a packet from this node

• optional DeviceMetrics device_metrics = 6

  The latest device metrics for the node.

• uint32 channel = 7

  local channel index we heard that node on. Only populated if its not the default channel.

• bool via_mqtt = 8

  True if we witnessed the node over MQTT instead of LoRA transport

• optional uint32 hops_away = 9

  Number of hops away from us this node is (0 if direct neighbor)

• bool is_favorite = 10

  True if node is in our favorites list Persists between NodeDB internal clean ups

• bool is_ignored = 11

  True if node is in our ignored list Persists between NodeDB internal clean ups

• bool is_key_manually_verified = 12

  True if node public key has been verified. Persists between NodeDB internal clean ups LSB 0 of the bitfield

Used in: NodeDatabase

• uint32 num = 1

  The node number

• optional UserLite user = 2

  The user info for this node

• optional PositionLite position = 3

  This position data. Note: before 1.2.14 we would also store the last time we've heard from this node in position.time, that is no longer true. Position.time now indicates the last time we received a POSITION from that node.

• float snr = 4

  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

• fixed32 last_heard = 5

  Set to indicate the last time we received a packet from this node

• optional DeviceMetrics device_metrics = 6

  The latest device metrics for the node.

• uint32 channel = 7

  local channel index we heard that node on. Only populated if its not the default channel.

• bool via_mqtt = 8

  True if we witnessed the node over MQTT instead of LoRA transport

• optional uint32 hops_away = 9

  Number of hops away from us this node is (0 if direct neighbor)

• bool is_favorite = 10

  True if node is in our favorites list Persists between NodeDB internal clean ups

• bool is_ignored = 11

  True if node is in our ignored list Persists between NodeDB internal clean ups

• uint32 next_hop = 12

  Last byte of the node number of the node that should be used as the next hop to reach this node.

• uint32 bitfield = 13

  Bitfield for storing booleans. LSB 0 is_key_manually_verified

RemoteHardwarePins associated with a node

Used in: DeviceState, NodeRemoteHardwarePinsResponse

• uint32 node_num = 1

  The node_num exposing the available gpio pin

• optional RemoteHardwarePin pin = 2

  The the available gpio pin for usage with RemoteHardware module

Response envelope for node_remote_hardware_pins

Used in: AdminMessage

• repeated NodeRemoteHardwarePin node_remote_hardware_pins = 1

  Nodes and their respective remote hardware GPIO pins

Position Location Information from ATAK

Used in: TAKPacket

• sfixed32 latitude_i = 1

  The new preferred location encoding, multiply by 1e-7 to get degrees in floating point

• sfixed32 longitude_i = 2

  The new preferred location encoding, multiply by 1e-7 to get degrees in floating point

• int32 altitude = 3

  Altitude (ATAK prefers HAE)

• uint32 speed = 4

  Speed

• uint32 course = 5

  Course in degrees

TODO: REPLACE

• uint32 wifi = 1

  seen Wifi devices

• uint32 ble = 2

  Seen BLE devices

• uint32 uptime = 3

  Uptime in seconds

For any new 'apps' that run on the device or via sister apps on phones/PCs they should pick and use a unique 'portnum' for their application. If you are making a new app using meshtastic, please send in a pull request to add your 'portnum' to this master table. PortNums should be assigned in the following range: 0-63 Core Meshtastic use, do not use for third party apps 64-127 Registered 3rd party apps, send in a pull request that adds a new entry to portnums.proto to register your application 256-511 Use one of these portnums for your private applications that you don't want to register publically All other values are reserved. Note: This was formerly a Type enum named 'typ' with the same id # We have change to this 'portnum' based scheme for specifying app handlers for particular payloads. This change is backwards compatible by treating the legacy OPAQUE/CLEAR_TEXT values identically.

Used in: Compressed, Data

• UNKNOWN_APP = 0

  Deprecated: do not use in new code (formerly called OPAQUE) A message sent from a device outside of the mesh, in a form the mesh does not understand NOTE: This must be 0, because it is documented in IMeshService.aidl to be so ENCODING: binary undefined

• TEXT_MESSAGE_APP = 1

  A simple UTF-8 text message, which even the little micros in the mesh can understand and show on their screen eventually in some circumstances even signal might send messages in this form (see below) ENCODING: UTF-8 Plaintext (?)

• REMOTE_HARDWARE_APP = 2

  Reserved for built-in GPIO/example app. See remote_hardware.proto/HardwareMessage for details on the message sent/received to this port number ENCODING: Protobuf

• POSITION_APP = 3

  The built-in position messaging app. Payload is a Position message. ENCODING: Protobuf

• NODEINFO_APP = 4

  The built-in user info app. Payload is a User message. ENCODING: Protobuf

• ROUTING_APP = 5

  Protocol control packets for mesh protocol use. Payload is a Routing message. ENCODING: Protobuf

• ADMIN_APP = 6

  Admin control packets. Payload is a AdminMessage message. ENCODING: Protobuf

• TEXT_MESSAGE_COMPRESSED_APP = 7

  Compressed TEXT_MESSAGE payloads. ENCODING: UTF-8 Plaintext (?) with Unishox2 Compression NOTE: The Device Firmware converts a TEXT_MESSAGE_APP to TEXT_MESSAGE_COMPRESSED_APP if the compressed payload is shorter. There's no need for app developers to do this themselves. Also the firmware will decompress any incoming TEXT_MESSAGE_COMPRESSED_APP payload and convert to TEXT_MESSAGE_APP.

• WAYPOINT_APP = 8

  Waypoint payloads. Payload is a Waypoint message. ENCODING: Protobuf

• AUDIO_APP = 9

  Audio Payloads. Encapsulated codec2 packets. On 2.4 GHZ Bandwidths only for now ENCODING: codec2 audio frames NOTE: audio frames contain a 3 byte header (0xc0 0xde 0xc2) and a one byte marker for the decompressed bitrate. This marker comes from the 'moduleConfig.audio.bitrate' enum minus one.

• DETECTION_SENSOR_APP = 10

  Same as Text Message but originating from Detection Sensor Module. NOTE: This portnum traffic is not sent to the public MQTT starting at firmware version 2.2.9

• ALERT_APP = 11

  Same as Text Message but used for critical alerts.

• KEY_VERIFICATION_APP = 12

  Module/port for handling key verification requests.

• REPLY_APP = 32

  Provides a 'ping' service that replies to any packet it receives. Also serves as a small example module. ENCODING: ASCII Plaintext

• IP_TUNNEL_APP = 33

  Used for the python IP tunnel feature ENCODING: IP Packet. Handled by the python API, firmware ignores this one and pases on.

• PAXCOUNTER_APP = 34

  Paxcounter lib included in the firmware ENCODING: protobuf

• SERIAL_APP = 64

  Provides a hardware serial interface to send and receive from the Meshtastic network. Connect to the RX/TX pins of a device with 38400 8N1. Packets received from the Meshtastic network is forwarded to the RX pin while sending a packet to TX will go out to the Mesh network. Maximum packet size of 240 bytes. Module is disabled by default can be turned on by setting SERIAL_MODULE_ENABLED = 1 in SerialPlugh.cpp. ENCODING: binary undefined

• STORE_FORWARD_APP = 65

  STORE_FORWARD_APP (Work in Progress) Maintained by Jm Casler (MC Hamster) : jm@casler.org ENCODING: Protobuf

• RANGE_TEST_APP = 66

  Optional port for messages for the range test module. ENCODING: ASCII Plaintext NOTE: This portnum traffic is not sent to the public MQTT starting at firmware version 2.2.9

• TELEMETRY_APP = 67

  Provides a format to send and receive telemetry data from the Meshtastic network. Maintained by Charles Crossan (crossan007) : crossan007@gmail.com ENCODING: Protobuf

• ZPS_APP = 68

  Experimental tools for estimating node position without a GPS Maintained by Github user a-f-G-U-C (a Meshtastic contributor) Project files at https://github.com/a-f-G-U-C/Meshtastic-ZPS ENCODING: arrays of int64 fields

• SIMULATOR_APP = 69

  Used to let multiple instances of Linux native applications communicate as if they did using their LoRa chip. Maintained by GitHub user GUVWAF. Project files at https://github.com/GUVWAF/Meshtasticator ENCODING: Protobuf (?)

• TRACEROUTE_APP = 70

  Provides a traceroute functionality to show the route a packet towards a certain destination would take on the mesh. Contains a RouteDiscovery message as payload. ENCODING: Protobuf

• NEIGHBORINFO_APP = 71

  Aggregates edge info for the network by sending out a list of each node's neighbors ENCODING: Protobuf

• ATAK_PLUGIN = 72

  ATAK Plugin Portnum for payloads from the official Meshtastic ATAK plugin

• MAP_REPORT_APP = 73

  Provides unencrypted information about a node for consumption by a map via MQTT

• POWERSTRESS_APP = 74

  PowerStress based monitoring support (for automated power consumption testing)

• RETICULUM_TUNNEL_APP = 76

  Reticulum Network Stack Tunnel App ENCODING: Fragmented RNS Packet. Handled by Meshtastic RNS interface

• CAYENNE_APP = 77

  App for transporting Cayenne Low Power Payload, popular for LoRaWAN sensor nodes. Offers ability to send arbitrary telemetry over meshtastic that is not covered by telemetry.proto ENCODING: CayenneLLP

• PRIVATE_APP = 256

  Private applications should use portnums >= 256. To simplify initial development and testing you can use "PRIVATE_APP" in your code without needing to rebuild protobuf files (via [regen-protos.sh](https://github.com/meshtastic/firmware/blob/master/bin/regen-protos.sh))

• ATAK_FORWARDER = 257

  ATAK Forwarder Module https://github.com/paulmandal/atak-forwarder ENCODING: libcotshrink

• MAX = 511

  Currently we limit port nums to no higher than this value

A GPS Position

Used in: AdminMessage, DeviceProfile, NodeInfo

• optional sfixed32 latitude_i = 1

  The new preferred location encoding, multiply by 1e-7 to get degrees in floating point

• optional sfixed32 longitude_i = 2

  TODO: REPLACE

• optional int32 altitude = 3

  In meters above MSL (but see issue #359)

• fixed32 time = 4

  This is usually not sent over the mesh (to save space), but it is sent from the phone so that the local device can set its time if it is sent over the mesh (because there are devices on the mesh without GPS or RTC). seconds since 1970

• Position.LocSource location_source = 5

  TODO: REPLACE

• Position.AltSource altitude_source = 6

  TODO: REPLACE

• fixed32 timestamp = 7

  Positional timestamp (actual timestamp of GPS solution) in integer epoch seconds

• int32 timestamp_millis_adjust = 8

  Pos. timestamp milliseconds adjustment (rarely available or required)

• optional sint32 altitude_hae = 9

  HAE altitude in meters - can be used instead of MSL altitude

• optional sint32 altitude_geoidal_separation = 10

  Geoidal separation in meters

• uint32 PDOP = 11

  Horizontal, Vertical and Position Dilution of Precision, in 1/100 units - PDOP is sufficient for most cases - for higher precision scenarios, HDOP and VDOP can be used instead, in which case PDOP becomes redundant (PDOP=sqrt(HDOP^2 + VDOP^2)) TODO: REMOVE/INTEGRATE

• uint32 HDOP = 12

  TODO: REPLACE

• uint32 VDOP = 13

  TODO: REPLACE

• uint32 gps_accuracy = 14

  GPS accuracy (a hardware specific constant) in mm multiplied with DOP to calculate positional accuracy Default: "'bout three meters-ish" :)

• optional uint32 ground_speed = 15

  Ground speed in m/s and True North TRACK in 1/100 degrees Clarification of terms: - "track" is the direction of motion (measured in horizontal plane) - "heading" is where the fuselage points (measured in horizontal plane) - "yaw" indicates a relative rotation about the vertical axis TODO: REMOVE/INTEGRATE

• optional uint32 ground_track = 16

  TODO: REPLACE

• uint32 fix_quality = 17

  GPS fix quality (from NMEA GxGGA statement or similar)

• uint32 fix_type = 18

  GPS fix type 2D/3D (from NMEA GxGSA statement)

• uint32 sats_in_view = 19

  GPS "Satellites in View" number

• uint32 sensor_id = 20

  Sensor ID - in case multiple positioning sensors are being used

• uint32 next_update = 21

  Estimated/expected time (in seconds) until next update: - if we update at fixed intervals of X seconds, use X - if we update at dynamic intervals (based on relative movement etc), but "AT LEAST every Y seconds", use Y

• uint32 seq_number = 22

  A sequence number, incremented with each Position message to help detect lost updates if needed

• uint32 precision_bits = 23

  Indicates the bits of precision set by the sending node

How the altitude was acquired: manual, GPS int/ext, etc Default: same as location_source if present

Used in: Position

• ALT_UNSET = 0

  TODO: REPLACE

• ALT_MANUAL = 1

  TODO: REPLACE

• ALT_INTERNAL = 2

  TODO: REPLACE

• ALT_EXTERNAL = 3

  TODO: REPLACE

• ALT_BAROMETRIC = 4

  TODO: REPLACE

How the location was acquired: manual, onboard GPS, external (EUD) GPS

Used in: Position, PositionLite

• LOC_UNSET = 0

  TODO: REPLACE

• LOC_MANUAL = 1

  TODO: REPLACE

• LOC_INTERNAL = 2

  TODO: REPLACE

• LOC_EXTERNAL = 3

  TODO: REPLACE

Position with static location information only for NodeDBLite

Used in: NodeInfoLite

• sfixed32 latitude_i = 1

  The new preferred location encoding, multiply by 1e-7 to get degrees in floating point

• sfixed32 longitude_i = 2

  TODO: REPLACE

• int32 altitude = 3

  In meters above MSL (but see issue #359)

• fixed32 time = 4

  This is usually not sent over the mesh (to save space), but it is sent from the phone so that the local device can set its RTC If it is sent over the mesh (because there are devices on the mesh without GPS), it will only be sent by devices which has a hardware GPS clock. seconds since 1970

• Position.LocSource location_source = 5

  TODO: REPLACE

Power Metrics (voltage / current / etc)

Used in: Telemetry

• optional float ch1_voltage = 1

  Voltage (Ch1)

• optional float ch1_current = 2

  Current (Ch1)

• optional float ch2_voltage = 3

  Voltage (Ch2)

• optional float ch2_current = 4

  Current (Ch2)

• optional float ch3_voltage = 5

  Voltage (Ch3)

• optional float ch3_current = 6

  Current (Ch3)

• optional float ch4_voltage = 7

  Voltage (Ch4)

• optional float ch4_current = 8

  Current (Ch4)

• optional float ch5_voltage = 9

  Voltage (Ch5)

• optional float ch5_current = 10

  Current (Ch5)

• optional float ch6_voltage = 11

  Voltage (Ch6)

• optional float ch6_current = 12

  Current (Ch6)

• optional float ch7_voltage = 13

  Voltage (Ch7)

• optional float ch7_current = 14

  Current (Ch7)

• optional float ch8_voltage = 15

  Voltage (Ch8)

• optional float ch8_current = 16

  Current (Ch8)

Note: There are no 'PowerMon' messages normally in use (PowerMons are sent only as structured logs - slogs). But we wrap our State enum in this message to effectively nest a namespace (without our linter yelling at us)

(message has no fields)

Any significant power changing event in meshtastic should be tagged with a powermon state transition. If you are making new meshtastic features feel free to add new entries at the end of this definition.

• None = 0

• CPU_DeepSleep = 1

• CPU_LightSleep = 2

• Vext1_On = 4

  The external Vext1 power is on. Many boards have auxillary power rails that the CPU turns on only occasionally. In cases where that rail has multiple devices on it we usually want to have logging on the state of that rail as an independent record. For instance on the Heltec Tracker 1.1 board, this rail is the power source for the GPS and screen. The log messages will be short and complete (see PowerMon.Event in the protobufs for details). something like "S:PM:C,0x00001234,REASON" where the hex number is the bitmask of all current states. (We use a bitmask for states so that if a log message gets lost it won't be fatal)

• Lora_RXOn = 8

• Lora_TXOn = 16

• Lora_RXActive = 32

• BT_On = 64

• LED_On = 128

• Screen_On = 256

• Screen_Drawing = 512

• Wifi_On = 1024

• GPS_Active = 2048

  GPS is actively trying to find our location See GPSPowerState for more details

PowerStress testing support via the C++ PowerStress module

• PowerStressMessage.Opcode cmd = 1

  What type of HardwareMessage is this?

• float num_seconds = 2

What operation would we like the UUT to perform. note: senders should probably set want_response in their request packets, so that they can know when the state machine has started processing their request

Used in: PowerStressMessage

• UNSET = 0

  Unset/unused

• PRINT_INFO = 1

  Print board version slog and send an ack that we are alive and ready to process commands

• FORCE_QUIET = 2

  Try to turn off all automatic processing of packets, screen, sleeping, etc (to make it easier to measure in isolation)

• END_QUIET = 3

  Stop powerstress processing - probably by just rebooting the board

• SCREEN_ON = 16

  Turn the screen on

• SCREEN_OFF = 17

  Turn the screen off

• CPU_IDLE = 32

  Let the CPU run but we assume mostly idling for num_seconds

• CPU_DEEPSLEEP = 33

  Force deep sleep for FIXME seconds

• CPU_FULLON = 34

  Spin the CPU as fast as possible for num_seconds

• LED_ON = 48

  Turn the LED on for num_seconds (and leave it on - for baseline power measurement purposes)

• LED_OFF = 49

  Force the LED off for num_seconds

• LORA_OFF = 64

  Completely turn off the LORA radio for num_seconds

• LORA_TX = 65

  Send Lora packets for num_seconds

• LORA_RX = 66

  Receive Lora packets for num_seconds (node will be mostly just listening, unless an external agent is helping stress this by sending packets on the current channel)

• BT_OFF = 80

  Turn off the BT radio for num_seconds

• BT_ON = 81

  Turn on the BT radio for num_seconds

• WIFI_OFF = 96

  Turn off the WIFI radio for num_seconds

• WIFI_ON = 97

  Turn on the WIFI radio for num_seconds

• GPS_OFF = 112

  Turn off the GPS radio for num_seconds

• GPS_ON = 113

  Turn on the GPS radio for num_seconds

Used in: FromRadio

• int32 res = 1

  Last attempt to queue status, ErrorCode

• uint32 free = 2

  Free entries in the outgoing queue

• uint32 maxlen = 3

  Maximum entries in the outgoing queue

• uint32 mesh_packet_id = 4

  What was mesh packet id that generated this response?

Canned message module configuration.

• string ringtone = 1

  Ringtone for PWM Buzzer in RTTTL Format.

A GPIO pin definition for remote hardware module

Used in: ModuleConfig.RemoteHardwareConfig, NodeRemoteHardwarePin

• uint32 gpio_pin = 1

  GPIO Pin number (must match Arduino)

• string name = 2

  Name for the GPIO pin (i.e. Front gate, mailbox, etc)

• RemoteHardwarePinType type = 3

  Type of GPIO access available to consumers on the mesh

Used in: RemoteHardwarePin

• UNKNOWN = 0

  Unset/unused

• DIGITAL_READ = 1

  GPIO pin can be read (if it is high / low)

• DIGITAL_WRITE = 2

  GPIO pin can be written to (high / low)

A message used in a traceroute

Used in: Routing

• repeated fixed32 route = 1

  The list of nodenums this packet has visited so far to the destination.

• repeated int32 snr_towards = 2

  The list of SNRs (in dB, scaled by 4) in the route towards the destination.

• repeated fixed32 route_back = 3

  The list of nodenums the packet has visited on the way back from the destination.

• repeated int32 snr_back = 4

  The list of SNRs (in dB, scaled by 4) in the route back from the destination.

A Routing control Data packet handled by the routing module

• oneof variant

  • RouteDiscovery route_request = 1

    A route request going from the requester

  • RouteDiscovery route_reply = 2

    A route reply

  • Routing.Error error_reason = 3

    A failure in delivering a message (usually used for routing control messages, but might be provided in addition to ack.fail_id to provide details on the type of failure).

A failure in delivering a message (usually used for routing control messages, but might be provided in addition to ack.fail_id to provide details on the type of failure).

Used in: Routing

• NONE = 0

  This message is not a failure

• NO_ROUTE = 1

  Our node doesn't have a route to the requested destination anymore.

• GOT_NAK = 2

  We received a nak while trying to forward on your behalf

• TIMEOUT = 3

  TODO: REPLACE

• NO_INTERFACE = 4

  No suitable interface could be found for delivering this packet

• MAX_RETRANSMIT = 5

  We reached the max retransmission count (typically for naive flood routing)

• NO_CHANNEL = 6

  No suitable channel was found for sending this packet (i.e. was requested channel index disabled?)

• TOO_LARGE = 7

  The packet was too big for sending (exceeds interface MTU after encoding)

• NO_RESPONSE = 8

  The request had want_response set, the request reached the destination node, but no service on that node wants to send a response (possibly due to bad channel permissions)

• DUTY_CYCLE_LIMIT = 9

  Cannot send currently because duty cycle regulations will be violated.

• BAD_REQUEST = 32

  The application layer service on the remote node received your request, but considered your request somehow invalid

• NOT_AUTHORIZED = 33

  The application layer service on the remote node received your request, but considered your request not authorized (i.e you did not send the request on the required bound channel)

• PKI_FAILED = 34

  The client specified a PKI transport, but the node was unable to send the packet using PKI (and did not send the message at all)

• PKI_UNKNOWN_PUBKEY = 35

  The receiving node does not have a Public Key to decode with

• ADMIN_BAD_SESSION_KEY = 36

  Admin packet otherwise checks out, but uses a bogus or expired session key

• ADMIN_PUBLIC_KEY_UNAUTHORIZED = 37

  Admin packet sent using PKC, but not from a public key on the admin key list

• RATE_LIMIT_EXCEEDED = 38

  Airtime fairness rate limit exceeded for a packet This typically enforced per portnum and is used to prevent a single node from monopolizing airtime

Used in: InterdeviceMessage

• MessageType type = 1

  The message type

• oneof data

  The sensor data, either as a float or an uint32

  • float float_value = 2

  • uint32 uint32_value = 3

Serial connection status

Used in: DeviceConnectionStatus

• uint32 baud = 1

  Serial baud rate

• bool is_connected = 2

  Whether the device has an active connection or not

This message wraps a MeshPacket with extra metadata about the sender and how it arrived.

• optional MeshPacket packet = 1

  The (probably encrypted) packet

• string channel_id = 2

  The global channel ID it was sent on

• string gateway_id = 3

  The sending gateway node ID. 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

Used in: AdminMessage

• uint32 node_num = 1

  The node number of the contact

• optional User user = 2

  The User of the contact

• bool should_ignore = 3

  Add this contact to the blocked / ignored list

• bool manually_verified = 4

  Set the IS_KEY_MANUALLY_VERIFIED bit

ATAK EUD Status <status battery='100' />

Used in: TAKPacket

• uint32 battery = 1

  Battery level

TODO: REPLACE

• StoreAndForward.RequestResponse rr = 1

  TODO: REPLACE

• oneof variant

  TODO: REPLACE

  • StoreAndForward.Statistics stats = 2

    TODO: REPLACE

  • StoreAndForward.History history = 3

    TODO: REPLACE

  • StoreAndForward.Heartbeat heartbeat = 4

    TODO: REPLACE

  • bytes text = 5

    Text from history message.

TODO: REPLACE

Used in: StoreAndForward

• uint32 period = 1

  Period in seconds that the heartbeat is sent out that will be sent to the client

• uint32 secondary = 2

  If set, this is not the primary Store & Forward router on the mesh

TODO: REPLACE

Used in: StoreAndForward

• uint32 history_messages = 1

  Number of that will be sent to the client

• uint32 window = 2

  The window of messages that was used to filter the history client requested

• uint32 last_request = 3

  Index in the packet history of the last message sent in a previous request to the server. Will be sent to the client before sending the history and can be set in a subsequent request to avoid getting packets the server already sent to the client.

001 - 063 = From Router 064 - 127 = From Client

Used in: StoreAndForward

• UNSET = 0

  Unset/unused

• ROUTER_ERROR = 1

  Router is an in error state.

• ROUTER_HEARTBEAT = 2

  Router heartbeat

• ROUTER_PING = 3

  Router has requested the client respond. This can work as a "are you there" message.

• ROUTER_PONG = 4

  The response to a "Ping"

• ROUTER_BUSY = 5

  Router is currently busy. Please try again later.

• ROUTER_HISTORY = 6

  Router is responding to a request for history.

• ROUTER_STATS = 7

  Router is responding to a request for stats.

• ROUTER_TEXT_DIRECT = 8

  Router sends a text message from its history that was a direct message.

• ROUTER_TEXT_BROADCAST = 9

  Router sends a text message from its history that was a broadcast.

• CLIENT_ERROR = 64

  Client is an in error state.

• CLIENT_HISTORY = 65

  Client has requested a replay from the router.

• CLIENT_STATS = 66

  Client has requested stats from the router.

• CLIENT_PING = 67

  Client has requested the router respond. This can work as a "are you there" message.

• CLIENT_PONG = 68

  The response to a "Ping"

• CLIENT_ABORT = 106

  Client has requested that the router abort processing the client's request

TODO: REPLACE

Used in: StoreAndForward

• uint32 messages_total = 1

  Number of messages we have ever seen

• uint32 messages_saved = 2

  Number of messages we have currently saved our history.

• uint32 messages_max = 3

  Maximum number of messages we will save

• uint32 up_time = 4

  Router uptime in seconds

• uint32 requests = 5

  Number of times any client sent a request to the S&F.

• uint32 requests_history = 6

  Number of times the history was requested.

• bool heartbeat = 7

  Is the heartbeat enabled on the server?

• uint32 return_max = 8

  Maximum number of messages the server will return.

• uint32 return_window = 9

  Maximum history window in minutes the server will return messages from.

Packets for the official ATAK Plugin

• bool is_compressed = 1

  Are the payloads strings compressed for LoRA transport?

• optional Contact contact = 2

  The contact / callsign for ATAK user

• optional Group group = 3

  The group for ATAK user

• optional Status status = 4

  The status of the ATAK EUD

• oneof payload_variant

  The payload of the packet

  • PLI pli = 5

    TAK position report

  • GeoChat chat = 6

    ATAK GeoChat message

  • bytes detail = 7

    Generic CoT detail XML May be compressed / truncated by the sender (EUD)

Used in: Group

• Unspecifed_Color = 0

  Unspecifed

• White = 1

  White

• Yellow = 2

  Yellow

• Orange = 3

  Orange

• Magenta = 4

  Magenta

• Red = 5

  Red

• Maroon = 6

  Maroon

• Purple = 7

  Purple

• Dark_Blue = 8

  Dark Blue

• Blue = 9

  Blue

• Cyan = 10

  Cyan

• Teal = 11

  Teal

• Green = 12

  Green

• Dark_Green = 13

  Dark Green

• Brown = 14

  Brown

Types of Measurements the telemetry module is equipped to handle

• fixed32 time = 1

  Seconds since 1970 - or 0 for unknown/unset

• oneof variant

  • DeviceMetrics device_metrics = 2

    Key native device metrics such as battery level

  • EnvironmentMetrics environment_metrics = 3

    Weather station or other environmental metrics

  • AirQualityMetrics air_quality_metrics = 4

    Air quality metrics

  • PowerMetrics power_metrics = 5

    Power Metrics

  • LocalStats local_stats = 6

    Local device mesh statistics

  • HealthMetrics health_metrics = 7

    Health telemetry metrics

  • HostMetrics host_metrics = 8

    Linux host metrics

Supported I2C Sensors for telemetry in Meshtastic

• SENSOR_UNSET = 0

  No external telemetry sensor explicitly set

• BME280 = 1

  High accuracy temperature, pressure, humidity

• BME680 = 2

  High accuracy temperature, pressure, humidity, and air resistance

• MCP9808 = 3

  Very high accuracy temperature

• INA260 = 4

  Moderate accuracy current and voltage

• INA219 = 5

  Moderate accuracy current and voltage

• BMP280 = 6

  High accuracy temperature and pressure

• SHTC3 = 7

  High accuracy temperature and humidity

• LPS22 = 8

  High accuracy pressure

• QMC6310 = 9

  3-Axis magnetic sensor

• QMI8658 = 10

  6-Axis inertial measurement sensor

• QMC5883L = 11

  3-Axis magnetic sensor

• SHT31 = 12

  High accuracy temperature and humidity

• PMSA003I = 13

  PM2.5 air quality sensor

• INA3221 = 14

  INA3221 3 Channel Voltage / Current Sensor

• BMP085 = 15

  BMP085/BMP180 High accuracy temperature and pressure (older Version of BMP280)

• RCWL9620 = 16

  RCWL-9620 Doppler Radar Distance Sensor, used for water level detection

• SHT4X = 17

  Sensirion High accuracy temperature and humidity

• VEML7700 = 18

  VEML7700 high accuracy ambient light(Lux) digital 16-bit resolution sensor.

• MLX90632 = 19

  MLX90632 non-contact IR temperature sensor.

• OPT3001 = 20

  TI OPT3001 Ambient Light Sensor

• LTR390UV = 21

  Lite On LTR-390UV-01 UV Light Sensor

• TSL25911FN = 22

  AMS TSL25911FN RGB Light Sensor

• AHT10 = 23

  AHT10 Integrated temperature and humidity sensor

• DFROBOT_LARK = 24

  DFRobot Lark Weather station (temperature, humidity, pressure, wind speed and direction)

• NAU7802 = 25

  NAU7802 Scale Chip or compatible

• BMP3XX = 26

  BMP3XX High accuracy temperature and pressure

• ICM20948 = 27

  ICM-20948 9-Axis digital motion processor

• MAX17048 = 28

  MAX17048 1S lipo battery sensor (voltage, state of charge, time to go)

• CUSTOM_SENSOR = 29

  Custom I2C sensor implementation based on https://github.com/meshtastic/i2c-sensor

• MAX30102 = 30

  MAX30102 Pulse Oximeter and Heart-Rate Sensor

• MLX90614 = 31

  MLX90614 non-contact IR temperature sensor

• SCD4X = 32

  SCD40/SCD41 CO2, humidity, temperature sensor

• RADSENS = 33

  ClimateGuard RadSens, radiation, Geiger-Muller Tube

• INA226 = 34

  High accuracy current and voltage

• DFROBOT_RAIN = 35

  DFRobot Gravity tipping bucket rain gauge

• DPS310 = 36

  Infineon DPS310 High accuracy pressure and temperature

• RAK12035 = 37

  RAKWireless RAK12035 Soil Moisture Sensor Module

• MAX17261 = 38

  MAX17261 lipo battery gauge

• PCT2075 = 39

  PCT2075 Temperature Sensor

• ADS1X15 = 40

  ADS1X15 ADC

• ADS1X15_ALT = 41

  ADS1X15 ADC_ALT

• SFA30 = 42

  Sensirion SFA30 Formaldehyde sensor

• SEN5X = 43

  SEN5X PM SENSORS

• TSL2561 = 44

  TSL2561 light sensor

• BH1750 = 45

  BH1750 light sensor

Used in: DeviceUIConfig

• DARK = 0

  Dark

• LIGHT = 1

  Light

• RED = 2

  Red

Packets/commands to the radio will be written (reliably) to the toRadio characteristic. Once the write completes the phone can assume it is handled.

• oneof payload_variant

  Log levels, chosen to match python logging conventions.

  • MeshPacket packet = 1

    Send this packet on the mesh

  • uint32 want_config_id = 3

    Phone wants radio to send full node db to the phone, This is typically the first packet sent to the radio when the phone gets a bluetooth connection. The radio will respond by sending back a MyNodeInfo, a owner, a radio config and a series of FromRadio.node_infos, and config_complete the integer you write into this field will be reported back in the config_complete_id response this allows clients to never be confused by a stale old partially sent config.

  • bool disconnect = 4

    Tell API server we are disconnecting now. This is useful for serial links where there is no hardware/protocol based notification that the client has dropped the link. (Sending this message is optional for clients)

  • XModem xmodemPacket = 5

  • MqttClientProxyMessage mqttClientProxyMessage = 6

    MQTT Client Proxy Message (for client / phone subscribed to MQTT sending to device)

  • Heartbeat heartbeat = 7

    Heartbeat message (used to keep the device connection awake on serial)

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. Also sent from nodes to each other when a new node signs on (so all clients can have this info) The algorithm is as follows: when a node starts up, it broadcasts their user and the normal flow is for all other nodes to reply with their User as well (so the new node can build its nodedb) If a node ever receives a User (not just the first broadcast) message where the sender node number equals our node number, that indicates a collision has occurred and the following steps should happen: If the receiving node (that was already in the mesh)'s macaddr is LOWER than the new User who just tried to sign in: it gets to keep its nodenum. We send a broadcast message of OUR User (we use a broadcast so that the other node can receive our message, considering we have the same id - it also serves to let observers correct their nodedb) - this case is rare so it should be okay. If any node receives a User where the macaddr is GTE than their local macaddr, they have been vetoed and should pick a new random nodenum (filtering against whatever it knows about the nodedb) and rebroadcast their User. A few nodenums are reserved and will never be requested: 0xff - broadcast 0 through 3 - for future use

Used in: AdminMessage, BackupPreferences, DeviceState, NodeInfo, SharedContact

• string id = 1

  A globally unique ID string for this user. In the case of Signal that would mean +16504442323, for the default macaddr derived id it would be !<8 hexidecimal bytes>. Note: app developers are encouraged to also use the following standard node IDs "^all" (for broadcast), "^local" (for the locally connected node)

• string long_name = 2

  A full name for this user, i.e. "Kevin Hester"

• string short_name = 3

  A VERY short name, ideally two characters. Suitable for a tiny OLED screen

• bytes macaddr = 4

  Deprecated in Meshtastic 2.1.x This is the addr of the radio. Not populated by the phone, but added by the esp32 when broadcasting

• HardwareModel hw_model = 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.

• bool is_licensed = 6

  In some regions Ham radio operators have different bandwidth limitations than others. If this user is a licensed operator, set this flag. Also, "long_name" should be their licence number.

• Config.DeviceConfig.Role role = 7

  Indicates that the user's role in the mesh

• bytes public_key = 8

  The public key of the user's device. This is sent out to other nodes on the mesh to allow them to compute a shared secret key.

• optional bool is_unmessagable = 9

  Whether or not the node can be messaged