miio.integrations.scishare.coffee package

Submodules

• miio.integrations.scishare.coffee.scishare_coffeemaker module
  • ScishareCoffee
    • ScishareCoffee.actions()
    • ScishareCoffee.boil_water()
    • ScishareCoffee.brew_americano()
    • ScishareCoffee.brew_espresso()
    • ScishareCoffee.buzzer_frequency()
    • ScishareCoffee.call_action()
    • ScishareCoffee.cancel_alarm()
    • ScishareCoffee.change_setting()
    • ScishareCoffee.configure_wifi()
    • ScishareCoffee.descriptors()
    • ScishareCoffee.get_device_group()
    • ScishareCoffee.get_properties()
    • ScishareCoffee.info()
    • ScishareCoffee.off()
    • ScishareCoffee.on()
    • ScishareCoffee.preheat()
    • ScishareCoffee.raw_command()
    • ScishareCoffee.send()
    • ScishareCoffee.send_handshake()
    • ScishareCoffee.sensors()
    • ScishareCoffee.settings()
    • ScishareCoffee.status()
    • ScishareCoffee.stop_preheat()
    • ScishareCoffee.supports_miot()
    • ScishareCoffee.update()
    • ScishareCoffee.update_progress()
    • ScishareCoffee.update_state()
    • ScishareCoffee.device_id
    • ScishareCoffee.model
    • ScishareCoffee.raw_id
    • ScishareCoffee.retry_count
    • ScishareCoffee.supported_models
    • ScishareCoffee.timeout
    • ScishareCoffee.token
  • ScishareCoffeeStatus
    • ScishareCoffeeStatus.descriptors()
    • ScishareCoffeeStatus.embed()
    • ScishareCoffeeStatus.state()
  • Status
    • Status.Brewing
    • Status.CoffeeReady
    • Status.NoWater
    • Status.Off
    • Status.On
    • Status.Preheating
    • Status.SelfCheck
    • Status.Standby
    • Status.StopDescaling
    • Status.StopPreheat
    • Status.Unknown

Module contents

class miio.integrations.scishare.coffee.ScishareCoffee(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 for Scishare coffee maker (scishare.coffee.s1102).

actions() → DescriptorCollection[ActionDescriptor]

Return device actions.

boil_water(amount: int, temperature: int) → bool

Boil water.

Parameters:

• amount – in milliliters

• temperature – in degrees

brew_americano(water_amount: int, water_temperature: int, coffee_amount: int, coffee_temperature: int) → bool

Brew americano.

Parameters:

• water_amount – water in milliliters

• water_temperature – water temperature

• coffee_amount – coffee amount in milliliters

• coffee_temperature – coffee temperature

brew_espresso(amount: int, temperature: int)

Brew espresso.

Parameters:

• amount – in milliliters

• temperature – in degrees

buzzer_frequency()

Unknown.

call_action(name: str, params=None)

Call action by name.

cancel_alarm() → bool

Unknown.

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.

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

Power off.

on() → bool

Power on.

preheat(temperature: int)

Pre-heat to given temperature.

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: 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.

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() → ScishareCoffeeStatus

Device status.

stop_preheat() → bool

Stop pre-heating.

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 = ['scishare.coffee.s1102']

timeout = 5

token: str | None