Data Models¶
Devices¶
wyze_sdk.models.devices.base¶
-
class
wyze_sdk.models.devices.base.
Device
(*, binding_ts: Optional[int] = None, binding_user_nickname: Optional[str] = None, conn_state: Optional[int] = None, conn_state_ts: Optional[int] = None, enr: Optional[str] = None, event_master_switch: Optional[int] = None, firmware_ver: Optional[str] = None, first_activation_ts: Optional[int] = None, first_binding_ts: Optional[int] = None, hardware_ver: Optional[str] = None, is_in_auto: Optional[int] = None, mac: Optional[str] = None, nickname: Optional[str] = None, parent_device_mac: Optional[str] = None, parent_device_enr: Optional[str] = None, product_model: Optional[str] = None, product_model_logo_url: Optional[str] = None, product_type: Optional[str] = None, push_switch: Optional[int] = None, timezone_gmt_offset: Optional[float] = None, timezone_name: Optional[str] = None, user_role: Optional[int] = None, type: Optional[str] = None, **others: dict)¶ -
attributes
= {'binding_ts', 'binding_user_nickname', 'conn_state', 'conn_state_ts', 'enr', 'event_master_switch', 'firmware_ver', 'first_activation_ts', 'first_binding_ts', 'hardware_ver', 'is_in_auto', 'mac', 'nickname', 'p2p_id', 'p2p_type', 'parent_device_enr', 'parent_device_mac', 'product_model', 'product_type', 'push_switch', 'timezone_gmt_offset', 'timezone_name', 'type', 'user_role'}¶
-
property
enr
¶
-
property
firmware_version
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
hardware_version
¶
-
property
is_online
¶
-
logger
= <Logger wyze_sdk.models.devices.base (WARNING)>¶
-
property
mac
¶
-
property
nickname
¶
-
property
parent_device
¶
-
property
product
¶
-
property
push_switch
¶
-
classmethod
remove_model_prefix
(text: str, model: str) → str¶
-
property
timezone
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
property
type
¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
wyze_sdk.models.devices.bulbs¶
-
class
wyze_sdk.models.devices.bulbs.
Bulb
(*, type: str = 'Light', **others: dict)¶ -
property
attributes
¶ WLAP19 bulbs (non-mesh, non-color) use the switch_state property to indicate whethere they are on or off. Newer bulbs appear to use some of the same PIDs but also have open_close_state and power_switch.
-
property
away_mode
¶
-
property
brightness
¶
-
property
color
¶
-
property
color_temp
¶
-
property
enr
¶
-
property
firmware_version
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
hardware_version
¶
-
property
ip
¶
-
property
is_on
¶
-
property
is_online
¶
-
logger
= <Logger wyze_sdk.models.devices.base (WARNING)>¶
-
property
mac
¶
-
property
nickname
¶
-
property
parent_device
¶
-
property
power_loss_recovery
¶
-
property
product
¶
-
property
push_switch
¶
-
classmethod
remove_model_prefix
(text: str, model: str) → str¶
-
property
rssi
¶
-
property
ssid
¶
-
property
switch_state
¶
-
property
timezone
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
type
= 'Light'¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
-
class
wyze_sdk.models.devices.bulbs.
MeshBulb
(**others: dict)¶ -
property
attributes
¶ WLAP19 bulbs (non-mesh, non-color) use the switch_state property to indicate whethere they are on or off. Newer bulbs appear to use some of the same PIDs but also have open_close_state and power_switch.
-
property
away_mode
¶
-
property
brightness
¶
-
property
color
¶
-
property
color_temp
¶
-
property
enr
¶
-
property
firmware_version
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
hardware_version
¶
-
property
ip
¶
-
property
is_on
¶
-
property
is_online
¶
-
logger
= <Logger wyze_sdk.models.devices.base (WARNING)>¶
-
property
mac
¶
-
property
nickname
¶
-
property
parent_device
¶
-
property
power_loss_recovery
¶
-
property
product
¶
-
classmethod
props
() → dict[str, PropDef]¶
-
property
push_switch
¶
-
classmethod
remove_model_prefix
(text: str, model: str) → str¶
-
property
rssi
¶
-
property
ssid
¶
-
property
switch_state
¶
-
property
timezone
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
type
= 'MeshLight'¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
wyze_sdk.models.devices.cameras¶
-
class
wyze_sdk.models.devices.cameras.
Camera
(*, event_list: Optional[Sequence[dict]] = None, **others: dict)¶ -
property
attributes
¶ set() -> new empty set object set(iterable) -> new set object
Build an unordered collection of unique elements.
-
property
enr
¶
-
property
firmware_version
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
hardware_version
¶
-
property
has_motion
¶
-
property
humidity
¶
-
property
ip
¶
-
property
is_audio_alarm
¶
-
property
is_co_alarm
¶
-
property
is_motion_alarm
¶
-
property
is_on
¶
-
property
is_online
¶
-
property
is_smoke_alarm
¶
-
property
latest_events
¶
-
logger
= <Logger wyze_sdk.models.devices.base (WARNING)>¶
-
property
mac
¶
-
property
motion_state
¶
-
property
nickname
¶
-
property
parent_device
¶
-
property
product
¶
-
property
push_switch
¶
-
classmethod
remove_model_prefix
(text: str, model: str) → str¶
-
property
rssi
¶
-
property
ssid
¶
-
property
switch_state
¶
-
property
temperature
¶
-
property
timezone
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
type
= 'Camera'¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
voltage
¶
-
property
wyze_sdk.models.devices.locks¶
-
class
wyze_sdk.models.devices.locks.
Lock
(parent: Optional[str] = None, record_count: Optional[int] = None, **others: dict)¶ -
property
attributes
¶ set() -> new empty set object set(iterable) -> new set object
Build an unordered collection of unique elements.
-
property
enr
¶
-
property
firmware_version
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
hardware_version
¶
-
property
is_locked
¶
-
property
is_online
¶
-
property
is_open
¶
-
property
lock_state
¶
-
logger
= <Logger wyze_sdk.models.devices.base (WARNING)>¶
-
property
mac
¶
-
property
nickname
¶
-
property
open_close_state
¶
-
property
parent
¶
-
property
parent_device
¶
-
classmethod
parse_uuid
(mac: str) → str¶
-
property
product
¶
-
property
push_switch
¶
-
property
record_count
¶
-
classmethod
remove_model_prefix
(text: str, model: str) → str¶
-
property
timezone
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
type
= 'Lock'¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
-
class
wyze_sdk.models.devices.locks.
LockEventSource
(value)¶ See: ford_lock_history_source
-
AUTO
= ('Auto', 8)¶
-
FINGERPRINT
= ('Fingerprint', 3)¶
-
INSIDE_BUTTON
= ('Inside button', 4)¶
-
INSIDE_HOLDER
= ('Inside holder', 6)¶
-
KEYPAD
= ('Keypad', [2, 102])¶
-
LOCAL
= ('Local', 1)¶
-
MANUAL
= ('Manual', 5)¶
-
NFC
= ('NFC', 7)¶
-
REMOTE
= ('Remote', 9)¶
-
describe
()¶
-
classmethod
parse
(code: int) → Optional[LockEventSource]¶
-
-
class
wyze_sdk.models.devices.locks.
LockEventType
(value)¶ See: ford_lock_history_event_id
-
AUTO_CALIBRATED
= ('Auto-calibrated', 2226)¶
-
CLOSED
= ('Closed', 2215)¶
-
JAMMED
= ('Jammed', 2221)¶
-
KEPT_OPEN
= ('Kept open longer than 24 hours', 2224)¶
-
LOCKED
= ('Locked', 2216)¶
-
OPENED
= ('Opened', 2214)¶
-
OPEN_TOO_LONG
= ('Open too long', 2218)¶
-
SWUNG_OPEN
= ('Swung open', 2223)¶
-
TOTALLY_JAMMED
= ('Totally jammed', 2222)¶
-
TRASH_MODE
= ('Trash mode', 2225)¶
-
UNLOCKED
= ('Unlocked', 2203)¶
-
describe
()¶
-
classmethod
parse
(code: int) → Optional[LockEventType]¶
-
-
class
wyze_sdk.models.devices.locks.
LockGateway
(*, rssi: Optional[int] = None, ssid: Optional[str] = None, locks: Optional[Sequence[dict]] = None, **others: dict)¶ -
property
attributes
¶ set() -> new empty set object set(iterable) -> new set object
Build an unordered collection of unique elements.
-
property
enr
¶
-
property
firmware_version
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
hardware_version
¶
-
property
ip
¶
-
property
is_online
¶
-
property
locks
¶
-
logger
= <Logger wyze_sdk.models.devices.base (WARNING)>¶
-
property
mac
¶
-
property
nickname
¶
-
property
parent_device
¶
-
classmethod
parse_uuid
(mac: str) → str¶
-
property
product
¶
-
property
push_switch
¶
-
classmethod
remove_model_prefix
(text: str, model: str) → str¶
-
property
rssi
¶
-
property
ssid
¶
-
property
timezone
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
type
= 'gateway'¶
-
property
uuid
¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
-
class
wyze_sdk.models.devices.locks.
LockLeftOpenTime
(value)¶ See: ford_open_alarm_time
-
MIN_1
= ('1 min', 2)¶
-
MIN_10
= ('10 min', 4)¶
-
MIN_30
= ('30 min', 5)¶
-
MIN_5
= ('5 min', 3)¶
-
MIN_60
= ('60 min', 6)¶
-
describe
()¶
-
classmethod
parse
(code: int) → Optional[LockLeftOpenTime]¶
-
-
class
wyze_sdk.models.devices.locks.
LockRecord
(*, type: Optional[Union[int, wyze_sdk.models.devices.locks.LockEventType]] = None, details: Optional[Union[dict, wyze_sdk.models.devices.locks.LockRecordDetail]] = None, priority: Optional[int] = None, processed: Optional[int] = None, time: Optional[datetime.datetime] = None, user_id: Optional[str] = None, uuid: Optional[str] = None, **others: dict)¶ A lock record.
See: com.yunding.ford.entity.FamilyRecord
-
property
attributes
¶ Provide a set of attributes of this object that will make up its JSON structure
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
property
type
¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
-
class
wyze_sdk.models.devices.locks.
LockRecordDetail
(*, id: Optional[int] = None, avatar: Optional[str] = None, email: Optional[str] = None, left_open_time: Optional[Union[int, wyze_sdk.models.devices.locks.LockLeftOpenTime]] = None, receiver_name: Optional[str] = None, role: Optional[str] = None, sender_name: Optional[str] = None, source: Optional[Union[int, wyze_sdk.models.devices.locks.LockEventSource]] = None, source_name: Optional[str] = None, sourceid: Optional[int] = None, time: Optional[datetime.datetime] = None, **others: dict)¶ A lock record’s details.
See: com.yunding.ford.entity.FamilyRecord.Detail
-
property
attributes
¶ Provide a set of attributes of this object that will make up its JSON structure
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
wyze_sdk.models.devices.plugs¶
-
class
wyze_sdk.models.devices.plugs.
OutdoorPlug
(**others: dict)¶ -
property
attributes
¶ set() -> new empty set object set(iterable) -> new set object
Build an unordered collection of unique elements.
-
property
away_mode
¶
-
property
enr
¶
-
property
firmware_version
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
hardware_version
¶
-
property
ip
¶
-
property
is_on
¶
-
property
is_online
¶
-
property
is_photosensitive
¶
-
logger
= <Logger wyze_sdk.models.devices.base (WARNING)>¶
-
property
mac
¶
-
property
nickname
¶
-
property
parent_device
¶
-
property
photosensitive_switch
¶
-
property
product
¶
-
property
push_switch
¶
-
classmethod
remove_model_prefix
(text: str, model: str) → str¶
-
property
rssi
¶
-
property
ssid
¶
-
property
status_light
¶
-
property
switch_state
¶
-
property
timezone
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
type
= 'OutdoorPlug'¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
-
class
wyze_sdk.models.devices.plugs.
Plug
(type: str = 'Plug', **others: dict)¶ -
property
attributes
¶ set() -> new empty set object set(iterable) -> new set object
Build an unordered collection of unique elements.
-
property
away_mode
¶
-
property
enr
¶
-
property
firmware_version
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
hardware_version
¶
-
property
ip
¶
-
property
is_on
¶
-
property
is_online
¶
-
logger
= <Logger wyze_sdk.models.devices.base (WARNING)>¶
-
property
mac
¶
-
property
nickname
¶
-
property
parent_device
¶
-
property
product
¶
-
property
push_switch
¶
-
classmethod
remove_model_prefix
(text: str, model: str) → str¶
-
property
rssi
¶
-
property
ssid
¶
-
property
status_light
¶
-
property
switch_state
¶
-
property
timezone
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
type
= 'Plug'¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
wyze_sdk.models.devices.scales¶
-
class
wyze_sdk.models.devices.scales.
Scale
(unit: Optional[str] = None, goal_weight: Optional[wyze_sdk.models.devices.scales.UserGoalWeight] = None, latest_records: Optional[Sequence[wyze_sdk.models.devices.scales.ScaleRecord]] = None, **others: dict)¶ -
property
attributes
¶ set() -> new empty set object set(iterable) -> new set object
Build an unordered collection of unique elements.
-
property
broadcast
¶
-
property
device_members
¶
-
property
enr
¶
-
property
firmware_version
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
goal_weight
¶
-
property
hardware_version
¶
-
property
ip
¶
-
property
is_online
¶
-
property
latest_records
¶
-
logger
= <Logger wyze_sdk.models.devices.base (WARNING)>¶
-
property
mac
¶
-
property
nickname
¶
-
property
parent_device
¶
-
property
product
¶
-
property
push_switch
¶
-
classmethod
remove_model_prefix
(text: str, model: str) → str¶
-
property
rssi
¶
-
property
ssid
¶
-
property
timezone
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
type
= 'Scale'¶
-
property
unit
¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
-
class
wyze_sdk.models.devices.scales.
ScaleRecord
(*, id: Optional[str] = None, age: Optional[int] = None, bmi: Optional[float] = None, bmr: Optional[float] = None, body_fat: Optional[float] = None, body_type: Optional[int] = None, body_vfr: Optional[float] = None, body_water: Optional[float] = None, bone_mineral: Optional[float] = None, device_id: Optional[str] = None, family_member_id: Optional[str] = None, gender: Optional[int] = None, height: Optional[float] = None, impedance: Optional[Sequence[int]] = None, mac: Optional[str] = None, measure_ts: Optional[int] = None, measure_type: Optional[int] = None, metabolic_age: Optional[int] = None, muscle: Optional[float] = None, occupation: Optional[int] = None, protein: Optional[float] = None, timezone: Optional[str] = None, user_id: Optional[int] = None, weight: Optional[float] = None, **others: dict)¶ A scale record.
See: com.wyze.ihealth.bean.GsonHs2sResults.DataBean
-
property
attributes
¶ Provide a set of attributes of this object that will make up its JSON structure
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
-
class
wyze_sdk.models.devices.scales.
UserGoalWeight
(*, id: Optional[str] = None, created: Optional[datetime.datetime] = None, current_weight: Optional[float] = None, goal_weight: Optional[float] = None, family_member_id: Optional[str] = None, updated: Optional[datetime.datetime] = None, user_id: Optional[int] = None, **others: dict)¶ A user goal weight record.
See: com.wyze.ihealth.bean.GsonUserGoalWeight
-
property
attributes
¶ Provide a set of attributes of this object that will make up its JSON structure
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
wyze_sdk.models.devices.sensors¶
-
class
wyze_sdk.models.devices.sensors.
ContactSensor
(**others: dict)¶ -
property
attributes
¶ set() -> new empty set object set(iterable) -> new set object
Build an unordered collection of unique elements.
-
property
enr
¶
-
property
firmware_version
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
hardware_version
¶
-
property
ip
¶
-
property
is_on
¶
-
property
is_online
¶
-
property
is_open
¶
-
logger
= <Logger wyze_sdk.models.devices.base (WARNING)>¶
-
property
mac
¶
-
property
nickname
¶
-
property
open_close_state
¶
-
property
parent_device
¶
-
property
product
¶
-
property
push_switch
¶
-
classmethod
remove_model_prefix
(text: str, model: str) → str¶
-
property
rssi
¶
-
property
ssid
¶
-
property
switch_state
¶
-
property
timezone
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
type
= 'ContactSensor'¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
voltage
¶
-
property
-
class
wyze_sdk.models.devices.sensors.
MotionSensor
(**others: dict)¶ -
property
attributes
¶ set() -> new empty set object set(iterable) -> new set object
Build an unordered collection of unique elements.
-
property
enr
¶
-
property
firmware_version
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
hardware_version
¶
-
property
has_motion
¶
-
property
ip
¶
-
property
is_on
¶
-
property
is_online
¶
-
logger
= <Logger wyze_sdk.models.devices.base (WARNING)>¶
-
property
mac
¶
-
property
motion_state
¶
-
property
nickname
¶
-
property
parent_device
¶
-
property
product
¶
-
property
push_switch
¶
-
classmethod
remove_model_prefix
(text: str, model: str) → str¶
-
property
rssi
¶
-
property
ssid
¶
-
property
switch_state
¶
-
property
timezone
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
type
= 'MotionSensor'¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
voltage
¶
-
property
wyze_sdk.models.devices.thermostats¶
-
class
wyze_sdk.models.devices.thermostats.
Thermostat
(**others: dict)¶ -
property
attributes
¶ set() -> new empty set object set(iterable) -> new set object
Build an unordered collection of unique elements.
-
property
cooling_setpoint
¶
-
property
current_scenario
¶
-
classmethod
device_info_props
() → dict[str, PropDef]¶
-
property
enr
¶
-
property
fan_mode
¶
-
property
firmware_version
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
hardware_version
¶
-
property
heating_setpoint
¶
-
property
humidity
¶
-
property
ip
¶
-
property
is_locked
¶
-
property
is_online
¶
-
property
lock_state
¶
-
logger
= <Logger wyze_sdk.models.devices.base (WARNING)>¶
-
property
mac
¶
-
property
nickname
¶
-
property
parent_device
¶
-
property
product
¶
-
classmethod
props
() → dict[str, PropDef]¶
-
property
push_switch
¶
-
classmethod
remove_model_prefix
(text: str, model: str) → str¶
-
property
rssi
¶
-
property
ssid
¶
-
property
system_mode
¶
-
property
temperature
¶
-
property
temperature_unit
¶
-
property
timezone
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
type
= 'Thermostat'¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
-
class
wyze_sdk.models.devices.thermostats.
ThermostatFanMode
(value)¶ See: com.wyze.earth.common.widget.EarthHomeControls
-
AUTO
= ('Auto', 'auto')¶
-
CYCLE
= ('Cycle', 'circ')¶
-
ON
= ('On', 'on')¶
-
describe
()¶
-
classmethod
parse
(code: str) → Optional[ThermostatFanMode]¶
-
wyze_sdk.models.devices.vacuums¶
-
class
wyze_sdk.models.devices.vacuums.
Vacuum
(**others: dict)¶ -
property
attributes
¶ set() -> new empty set object set(iterable) -> new set object
Build an unordered collection of unique elements.
-
property
clean_level
¶
-
property
current_map
¶
-
property
current_position
¶
-
classmethod
device_info_props
() → dict[str, PropDef]¶
-
property
enr
¶
-
property
firmware_version
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
hardware_version
¶
-
property
ip
¶
-
property
is_online
¶
-
logger
= <Logger wyze_sdk.models.devices.base (WARNING)>¶
-
property
mac
¶
-
property
mode
¶
-
property
nickname
¶
-
property
parent_device
¶
-
property
product
¶
-
classmethod
props
() → dict[str, PropDef]¶
-
property
push_switch
¶
-
classmethod
remove_model_prefix
(text: str, model: str) → str¶
-
property
rooms
¶
-
property
rssi
¶
-
property
ssid
¶
-
property
timezone
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
type
= 'Vacuum'¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
voltage
¶
-
property
-
class
wyze_sdk.models.devices.vacuums.
VacuumMap
(*, id: Optional[int] = None, name: Optional[str] = None, created: Optional[datetime.datetime] = None, updated: Optional[datetime.datetime] = None, blob: Optional[dict] = None, **others: dict)¶ The protobuf definition for a vacuum map.
-
property
attributes
¶ Provide a set of attributes of this object that will make up its JSON structure
-
property
charge_station
¶
-
property
created
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
id
¶
-
property
name
¶
-
parse_blob
(blob: str) → dict¶
-
property
rooms
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
property
updated
¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
Provide a set of attributes of this object that will make up its JSON structure
Construct a dictionary out of non-null keys (from attributes property) present on this object.
Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
- Raises
WyzeObjectFormationError – if the object was not valid
-
class
wyze_sdk.models.devices.vacuums.
VacuumMapPoint
(*, x: Optional[float] = None, y: Optional[float] = None, phi: Optional[float] = None, **others: dict)¶ -
property
attributes
¶ Provide a set of attributes of this object that will make up its JSON structure
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
-
class
wyze_sdk.models.devices.vacuums.
VacuumMapRoom
(*, id: Optional[str] = None, name: Optional[str] = None, clean_state: Optional[int] = None, room_clean: Optional[int] = None, name_position: Optional[wyze_sdk.models.devices.vacuums.VacuumMapPoint] = None, **others: dict)¶ -
property
attributes
¶ Provide a set of attributes of this object that will make up its JSON structure
-
property
clean_state
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
id
¶
-
property
name
¶
-
property
name_position
¶
-
property
room_clean
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
-
class
wyze_sdk.models.devices.vacuums.
VacuumMode
(value)¶ An enumeration.
-
BREAK_POINT
= ('break point', [11, 33, 39])¶
-
FULL_FINISH_SWEEPING_ON_WAY_CHARGE
= ('full finish sweeping on way charge', [10, 12, 26, 32, 38])¶
-
IDLE
= ('idle', [0, 14, 29, 35, 40])¶
-
ON_WAY_CHARGE
= ('on way charge', 5)¶
-
PAUSE
= ('pause', [4, 9, 27, 31, 37])¶
-
SWEEPING
= ('sweeping', [1, 7, 25, 30, 36])¶
-
describe
() → str¶
-
classmethod
parse
(code: int) → Optional[VacuumMode]¶
-
-
class
wyze_sdk.models.devices.vacuums.
VacuumSuctionLevel
(value)¶ An enumeration.
-
QUIET
= ('Quiet', 1)¶
-
STANDARD
= ('Standard', 2)¶
-
STRONG
= ('Strong', 3)¶
-
describe
() → str¶
-
classmethod
parse
(code: Union[str, int]) → Optional[VacuumSuctionLevel]¶
-
-
class
wyze_sdk.models.devices.vacuums.
VacuumSweepRecord
(*, created: Optional[datetime.datetime] = None, started: Optional[datetime.datetime] = None, clean_type: Optional[int] = None, clean_time: Optional[int] = None, clean_size: Optional[int] = None, model: Optional[str] = None, **others: dict)¶ A vacuum sweep record.
-
property
attributes
¶ Provide a set of attributes of this object that will make up its JSON structure
-
property
clean_size
¶ The area cleaned during this sweep record (in sq.ft.).
What comes from the API is some number related to m^2, but it’s been multiplied by 100, presumably to send across an integer that can be parsed to a single significant digit?
-
property
clean_time
¶ The cleaning time of this sweep record (in minutes).
-
property
created
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
property
map_img_big_url
¶
-
property
map_img_small_url
¶
-
property
model
¶
-
property
started
¶
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
Events¶
-
class
wyze_sdk.models.events.
AiEventType
(value)¶ - See: com.wyze.platformkit.config.AiConfig
com.wyze.event.faceai.WyzeCloudEventFaceAI
-
BARKING
= ('Dog Barking', 800002)¶
-
CAR
= ('Car', [])¶
-
CAT
= ('Cat', [])¶
-
CRYING
= ('Baby Crying', 800001)¶
-
DELIVERY_TRUCK
= ('Delivery Truck', [])¶
-
DOG
= ('Dog', [])¶
-
FACE
= ('Face', 101001)¶
-
MEOWING
= ('Cat Meowing', 800003)¶
-
NOTHING
= ('Nothing', 0)¶
-
PACKAGE
= ('Package', 104)¶
-
PERSON
= ('Person', 101)¶
-
PET
= ('Pet', 103)¶
-
SCHOOL_BUS
= ('School Bus', [])¶
-
VEHICLE
= ('Vehicle', 102)¶
-
describe
()¶
-
classmethod
parse
(code: int) → Optional[AiEventType]¶
-
class
wyze_sdk.models.events.
Event
(*, device_mac: Optional[str] = None, event_id: Optional[int] = None, event_ts: Optional[datetime.datetime] = None, event_category: Optional[int] = None, event_params: Optional[dict] = None, event_value: Optional[str] = None, file_list: Optional[Sequence[dict]] = None, tag_list: Optional[Sequence[int]] = None, read_state: Optional[int] = None, **others: dict)¶ A Wyze event.
See: com.wyze.platformkit.model.WpkEventData
-
property
alarm_type
¶
-
property
attributes
¶ Provide a set of attributes of this object that will make up its JSON structure
-
property
files
¶
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property
-
class
wyze_sdk.models.events.
EventAlarmType
(value)¶ See: com.HLApi.Obj.EventItem
-
CO
= ('Carbon Monoxide', 5)¶
-
DOORBELL_RANG
= ('Doorbell rang', 10)¶
-
FACE
= ('Face appeared', 12)¶
-
MOTION
= ('Motion', [1, 6, 7, 13])¶
-
OTHER
= ('Other', 3)¶
-
SCENE
= ('Scene action', 11)¶
-
SMOKE
= ('Smoke', 4)¶
-
SOUND
= ('Sound', 2)¶
-
TRIGGERED
= ('Triggered', 8)¶
-
describe
()¶
-
classmethod
parse
(code: int) → Optional[EventAlarmType]¶
-
-
class
wyze_sdk.models.events.
EventFile
(*, file_id: Optional[str] = None, type: Optional[int] = None, status: Optional[int] = None, url: Optional[str] = None, **others: dict)¶ A file (photo, video) associated with a Wyze event.
See: com.wyze.platformkit.model.WpkEventData
-
property
attributes
¶ Provide a set of attributes of this object that will make up its JSON structure
-
get_non_null_attributes
() → dict¶ Construct a dictionary out of non-null keys (from attributes property) present on this object.
-
to_dict
(*args) → dict¶ Extract this object as a JSON-compatible, Wyze-API-valid dictionary.
- Parameters
args – Any specific formatting args (rare; generally not required)
- Raises
WyzeObjectFormationError – if the object was not valid
-
property
type
¶
-
validate_json
() → None¶ - Raises
WyzeObjectFormationError – if the object was not valid
-
property