Optional data: PartialMessage<AdminMessage>TODO: REPLACE
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)
from field: uint32 get_channel_request = 1;
TODO: REPLACE
from field: meshtastic.Channel get_channel_response = 2;
Send the current owner data in the response to this message.
from field: bool get_owner_request = 3;
TODO: REPLACE
from field: meshtastic.User get_owner_response = 4;
Ask for the following config data to be sent
from field: meshtastic.AdminMessage.ConfigType get_config_request = 5;
Send the current Config in the response to this message.
from field: meshtastic.Config get_config_response = 6;
Ask for the following config data to be sent
from field: meshtastic.AdminMessage.ModuleConfigType get_module_config_request = 7;
Send the current Config in the response to this message.
from field: meshtastic.ModuleConfig get_module_config_response = 8;
Get the Canned Message Module messages in the response to this message.
from field: bool get_canned_message_module_messages_request = 10;
Get the Canned Message Module messages in the response to this message.
from field: string get_canned_message_module_messages_response = 11;
Request the node to send device metadata (firmware, protobuf version, etc)
from field: bool get_device_metadata_request = 12;
Device metadata response
from field: meshtastic.DeviceMetadata get_device_metadata_response = 13;
Get the Ringtone in the response to this message.
from field: bool get_ringtone_request = 14;
Get the Ringtone in the response to this message.
from field: string get_ringtone_response = 15;
Request the node to send it's connection status
from field: bool get_device_connection_status_request = 16;
Device connection status response
from field: meshtastic.DeviceConnectionStatus get_device_connection_status_response = 17;
Setup a node for licensed amateur (ham) radio operation
from field: meshtastic.HamParameters set_ham_mode = 18;
Get the mesh's nodes with their available gpio pins for RemoteHardware module use
from field: bool get_node_remote_hardware_pins_request = 19;
Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use
from field: meshtastic.NodeRemoteHardwarePinsResponse get_node_remote_hardware_pins_response = 20;
Enter (UF2) DFU mode Only implemented on NRF52 currently
from field: bool enter_dfu_mode_request = 21;
Delete the file by the specified path from the device
from field: string delete_file_request = 22;
Set the owner for this node
from field: meshtastic.User set_owner = 32;
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.
from field: meshtastic.Channel set_channel = 33;
Set the current Config
from field: meshtastic.Config set_config = 34;
Set the current Config
from field: meshtastic.ModuleConfig set_module_config = 35;
Set the Canned Message Module messages text.
from field: string set_canned_message_module_messages = 36;
Set the ringtone for ExternalNotification.
from field: string set_ringtone_message = 37;
Remove the node by the specified node-num from the NodeDB on the device
from field: uint32 remove_by_nodenum = 38;
Set specified node-num to be favorited on the NodeDB on the device
from field: uint32 set_favorite_node = 39;
Set specified node-num to be un-favorited on the NodeDB on the device
from field: uint32 remove_favorite_node = 40;
Set fixed position data on the node and then set the position.fixed_position = true
from field: meshtastic.Position set_fixed_position = 41;
Clear fixed position coordinates and then set position.fixed_position = false
from field: bool remove_fixed_position = 42;
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)
from field: bool begin_edit_settings = 64;
Commits an open transaction for any edits made to config, module config, owner, and channel settings
from field: bool commit_edit_settings = 65;
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.
from field: int32 reboot_ota_seconds = 95;
This message is only supported for the simulator Portduino build. If received the simulator will exit successfully.
from field: bool exit_simulator = 96;
Tell the node to reboot in this many seconds (or <0 to cancel reboot)
from field: int32 reboot_seconds = 97;
Tell the node to shutdown in this many seconds (or <0 to cancel shutdown)
from field: int32 shutdown_seconds = 98;
Tell the node to factory reset, all device settings will be returned to factory defaults.
from field: int32 factory_reset = 99;
Tell the node to reset the nodedb.
from field: int32 nodedb_reset = 100;
Optional value?: undefinedfrom oneof meshtastic.AdminMessage.payload_variant
Static Readonly fieldsStatic Readonly runtimeStatic Readonly typeCreate a deep copy.
Compare with a message of the same type.
Parse from binary data, merging fields.
Repeated fields are appended. Map entries are added, overwriting existing keys.
If a message field is already present, it will be merged with the new data.
Optional options: Partial<BinaryReadOptions>Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.
Protected toJSONOverride for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).
Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.
This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.
Static equalsStatic fromOptional options: Partial<BinaryReadOptions>Static fromOptional options: Partial<JsonReadOptions>Static fromOptional options: Partial<JsonReadOptions>Generated using TypeDoc
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)
Generated
from message meshtastic.AdminMessage