miio.cooker module

exception miio.cooker.CookerException[source]

Bases: DeviceException

with_traceback()

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

args
class miio.cooker.Cooker(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 chunmi.cooker.*.

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.

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

Retrieves a temperature history.

The temperature is only available while cooking. Approx. six data points per minute.

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

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

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

Enable warnings?

set_interaction(settings: CookerSettings, timeouts: InteractionTimeouts)[source]

Set interaction.

Supported by all cookers except MODEL_PRESS1

set_menu(profile: str)[source]

Select one of the default(?) cooking profiles.

set_no_warnings()[source]

Disable warnings.

settings() Dict[str, SettingDescriptor]

Return list of settings.

start(profile: str)[source]

Start cooking a profile.

status() CookerStatus[source]

Retrieve properties.

stop()[source]

Stop cooking.

stop_outdated_firmware()[source]

Stop cooking (obsolete).

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 = ['chunmi.cooker.normal1', 'chunmi.cooker.normal2', 'chunmi.cooker.normal3', 'chunmi.cooker.normal4', 'chunmi.cooker.normal5', 'chunmi.cooker.press1', 'chunmi.cooker.press2']
timeout = 5
class miio.cooker.CookerCustomizations(custom: str)[source]

Bases: DeviceStatus

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 favorite_appointment: time
property favorite_cooking: time
property jingzhu_appointment: time
property kuaizhu_appointment: time
property zhuzhou_appointment: time
property zhuzhou_cooking: time
class miio.cooker.CookerSettings(settings: Optional[str] = None)[source]

Bases: DeviceStatus

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 auto_keep_warm: bool
property favorite_auto_keep_warm: bool
property jingzhu_auto_keep_warm: bool
property kuaizhu_auto_keep_warm: bool
property led_on: bool
property lid_open_warning: bool
property lid_open_warning_delayed: bool
property pressure_supported: bool
property zhuzhou_auto_keep_warm: bool
class miio.cooker.CookerStatus(data)[source]

Bases: DeviceStatus

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 cooker_settings: CookerSettings

Settings of the cooker.

property cooking_delayed: Optional[int]

Wait n minutes before cooking / scheduled cooking.

property custom: Optional[CookerCustomizations]
property duration: int

Duration of the cooking process.

property favorite: int

Favored recipe id.

Can be compared with the menu property.

property firmware_version: int

Firmware version.

property hardware_version: int

Hardware version.

property interaction_timeouts: InteractionTimeouts

Interaction timeouts.

property menu: int

Selected recipe id.

property mode: OperationMode

Current operation mode.

property remaining: int

Remaining minutes of the cooking process.

property stage: Optional[CookingStage]

Current stage if cooking.

property start_time: Optional[time]

Start time of cooking?

The property “temp” is used for different purposes. Example values: 29, 031e0b23, 031e0b23031e

property temperature: Optional[int]

Current temperature, if idle.

Example values: 29, 031e0b23, 031e0b23031e

class miio.cooker.CookingStage(stage: str)[source]

Bases: DeviceStatus

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 description: str
property name: str
property raw: str
property rice_id: int
property state: int

10: Cooking finished 11: Cooking finished 12: Cooking finished

property taste: int
property taste_phase: int
class miio.cooker.InteractionTimeouts(timeouts: Optional[str] = None)[source]

Bases: DeviceStatus

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 led_off: int
property lid_open: int
property lid_open_warning: int
class miio.cooker.OperationMode(value)[source]

Bases: Enum

An enumeration.

AutoKeepWarm = 'autokeepwarm'
Cancel = 'Отмена'
Cooking = 'cooking'
Finish = 'finish'
FinishA = 'finisha'
KeepTemp = 'keep_temp'
KeepWarm = 'keepwarm'
Notice = 'notice'
Offline = 'offline'
Online = 'online'
PreCook = 'precook'
Resume = 'resume'
ResumeP = 'resumep'
Running = 'running'
Start = 'start'
StartP = 'startp'
Waiting = 'waiting'
class miio.cooker.TemperatureHistory(data: str)[source]

Bases: DeviceStatus

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 raw: str
property temperatures: List[int]