miio.integrations.chuangmi.camera package

Submodules

• miio.integrations.chuangmi.camera.chuangmi_camera module
  • CameraStatus
    • CameraStatus.descriptors()
    • CameraStatus.embed()
    • CameraStatus.flip
    • CameraStatus.full_color
    • CameraStatus.improve_program
    • CameraStatus.light
    • CameraStatus.max_client
    • CameraStatus.mini_level
    • CameraStatus.motion_record
    • CameraStatus.night_mode
    • CameraStatus.power
    • CameraStatus.sdcard_status
    • CameraStatus.track
    • CameraStatus.watermark
    • CameraStatus.wdr
  • ChuangmiCamera
    • ChuangmiCamera.actions()
    • ChuangmiCamera.alarm()
    • ChuangmiCamera.call_action()
    • ChuangmiCamera.change_setting()
    • ChuangmiCamera.clear_nas_dir()
    • ChuangmiCamera.configure_wifi()
    • ChuangmiCamera.descriptors()
    • ChuangmiCamera.flip_off()
    • ChuangmiCamera.flip_on()
    • ChuangmiCamera.full_color_off()
    • ChuangmiCamera.full_color_on()
    • ChuangmiCamera.get_device_group()
    • ChuangmiCamera.get_nas_config()
    • ChuangmiCamera.get_properties()
    • ChuangmiCamera.improve_program_off()
    • ChuangmiCamera.improve_program_on()
    • ChuangmiCamera.info()
    • ChuangmiCamera.light_off()
    • ChuangmiCamera.light_on()
    • ChuangmiCamera.motion_record_off()
    • ChuangmiCamera.motion_record_on()
    • ChuangmiCamera.motion_record_stop()
    • ChuangmiCamera.night_mode_auto()
    • ChuangmiCamera.night_mode_off()
    • ChuangmiCamera.night_mode_on()
    • ChuangmiCamera.off()
    • ChuangmiCamera.on()
    • ChuangmiCamera.raw_command()
    • ChuangmiCamera.rotate()
    • ChuangmiCamera.send()
    • ChuangmiCamera.send_handshake()
    • ChuangmiCamera.sensors()
    • ChuangmiCamera.set_home_monitoring_config()
    • ChuangmiCamera.set_motion_sensitivity()
    • ChuangmiCamera.set_nas_config()
    • ChuangmiCamera.settings()
    • ChuangmiCamera.status()
    • ChuangmiCamera.supports_miot()
    • ChuangmiCamera.update()
    • ChuangmiCamera.update_progress()
    • ChuangmiCamera.update_state()
    • ChuangmiCamera.watermark_off()
    • ChuangmiCamera.watermark_on()
    • ChuangmiCamera.wdr_off()
    • ChuangmiCamera.wdr_on()
    • ChuangmiCamera.device_id
    • ChuangmiCamera.model
    • ChuangmiCamera.raw_id
    • ChuangmiCamera.retry_count
    • ChuangmiCamera.supported_models
    • ChuangmiCamera.timeout
    • ChuangmiCamera.token
  • Direction
    • Direction.Down
    • Direction.Left
    • Direction.Right
    • Direction.Up
  • HomeMonitoringMode
    • HomeMonitoringMode.AllDay
    • HomeMonitoringMode.Custom
    • HomeMonitoringMode.Off
  • MotionDetectionSensitivity
    • MotionDetectionSensitivity.High
    • MotionDetectionSensitivity.Low
  • NASState
    • NASState.Off
    • NASState.On
  • NASSyncInterval
    • NASSyncInterval.Day
    • NASSyncInterval.Hour
    • NASSyncInterval.Realtime
  • NASVideoRetentionTime
    • NASVideoRetentionTime.HalfYear
    • NASVideoRetentionTime.Month
    • NASVideoRetentionTime.Quarter
    • NASVideoRetentionTime.Week
    • NASVideoRetentionTime.Year

Module contents

class miio.integrations.chuangmi.camera.ChuangmiCamera(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 Chuangmi Camera.

actions() → DescriptorCollection[ActionDescriptor]

Return device actions.

alarm()

Sound a loud alarm for 10 seconds.

call_action(name: str, params=None)

Call action by name.

change_setting(name: str, params=None)

Change setting value.

clear_nas_dir()

Clear NAS directory.

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.

flip_off()

Flip image 180 degrees off.

flip_on()

Flip image 180 degrees on.

full_color_off()

Full color off.

full_color_on()

Full color on.

classmethod get_device_group()

get_nas_config()

Get NAS config info.

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.

improve_program_off()

Improve program off.

improve_program_on()

Improve program on.

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

light_off()

Light off.

light_on()

Light on.

motion_record_off()

Motion record off, always record video.

motion_record_on()

Start recording when motion detected.

motion_record_stop()

Motion record off, video recording stopped.

night_mode_auto()

Auto switch to night mode.

night_mode_off()

Night mode off.

night_mode_on()

Night mode always on.

off()

Power off.

on()

Power on.

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

rotate(direction: Direction)

Rotate camera to given direction (left, right, up, down).

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_home_monitoring_config(mode: HomeMonitoringMode = HomeMonitoringMode.AllDay, start_hour: int = 10, start_minute: int = 0, end_hour: int = 17, end_minute: int = 0, notify: int = 1, interval: int = 5)

Set home monitoring configuration.

set_motion_sensitivity(sensitivity: MotionDetectionSensitivity)

Set motion sensitivity (high, low).

set_nas_config(state: NASState, share=None, sync_interval: NASSyncInterval = NASSyncInterval.Realtime, video_retention_time: NASVideoRetentionTime = NASVideoRetentionTime.Week)

Set NAS configuration.

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() → CameraStatus

Retrieve properties.

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.

watermark_off()

Watermark off.

watermark_on()

Watermark on.

wdr_off()

Wide dynamic range off.

wdr_on()

Wide dynamic range on.

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 = ['chuangmi.camera.ipc009', 'chuangmi.camera.ipc013', 'chuangmi.camera.ipc019', 'chuangmi.camera.021a04', 'chuangmi.camera.038a2']

timeout = 5

token: str | None