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[source]

Bases: 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)[source]

Bases: Device

Main class representing the Xiaomi Aqara Camera.

alarm_sound(sound_id)[source]

List or set the alarm sound.

arm()[source]

Arm the camera?

arm_status()[source]

Return arming information.

buttons() List[ButtonDescriptor]

Return a list of button-like, clickable actions of the device.

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

Configure the wifi settings.

disarm()[source]

Disarm the camera?

flip_off()[source]

Flip off.

flip_on()[source]

Flip on.

fullstop_off()[source]

Fullstop off.

fullstop_on()[source]

Fullstop on.

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.

Returns

List of property values.

info(*, skip_cache=False) DeviceInfo

Get (and cache) miIO protocol information from the device.

This includes information about connected wlan network, and hardware and software versions.

Parameters

bool (skip_cache) – Skip the cache

ir_off()[source]

IR off.

ir_on()[source]

IR on.

led_off()[source]

LED off.

led_on()[source]

LED on.

md_off()[source]

MD off.

md_on()[source]

IR on.

md_sensitivity(sensitivity)[source]

Get or set the motion detection sensitivity.

off()[source]

Camera off.

on()[source]

Camera on.

pair(timeout: int)[source]

Start (or stop with “0”) pairing.

raw_command(command, parameters)

Send a raw command to the device. This is mostly useful when trying out commands which are not implemented by a given device instance.

Parameters
  • command (str) – Command to send

  • parameters (dict) – Parameters to send

sd_format()[source]

Format the SD card.

Returns True when formating has started successfully.

sd_status()[source]

SD card status.

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.

sensors() Dict[str, SensorDescriptor]

Return sensors.

set_alarm_volume(volume)[source]

Set alarm volume.

settings() Dict[str, SettingDescriptor]

Return list of settings.

status() CameraStatus[source]

Camera status.

switches() Dict[str, SwitchDescriptor]

Return toggleable switches.

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)[source]

Bases: object

Container for arm statuses.

alarm_volume: int
arm_wait_time: int
is_armed: bool
class miio.aqaracamera.CameraOffset(x, y, radius)[source]

Bases: object

Container for camera offset data.

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

Bases: DeviceStatus

Container for status reports from the Aqara Camera.

embed(other: DeviceStatus)

Embed another status container to current one.

This makes it easy to provide a single status response for cases where responses from multiple I/O calls is wanted to provide a simple interface for downstreams.

Internally, this will prepend the name of the other class to the property names, and override the __getattribute__ to lookup attributes in the embedded containers.

sensors() Dict[str, SensorDescriptor]

Return the dict of sensors exposed by the status container.

You can use @sensor decorator to define sensors inside your status class.

settings() Dict[str, SettingDescriptor]

Return the dict of settings exposed by the status container.

You can use @setting decorator to define sensors inside your status class.

switches() Dict[str, SwitchDescriptor]

Return the dict of sensors exposed by the status container.

You can use @sensor decorator to define sensors inside your status class.

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: 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)[source]

Bases: 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)[source]

Bases: IntEnum

State of the SD card.

FormatRequired = 2
Formating = 3
NoCardInserted = 0
Ok = 1