meshtastic-protobuf/admin.proto

142 wiersze
4.5 KiB
Protocol Buffer
Czysty Zwykły widok Historia

2021-02-25 12:35:51 +00:00
syntax = "proto3";
option java_package = "com.geeksville.mesh";
option optimize_for = LITE_RUNTIME;
option go_package = "github.com/meshtastic/gomeshproto";
2021-02-25 12:35:51 +00:00
import "cannedmessages.proto";
import "channel.proto";
import "mesh.proto";
2021-12-30 18:12:21 +00:00
import "radioconfig.proto";
2021-02-25 12:35:51 +00:00
2021-02-27 05:43:36 +00:00
option java_outer_classname = "AdminProtos";
2021-03-07 08:28:48 +00:00
/*
2021-04-20 09:08:28 +00:00
* This message is handled by the Admin plugin and is responsible for all settings/channel read/write operations.
* This message is used to do settings operations to both remote AND local nodes.
2021-03-07 08:28:48 +00:00
* (Prior to 1.2 these operations were done via special ToRadio operations)
*/
2021-02-25 12:35:51 +00:00
message AdminMessage {
oneof variant {
/*
* Set the radio provisioning for this node
*/
RadioConfig set_radio = 1;
/*
* Set the owner for this node
*/
User set_owner = 2;
/*
* 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.
*/
Channel set_channel = 3;
/*
* Send the current RadioConfig in the response to this message.
*/
bool get_radio_request = 4;
RadioConfig get_radio_response = 5;
/*
* 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)
*/
uint32 get_channel_request = 6;
Channel get_channel_response = 7;
2021-03-11 03:11:45 +00:00
/*
* Send the current owner data in the response to this message.
*/
bool get_owner_request = 8;
User get_owner_response = 9;
/*
* Setting channels/radio config remotely carries the risk that you might send an invalid config and the radio never talks to your mesh again.
* Therefore if setting either of these properties remotely, you must send a confirm_xxx message within 10 minutes.
* If you fail to do so, the radio will assume loss of comms and revert your changes.
* These messages are optional when changing the local node.
*/
bool confirm_set_channel = 32;
bool confirm_set_radio = 33;
2021-03-18 11:08:37 +00:00
/*
* This message is only supported for the simulator porduino build.
* If received the simulator will exit successfully.
*/
bool exit_simulator = 34;
2021-03-27 02:04:22 +00:00
/*
* Tell the node to reboot in this many seconds (or <0 to cancel reboot)
*/
int32 reboot_seconds = 35;
2022-01-19 01:39:38 +00:00
/*
* Get the Canned Message Plugin message part1 in the response to this message.
*/
bool get_canned_message_plugin_part1_request = 36;
2022-01-19 18:54:26 +00:00
CannedMessagePluginMessagePart1 get_canned_message_plugin_part1_response = 37;
2022-01-19 01:39:38 +00:00
/*
* Get the Canned Message Plugin message part2 in the response to this message.
*/
bool get_canned_message_plugin_part2_request = 38;
2022-01-19 18:54:26 +00:00
CannedMessagePluginMessagePart2 get_canned_message_plugin_part2_response = 39;
2022-01-19 01:39:38 +00:00
/*
* Get the Canned Message Plugin message part3 in the response to this message.
*/
bool get_canned_message_plugin_part3_request = 40;
2022-01-19 18:54:26 +00:00
CannedMessagePluginMessagePart3 get_canned_message_plugin_part3_response = 41;
2022-01-19 01:39:38 +00:00
/*
* Get the Canned Message Plugin message part4 in the response to this message.
*/
bool get_canned_message_plugin_part4_request = 42;
2022-01-19 18:54:26 +00:00
CannedMessagePluginMessagePart4 get_canned_message_plugin_part4_response = 43;
2022-01-19 01:39:38 +00:00
/*
* Get the Canned Message Plugin message part5 in the response to this message.
*/
bool get_canned_message_plugin_part5_request = 44;
2022-01-19 18:54:26 +00:00
CannedMessagePluginMessagePart5 get_canned_message_plugin_part5_response = 45;
2022-01-19 01:39:38 +00:00
/*
* Set the canned message plugin part 1 text.
*/
2022-01-19 19:57:27 +00:00
CannedMessagePluginMessagePart1 set_canned_message_plugin_part1 = 46;
2022-01-19 01:39:38 +00:00
/*
* Set the canned message plugin part 2 text.
*/
2022-01-19 19:57:27 +00:00
CannedMessagePluginMessagePart2 set_canned_message_plugin_part2 = 47;
2022-01-19 01:39:38 +00:00
/*
* Set the canned message plugin part 3 text.
*/
2022-01-19 19:57:27 +00:00
CannedMessagePluginMessagePart3 set_canned_message_plugin_part3 = 48;
2022-01-19 01:39:38 +00:00
/*
* Set the canned message plugin part 4 text.
*/
2022-01-19 19:57:27 +00:00
CannedMessagePluginMessagePart4 set_canned_message_plugin_part4 = 49;
2022-01-19 01:39:38 +00:00
/*
* Set the canned message plugin part 5 text.
*/
2022-01-19 19:57:27 +00:00
CannedMessagePluginMessagePart5 set_canned_message_plugin_part5 = 50;
2022-01-19 01:39:38 +00:00
2022-01-21 00:43:16 +00:00
/*
* Tell the node to shutdown in this many seconds (or <0 to cancel shutdown)
*/
int32 shutdown_seconds = 51;
}
2022-01-19 01:39:38 +00:00
} // AdminMessage