miio.alarmclock module

class miio.alarmclock.AlarmClock(ip: Optional[str] = None, token: Optional[str] = None, start_id: int = 0, debug: int = 0, lazy_discover: bool = True, timeout: Optional[int] = None, *, model: Optional[str] = None)[source]

Bases: miio.device.Device

Implementation of Xiao AI Smart Alarm Clock.

Note, this device is not very responsive to the requests, so it may take several seconds /tries to get an answer.

alarmops(*args, **kwargs)
cancel(*args, **kwargs)
clock_system(*args, **kwargs)
configure_wifi(ssid, password, uid=0, extra_params=None)

Configure the wifi settings.

countdown(*args, **kwargs)
get_button_light(*args, **kwargs)
get_config_version(*args, **kwargs)
classmethod get_device_group()
get_properties(properties, *, property_getter='get_prop', max_properties=None)

Request properties in slices based on given max_properties.

This is necessary as some devices have limitation on how many properties can be queried at once.

If max_properties is None, all properties are requested at once.

Parameters
  • properties (list) – List of properties to query from the device.

  • max_properties (int) – Number of properties that can be requested at once.

:return List of property values.

get_ring(*args, **kwargs)
info(*args, **kwargs)
near_wakeup(*args, **kwargs)
night_mode(*args, **kwargs)
query(*args, **kwargs)
raw_command(*args, **kwargs)
send(command: str, parameters: Optional[Any] = None, retry_count: Optional[int] = None, *, extra_parameters=None) Any

Send a command to the device.

Basic format of the request: {“id”: 1234, “method”: command, “parameters”: parameters}

extra_parameters allows passing elements to the top-level of the request. This is necessary for some devices, such as gateway devices, which expect the sub-device identifier to be on the top-level.

Parameters
  • command (str) – Command to send

  • parameters (dict) – Parameters to send

  • retry_count (int) – How many times to retry on error

  • extra_parameters (dict) – Extra top-level parameters

  • model (str) – Force model to avoid autodetection

send_handshake()

Send initial handshake to the device.

set_button_light(*args, **kwargs)
set_hourly_system(*args, **kwargs)
set_night_mode(*args, **kwargs)
set_ring(*args, **kwargs)
set_volume(*args, **kwargs)
start_countdown(*args, **kwargs)
test_properties(*args, **kwargs)
update(url: str, md5: str)

Start an OTA update.

update_progress() int

Return current update progress [0-100].

update_state()

Return current update state.

volume(*args, **kwargs)
property device_id: int

Return device id (did), if available.

property model: str

Return device model.

property raw_id: int

Return the last used protocol sequence id.

retry_count = 3
supported_models = ['zimi.clock.myk01']
timeout = 5
class miio.alarmclock.AlarmType(value)[source]

Bases: enum.Enum

An enumeration.

Alarm = 'alarm'
Reminder = 'reminder'
Timer = 'timer'
class miio.alarmclock.HourlySystem(value)[source]

Bases: enum.Enum

An enumeration.

Twelve = 12
TwentyFour = 24
class miio.alarmclock.Nightmode(data)[source]

Bases: miio.device.DeviceStatus

property enabled: bool
property end
property start
class miio.alarmclock.RingTone(data)[source]

Bases: miio.device.DeviceStatus

class miio.alarmclock.Tone(value)[source]

Bases: enum.Enum

An enumeration.

Fifth = 'a5.mp3'
First = 'a1.mp3'
Fourth = 'a4.mp3'
Second = 'a2.mp3'
Seventh = 'a7.mp3'
Sixth = 'a6.mp3'
Third = 'a3.mp3'