Models¶
Typed views of the cloud JSON payloads.
Field names on the wire are the Java field names of the app's Gson models (no naming policy, nulls omitted). Yes/no flags are the strings "S"/"N". Each model keeps the raw JSON it was built from so write endpoints (which often re-post whole objects, e.g. room-setup) can echo unknown fields back unchanged.
dataclass
¶
Installation(
id_installation: int,
id_installation_device: int,
inst_code: str,
description: str,
firmware_version: str,
active_timer: bool,
workdays: str,
installation_order: int,
raw: JsonDict,
)
dataclass
¶
Command(
id_installation_device_command: int,
id_installation_device: int,
id_devicetype_command_model: int,
command_action: str,
command_param: str,
lowlevel_command: str,
command_index: int,
raw: JsonDict,
)
A command a device accepts (element of deviceCommandList / CommandCloud).
dataclass
¶
Timer(
id_installation_device_timer: int,
id_installation_device_command: int,
timer_order: int,
timer_date: str,
active: bool,
days: str,
twilight: bool,
sun_event: int,
twilight_offset: int,
command_param: str,
raw: JsonDict,
)
A device timer (TimerCloud).
dataclass
¶
DeviceInfo(
id_installation_device: int,
id_devicemodel: int,
id_devicetype: int,
device_code: int,
device_index: int,
device_order: int,
label: str,
sub_model: str,
favorite: bool,
feedback: bool,
direct_only: bool,
active_timer: bool,
commands: list[Command],
timers: list[Timer],
raw: JsonDict,
)
A device as configured in the cloud (DeviceCloud).
dataclass
¶
Room(
id_installation_room: int,
id_roomtype: int,
description: str,
order: int,
devices: list[DeviceInfo],
raw: JsonDict,
)
A room and its devices (RoomCloud).
dataclass
¶
StatusItem(
status_item: str,
status_value: str,
statusitem_code: str,
lowlevel_statusitem: str,
id_installation_device_statusitem: int,
id_devicetype_statusitem_model: int,
)
One entry of status-device-list.
dataclass
¶
A step of a scenario (idInstallationDeviceCommand + value).
dataclass
¶
Scenario(
id_installation_scenario: int,
description: str,
icon: int,
order: int,
id_installation_room: int,
steps: list[ScenarioStep],
id_installation_device: int,
raw: JsonDict,
)
A scenario (ScenarioCloud).