miio.integrations.light.yeelight.yeelight module

exception miio.integrations.light.yeelight.yeelight.YeelightException

Bases: miio.exceptions.DeviceException

with_traceback()

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

args

class miio.integrations.light.yeelight.yeelight.Yeelight(ip: Optional[str] = None, token: Optional[str] = None, start_id: int = 0, debug: int = 0, lazy_discover: bool = True, model: Optional[str] = None)

Bases: miio.device.Device

A rudimentary support for Yeelight bulbs.

The API is the same as defined in https://www.yeelight.com/download/Yeelight_Inter-Operation_Spec.pdf and only partially implmented here.

For a more complete implementation please refer to python-yeelight package (https://yeelight.readthedocs.io/en/latest/), which however requires enabling the developer mode on the bulbs.

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

Configure the wifi settings.

dump_ble_debug(*args, **kwargs)

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.

:return List of property values.

info(*args, **kwargs)

off(*args, **kwargs)

on(*args, **kwargs)

raw_command(*args, **kwargs)

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.

set_brightness(*args, **kwargs)

set_color_temp(*args, **kwargs)

set_default(*args, **kwargs)

set_developer_mode(*args, **kwargs)

set_hsv(hsv)

Set color in HSV.

set_name(*args, **kwargs)

set_rgb(*args, **kwargs)

set_save_state_on_change(*args, **kwargs)

set_scene(scene, *vals)

Set the scene.

status(*args, **kwargs)

test_properties(*args, **kwargs)

toggle(*args, **kwargs)

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 = []

timeout = 5

token: Optional[str]

property valid_temperature_range: miio.integrations.light.yeelight.spec_helper.ColorTempRange

class miio.integrations.light.yeelight.yeelight.YeelightMode(value)

Bases: enum.IntEnum

An enumeration.

ColorTemperature = 2

HSV = 3

RGB = 1

class miio.integrations.light.yeelight.yeelight.YeelightStatus(data)

Bases: miio.device.DeviceStatus

property brightness: int

Return current brightness.

property cli_format: str

Return human readable sub lights string.

property color_flow_params: Optional[str]

Return color flowing params.

property color_flowing: bool

Return whether the color flowing is active.

property color_mode: miio.integrations.light.yeelight.yeelight.YeelightMode

Return current color mode.

property color_temp: Optional[int]

Return current color temperature, if applicable.

property delay_off: int

Return delay in minute before bulb is off.

property developer_mode: Optional[bool]

Return whether the developer mode is active.

property hsv: Optional[Tuple[int, int, int]]

Return current color in HSV if HSV mode is active.

property is_on: bool

Return whether the light is on or off.

property lights: List[miio.integrations.light.yeelight.yeelight.YeelightSubLight]

Return list of sub lights.

property moonlight_mode: Optional[bool]

Return whether the moonlight mode is active.

property moonlight_mode_brightness: Optional[int]

Return current moonlight brightness.

property music_mode: Optional[bool]

Return whether the music mode is active.

property name: str

Return the internal name of the bulb.

property rgb: Optional[Tuple[int, int, int]]

Return color in RGB if RGB mode is active.

property save_state_on_change: bool

Return whether the bulb state is saved on change.

class miio.integrations.light.yeelight.yeelight.YeelightSubLight(data, type)

Bases: miio.device.DeviceStatus

get_prop_name(prop) → str

property brightness: int

Return current brightness.

property color_flow_params: Optional[str]

Return color flowing params.

property color_flowing: bool

Return whether the color flowing is active.

property color_mode: miio.integrations.light.yeelight.yeelight.YeelightMode

Return current color mode.

property color_temp: Optional[int]

Return current color temperature, if applicable.

property hsv: Optional[Tuple[int, int, int]]

Return current color in HSV if HSV mode is active.

property is_on: bool

Return whether the light is on or off.

property rgb: Optional[Tuple[int, int, int]]

Return color in RGB if RGB mode is active.