miio.integrations.lumi.camera package

Submodules

• miio.integrations.lumi.camera.aqaracamera module
  • AqaraCamera
    • AqaraCamera.actions()
    • AqaraCamera.alarm_sound()
    • AqaraCamera.arm()
    • AqaraCamera.arm_status()
    • AqaraCamera.call_action()
    • AqaraCamera.change_setting()
    • AqaraCamera.configure_wifi()
    • AqaraCamera.descriptors()
    • AqaraCamera.disarm()
    • AqaraCamera.flip_off()
    • AqaraCamera.flip_on()
    • AqaraCamera.fullstop_off()
    • AqaraCamera.fullstop_on()
    • AqaraCamera.get_device_group()
    • AqaraCamera.get_properties()
    • AqaraCamera.info()
    • AqaraCamera.ir_off()
    • AqaraCamera.ir_on()
    • AqaraCamera.led_off()
    • AqaraCamera.led_on()
    • AqaraCamera.md_off()
    • AqaraCamera.md_on()
    • AqaraCamera.md_sensitivity()
    • AqaraCamera.off()
    • AqaraCamera.on()
    • AqaraCamera.pair()
    • AqaraCamera.raw_command()
    • AqaraCamera.sd_format()
    • AqaraCamera.sd_status()
    • AqaraCamera.send()
    • AqaraCamera.send_handshake()
    • AqaraCamera.sensors()
    • AqaraCamera.set_alarm_volume()
    • AqaraCamera.settings()
    • AqaraCamera.status()
    • AqaraCamera.supports_miot()
    • AqaraCamera.update()
    • AqaraCamera.update_progress()
    • AqaraCamera.update_state()
    • AqaraCamera.device_id
    • AqaraCamera.model
    • AqaraCamera.raw_id
    • AqaraCamera.retry_count
    • AqaraCamera.supported_models
    • AqaraCamera.timeout
    • AqaraCamera.token
  • ArmStatus
    • ArmStatus.alarm_volume
    • ArmStatus.arm_wait_time
    • ArmStatus.is_armed
  • CameraOffset
  • CameraStatus
    • CameraStatus.descriptors()
    • CameraStatus.embed()
    • CameraStatus.av_id
    • CameraStatus.av_password
    • CameraStatus.channel_id
    • CameraStatus.flipped
    • CameraStatus.fullstop
    • CameraStatus.ir
    • CameraStatus.is_on
    • CameraStatus.led
    • CameraStatus.md
    • CameraStatus.md_sensitivity
    • CameraStatus.offsets
    • CameraStatus.p2p_id
    • CameraStatus.type
    • CameraStatus.video_status
  • MotionDetectionSensitivity
    • MotionDetectionSensitivity.High
    • MotionDetectionSensitivity.Low
    • MotionDetectionSensitivity.Medium
  • SDCardStatus
    • SDCardStatus.FormatRequired
    • SDCardStatus.Formating
    • SDCardStatus.NoCardInserted
    • SDCardStatus.Ok

Module contents

class miio.integrations.lumi.camera.AqaraCamera(ip: str | None = None, token: str | None = None, start_id: int = 0, debug: int = 0, lazy_discover: bool = True, timeout: int | None = None, *, model: str | None = None)

Bases: Device

Main class representing the Xiaomi Aqara Camera.

actions() → DescriptorCollection[ActionDescriptor]

Return device actions.

alarm_sound(sound_id)

List or set the alarm sound.

arm()

Arm the camera?

arm_status()

Return arming information.

call_action(name: str, params=None)

Call action by name.

change_setting(name: str, params=None)

Change setting value.

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

Configure the wifi settings.

descriptors() → DescriptorCollection[Descriptor]

Return a collection containing all descriptors for the device.

disarm()

Disarm the camera?

flip_off()

Flip off.

flip_on()

Flip on.

fullstop_off()

Fullstop off.

fullstop_on()

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()

IR off.

ir_on()

IR on.

led_off()

LED off.

led_on()

LED on.

md_off()

MD off.

md_on()

IR on.

md_sensitivity(sensitivity)

Get or set the motion detection sensitivity.

off()

Camera off.

on()

Camera on.

pair(timeout: int)

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()

Format the SD card.

Returns True when formating has started successfully.

sd_status()

SD card status.

send(command: str, parameters: Any | None = None, retry_count: int | None = 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() → DescriptorCollection[PropertyDescriptor]

Return read-only properties.

set_alarm_volume(volume)

Set alarm volume.

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() → CameraStatus

Camera status.

supports_miot() → bool

Return True if the device supports miot commands.

This requests a single property (siid=1, piid=1) and returns True on success.

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 the device id (did).

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

token: str | None