miio.cloud module

class miio.cloud.CloudDeviceInfo(*, localip: str, token: str, did: str, mac: str, name: str, model: str, desc: str, locale: str, parent_id: str, parent_model: str, ssid: str, bssid: str, isOnline: bool, rssi: int, **extra_data: Any)[source]

Bases: BaseModel

Model for the xiaomi cloud device information.

Note that only some selected information is directly exposed, raw data is available using raw_data().

class Config[source]

Bases: object

extra = 'allow'
classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) Model

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) Model

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters:
  • include – fields to include in new model

  • exclude – fields to exclude from new model, as with values this takes precedence over include

  • update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data

  • deep – set to True to make a deep copy of the model

Returns:

new model instance

dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) DictStrAny

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

classmethod from_orm(obj: Any) Model
json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) unicode

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) Model
classmethod parse_obj(obj: Any) Model
classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) Model
classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') DictStrAny
classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) unicode
classmethod update_forward_refs(**localns: Any) None

Try to update ForwardRefs on fields based on this Model, globalns and localns.

classmethod validate(value: Any) Model
bssid: str
description: str
did: str
ip: str
property is_child

Return True for gateway sub devices.

is_online: bool
locale: str
mac: str
model: str
name: str
parent_id: str
parent_model: str
property raw_data

Return the raw data.

rssi: int
ssid: str
token: str
class miio.cloud.CloudInterface(username, password)[source]

Bases: object

Cloud interface using micloud library.

You can use this to obtain a list of devices and their tokens. The get_devices() takes the locale string (e.g., ‘us’) as an argument, defaulting to all known locales (accessible through available_locales()).

Example:

ci = CloudInterface(username="foo", password=...)
devs = ci.get_devices()
for did, dev in devs.items():
    print(dev)
classmethod available_locales() Dict[str, str][source]

Return available locales.

The value is the human-readable name of the locale.

get_devices(locale: Optional[str] = None) Dict[str, CloudDeviceInfo][source]

Return a list of available devices keyed with a device id.

If no locale is given, all known locales are browsed. If a device id is already seen in another locale, it is excluded from the results.