Skip to content

System console request models

Fields below preserve source annotations and defaults.

WifiConnectPayload

Source: hr_system_console/api/system_console/main.py, line 31

ssid: str
password: str = ''

WifiForgetPayload

Source: hr_system_console/api/system_console/main.py, line 36

ssid: str

WifiDisconnectPayload

Source: hr_system_console/api/system_console/main.py, line 40

device: str = ''

InternetSharingPayload

Source: hr_system_console/api/system_console/main.py, line 44

targetDevice: str = ''

EthernetPayload

Source: hr_system_console/api/system_console/main.py, line 48

values: Dict[str, Any]

EthernetDevicePayload

Source: hr_system_console/api/system_console/main.py, line 52

device: str
enabled: bool

EthernetTokenPayload

Source: hr_system_console/api/system_console/main.py, line 57

token: str

DefaultAudioPayload

Source: hr_system_console/api/system_console/main.py, line 61

kind: str
name: str

VolumePayload

Source: hr_system_console/api/system_console/main.py, line 66

kind: str
name: str
volume: int

ChannelMapPayload

Source: hr_system_console/api/system_console/main.py, line 72

name: str
channels: Dict[str, int]

RoutingConnectionPayload

Source: hr_system_console/api/system_console/main.py, line 77

sourceChannel: str
targetChannel: str
gain: int = 100

RoutingApplyPayload

Source: hr_system_console/api/system_console/main.py, line 83

physicalSink: str = ''
connections: Optional[List[RoutingConnectionPayload]] = None
preset: str = ''
persist: bool = False

RoutingPresetPayload

Source: hr_system_console/api/system_console/main.py, line 90

preset: str
physicalSink: str = ''
persist: bool = True

RoutingTonePayload

Source: hr_system_console/api/system_console/main.py, line 96

channel: str
sink: str = ''
seconds: float = 1.0
mode: str = 'voice'

AudioChoicePayload

Source: hr_system_console/api/system_console/main.py, line 103

name: str = ''
cardName: str = ''
profileName: str = ''

HrsdkConfigPayload

Source: hr_system_console/api/system_console/main.py, line 109

values: Dict[str, str]

RuntimeSecretsPayload

Source: hr_system_console/api/system_console/main.py, line 113

set: Dict[str, str] = Field(default_factory=dict)
clear: List[str] = Field(default_factory=list)

HrsdkContainerPayload

Source: hr_system_console/api/system_console/main.py, line 118

repository: str

SetupPayload

Source: hr_system_console/api/system_console/main.py, line 122

values: Dict[str, Any]

ReleasePayload

Source: hr_system_console/api/system_console/main.py, line 126

version: str = ''
configRef: str = ''

RustdeskPasswordPayload

Source: hr_system_console/api/system_console/main.py, line 131

password: str

RustdeskVirtualDisplayPayload

Source: hr_system_console/api/system_console/main.py, line 135

enabled: bool

ServoTargetPayload

Source: hr_system_console/api/system_console/main.py, line 139

port: str
baud: int = 1000000
family: str = 'sms_sts'
servoId: int

ServoScanPayload

Source: hr_system_console/api/system_console/main.py, line 146

port: str
baud: int = 1000000
family: str = 'sms_sts'
fromId: int = 0
toId: int = 253

ServoWritePayload

Source: hr_system_console/api/system_console/main.py, line 154

port: str
baud: int = 1000000
family: str = 'sms_sts'
servoId: int
address: int
value: int

ServoConfigPayload

Source: hr_system_console/api/system_console/main.py, line 159

robotName: str = ''
robotBody: str = ''

ServoMovePayload

Source: hr_system_console/api/system_console/main.py, line 164

port: str
baud: int = 1000000
family: str = 'sms_sts'
servoId: int
robotName: str = ''
robotBody: str = ''
position: int
speed: int