Skip to main content

Built and signed on GitHub Actions

It is unknown whether this package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Node.js
It is unknown whether this package works with Deno
It is unknown whether this package works with Bun
It is unknown whether this package works with Browsers
JSR Score
52%
Published
4 days ago (2.5.7)
N
Admin
No documentation available
T
Admin.AdminMessage

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)

v
Admin.AdminMessage_ConfigTypeSchema

Describes the enum meshtastic.AdminMessage.ConfigType.

v
Admin.AdminMessage_ModuleConfigTypeSchema

Describes the enum meshtastic.AdminMessage.ModuleConfigType.

v
Admin.AdminMessageSchema

Describes the message meshtastic.AdminMessage.Use create(AdminMessageSchema) to create a new message.

v
Admin.file_admin

Describes the file admin.proto.

T
Admin.HamParameters

Parameters for setting up Meshtastic for ameteur radio usage

v
Admin.HamParametersSchema

Describes the message meshtastic.HamParameters.Use create(HamParametersSchema) to create a new message.

T
Admin.NodeRemoteHardwarePinsResponse

Response envelope for node_remote_hardware_pins

v
Admin.NodeRemoteHardwarePinsResponseSchema

Describes the message meshtastic.NodeRemoteHardwarePinsResponse.Use create(NodeRemoteHardwarePinsResponseSchema) to create a new message.

N
AppOnly
No documentation available
T
AppOnly.ChannelSet

This is the most compact possible representation for a set of channels.It includes only one PRIMARY channel (which must be first) andany 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

v
AppOnly.ChannelSetSchema

Describes the message meshtastic.ChannelSet.Use create(ChannelSetSchema) to create a new message.

v
AppOnly.file_apponly

Describes the file apponly.proto.

N
ATAK
No documentation available
T
ATAK.Contact

ATAK Contact

v
ATAK.ContactSchema

Describes the message meshtastic.Contact.Use create(ContactSchema) to create a new message.

v
ATAK.file_atak

Describes the file atak.proto.

T
ATAK.GeoChat

ATAK GeoChat message

v
ATAK.GeoChatSchema

Describes the message meshtastic.GeoChat.Use create(GeoChatSchema) to create a new message.

T
ATAK.Group

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

v
ATAK.GroupSchema

Describes the message meshtastic.Group.Use create(GroupSchema) to create a new message.

E
ATAK.MemberRole

Role of the group member

v
ATAK.MemberRoleSchema

Describes the enum meshtastic.MemberRole.

T
ATAK.PLI

Position Location Information from ATAK

v
ATAK.PLISchema

Describes the message meshtastic.PLI.Use create(PLISchema) to create a new message.

T
ATAK.Status

ATAK EUD Status

v
ATAK.StatusSchema

Describes the message meshtastic.Status.Use create(StatusSchema) to create a new message.

T
ATAK.TAKPacket

Packets for the official ATAK Plugin

v
ATAK.TAKPacketSchema

Describes the message meshtastic.TAKPacket.Use create(TAKPacketSchema) to create a new message.

E
ATAK.Team
No documentation available
v
ATAK.TeamSchema

Describes the enum meshtastic.Team.

N
CannedMessages
No documentation available
T
CannedMessages.CannedMessageModuleConfig

Canned message module configuration.

v
CannedMessages.CannedMessageModuleConfigSchema

Describes the message meshtastic.CannedMessageModuleConfig.Use create(CannedMessageModuleConfigSchema) to create a new message.

v
CannedMessages.file_cannedmessages

Describes the file cannedmessages.proto.

N
Channel
No documentation available
T
Channel.Channel

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

E
Channel.Channel_Role

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 wouldoccasionally 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 allowcross 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)

v
Channel.Channel_RoleSchema

Describes the enum meshtastic.Channel.Role.

v
Channel.ChannelSchema

Describes the message meshtastic.Channel.Use create(ChannelSchema) to create a new message.

T
Channel.ChannelSettings

This information can be encoded as a QRcode/url so that other users can configuretheir radio to join the same channel.A note about how channel names are shown to users: channelname-Xpoundsymbol 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 thischannel - so that if the user changes anything about the channel (which doesforce a new PSK) this letter will also change. Thus preventing user confusion iftwo friends try to type in a channel name of "BobsChan" and then can't talkbecause 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), theusers 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

v
Channel.ChannelSettingsSchema

Describes the message meshtastic.ChannelSettings.Use create(ChannelSettingsSchema) to create a new message.

v
Channel.file_channel

Describes the file channel.proto.

T
Channel.ModuleSettings

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

v
Channel.ModuleSettingsSchema

Describes the message meshtastic.ModuleSettings.Use create(ModuleSettingsSchema) to create a new message.

N
ClientOnly
No documentation available
T
ClientOnly.DeviceProfile

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

v
ClientOnly.DeviceProfileSchema

Describes the message meshtastic.DeviceProfile.Use create(DeviceProfileSchema) to create a new message.

v
ClientOnly.file_clientonly

Describes the file clientonly.proto.

N
Config
No documentation available
T
Config.Config
No documentation available
T
Config.Config_BluetoothConfig
No documentation available
E
Config.Config_BluetoothConfig_PairingMode
No documentation available
v
Config.Config_BluetoothConfig_PairingModeSchema

Describes the enum meshtastic.Config.BluetoothConfig.PairingMode.

v
Config.Config_BluetoothConfigSchema

Describes the message meshtastic.Config.BluetoothConfig.Use create(Config_BluetoothConfigSchema) to create a new message.

E
Config.Config_DeviceConfig_RebroadcastMode

Defines the device's behavior for how messages are rebroadcast

v
Config.Config_DeviceConfig_RebroadcastModeSchema

Describes the enum meshtastic.Config.DeviceConfig.RebroadcastMode.

E
Config.Config_DeviceConfig_Role

Defines the device's role on the Mesh network

v
Config.Config_DeviceConfig_RoleSchema

Describes the enum meshtastic.Config.DeviceConfig.Role.

v
Config.Config_DeviceConfigSchema

Describes the message meshtastic.Config.DeviceConfig.Use create(Config_DeviceConfigSchema) to create a new message.

T
v
Config.Config_DisplayConfig_CompassOrientationSchema

Describes the enum meshtastic.Config.DisplayConfig.CompassOrientation.

E
Config.Config_DisplayConfig_DisplayMode
No documentation available
v
Config.Config_DisplayConfig_DisplayModeSchema

Describes the enum meshtastic.Config.DisplayConfig.DisplayMode.

E
v
Config.Config_DisplayConfig_DisplayUnitsSchema

Describes the enum meshtastic.Config.DisplayConfig.DisplayUnits.

E
Config.Config_DisplayConfig_GpsCoordinateFormat

How the GPS coordinates are displayed on the OLED screen.

v
Config.Config_DisplayConfig_GpsCoordinateFormatSchema

Describes the enum meshtastic.Config.DisplayConfig.GpsCoordinateFormat.

E
Config.Config_DisplayConfig_OledType

Override OLED outo detect with this if it fails.

v
Config.Config_DisplayConfig_OledTypeSchema

Describes the enum meshtastic.Config.DisplayConfig.OledType.

v
Config.Config_DisplayConfigSchema

Describes the message meshtastic.Config.DisplayConfig.Use create(Config_DisplayConfigSchema) to create a new message.

E
Config.Config_LoRaConfig_ModemPreset

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

v
Config.Config_LoRaConfig_ModemPresetSchema

Describes the enum meshtastic.Config.LoRaConfig.ModemPreset.

E
Config.Config_LoRaConfig_RegionCode
No documentation available
v
Config.Config_LoRaConfig_RegionCodeSchema

Describes the enum meshtastic.Config.LoRaConfig.RegionCode.

v
Config.Config_LoRaConfigSchema

Describes the message meshtastic.Config.LoRaConfig.Use create(Config_LoRaConfigSchema) to create a new message.

T
E
Config.Config_NetworkConfig_AddressMode
No documentation available
v
Config.Config_NetworkConfig_AddressModeSchema

Describes the enum meshtastic.Config.NetworkConfig.AddressMode.

T
Config.Config_NetworkConfig_IpV4Config
No documentation available
v
Config.Config_NetworkConfig_IpV4ConfigSchema

Describes the message meshtastic.Config.NetworkConfig.IpV4Config.Use create(Config_NetworkConfig_IpV4ConfigSchema) to create a new message.

v
Config.Config_NetworkConfigSchema

Describes the message meshtastic.Config.NetworkConfig.Use create(Config_NetworkConfigSchema) to create a new message.

T
E
Config.Config_PositionConfig_GpsMode
No documentation available
v
Config.Config_PositionConfig_GpsModeSchema

Describes the enum meshtastic.Config.PositionConfig.GpsMode.

E
Config.Config_PositionConfig_PositionFlags

Bit field of boolean configuration options, indicating which optionalfields to include when assembling POSITION messages.Longitude, latitude, altitude, speed, heading, and DOPare 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

v
Config.Config_PositionConfig_PositionFlagsSchema

Describes the enum meshtastic.Config.PositionConfig.PositionFlags.

v
Config.Config_PositionConfigSchema

Describes the message meshtastic.Config.PositionConfig.Use create(Config_PositionConfigSchema) to create a new message.

T
Config.Config_PowerConfig

Power ConfigSee Power Config for additional power config details.

v
Config.Config_PowerConfigSchema

Describes the message meshtastic.Config.PowerConfig.Use create(Config_PowerConfigSchema) to create a new message.

T
Config.Config_SecurityConfig
No documentation available
v
Config.Config_SecurityConfigSchema

Describes the message meshtastic.Config.SecurityConfig.Use create(Config_SecurityConfigSchema) to create a new message.

T
Config.Config_SessionkeyConfig

Blank config request, strictly for getting the session key

v
Config.Config_SessionkeyConfigSchema

Describes the message meshtastic.Config.SessionkeyConfig.Use create(Config_SessionkeyConfigSchema) to create a new message.

v
Config.ConfigSchema

Describes the message meshtastic.Config.Use create(ConfigSchema) to create a new message.

v
Config.file_config

Describes the file config.proto.

N
ConnectionStatus
No documentation available
T
ConnectionStatus.BluetoothConnectionStatus

Bluetooth connection status

v
ConnectionStatus.BluetoothConnectionStatusSchema

Describes the message meshtastic.BluetoothConnectionStatus.Use create(BluetoothConnectionStatusSchema) to create a new message.

T
ConnectionStatus.DeviceConnectionStatus
No documentation available
v
ConnectionStatus.DeviceConnectionStatusSchema

Describes the message meshtastic.DeviceConnectionStatus.Use create(DeviceConnectionStatusSchema) to create a new message.

T
ConnectionStatus.EthernetConnectionStatus

Ethernet connection status

v
ConnectionStatus.EthernetConnectionStatusSchema

Describes the message meshtastic.EthernetConnectionStatus.Use create(EthernetConnectionStatusSchema) to create a new message.

v
ConnectionStatus.file_connection_status

Describes the file connection_status.proto.

T
ConnectionStatus.NetworkConnectionStatus

Ethernet or WiFi connection status

v
ConnectionStatus.NetworkConnectionStatusSchema

Describes the message meshtastic.NetworkConnectionStatus.Use create(NetworkConnectionStatusSchema) to create a new message.

T
ConnectionStatus.SerialConnectionStatus

Serial connection status

v
ConnectionStatus.SerialConnectionStatusSchema

Describes the message meshtastic.SerialConnectionStatus.Use create(SerialConnectionStatusSchema) to create a new message.

T
ConnectionStatus.WifiConnectionStatus

WiFi connection status

v
ConnectionStatus.WifiConnectionStatusSchema

Describes the message meshtastic.WifiConnectionStatus.Use create(WifiConnectionStatusSchema) to create a new message.

N
LocalOnly
No documentation available
v
LocalOnly.file_localonly

Describes the file localonly.proto.

T
LocalOnly.LocalConfig
No documentation available
v
LocalOnly.LocalConfigSchema

Describes the message meshtastic.LocalConfig.Use create(LocalConfigSchema) to create a new message.

T
LocalOnly.LocalModuleConfig
No documentation available
v
LocalOnly.LocalModuleConfigSchema

Describes the message meshtastic.LocalModuleConfig.Use create(LocalModuleConfigSchema) to create a new message.

N
Mesh
No documentation available
T
Mesh.ChunkedPayload
No documentation available
T
Mesh.ChunkedPayloadResponse

Responses to a ChunkedPayload request

v
Mesh.ChunkedPayloadResponseSchema

Describes the message meshtastic.ChunkedPayloadResponse.Use create(ChunkedPayloadResponseSchema) to create a new message.

v
Mesh.ChunkedPayloadSchema

Describes the message meshtastic.ChunkedPayload.Use create(ChunkedPayloadSchema) to create a new message.

T
Mesh.ClientNotification

A notification message from the device to the clientTo be used for important messages that should to be displayed to the userin the form of push notifications or validation messages when savinginvalid configuration.

v
Mesh.ClientNotificationSchema

Describes the message meshtastic.ClientNotification.Use create(ClientNotificationSchema) to create a new message.

T
Mesh.Compressed

Compressed message payload

v
Mesh.CompressedSchema

Describes the message meshtastic.Compressed.Use create(CompressedSchema) to create a new message.

E
Mesh.Constants

Shared constants between device and phone

v
Mesh.ConstantsSchema

Describes the enum meshtastic.Constants.

E
Mesh.CriticalErrorCode

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

v
Mesh.CriticalErrorCodeSchema

Describes the enum meshtastic.CriticalErrorCode.

T
Mesh.Data

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

v
Mesh.DataSchema

Describes the message meshtastic.Data.Use create(DataSchema) to create a new message.

T
Mesh.DeviceMetadata

Device metadata response

v
Mesh.DeviceMetadataSchema

Describes the message meshtastic.DeviceMetadata.Use create(DeviceMetadataSchema) to create a new message.

v
Mesh.file_mesh

Describes the file mesh.proto.

T
Mesh.FileInfo

Individual File info for the device

v
Mesh.FileInfoSchema

Describes the message meshtastic.FileInfo.Use create(FileInfoSchema) to create a new message.

T
Mesh.FromRadio

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.

v
Mesh.FromRadioSchema

Describes the message meshtastic.FromRadio.Use create(FromRadioSchema) to create a new message.

E
Mesh.HardwareModel

Note: these enum names must EXACTLY match the string used in the devicebin/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 .

v
Mesh.HardwareModelSchema

Describes the enum meshtastic.HardwareModel.

T
Mesh.Heartbeat

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.

v
Mesh.HeartbeatSchema

Describes the message meshtastic.Heartbeat.Use create(HeartbeatSchema) to create a new message.

T
Mesh.LogRecord

Debug output from the device.To minimize the size of records inside the device code, if a time/source/level is not seton 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.

E
Mesh.LogRecord_Level

Log levels, chosen to match python logging conventions.

v
Mesh.LogRecord_LevelSchema

Describes the enum meshtastic.LogRecord.Level.

v
Mesh.LogRecordSchema

Describes the message meshtastic.LogRecord.Use create(LogRecordSchema) to create a new message.

T
Mesh.MeshPacket

A packet envelope sent/received over the meshonly 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.

E
Mesh.MeshPacket_Delayed

Identify if this is a delayed packet

v
Mesh.MeshPacket_DelayedSchema

Describes the enum meshtastic.MeshPacket.Delayed.

E
Mesh.MeshPacket_Priority

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 makinga protocol there isn’t much need to use message priority to change the orderof transmission (because interfaces are fairly fast).But for lora where packets can take a few seconds each, it is very importantto 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.

v
Mesh.MeshPacket_PrioritySchema

Describes the enum meshtastic.MeshPacket.Priority.

v
Mesh.MeshPacketSchema

Describes the message meshtastic.MeshPacket.Use create(MeshPacketSchema) to create a new message.

T
Mesh.MqttClientProxyMessage

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

v
Mesh.MqttClientProxyMessageSchema

Describes the message meshtastic.MqttClientProxyMessage.Use create(MqttClientProxyMessageSchema) to create a new message.

T
Mesh.MyNodeInfo

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

v
Mesh.MyNodeInfoSchema

Describes the message meshtastic.MyNodeInfo.Use create(MyNodeInfoSchema) to create a new message.

T
Mesh.Neighbor

A single edge in the mesh

T
Mesh.NeighborInfo

Full info on edges for a single node

v
Mesh.NeighborInfoSchema

Describes the message meshtastic.NeighborInfo.Use create(NeighborInfoSchema) to create a new message.

v
Mesh.NeighborSchema

Describes the message meshtastic.Neighbor.Use create(NeighborSchema) to create a new message.

T
Mesh.NodeInfo

The bluetooth to device link:Old BTLE protocol docs from TODO, merge in above and make real docs...use protocol buffers, and NanoPBmessages 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 IDstring used for this node, a human readable string shown for that id, and a veryshort human readable string suitable for oled screen) SEND_OPAQUE(dest, payload)(for signal messages or other applications) SEND_TEXT(dest, text) Get allnodes() (returns list of nodes, with full info, last time seen, loc, batterylevel etc) SET_CONFIG (switches device to a new set of radio params andpreshared key, drops all existing nodes, force our node to rejoin this new group)Full information about a node on the mesh

v
Mesh.NodeInfoSchema

Describes the message meshtastic.NodeInfo.Use create(NodeInfoSchema) to create a new message.

T
Mesh.NodeRemoteHardwarePin

RemoteHardwarePins associated with a node

v
Mesh.NodeRemoteHardwarePinSchema

Describes the message meshtastic.NodeRemoteHardwarePin.Use create(NodeRemoteHardwarePinSchema) to create a new message.

T
Mesh.Position

a gps position

E
Mesh.Position_AltSource

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

v
Mesh.Position_AltSourceSchema

Describes the enum meshtastic.Position.AltSource.

E
Mesh.Position_LocSource

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

v
Mesh.Position_LocSourceSchema

Describes the enum meshtastic.Position.LocSource.

v
Mesh.PositionSchema

Describes the message meshtastic.Position.Use create(PositionSchema) to create a new message.

T
Mesh.QueueStatus
No documentation available
v
Mesh.QueueStatusSchema

Describes the message meshtastic.QueueStatus.Use create(QueueStatusSchema) to create a new message.

T
Mesh.resend_chunks

Wrapper message for broken repeated oneof support

v
Mesh.resend_chunksSchema

Describes the message meshtastic.resend_chunks.Use create(resend_chunksSchema) to create a new message.

T
Mesh.RouteDiscovery

A message used in a traceroute

v
Mesh.RouteDiscoverySchema

Describes the message meshtastic.RouteDiscovery.Use create(RouteDiscoverySchema) to create a new message.

T
Mesh.Routing

A Routing control Data packet handled by the routing module

E
Mesh.Routing_Error

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

v
Mesh.Routing_ErrorSchema

Describes the enum meshtastic.Routing.Error.

v
Mesh.RoutingSchema

Describes the message meshtastic.Routing.Use create(RoutingSchema) to create a new message.

T
Mesh.ToRadio

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

v
Mesh.ToRadioSchema

Describes the message meshtastic.ToRadio.Use create(ToRadioSchema) to create a new message.

T
Mesh.User

Broadcast when a newly powered mesh node wants to find a node num it can useSent 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 allother 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 wherethe sender node number equals our node number, that indicates a collision hasoccurred and the following steps should happen:If the receiving node (that was already in the mesh)'s macaddr is LOWER than thenew 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 canreceive our message, considering we have the same id - it also serves to letobservers 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 againstwhatever it knows about the nodedb) and rebroadcast their User.A few nodenums are reserved and will never be requested:0xff - broadcast0 through 3 - for future use

v
Mesh.UserSchema

Describes the message meshtastic.User.Use create(UserSchema) to create a new message.

T
Mesh.Waypoint

Waypoint message, used to share arbitrary locations across the mesh

v
Mesh.WaypointSchema

Describes the message meshtastic.Waypoint.Use create(WaypointSchema) to create a new message.

N
ModuleConfig
No documentation available
v
ModuleConfig.file_module_config

Describes the file module_config.proto.

T
T
ModuleConfig.ModuleConfig_AmbientLightingConfig

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.

v
ModuleConfig.ModuleConfig_AmbientLightingConfigSchema

Describes the message meshtastic.ModuleConfig.AmbientLightingConfig.Use create(ModuleConfig_AmbientLightingConfigSchema) to create a new message.

T
ModuleConfig.ModuleConfig_AudioConfig

Audio Config for codec2 voice

v
ModuleConfig.ModuleConfig_AudioConfig_Audio_BaudSchema

Describes the enum meshtastic.ModuleConfig.AudioConfig.Audio_Baud.

v
ModuleConfig.ModuleConfig_AudioConfigSchema

Describes the message meshtastic.ModuleConfig.AudioConfig.Use create(ModuleConfig_AudioConfigSchema) to create a new message.

v
ModuleConfig.ModuleConfig_CannedMessageConfig_InputEventCharSchema

Describes the enum meshtastic.ModuleConfig.CannedMessageConfig.InputEventChar.

v
ModuleConfig.ModuleConfig_CannedMessageConfigSchema

Describes the message meshtastic.ModuleConfig.CannedMessageConfig.Use create(ModuleConfig_CannedMessageConfigSchema) to create a new message.

T
ModuleConfig.ModuleConfig_DetectionSensorConfig

Detection Sensor Module Config

v
ModuleConfig.ModuleConfig_DetectionSensorConfig_TriggerTypeSchema

Describes the enum meshtastic.ModuleConfig.DetectionSensorConfig.TriggerType.

v
ModuleConfig.ModuleConfig_DetectionSensorConfigSchema

Describes the message meshtastic.ModuleConfig.DetectionSensorConfig.Use create(ModuleConfig_DetectionSensorConfigSchema) to create a new message.

v
ModuleConfig.ModuleConfig_ExternalNotificationConfigSchema

Describes the message meshtastic.ModuleConfig.ExternalNotificationConfig.Use create(ModuleConfig_ExternalNotificationConfigSchema) to create a new message.

T
ModuleConfig.ModuleConfig_MapReportSettings

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

v
ModuleConfig.ModuleConfig_MapReportSettingsSchema

Describes the message meshtastic.ModuleConfig.MapReportSettings.Use create(ModuleConfig_MapReportSettingsSchema) to create a new message.

v
ModuleConfig.ModuleConfig_MQTTConfigSchema

Describes the message meshtastic.ModuleConfig.MQTTConfig.Use create(ModuleConfig_MQTTConfigSchema) to create a new message.

v
ModuleConfig.ModuleConfig_NeighborInfoConfigSchema

Describes the message meshtastic.ModuleConfig.NeighborInfoConfig.Use create(ModuleConfig_NeighborInfoConfigSchema) to create a new message.

T
ModuleConfig.ModuleConfig_PaxcounterConfig

Config for the Paxcounter Module

v
ModuleConfig.ModuleConfig_PaxcounterConfigSchema

Describes the message meshtastic.ModuleConfig.PaxcounterConfig.Use create(ModuleConfig_PaxcounterConfigSchema) to create a new message.

T
ModuleConfig.ModuleConfig_RangeTestConfig

Preferences for the RangeTestModule

v
ModuleConfig.ModuleConfig_RangeTestConfigSchema

Describes the message meshtastic.ModuleConfig.RangeTestConfig.Use create(ModuleConfig_RangeTestConfigSchema) to create a new message.

T
v
ModuleConfig.ModuleConfig_RemoteHardwareConfigSchema

Describes the message meshtastic.ModuleConfig.RemoteHardwareConfig.Use create(ModuleConfig_RemoteHardwareConfigSchema) to create a new message.

v
ModuleConfig.ModuleConfig_SerialConfig_Serial_BaudSchema

Describes the enum meshtastic.ModuleConfig.SerialConfig.Serial_Baud.

v
ModuleConfig.ModuleConfig_SerialConfig_Serial_ModeSchema

Describes the enum meshtastic.ModuleConfig.SerialConfig.Serial_Mode.

v
ModuleConfig.ModuleConfig_SerialConfigSchema

Describes the message meshtastic.ModuleConfig.SerialConfig.Use create(ModuleConfig_SerialConfigSchema) to create a new message.

T
ModuleConfig.ModuleConfig_StoreForwardConfig

Store and Forward Module Config

v
ModuleConfig.ModuleConfig_StoreForwardConfigSchema

Describes the message meshtastic.ModuleConfig.StoreForwardConfig.Use create(ModuleConfig_StoreForwardConfigSchema) to create a new message.

T
ModuleConfig.ModuleConfig_TelemetryConfig

Configuration for both device and environment metrics

v
ModuleConfig.ModuleConfig_TelemetryConfigSchema

Describes the message meshtastic.ModuleConfig.TelemetryConfig.Use create(ModuleConfig_TelemetryConfigSchema) to create a new message.

v
ModuleConfig.ModuleConfigSchema

Describes the message meshtastic.ModuleConfig.Use create(ModuleConfigSchema) to create a new message.

T
ModuleConfig.RemoteHardwarePin

A GPIO pin definition for remote hardware module

v
ModuleConfig.RemoteHardwarePinSchema

Describes the message meshtastic.RemoteHardwarePin.Use create(RemoteHardwarePinSchema) to create a new message.

E
ModuleConfig.RemoteHardwarePinType
No documentation available
v
ModuleConfig.RemoteHardwarePinTypeSchema

Describes the enum meshtastic.RemoteHardwarePinType.

N
Mqtt
No documentation available
v
Mqtt.file_mqtt

Describes the file mqtt.proto.

T
Mqtt.MapReport

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

v
Mqtt.MapReportSchema

Describes the message meshtastic.MapReport.Use create(MapReportSchema) to create a new message.

T
Mqtt.ServiceEnvelope

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

v
Mqtt.ServiceEnvelopeSchema

Describes the message meshtastic.ServiceEnvelope.Use create(ServiceEnvelopeSchema) to create a new message.

N
PaxCount
No documentation available
v
PaxCount.file_paxcount

Describes the file paxcount.proto.

T
PaxCount.Paxcount

TODO: REPLACE

v
PaxCount.PaxcountSchema

Describes the message meshtastic.Paxcount.Use create(PaxcountSchema) to create a new message.

N
Portnums
No documentation available
v
Portnums.file_portnums

Describes the file portnums.proto.

E
Portnums.PortNum

For any new 'apps' that run on the device or via sister apps on phones/PCs they should pick and use aunique 'portnum' for their application.If you are making a new app using meshtastic, please send in a pull request to add your 'portnum' to thismaster table.PortNums should be assigned in the following range:0-63 Core Meshtastic use, do not use for third party apps64-127 Registered 3rd party apps, send in a pull request that adds a new entry to portnums.proto to register your application256-511 Use one of these portnums for your private applications that you don't want to register publicallyAll 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.

v
Portnums.PortNumSchema

Describes the enum meshtastic.PortNum.

N
PowerMon
No documentation available
v
PowerMon.file_powermon

Describes the file powermon.proto.

T
PowerMon.PowerMon

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)

E
PowerMon.PowerMon_State

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.

v
PowerMon.PowerMon_StateSchema

Describes the enum meshtastic.PowerMon.State.

v
PowerMon.PowerMonSchema

Describes the message meshtastic.PowerMon.Use create(PowerMonSchema) to create a new message.

T
PowerMon.PowerStressMessage

PowerStress testing support via the C++ PowerStress module

E
PowerMon.PowerStressMessage_Opcode

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 statemachine has started processing their request

v
PowerMon.PowerStressMessage_OpcodeSchema

Describes the enum meshtastic.PowerStressMessage.Opcode.

v
PowerMon.PowerStressMessageSchema

Describes the message meshtastic.PowerStressMessage.Use create(PowerStressMessageSchema) to create a new message.

N
RemoteHardware
No documentation available
v
RemoteHardware.file_remote_hardware

Describes the file remote_hardware.proto.

T
RemoteHardware.HardwareMessage

An example app to show off the module system. This message is used forREMOTE_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 dangerousbecause 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?)

v
RemoteHardware.HardwareMessage_TypeSchema

Describes the enum meshtastic.HardwareMessage.Type.

v
RemoteHardware.HardwareMessageSchema

Describes the message meshtastic.HardwareMessage.Use create(HardwareMessageSchema) to create a new message.

N
Rtttl
No documentation available
v
Rtttl.file_rtttl

Describes the file rtttl.proto.

T
Rtttl.RTTTLConfig

Canned message module configuration.

v
Rtttl.RTTTLConfigSchema

Describes the message meshtastic.RTTTLConfig.Use create(RTTTLConfigSchema) to create a new message.

N
StoreForward
No documentation available
v
StoreForward.file_storeforward

Describes the file storeforward.proto.

v
StoreForward.StoreAndForward_HeartbeatSchema

Describes the message meshtastic.StoreAndForward.Heartbeat.Use create(StoreAndForward_HeartbeatSchema) to create a new message.

v
StoreForward.StoreAndForward_HistorySchema

Describes the message meshtastic.StoreAndForward.History.Use create(StoreAndForward_HistorySchema) to create a new message.

E
StoreForward.StoreAndForward_RequestResponse

001 - 063 = From Router064 - 127 = From Client

v
StoreForward.StoreAndForward_RequestResponseSchema

Describes the enum meshtastic.StoreAndForward.RequestResponse.

v
StoreForward.StoreAndForward_StatisticsSchema

Describes the message meshtastic.StoreAndForward.Statistics.Use create(StoreAndForward_StatisticsSchema) to create a new message.

v
StoreForward.StoreAndForwardSchema

Describes the message meshtastic.StoreAndForward.Use create(StoreAndForwardSchema) to create a new message.

N
Telemetry
No documentation available
T
Telemetry.AirQualityMetrics

Air quality metrics

v
Telemetry.AirQualityMetricsSchema

Describes the message meshtastic.AirQualityMetrics.Use create(AirQualityMetricsSchema) to create a new message.

T
Telemetry.DeviceMetrics

Key native device metrics such as battery level

v
Telemetry.DeviceMetricsSchema

Describes the message meshtastic.DeviceMetrics.Use create(DeviceMetricsSchema) to create a new message.

T
Telemetry.EnvironmentMetrics

Weather station or other environmental metrics

v
Telemetry.EnvironmentMetricsSchema

Describes the message meshtastic.EnvironmentMetrics.Use create(EnvironmentMetricsSchema) to create a new message.

v
Telemetry.file_telemetry

Describes the file telemetry.proto.

T
Telemetry.HealthMetrics

Health telemetry metrics

v
Telemetry.HealthMetricsSchema

Describes the message meshtastic.HealthMetrics.Use create(HealthMetricsSchema) to create a new message.

T
Telemetry.LocalStats

Local device mesh statistics

v
Telemetry.LocalStatsSchema

Describes the message meshtastic.LocalStats.Use create(LocalStatsSchema) to create a new message.

T
Telemetry.Nau7802Config

NAU7802 Telemetry configuration, for saving to flash

v
Telemetry.Nau7802ConfigSchema

Describes the message meshtastic.Nau7802Config.Use create(Nau7802ConfigSchema) to create a new message.

T
Telemetry.PowerMetrics

Power Metrics (voltage / current / etc)

v
Telemetry.PowerMetricsSchema

Describes the message meshtastic.PowerMetrics.Use create(PowerMetricsSchema) to create a new message.

T
Telemetry.Telemetry

Types of Measurements the telemetry module is equipped to handle

v
Telemetry.TelemetrySchema

Describes the message meshtastic.Telemetry.Use create(TelemetrySchema) to create a new message.

E
Telemetry.TelemetrySensorType

Supported I2C Sensors for telemetry in Meshtastic

v
Telemetry.TelemetrySensorTypeSchema

Describes the enum meshtastic.TelemetrySensorType.

N
Xmodem
No documentation available
v
Xmodem.file_xmodem

Describes the file xmodem.proto.

T
Xmodem.XModem
No documentation available
E
Xmodem.XModem_Control
No documentation available
v
Xmodem.XModem_ControlSchema

Describes the enum meshtastic.XModem.Control.

v
Xmodem.XModemSchema

Describes the message meshtastic.XModem.Use create(XModemSchema) to create a new message.