miio.aqaracamera module

Aqara camera support.

Support for lumi.camera.aq1

Todo

add alarm/sound parts (get_music_info, {get,set}_alarming_volume, set_default_music, play_music_new, set_sound_playing)

Todo

add sdcard status & fix all TODOS

Todo

add tests

exception miio.aqaracamera.CameraException

Bases: miio.exceptions.DeviceException

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

class miio.aqaracamera.AqaraCamera(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)

Bases: miio.device.Device

Main class representing the Xiaomi Aqara Camera.

alarm_sound(*args, **kwargs)

arm(*args, **kwargs)

arm_status(*args, **kwargs)

configure_wifi(ssid, password, uid=0, extra_params=None)

Configure the wifi settings.

disarm(*args, **kwargs)

flip_off(*args, **kwargs)

flip_on(*args, **kwargs)

fullstop_off(*args, **kwargs)

fullstop_on(*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.

info(*args, **kwargs)

ir_off(*args, **kwargs)

ir_on(*args, **kwargs)

led_off(*args, **kwargs)

led_on(*args, **kwargs)

md_off(*args, **kwargs)

md_on(*args, **kwargs)

md_sensitivity(*args, **kwargs)

off(*args, **kwargs)

on(*args, **kwargs)

pair(*args, **kwargs)

raw_command(*args, **kwargs)

sd_format(*args, **kwargs)

sd_status(*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_alarm_volume(*args, **kwargs)

status(*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.

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 = ['lumi.camera.aq1', 'lumi.camera.aq2']

timeout = 5

class miio.aqaracamera.ArmStatus(is_armed, arm_wait_time, alarm_volume)

Bases: object

Container for arm statuses.

alarm_volume: int

arm_wait_time: int

is_armed: bool

class miio.aqaracamera.CameraOffset(x, y, radius)

Bases: object

Container for camera offset data.

class miio.aqaracamera.CameraStatus(data: Dict[str, Any])

Bases: miio.device.DeviceStatus

Container for status reports from the Aqara Camera.

property av_id: str

TODO: What is this? ID for the cloud?

property av_password: str

TODO: What is this? Password for the cloud?

property channel_id: int

TODO: Zigbee channel?

property flipped: bool

TODO: If camera is flipped?

property fullstop: bool

Is alarm triggered by MD.

property ir

IR mode.

property is_on: bool

True if device is currently on.

property led

LED status.

property md: bool

Motion detection state.

property md_sensitivity

Motion detection sensitivity.

property offsets: miio.aqaracamera.CameraOffset

Camera offset information.

property p2p_id: str

P2P ID for video and audio.

property type: str

TODO: Type of the camera? Name?

property video_status: bool

Video state.

class miio.aqaracamera.MotionDetectionSensitivity(value)

Bases: enum.IntEnum

‘Default’ values for md sensitivity.

Currently unused as the value can also be set arbitrarily.

High = 6000000

Low = 11000000

Medium = 10000000

class miio.aqaracamera.SDCardStatus(value)

Bases: enum.IntEnum

State of the SD card.

FormatRequired = 2

Formating = 3

NoCardInserted = 0

Ok = 1