xs1_api_client.device.actuator package

Submodules

xs1_api_client.device.actuator.base module

class xs1_api_client.device.actuator.base.XS1Actuator(state, api_interface)[source]

Bases: xs1_api_client.device.base.XS1Device

Represents a basic XS1 Actuator, there may be special variants for some types.

call_function(function)[source]

Calls the specified function by id and saves the api response as the new state

Parameters:function – XS1Function object
get_functions()[source]
Returns:a list of functions that can be executed using the call_function() method
set_value(value)[source]

Sets a new value for this actuator

Parameters:value – new value to set
update()[source]

Updates the state of this actuator

class xs1_api_client.device.actuator.base.XS1Function(actuator, id, type, description)[source]

Bases: object

Represents a function of a XS1Actuator.

description()[source]
Returns:a description for this function
execute()[source]

Executes this function and sets the response as the new actuator value

id()[source]
Returns:the id of this function (note that this id is only unique for a single actuator!)
type()[source]
Returns:the type of this function

xs1_api_client.device.actuator.switch module

class xs1_api_client.device.actuator.switch.XS1Switch(state, api_interface)[source]

Bases: xs1_api_client.device.actuator.base.XS1Actuator

Represents a XS1 Switch.

turn_off()[source]

Turns off the switch.

turn_on()[source]

Turns on the switch.

xs1_api_client.device.actuator.thermostat module

class xs1_api_client.device.actuator.thermostat.XS1Thermostat(state, api_interface)[source]

Bases: xs1_api_client.device.actuator.base.XS1Actuator

Represents a basic XS1 Actuator, there may be special variants for some types.

set_temperature(temp)[source]

Sets the new target temperature of this thermostat

Parameters:temp – double value

Module contents