xs1_api_client.device package

Subpackages

• xs1_api_client.device.actuator package
  • Submodules
  • xs1_api_client.device.actuator.switch module
  • xs1_api_client.device.actuator.thermostat module
  • Module contents
• xs1_api_client.device.sensor package
  • Module contents

Module contents

class xs1_api_client.device.XS1Device(state: dict, api) → None

Bases: object

This is a generic XS1 device, all other objetcs inherit from this.

NAME_PATTERN_VALID = re.compile('^[a-zA-Z0-9_]+$', re.IGNORECASE)

enabled() → bool

Returns:Returns if this device is enabled.

id() → int

Returns:id of this device

last_update() → int

Returns:the time when this device’s value was updated last

name() → str

Returns:the name of this device

new_value()

Returns the new value to set for this device. If this value differs from the currrent value the gateway is still trying to update the value on the device. If it does not differ the value has already been set.

Returns:the new value to set for this device

set_name(name: str)

Sets a new name for this device. Keep in mind that there are some limitations for a device name.

Parameters:name – the new name to set Returns:the new name of the actuator

set_state(new_state: dict) → None

Sets a new state for this device. If there is an existing state, new and old values will be merged to retain any information that was missing from api responses.

Parameters:new_state – new representation of this device (api response)

set_value(value) → None

Sets a new value for this device. This method should be implemented by inheriting classes.

Parameters:value – the new value to set

type() → str

Returns:the type of this device

unit() → str

Returns:the unit that is used for the value

update() → None

Updates the current value of this device. This method should be implemented by inheriting classes.

value()

Returns:the current value of this device