AdminMessage: Message<"meshtastic.AdminMessage"> & {
    payloadVariant:
        | {
            case: "getChannelRequest";
            value: number;
        }
        | {
            case: "getChannelResponse";
            value: Channel;
        }
        | {
            case: "getOwnerRequest";
            value: boolean;
        }
        | {
            case: "getOwnerResponse";
            value: User;
        }
        | {
            case: "getConfigRequest";
            value: AdminMessage_ConfigType;
        }
        | {
            case: "getConfigResponse";
            value: Config;
        }
        | {
            case: "getModuleConfigRequest";
            value: AdminMessage_ModuleConfigType;
        }
        | {
            case: "getModuleConfigResponse";
            value: ModuleConfig;
        }
        | {
            case: "getCannedMessageModuleMessagesRequest";
            value: boolean;
        }
        | {
            case: "getCannedMessageModuleMessagesResponse";
            value: string;
        }
        | {
            case: "getDeviceMetadataRequest";
            value: boolean;
        }
        | {
            case: "getDeviceMetadataResponse";
            value: DeviceMetadata;
        }
        | {
            case: "getRingtoneRequest";
            value: boolean;
        }
        | {
            case: "getRingtoneResponse";
            value: string;
        }
        | {
            case: "getDeviceConnectionStatusRequest";
            value: boolean;
        }
        | {
            case: "getDeviceConnectionStatusResponse";
            value: DeviceConnectionStatus;
        }
        | {
            case: "setHamMode";
            value: HamParameters;
        }
        | {
            case: "getNodeRemoteHardwarePinsRequest";
            value: boolean;
        }
        | {
            case: "getNodeRemoteHardwarePinsResponse";
            value: NodeRemoteHardwarePinsResponse;
        }
        | {
            case: "enterDfuModeRequest";
            value: boolean;
        }
        | {
            case: "deleteFileRequest";
            value: string;
        }
        | {
            case: "setScale";
            value: number;
        }
        | {
            case: "setOwner";
            value: User;
        }
        | {
            case: "setChannel";
            value: Channel;
        }
        | {
            case: "setConfig";
            value: Config;
        }
        | {
            case: "setModuleConfig";
            value: ModuleConfig;
        }
        | {
            case: "setCannedMessageModuleMessages";
            value: string;
        }
        | {
            case: "setRingtoneMessage";
            value: string;
        }
        | {
            case: "removeByNodenum";
            value: number;
        }
        | {
            case: "setFavoriteNode";
            value: number;
        }
        | {
            case: "removeFavoriteNode";
            value: number;
        }
        | {
            case: "setFixedPosition";
            value: Position;
        }
        | {
            case: "removeFixedPosition";
            value: boolean;
        }
        | {
            case: "setTimeOnly";
            value: number;
        }
        | {
            case: "getUiConfigRequest";
            value: boolean;
        }
        | {
            case: "getUiConfigResponse";
            value: DeviceUIConfig;
        }
        | {
            case: "storeUiConfig";
            value: DeviceUIConfig;
        }
        | {
            case: "beginEditSettings";
            value: boolean;
        }
        | {
            case: "commitEditSettings";
            value: boolean;
        }
        | {
            case: "factoryResetDevice";
            value: number;
        }
        | {
            case: "rebootOtaSeconds";
            value: number;
        }
        | {
            case: "exitSimulator";
            value: boolean;
        }
        | {
            case: "rebootSeconds";
            value: number;
        }
        | {
            case: "shutdownSeconds";
            value: number;
        }
        | {
            case: "factoryResetConfig";
            value: number;
        }
        | {
            case: "nodedbReset";
            value: number;
        }
        | {
            case: undefined;
            value?: undefined;
        };
    sessionPasskey: Uint8Array;
}

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)

Type declaration

  • payloadVariant:
        | {
            case: "getChannelRequest";
            value: number;
        }
        | {
            case: "getChannelResponse";
            value: Channel;
        }
        | {
            case: "getOwnerRequest";
            value: boolean;
        }
        | {
            case: "getOwnerResponse";
            value: User;
        }
        | {
            case: "getConfigRequest";
            value: AdminMessage_ConfigType;
        }
        | {
            case: "getConfigResponse";
            value: Config;
        }
        | {
            case: "getModuleConfigRequest";
            value: AdminMessage_ModuleConfigType;
        }
        | {
            case: "getModuleConfigResponse";
            value: ModuleConfig;
        }
        | {
            case: "getCannedMessageModuleMessagesRequest";
            value: boolean;
        }
        | {
            case: "getCannedMessageModuleMessagesResponse";
            value: string;
        }
        | {
            case: "getDeviceMetadataRequest";
            value: boolean;
        }
        | {
            case: "getDeviceMetadataResponse";
            value: DeviceMetadata;
        }
        | {
            case: "getRingtoneRequest";
            value: boolean;
        }
        | {
            case: "getRingtoneResponse";
            value: string;
        }
        | {
            case: "getDeviceConnectionStatusRequest";
            value: boolean;
        }
        | {
            case: "getDeviceConnectionStatusResponse";
            value: DeviceConnectionStatus;
        }
        | {
            case: "setHamMode";
            value: HamParameters;
        }
        | {
            case: "getNodeRemoteHardwarePinsRequest";
            value: boolean;
        }
        | {
            case: "getNodeRemoteHardwarePinsResponse";
            value: NodeRemoteHardwarePinsResponse;
        }
        | {
            case: "enterDfuModeRequest";
            value: boolean;
        }
        | {
            case: "deleteFileRequest";
            value: string;
        }
        | {
            case: "setScale";
            value: number;
        }
        | {
            case: "setOwner";
            value: User;
        }
        | {
            case: "setChannel";
            value: Channel;
        }
        | {
            case: "setConfig";
            value: Config;
        }
        | {
            case: "setModuleConfig";
            value: ModuleConfig;
        }
        | {
            case: "setCannedMessageModuleMessages";
            value: string;
        }
        | {
            case: "setRingtoneMessage";
            value: string;
        }
        | {
            case: "removeByNodenum";
            value: number;
        }
        | {
            case: "setFavoriteNode";
            value: number;
        }
        | {
            case: "removeFavoriteNode";
            value: number;
        }
        | {
            case: "setFixedPosition";
            value: Position;
        }
        | {
            case: "removeFixedPosition";
            value: boolean;
        }
        | {
            case: "setTimeOnly";
            value: number;
        }
        | {
            case: "getUiConfigRequest";
            value: boolean;
        }
        | {
            case: "getUiConfigResponse";
            value: DeviceUIConfig;
        }
        | {
            case: "storeUiConfig";
            value: DeviceUIConfig;
        }
        | {
            case: "beginEditSettings";
            value: boolean;
        }
        | {
            case: "commitEditSettings";
            value: boolean;
        }
        | {
            case: "factoryResetDevice";
            value: number;
        }
        | {
            case: "rebootOtaSeconds";
            value: number;
        }
        | {
            case: "exitSimulator";
            value: boolean;
        }
        | {
            case: "rebootSeconds";
            value: number;
        }
        | {
            case: "shutdownSeconds";
            value: number;
        }
        | {
            case: "factoryResetConfig";
            value: number;
        }
        | {
            case: "nodedbReset";
            value: number;
        }
        | {
            case: undefined;
            value?: undefined;
        }

    TODO: REPLACE

    from oneof meshtastic.AdminMessage.payload_variant

  • sessionPasskey: Uint8Array

    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.

    from field: bytes session_passkey = 101;

from message meshtastic.AdminMessage