miio.integrations.dmaker.airfresh.airfresh_t2017 module

class miio.integrations.dmaker.airfresh.airfresh_t2017.AirFreshA1(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)[source]

Bases: Device

Main class representing the air fresh a1.

actions() → DescriptorCollection[ActionDescriptor]: Return device actions.

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.

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.

get_ptc_timer()[source]

Returns a list of PTC timers.

Response unknown.

get_timer()[source]: Response unknown.

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

off()[source]: Power off.

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

reset_dust_filter()[source]: Resets filter lifetime of the dust filter.

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_buzzer(buzzer: bool)[source]: Set sound on/off.

set_child_lock(lock: bool)[source]: Set child lock on/off.

set_display(display: bool)[source]: Turn led on/off.

set_favorite_speed(speed: int)[source]: Sets the fan speed in favorite mode.

set_mode(mode: OperationMode)[source]: Set mode.

set_ptc(ptc: bool)[source]: Turn ptc on/off.

set_ptc_timer()[source]

Set PTC timer (not implemented)

Value construction:

value = time.index + '-' +
    time.hexSum + '-' +
    time.startTime + '-' +
    time.ptcTimer.endTime + '-' +
    time.level + '-' +
    time.status;
return self.send("set_ptc_timer", [value])

settings() → DescriptorCollection[PropertyDescriptor]: Return settable properties.

status() → AirFreshStatus[source]: 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.

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 = ['dmaker.airfresh.t2017', 'dmaker.airfresh.a1']

timeout = 5

token: str | None

class miio.integrations.dmaker.airfresh.airfresh_t2017.AirFreshStatus(data: Dict[str, Any])[source]

Bases: DeviceStatus

Container for status reports from the air fresh t2017.

descriptors() → DescriptorCollection[PropertyDescriptor]

Return the dict of sensors exposed by the status container.

Use @sensor and @setting decorators to define properties.

embed(name: str, 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 attribute names, and override the __getattribute__ to lookup attributes in the embedded containers.

property buzzer: bool: Return True if sound is on.

property child_lock: bool: Return True if child lock is on.

property co2: int: Carbon dioxide.

property control_speed: int: Control speed.

property display: bool: Return True if the display is on.

property display_orientation: DisplayOrientation | None: Display orientation.

property dust_filter_life_remaining: int | None: Remaining dust filter life in percent.

property dust_filter_life_remaining_days: int | None: Remaining dust filter life in days.

property favorite_speed: int: Favorite speed.

property is_on: bool: Return True if device is on.

property mode: OperationMode: Current operation mode.

property pm25: int: Fine particulate patter (PM2.5).

property power: str: Power state.

property ptc: bool: Return True if PTC is on.

property ptc_level: PtcLevel | None: PTC level.

property ptc_status: bool: Return true if PTC status is on.

property temperature: int: Current temperature in degree celsions.

property upper_filter_life_remaining: int | None: Remaining upper filter life in percent.

property upper_filter_life_remaining_days: int | None: Remaining upper filter life in days.

class miio.integrations.dmaker.airfresh.airfresh_t2017.AirFreshT2017(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)[source]

Bases: AirFreshA1

Main class representing the air fresh t2017.

actions() → DescriptorCollection[ActionDescriptor]: Return device actions.

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.

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.

get_ptc_timer()

Returns a list of PTC timers.

Response unknown.

get_timer(): Response unknown.

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

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

reset_dust_filter()[source]: Resets filter lifetime of the dust filter.

reset_upper_filter()[source]: Resets filter lifetime of the upper filter.

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_buzzer(buzzer: bool): Set sound on/off.

set_child_lock(lock: bool): Set child lock on/off.

set_display(display: bool): Turn led on/off.

set_display_orientation(orientation: DisplayOrientation)[source]: Set display orientation.

set_favorite_speed(speed: int)[source]: Sets the fan speed in favorite mode.

set_mode(mode: OperationMode): Set mode.

set_ptc(ptc: bool): Turn ptc on/off.

set_ptc_level(level: PtcLevel)[source]: Set PTC level.

set_ptc_timer()

Set PTC timer (not implemented)

Value construction:

value = time.index + '-' +
    time.hexSum + '-' +
    time.startTime + '-' +
    time.ptcTimer.endTime + '-' +
    time.level + '-' +
    time.status;
return self.send("set_ptc_timer", [value])

settings() → DescriptorCollection[PropertyDescriptor]: Return settable properties.

status() → AirFreshStatus: 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.

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 = ['dmaker.airfresh.t2017', 'dmaker.airfresh.a1']

timeout = 5

token: str | None

class miio.integrations.dmaker.airfresh.airfresh_t2017.DisplayOrientation(value)[source]

Bases: Enum

An enumeration.

LandscapeLeft = 'left'

LandscapeRight = 'right'

Portrait = 'forward'

class miio.integrations.dmaker.airfresh.airfresh_t2017.OperationMode(value)[source]

Bases: Enum

An enumeration.

Auto = 'auto'

Favorite = 'favourite'

Off = 'off'

Sleep = 'sleep'

class miio.integrations.dmaker.airfresh.airfresh_t2017.PtcLevel(value)[source]

Bases: Enum

An enumeration.

High = 'high'

Low = 'low'

Medium = 'medium'