Gateway Module Webservice API 2

From OpenMotics
Jump to navigation Jump to search

Contents

Work in progress on new API documentation


THIS IS A WORK IN PROGRESS, DO NOT USE FOR PRODUCTION. IT'S FOR TESTING PURPOSES ONLY. The idea is that these docs will be auto-generated.


add_schedule

-

Parameters:

parameter type description
name str None
start int None
schedule_type str None
arguments json None
repeat json None
duration int None
end int None

Returns: (return data)


create_user

Create a new user using a username and a password. Only possible in authorized mode.


?: :type username: str ?: :type password: str

Parameters:

parameter type description
username None Name of the user.
password None Password of the user.

Returns: (return data)


do_basic_action

Execute a basic action.


?: :type action_type: int ?: :type action_number: int

Parameters:

parameter type description
action_type int The type of the action as defined by the master api.
action_number int The number provided to the basic action, its meaning depends on the action_type.

Returns: (return data)


do_group_action

Execute a group action.


?: :type group_action_id: int

Parameters:

parameter type description
group_action_id int The id of the group action

Returns: (return data)


do_raw_energy_command

Perform a raw energy module command, for debugging purposes.


?: :type address: int ?: :type mode: str ?: :type command: str ?: :type data: str ?: :returns: dict with 'data': comma separated list of Bytes ?: :rtype: dict

Parameters:

parameter type description
address int The address of the energy module
mode None 1 char: S or G
command None 3 char power command
data None comma seperated list of Bytes

Returns: (return data)


do_shutter_down

Make a shutter go down. The shutter stops automatically when the down position is

       reached (after the predefined number of seconds).


?: :type id: int ?: :returns:'status': 'OK'. ?: :rtype: dict

Parameters:

parameter type description
id int The id of the shutter.

Returns: (return data)


do_shutter_group_down

Make a shutter group go down. The shutters stop automatically when the down position is

       reached (after the predefined number of seconds).


?: :type id: int ?: :returns:'status': 'OK'. ?: :rtype: dict

Parameters:

parameter type description
id int The id of the shutter group.

Returns: (return data)


do_shutter_group_stop

Make a shutter group stop.


?: :type id: int ?: :returns:'status': 'OK'. ?: :rtype: dict

Parameters:

parameter type description
id int The id of the shutter group.

Returns: (return data)


do_shutter_group_up

Make a shutter group go up. The shutters stop automatically when the up position is

       reached (after the predefined number of seconds).


?: :type id: int ?: :returns:'status': 'OK'. ?: :rtype: dict

Parameters:

parameter type description
id int The id of the shutter group.

Returns: (return data)


do_shutter_stop

Make a shutter stop.


?: :type id: int ?: :returns:'status': 'OK'. ?: :rtype: dict

Parameters:

parameter type description
id int The id of the shutter.

Returns: (return data)


do_shutter_up

Make a shutter go up. The shutter stops automatically when the up position is

       reached (after the predefined number of seconds).


?: :type id: int ?: :returns:'status': 'OK'. ?: :rtype: dict

Parameters:

parameter type description
id int The id of the shutter.

Returns: (return data)


do_url_action

Execute an url action.


?: :type url: str ?: :type method: str | None ?: :type headers: str | None ?: :type data: str | None ?: :type auth: str | None ?: :type timeout: int | None ?: :returns: 'headers': response headers, 'data': response body. ?: :rtype: dict

Parameters:

parameter type description
url None The url to fetch.
method None (optional) The http method (defaults to GET).
headers json (optional) The http headers to send (format: json encoded dict)
data None (optional) Bytes to send in the body of the request.
auth json (optional) Json encoded tuple (username, password).
timeout int (optional) Timeout in seconds for the http request (default = 10 sec).

Returns: (return data)


flash_leds

Flash the leds on the module for an output/input/sensor.


?: :type type: int ?: :type id: int ?: :returns: 'status': 'OK'. ?: :rtype: dict

Parameters:

parameter type description
type int The module type: output/dimmer (0), input (1), sensor/temperatur (2).
id int The id of the output/input/sensor.

Returns: (return data)


get_airco_status

Get the mode of the airco attached to a all thermostats.


?: :returns: dict with ASB0-ASB31. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_api_docs

-

Parameters:

parameter type description
output_format str None

Returns: (return data)


get_can_led_configuration

Get a specific can_led_configuration defined by its id.


?: :type id: int ?: :type fields: list ?: :returns: 'config': can_led_configuration dict: contains 'id' (Id), 'can_led_1_function' (Enum), 'can_led_1_id' (Byte), 'can_led_2_function' (Enum), 'can_led_2_id' (Byte), 'can_led_3_function' (Enum), 'can_led_3_id' (Byte), 'can_led_4_function' (Enum), 'can_led_4_id' (Byte), 'room' (Byte) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the can_led_configuration
fields json The field of the can_led_configuration to get. (None gets all fields)

Returns: (return data)


get_can_led_configurations

Get all can_led_configurations.


?: :type fields: list ?: :returns: 'config': list of can_led_configuration dict: contains 'id' (Id), 'can_led_1_function' (Enum), 'can_led_1_id' (Byte), 'can_led_2_function' (Enum), 'can_led_2_id' (Byte), 'can_led_3_function' (Enum), 'can_led_3_id' (Byte), 'can_led_4_function' (Enum), 'can_led_4_id' (Byte), 'room' (Byte) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the can_led_configuration to get. (None gets all fields)

Returns: (return data)


get_cooling_configuration

Get a specific cooling_configuration defined by its id.


?: :type id: int ?: :type fields: list ?: :returns: 'config': cooling_configuration dict: contains 'id' (Id), 'auto_fri' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_mon' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sat' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sun' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_thu' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_tue' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_wed' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'name' (String[16]), 'output0' (Byte), 'output1' (Byte), 'permanent_manual' (Boolean), 'pid_d' (Byte), 'pid_i' (Byte), 'pid_int' (Byte), 'pid_p' (Byte), 'room' (Byte), 'sensor' (Byte), 'setp0' (Temp), 'setp1' (Temp), 'setp2' (Temp), 'setp3' (Temp), 'setp4' (Temp), 'setp5' (Temp) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the cooling_configuration
fields json The field of the cooling_configuration to get. (None gets all fields)

Returns: (return data)


get_cooling_configurations

Get all cooling_configurations.


?: :type fields: list ?: :returns: 'config': list of cooling_configuration dict: contains 'id' (Id), 'auto_fri' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_mon' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sat' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sun' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_thu' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_tue' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_wed' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'name' (String[16]), 'output0' (Byte), 'output1' (Byte), 'permanent_manual' (Boolean), 'pid_d' (Byte), 'pid_i' (Byte), 'pid_int' (Byte), 'pid_p' (Byte), 'room' (Byte), 'sensor' (Byte), 'setp0' (Temp), 'setp1' (Temp), 'setp2' (Temp), 'setp3' (Temp), 'setp4' (Temp), 'setp5' (Temp) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the cooling_configuration to get. (None gets all fields)

Returns: (return data)


get_cooling_pump_group_configuration

Get a specific cooling_pump_group_configuration defined by its id.


?: :type id: int ?: :type fields: list ?: :returns: 'config': cooling_pump_group_configuration dict: contains 'id' (Id), 'outputs' (CSV[32]), 'room' (Byte) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the cooling_pump_group_configuration
fields json The field of the cooling_pump_group_configuration to get. (None gets all fields)

Returns: (return data)


get_cooling_pump_group_configurations

Get all cooling_pump_group_configurations.


?: :type fields: list ?: :returns: 'config': list of cooling_pump_group_configuration dict: contains 'id' (Id), 'outputs' (CSV[32]), 'room' (Byte) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the cooling_pump_group_configuration to get. (None gets all fields)

Returns: (return data)


get_dimmer_configuration

Get the dimmer_configuration.


?: :type fields: list ?: :returns: 'config': dimmer_configuration dict: contains 'dim_memory' (Byte), 'dim_step' (Byte), 'dim_wait_cycle' (Byte), 'min_dim_level' (Byte) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the dimmer_configuration to get. (None gets all fields)

Returns: (return data)


get_energy_frequency

Gets the frequency components for a given module and optional input (no input means all)


?: :type module_id: int ?: :type input_id: int | None ?: :returns: A dict with the input_id(s) as key, and as value another dict with for ?: voltage and current the 20 frequency components ?: :rtype: dict

Parameters:

parameter type description
module_id int The id of the power module
input_id int The id of the input on the given power module

Returns: (return data)


get_energy_time

Gets 1 period of given module and optional input (no input means all).


?: :type module_id: int ?: :type input_id: int or None ?: :returns: A dict with the input_id(s) as key, and as value another dict with ?: (up to 80) voltage and current samples. ?: :rtype: dict

Parameters:

parameter type description
module_id int The id of the power module.
input_id int The id of the input on the given power module

Returns: (return data)


get_errors

Get the number of seconds since the last successul communication with the master and

       power modules (master_last_success, power_last_success) and the error list per module
       (input and output modules). The modules are identified by O1, O2, I1, I2, ...


?: :returns: 'errors': list of tuples (module, nr_errors), 'master_last_success': UNIX timestamp of the last succesful master communication and 'power_last_success': UNIX timestamp of the last successful power communication. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_features

Returns all available features this Gateway supports. This allows to make flexible clients

Parameters:

parameter type description

Returns: (return data)


get_full_backup

Get a backup (tar) of the master eeprom and the sqlite databases.


?: :returns: Tar containing 4 files: master.eep, config.db, scheduled.db, power.db and ?: eeprom_extensions.db as a string of bytes. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_global_rtd10_configuration

Get the global_rtd10_configuration.


?: :type fields: list ?: :returns: 'config': global_rtd10_configuration dict: contains 'output_value_cooling_16' (Byte), 'output_value_cooling_16_5' (Byte), 'output_value_cooling_17' (Byte), 'output_value_cooling_17_5' (Byte), 'output_value_cooling_18' (Byte), 'output_value_cooling_18_5' (Byte), 'output_value_cooling_19' (Byte), 'output_value_cooling_19_5' (Byte), 'output_value_cooling_20' (Byte), 'output_value_cooling_20_5' (Byte), 'output_value_cooling_21' (Byte), 'output_value_cooling_21_5' (Byte), 'output_value_cooling_22' (Byte), 'output_value_cooling_22_5' (Byte), 'output_value_cooling_23' (Byte), 'output_value_cooling_23_5' (Byte), 'output_value_cooling_24' (Byte), 'output_value_heating_16' (Byte), 'output_value_heating_16_5' (Byte), 'output_value_heating_17' (Byte), 'output_value_heating_17_5' (Byte), 'output_value_heating_18' (Byte), 'output_value_heating_18_5' (Byte), 'output_value_heating_19' (Byte), 'output_value_heating_19_5' (Byte), 'output_value_heating_20' (Byte), 'output_value_heating_20_5' (Byte), 'output_value_heating_21' (Byte), 'output_value_heating_21_5' (Byte), 'output_value_heating_22' (Byte), 'output_value_heating_22_5' (Byte), 'output_value_heating_23' (Byte), 'output_value_heating_23_5' (Byte), 'output_value_heating_24' (Byte) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the global_rtd10_configuration to get. (None gets all fields)

Returns: (return data)


get_global_thermostat_configuration

Get the global_thermostat_configuration.


?: :type fields: list ?: :returns: 'config': global_thermostat_configuration dict: contains 'outside_sensor' (Byte), 'pump_delay' (Byte), 'switch_to_cooling_output_0' (Byte), 'switch_to_cooling_output_1' (Byte), 'switch_to_cooling_output_2' (Byte), 'switch_to_cooling_output_3' (Byte), 'switch_to_cooling_value_0' (Byte), 'switch_to_cooling_value_1' (Byte), 'switch_to_cooling_value_2' (Byte), 'switch_to_cooling_value_3' (Byte), 'switch_to_heating_output_0' (Byte), 'switch_to_heating_output_1' (Byte), 'switch_to_heating_output_2' (Byte), 'switch_to_heating_output_3' (Byte), 'switch_to_heating_value_0' (Byte), 'switch_to_heating_value_1' (Byte), 'switch_to_heating_value_2' (Byte), 'switch_to_heating_value_3' (Byte), 'threshold_temp' (Temp) ?: :rtype: str

Parameters:

parameter type description
fields json The field of the global_thermostat_configuration to get. (None gets all fields)

Returns: (return data)


get_group_action_configuration

Get a specific group_action_configuration defined by its id.


?: :type id: int ?: :type fields: list ?: :returns: 'config': group_action_configuration dict: contains 'id' (Id), 'actions' (Actions[16]), 'name' (String[16]) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the group_action_configuration
fields json The field of the group_action_configuration to get. (None gets all fields)

Returns: (return data)


get_group_action_configurations

Get all group_action_configurations.


?: :type fields: list ?: :returns: 'config': list of group_action_configuration dict: contains 'id' (Id), 'actions' (Actions[16]), 'name' (String[16]) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the group_action_configuration to get. (None gets all fields)

Returns: (return data)


get_input_configuration

Get a specific input_configuration defined by its id.


?: :type id: int ?: :type fields: list ?: :returns: 'config': input_configuration dict: contains 'id' (Id), 'action' (Byte), 'basic_actions' (Actions[15]), 'invert' (Byte), 'module_type' (String[1]), 'name' (String[8]), 'room' (Byte) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the input_configuration
fields json The field of the input_configuration to get. (None gets all fields)

Returns: (return data)


get_input_configurations

Get all input_configurations.


?: :type fields: list ?: :returns: 'config': list of input_configuration dict: contains 'id' (Id), 'action' (Byte), 'basic_actions' (Actions[15]), 'invert' (Byte), 'module_type' (String[1]), 'name' (String[8]), 'room' (Byte) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the input_configuration to get. (None gets all fields)

Returns: (return data)


get_last_inputs

Get the 5 last pressed inputs during the last 5 minutes.


?: :returns: 'inputs': list of tuples (input, output). ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_master_backup

Get a backup of the eeprom of the master.


?: :returns: This function does not return a dict, unlike all other API functions: it returns a string of bytes (size = 64kb). ?: :rtype: bytearray

Parameters:

parameter type description

Returns: (return data)


get_metric_definitions

-

Parameters:

parameter type description
source None None
metric_type None None

Returns: (return data)


get_module_log

Get the log messages from the module discovery mode. This returns the current log

       messages and clear the log messages.


?: :returns: 'log': list of tuples (log_level, message). ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_modules

Get a list of all modules attached and registered with the master.


?: :returns: Dict with: ?: * 'outputs' (list of module types: O,R,D), ?: * 'inputs' (list of input module types: I,T,L,C) ?: * 'shutters' (List of modules types: S). ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_output_configuration

Get a specific output_configuration defined by its id.


?: :type id: int ?: :type fields: list ?: :returns: 'config': output_configuration dict: contains 'id' (Id), 'can_led_1_function' (Enum), 'can_led_1_id' (Byte), 'can_led_2_function' (Enum), 'can_led_2_id' (Byte), 'can_led_3_function' (Enum), 'can_led_3_id' (Byte), 'can_led_4_function' (Enum), 'can_led_4_id' (Byte), 'floor' (Byte), 'module_type' (String[1]), 'name' (String[16]), 'room' (Byte), 'timer' (Word), 'type' (Byte) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the output_configuration
fields json The fields of the output_configuration to get. (None gets all fields)

Returns: (return data)


get_output_configurations

Get all output_configurations.


?: :type fields: list ?: :returns: 'config': list of output_configuration dict: contains 'id' (Id), 'can_led_1_function' (Enum), 'can_led_1_id' (Byte), 'can_led_2_function' (Enum), 'can_led_2_id' (Byte), 'can_led_3_function' (Enum), 'can_led_3_id' (Byte), 'can_led_4_function' (Enum), 'can_led_4_id' (Byte), 'floor' (Byte), 'module_type' (String[1]), 'name' (String[16]), 'room' (Byte), 'timer' (Word), 'type' (Byte) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the output_configuration to get. (None gets all fields)

Returns: (return data)


get_output_status

Get the status of the outputs.


?: :returns: 'status': list of dictionaries with the following keys: id, status, dimmer and ctimer.

Parameters:

parameter type description

Returns: (return data)


get_plugin_logs

Get the logs for all plugins.


?: :returns: 'logs': dict with the names of the plugins as keys and the logs (String) as value. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_plugins

Get the installed plugins.


?: :returns: 'plugins': dict with name, version and interfaces where name and version are strings and interfaces is a list of tuples (interface, version) which are both strings. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_power_modules

Get information on the power modules. The times format is a comma seperated list of

       HH

?: :MM formatted times times (index 0 = start Monday, index 1 = stop Monday, ?: index 2 = start Tuesday, ...). ?: ?: :returns: 'modules': list of dictionaries with the following keys: 'id', 'name', 'address', 'input0', 'input1', 'input2', 'input3', 'input4', 'input5', 'input6', 'input7', 'sensor0', 'sensor1', 'sensor2', 'sensor3', 'sensor4', 'sensor5', 'sensor6', 'sensor7', 'times0', 'times1', 'times2', 'times3', 'times4', 'times5', 'times6', 'times7'. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_pulse_counter_configuration

Get a specific pulse_counter_configuration defined by its id.


?: :type id: int ?: :type fields: list ?: :returns: 'config': pulse_counter_configuration dict: contains 'id' (Id), 'input' (Byte), 'name' (String[16]), 'room' (Byte) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the pulse_counter_configuration
fields json The field of the pulse_counter_configuration to get. (None gets all fields)

Returns: (return data)


get_pulse_counter_configurations

Get all pulse_counter_configurations.


?: :type fields: list ?: :returns: 'config': list of pulse_counter_configuration dict: contains 'id' (Id), 'input' (Byte), 'name' (String[16]), 'room' (Byte) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the pulse_counter_configuration to get. (None gets all fields)

Returns: (return data)


get_pulse_counter_status

Get the pulse counter values.


?: :returns: 'counters': array with the 8 pulse counter values. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_pump_group_configuration

Get a specific pump_group_configuration defined by its id.


?: :type id: int ?: :type fields: list ?: :returns: 'config': pump_group_configuration dict: contains 'id' (Id), 'outputs' (CSV[32]), 'room' (Byte) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the pump_group_configuration
fields json The field of the pump_group_configuration to get. (None gets all fields)

Returns: (return data)


get_pump_group_configurations

Get all pump_group_configurations.


?: :type fields: list ?: :returns: 'config': list of pump_group_configuration dict: contains 'id' (Id), 'outputs' (CSV[32]), 'room' (Byte) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the pump_group_configuration to get. (None gets all fields)

Returns: (return data)


get_realtime_power

Get the realtime power measurements.


?: :returns: module id as the keys: [voltage, frequency, current, power]. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_reset_dirty_flag

Gets the dirty flags, and immediately clears them

Parameters:

parameter type description

Returns: (return data)


get_room_configuration

Get a specific room_configuration defined by its id.


?: :type id: int ?: :type fields: list ?: :returns: 'config': room_configuration dict: contains 'id' (Id), 'floor' (Byte), 'name' (String) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the room_configuration
fields json The field of the room_configuration to get. (None gets all fields)

Returns: (return data)


get_room_configurations

Get all room_configurations.


?: :type fields: list ?: :returns: 'config': list of room_configuration dict: contains 'id' (Id), 'floor' (Byte), 'name' (String) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the room_configuration to get. (None gets all fields)

Returns: (return data)


get_rtd10_cooling_configuration

Get a specific rtd10_cooling_configuration defined by its id.


?: :type id: int ?: :type fields: list ?: :returns: 'config': rtd10_cooling_configuration dict: contains 'id' (Id), 'mode_output' (Byte), 'mode_value' (Byte), 'on_off_output' (Byte), 'poke_angle_output' (Byte), 'poke_angle_value' (Byte), 'room' (Byte), 'temp_setpoint_output' (Byte), 'ventilation_speed_output' (Byte), 'ventilation_speed_value' (Byte) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the rtd10_cooling_configuration
fields json The field of the rtd10_cooling_configuration to get. (None gets all fields)

Returns: (return data)


get_rtd10_cooling_configurations

Get all rtd10_cooling_configurations.


?: :type fields: list ?: :returns: 'config': list of rtd10_cooling_configuration dict: contains 'id' (Id), 'mode_output' (Byte), 'mode_value' (Byte), 'on_off_output' (Byte), 'poke_angle_output' (Byte), 'poke_angle_value' (Byte), 'room' (Byte), 'temp_setpoint_output' (Byte), 'ventilation_speed_output' (Byte), 'ventilation_speed_value' (Byte) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the rtd10_cooling_configuration to get. (None gets all fields)

Returns: (return data)


get_rtd10_heating_configuration

Get a specific rtd10_heating_configuration defined by its id.


?: :type id: int ?: :type fields: list ?: :returns: 'config': rtd10_heating_configuration dict: contains 'id' (Id), 'mode_output' (Byte), 'mode_value' (Byte), 'on_off_output' (Byte), 'poke_angle_output' (Byte), 'poke_angle_value' (Byte), 'room' (Byte), 'temp_setpoint_output' (Byte), 'ventilation_speed_output' (Byte), 'ventilation_speed_value' (Byte) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the rtd10_heating_configuration
fields json The field of the rtd10_heating_configuration to get. (None gets all fields)

Returns: (return data)


get_rtd10_heating_configurations

Get all rtd10_heating_configurations.


?: :type fields: list ?: :returns: 'config': list of rtd10_heating_configuration dict: contains 'id' (Id), 'mode_output' (Byte), 'mode_value' (Byte), 'on_off_output' (Byte), 'poke_angle_output' (Byte), 'poke_angle_value' (Byte), 'room' (Byte), 'temp_setpoint_output' (Byte), 'ventilation_speed_output' (Byte), 'ventilation_speed_value' (Byte) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the rtd10_heating_configuration to get. (None gets all fields)

Returns: (return data)


get_scheduled_action_configuration

Get a specific scheduled_action_configuration defined by its id.


?: :type id: int ?: :type fields: list ?: :returns: 'config': scheduled_action_configuration dict: contains 'id' (Id), 'action' (Actions[1]), 'day' (Byte), 'hour' (Byte), 'minute' (Byte) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the scheduled_action_configuration
fields json The field of the scheduled_action_configuration to get. (None gets all fields)

Returns: (return data)


get_scheduled_action_configurations

Get all scheduled_action_configurations.


?: :type fields: list ?: :returns: 'config': list of scheduled_action_configuration dict: contains 'id' (Id), 'action' (Actions[1]), 'day' (Byte), 'hour' (Byte), 'minute' (Byte) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the scheduled_action_configuration to get. (None gets all fields)

Returns: (return data)


get_sensor_brightness_status

Get the current brightness of all sensors.


?: :returns: 'status': List of 32 bytes, 1 for each sensor. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_sensor_configuration

Get a specific sensor_configuration defined by its id.


?: :type id: int ?: :type fields: list ?: :returns: 'config': sensor_configuration dict: contains 'id' (Id), 'name' (String[16]), 'offset' (SignedTemp(-7.5 to 7.5 degrees)), 'room' (Byte), 'virtual' (Boolean) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the sensor_configuration
fields json The field of the sensor_configuration to get. (None gets all fields)

Returns: (return data)


get_sensor_configurations

Get all sensor_configurations.


?: :type fields: list ?: :returns: 'config': list of sensor_configuration dict: contains 'id' (Id), 'name' (String[16]), 'offset' (SignedTemp(-7.5 to 7.5 degrees)), 'room' (Byte), 'virtual' (Boolean) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the sensor_configuration to get. (None gets all fields)

Returns: (return data)


get_sensor_humidity_status

Get the current humidity of all sensors.


?: :returns: 'status': List of 32 bytes, 1 for each sensor. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_sensor_temperature_status

Get the current temperature of all sensors.


?: :returns: 'status': list of 32 temperatures, 1 for each sensor. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_settings

Gets a given setting

Parameters:

parameter type description
settings json None

Returns: (return data)


get_shutter_configuration

Get a specific shutter_configuration defined by its id.


?: :type id: Id ?: :type fields: list ?: :returns: 'config': shutter_configuration dict: contains 'id' (Id), 'group_1' (Byte), 'group_2' (Byte), 'name' (String[16]), 'room' (Byte), 'timer_down' (Byte), 'timer_up' (Byte), 'up_down_config' (Byte) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the shutter_configuration
fields json The fields of the shutter_configuration to get. (None gets all fields)

Returns: (return data)


get_shutter_configurations

Get all shutter_configurations.


?: :type fields: list ?: :returns: 'config': list of shutter_configuration dict: contains 'id' (Id), 'group_1' (Byte), 'group_2' (Byte), 'name' (String[16]), 'room' (Byte), 'timer_down' (Byte), 'timer_up' (Byte), 'up_down_config' (Byte) ?: :rtype: dict

Parameters:

parameter type description
fields json The fields of the shutter_configuration to get. (None gets all fields)

Returns: (return data)


get_shutter_group_configuration

Get a specific shutter_group_configuration defined by its id.


?: :type id: int ?: :type fields: list ?: :returns: 'config': shutter_group_configuration dict: contains 'id' (Id), 'room' (Byte), 'timer_down' (Byte), 'timer_up' (Byte) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the shutter_group_configuration
fields json The field of the shutter_group_configuration to get. (None gets all fields)

Returns: (return data)


get_shutter_group_configurations

Get all shutter_group_configurations.


?: :type fields: list ?: :returns: 'config': list of shutter_group_configuration dict: contains 'id' (Id), 'room' (Byte), 'timer_down' (Byte), 'timer_up' (Byte) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the shutter_group_configuration to get. (None gets all fields)

Returns: (return data)


get_shutter_status

Get the status of the shutters.


?: :returns: 'status': list of dictionaries with the following keys: id, position. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_startup_action_configuration

Get the startup_action_configuration.


?: :type fields: list ?: :returns: 'config': startup_action_configuration dict: contains 'actions' (Actions[100]) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the startup_action_configuration to get. (None gets all fields)

Returns: (return data)


get_status

Get the status of the master.


?: :returns: 'time': hour and minutes (HH:MM), 'date': day, month, year (DD:MM:YYYY), 'mode': Integer, 'version': a.b.c and 'hw_version': hardware version (Integer). ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_thermostat_configuration

Get a specific thermostat_configuration defined by its id.


?: :type id: int ?: :type fields: list ?: :returns: 'config': thermostat_configuration dict: contains 'id' (Id), 'auto_fri' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_mon' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sat' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sun' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_thu' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_tue' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_wed' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'name' (String[16]), 'output0' (Byte), 'output1' (Byte), 'permanent_manual' (Boolean), 'pid_d' (Byte), 'pid_i' (Byte), 'pid_int' (Byte), 'pid_p' (Byte), 'room' (Byte), 'sensor' (Byte), 'setp0' (Temp), 'setp1' (Temp), 'setp2' (Temp), 'setp3' (Temp), 'setp4' (Temp), 'setp5' (Temp) ?: :rtype: dict

Parameters:

parameter type description
id int The id of the thermostat_configuration
fields json The field of the thermostat_configuration to get. (None gets all fields)

Returns: (return data)


get_thermostat_configurations

Get all thermostat_configurations.


?: :type fields: list ?: :returns: 'config': list of thermostat_configuration dict: contains 'id' (Id), 'auto_fri' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_mon' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sat' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sun' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_thu' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_tue' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_wed' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'name' (String[16]), 'output0' (Byte), 'output1' (Byte), 'permanent_manual' (Boolean), 'pid_d' (Byte), 'pid_i' (Byte), 'pid_int' (Byte), 'pid_p' (Byte), 'room' (Byte), 'sensor' (Byte), 'setp0' (Temp), 'setp1' (Temp), 'setp2' (Temp), 'setp3' (Temp), 'setp4' (Temp), 'setp5' (Temp) ?: :rtype: dict

Parameters:

parameter type description
fields json The field of the thermostat_configuration to get. (None gets all fields)

Returns: (return data)


get_thermostat_status

Get the status of the thermostats.


?: :returns: global status information about the thermostats: 'thermostats_on', 'automatic' and 'setpoint' and 'status': a list with status information for all thermostats, each element in the list is a dict with the following keys: 'id', 'act', 'csetp', 'output0', 'output1', 'outside', 'mode'. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_timezone

Get the timezone for the gateway.


?: :returns: 'timezone': the timezone in 'Continent/City' format (String). ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_total_energy

Get the total energy (Wh) consumed by the power modules.


?: :returns: modules id as key: [day, night]. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_update_output

Get the output of the last update.


?: :returns: 'output': String with the output from the update script. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_usernames

Get the names of the users on the gateway. Only possible in authorized mode.


?: :returns: 'usernames': list of usernames (String). ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


get_version

Get the version of the openmotics software.


?: :returns: 'version': String (a.b.c). ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


in_power_address_mode

Check if the power modules are in address mode.


?: :returns: 'address_mode': Boolean ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


index

Index page of the web service (Gateway GUI)

?: :returns: Contents of index.html ?: :rtype: str

Parameters:

parameter type description

Returns: (return data)


install_plugin

Install a new plugin. The package_data should include a __init__.py file and

       will be installed in /opt/openmotics/python/plugins/<name>.


?: :type md5: String ?: :type package_data: multipart/form-data encoded byte string.

Parameters:

parameter type description
md5 None md5 sum of the package_data.
package_data None a tgz file containing the content of the plugin package.

Returns: (return data)


list_scheduled_actions

-

Parameters:

parameter type description

Returns: (return data)


list_schedules

-

Parameters:

parameter type description

Returns: (return data)


login

Login to the web service, returns a token if successful, returns HTTP status code 401 otherwise.


?: :type username: str ?: :type password: str ?: :type timeout: int ?: :returns: Authentication token ?: :rtype: str

Parameters:

parameter type description
username None Name of the user.
password None Password of the user.
timeout int Optional session timeout. 30d >= x >= 1h

Returns: (return data)


logout

Logout from the web service.


?: :returns: 'status': 'OK' ?: :rtype: str

Parameters:

parameter type description
token None None

Returns: (return data)


master_clear_error_list

Clear the number of errors.

Parameters:

parameter type description

Returns: (return data)


master_restore

Restore a backup of the eeprom of the master.


?: :type data: multipart/form-data encoded bytes (size = 64 kb). ?: :returns: 'output': array with the addresses that were written. ?: :rtype: dict

Parameters:

parameter type description
data None The eeprom backup to restore.

Returns: (return data)


module_discover_start

Start the module discover mode on the master.


?: :returns: 'status': 'OK'. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


module_discover_status

Gets the status of the module discover mode on the master.


?: :returns 'running': true|false ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


module_discover_stop

Stop the module discover mode on the master.


?: :returns: 'status': 'OK'. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


open_maintenance

Open maintenance mode, return the port of the maintenance socket.


?: :returns: 'port': Port on which the maintenance ssl socket is listening (Integer between 6000 and 7000). ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


remove_plugin

Remove a plugin. This removes the package data and configuration data of the plugin.


?: :type name: str

Parameters:

parameter type description
name None Name of the plugin to remove.

Returns: (return data)


remove_schedule

-

Parameters:

parameter type description
schedule_id int None

Returns: (return data)


remove_scheduled_action

-

Parameters:

parameter type description
id int None

Returns: (return data)


remove_user

Remove a user. Only possible in authorized mode.


?: :type username: str

Parameters:

parameter type description
username None Name of the user to remove.

Returns: (return data)


reset_master

Perform a cold reset on the master.


?: :returns: 'status': 'OK'. ?: :rtype: dict

Parameters:

parameter type description

Returns: (return data)


restore_full_backup

Restore a full backup containing the master eeprom and the sqlite databases.


?: :type backup_data: multipart/form-data encoded bytes. ?: :returns: dict with 'output' key. ?: :rtype: dict

Parameters:

parameter type description
backup_data None The full backup to restore: tar containing 4 files: master.eep, config.db, scheduled.db, power.db and eeprom_extensions.db as a string of bytes.

Returns: (return data)


schedule_action

-

Parameters:

parameter type description
timestamp int None
action json None

Returns: (return data)


self_test

Perform a Gateway self-test.

Parameters:

parameter type description

Returns: (return data)


set_airco_status

Set the mode of the airco attached to a given thermostat.


?: :type thermostat_id: int ?: :type airco_on: bool ?: :returns: dict with 'status' ?: :rtype: dict

Parameters:

parameter type description
thermostat_id int The thermostat id.
airco_on bool Turns the airco on if True.

Returns: (return data)


set_all_lights_floor_off

Turn all lights on a given floor off.


?: :type floor: int

Parameters:

parameter type description
floor int The id of the floor

Returns: (return data)


set_all_lights_floor_on

Turn all lights on a given floor on.


?: :type floor: int

Parameters:

parameter type description
floor int The id of the floor

Returns: (return data)


set_all_lights_off

Turn all lights off.

Parameters:

parameter type description

Returns: (return data)


set_can_led_configuration

Set one can_led_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The can_led_configuration to set: can_led_configuration dict: contains 'id' (Id), 'can_led_1_function' (Enum), 'can_led_1_id' (Byte), 'can_led_2_function' (Enum), 'can_led_2_id' (Byte), 'can_led_3_function' (Enum), 'can_led_3_id' (Byte), 'can_led_4_function' (Enum), 'can_led_4_id' (Byte), 'room' (Byte)

Returns: (return data)


set_can_led_configurations

Set multiple can_led_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of can_led_configurations to set: list of can_led_configuration dict: contains 'id' (Id), 'can_led_1_function' (Enum), 'can_led_1_id' (Byte), 'can_led_2_function' (Enum), 'can_led_2_id' (Byte), 'can_led_3_function' (Enum), 'can_led_3_id' (Byte), 'can_led_4_function' (Enum), 'can_led_4_id' (Byte), 'room' (Byte)

Returns: (return data)


set_cooling_configuration

Set one cooling_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The cooling_configuration to set: cooling_configuration dict: contains 'id' (Id), 'auto_fri' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_mon' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sat' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sun' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_thu' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_tue' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_wed' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'name' (String[16]), 'output0' (Byte), 'output1' (Byte), 'permanent_manual' (Boolean), 'pid_d' (Byte), 'pid_i' (Byte), 'pid_int' (Byte), 'pid_p' (Byte), 'room' (Byte), 'sensor' (Byte), 'setp0' (Temp), 'setp1' (Temp), 'setp2' (Temp), 'setp3' (Temp), 'setp4' (Temp), 'setp5' (Temp)

Returns: (return data)


set_cooling_configurations

Set multiple cooling_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of cooling_configurations to set: list of cooling_configuration dict: contains 'id' (Id), 'auto_fri' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_mon' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sat' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sun' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_thu' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_tue' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_wed' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'name' (String[16]), 'output0' (Byte), 'output1' (Byte), 'permanent_manual' (Boolean), 'pid_d' (Byte), 'pid_i' (Byte), 'pid_int' (Byte), 'pid_p' (Byte), 'room' (Byte), 'sensor' (Byte), 'setp0' (Temp), 'setp1' (Temp), 'setp2' (Temp), 'setp3' (Temp), 'setp4' (Temp), 'setp5' (Temp)

Returns: (return data)


set_cooling_pump_group_configuration

Set one cooling_pump_group_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The cooling_pump_group_configuration to set: cooling_pump_group_configuration dict: contains 'id' (Id), 'outputs' (CSV[32]), 'room' (Byte)

Returns: (return data)


set_cooling_pump_group_configurations

Set multiple cooling_pump_group_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of cooling_pump_group_configurations to set: list of cooling_pump_group_configuration dict: contains 'id' (Id), 'outputs' (CSV[32]), 'room' (Byte)

Returns: (return data)


set_current_setpoint

Set the current setpoint of a thermostat.


?: :type thermostat: int ?: :type temperature: float ?: :return: 'status': 'OK'. ?: :rtype: dict

Parameters:

parameter type description
thermostat int The id of the thermostat to set
temperature float The temperature to set in degrees Celcius

Returns: (return data)


set_dimmer_configuration

Set the dimmer_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The dimmer_configuration to set: dimmer_configuration dict: contains 'dim_memory' (Byte), 'dim_step' (Byte), 'dim_wait_cycle' (Byte), 'min_dim_level' (Byte)

Returns: (return data)


set_global_rtd10_configuration

Set the global_rtd10_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The global_rtd10_configuration to set: global_rtd10_configuration dict: contains 'output_value_cooling_16' (Byte), 'output_value_cooling_16_5' (Byte), 'output_value_cooling_17' (Byte), 'output_value_cooling_17_5' (Byte), 'output_value_cooling_18' (Byte), 'output_value_cooling_18_5' (Byte), 'output_value_cooling_19' (Byte), 'output_value_cooling_19_5' (Byte), 'output_value_cooling_20' (Byte), 'output_value_cooling_20_5' (Byte), 'output_value_cooling_21' (Byte), 'output_value_cooling_21_5' (Byte), 'output_value_cooling_22' (Byte), 'output_value_cooling_22_5' (Byte), 'output_value_cooling_23' (Byte), 'output_value_cooling_23_5' (Byte), 'output_value_cooling_24' (Byte), 'output_value_heating_16' (Byte), 'output_value_heating_16_5' (Byte), 'output_value_heating_17' (Byte), 'output_value_heating_17_5' (Byte), 'output_value_heating_18' (Byte), 'output_value_heating_18_5' (Byte), 'output_value_heating_19' (Byte), 'output_value_heating_19_5' (Byte), 'output_value_heating_20' (Byte), 'output_value_heating_20_5' (Byte), 'output_value_heating_21' (Byte), 'output_value_heating_21_5' (Byte), 'output_value_heating_22' (Byte), 'output_value_heating_22_5' (Byte), 'output_value_heating_23' (Byte), 'output_value_heating_23_5' (Byte), 'output_value_heating_24' (Byte)

Returns: (return data)


set_global_thermostat_configuration

Set the global_thermostat_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The global_thermostat_configuration to set: global_thermostat_configuration dict: contains 'outside_sensor' (Byte), 'pump_delay' (Byte), 'switch_to_cooling_output_0' (Byte), 'switch_to_cooling_output_1' (Byte), 'switch_to_cooling_output_2' (Byte), 'switch_to_cooling_output_3' (Byte), 'switch_to_cooling_value_0' (Byte), 'switch_to_cooling_value_1' (Byte), 'switch_to_cooling_value_2' (Byte), 'switch_to_cooling_value_3' (Byte), 'switch_to_heating_output_0' (Byte), 'switch_to_heating_output_1' (Byte), 'switch_to_heating_output_2' (Byte), 'switch_to_heating_output_3' (Byte), 'switch_to_heating_value_0' (Byte), 'switch_to_heating_value_1' (Byte), 'switch_to_heating_value_2' (Byte), 'switch_to_heating_value_3' (Byte), 'threshold_temp' (Temp)

Returns: (return data)


set_group_action_configuration

Set one group_action_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The group_action_configuration to set: group_action_configuration dict: contains 'id' (Id), 'actions' (Actions[16]), 'name' (String[16])

Returns: (return data)


set_group_action_configurations

Set multiple group_action_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of group_action_configurations to set: list of group_action_configuration dict: contains 'id' (Id), 'actions' (Actions[16]), 'name' (String[16])

Returns: (return data)


set_input_configuration

Set one input_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The input_configuration to set: input_configuration dict: contains 'id' (Id), 'action' (Byte), 'basic_actions' (Actions[15]), 'invert' (Byte), 'name' (String[8]), 'room' (Byte)

Returns: (return data)


set_input_configurations

Set multiple input_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of input_configurations to set: list of input_configuration dict: contains 'id' (Id), 'action' (Byte), 'basic_actions' (Actions[15]), 'invert' (Byte), 'name' (String[8]), 'room' (Byte)

Returns: (return data)


set_master_status_leds

Set the status of the leds on the master.


?: :type status: bool

Parameters:

parameter type description
status bool whether the leds should be on (true) or off (false).

Returns: (return data)


set_output

Set the status, dimmer and timer of an output.


?: :type id: int ?: :type is_on: bool ?: :type dimmer: int or None ?: :type timer: int

Parameters:

parameter type description
id int The id of the output to set
is_on bool Whether the output should be on
dimmer int The dimmer value to set, None if unchanged
timer int The timer value to set, None if unchanged

Returns: (return data)


set_output_configuration

Set one output_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The output_configuration to set: dict: contains 'id' (Id), 'can_led_1_function' (Enum), 'can_led_1_id' (Byte), 'can_led_2_function' (Enum), 'can_led_2_id' (Byte), 'can_led_3_function' (Enum), 'can_led_3_id' (Byte), 'can_led_4_function' (Enum), 'can_led_4_id' (Byte), 'floor' (Byte), 'name' (String[16]), 'room' (Byte), 'timer' (Word), 'type' (Byte)

Returns: (return data)


set_output_configurations

Set multiple output_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of output_configurations to set: list of output_configuration dict: contains 'id' (Id), 'can_led_1_function' (Enum), 'can_led_1_id' (Byte), 'can_led_2_function' (Enum), 'can_led_2_id' (Byte), 'can_led_3_function' (Enum), 'can_led_3_id' (Byte), 'can_led_4_function' (Enum), 'can_led_4_id' (Byte), 'floor' (Byte), 'name' (String[16]), 'room' (Byte), 'timer' (Word), 'type' (Byte)

Returns: (return data)


set_per_thermostat_mode

Set the thermostat mode of a given thermostat. Thermostats can be set to automatic or

       manual, in case of manual a setpoint (0 to 5) can be provided.


?: :type thermostat_id: int ?: :type automatic: bool ?: :type setpoint: int

Parameters:

parameter type description
thermostat_id int The thermostat id
automatic bool Automatic mode (True) or Manual mode (False).
setpoint int The current setpoint.

Returns: (return data)


set_power_modules

Set information for the power modules.


?: :type modules: str

Parameters:

parameter type description
modules None json encoded list of dicts with keys: 'id', 'name', 'input0', 'input1', 'input2', 'input3', 'input4', 'input5', 'input6', 'input7', 'sensor0', 'sensor1', 'sensor2', 'sensor3', 'sensor4', 'sensor5', 'sensor6', 'sensor7', 'times0', 'times1', 'times2', 'times3', 'times4', 'times5', 'times6', 'times7'.

Returns: (return data)


set_power_voltage

Set the voltage for a given module.


?: :type module_id: int ?: :type voltage: float

Parameters:

parameter type description
module_id int The id of the power module.
voltage float The voltage to set for the power module.

Returns: (return data)


set_pulse_counter_configuration

Set one pulse_counter_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The pulse_counter_configuration to set: pulse_counter_configuration dict: contains 'id' (Id), 'input' (Byte), 'name' (String[16]), 'room' (Byte)

Returns: (return data)


set_pulse_counter_configurations

Set multiple pulse_counter_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of pulse_counter_configurations to set: list of pulse_counter_configuration dict: contains 'id' (Id), 'input' (Byte), 'name' (String[16]), 'room' (Byte)

Returns: (return data)


set_pump_group_configuration

Set one pump_group_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The pump_group_configuration to set: pump_group_configuration dict: contains 'id' (Id), 'outputs' (CSV[32]), 'room' (Byte)

Returns: (return data)


set_pump_group_configurations

Set multiple pump_group_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of pump_group_configurations to set: list of pump_group_configuration dict: contains 'id' (Id), 'outputs' (CSV[32]), 'room' (Byte)

Returns: (return data)


set_room_configuration

Set one room_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The room_configuration to set: room_configuration dict: contains 'id' (Id), 'floor' (Byte), 'name' (String)

Returns: (return data)


set_room_configurations

Set multiple room_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of room_configurations to set: list of room_configuration dict: contains 'id' (Id), 'floor' (Byte), 'name' (String)

Returns: (return data)


set_rtd10_cooling_configuration

Set one rtd10_cooling_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The rtd10_cooling_configuration to set: rtd10_cooling_configuration dict: contains 'id' (Id), 'mode_output' (Byte), 'mode_value' (Byte), 'on_off_output' (Byte), 'poke_angle_output' (Byte), 'poke_angle_value' (Byte), 'room' (Byte), 'temp_setpoint_output' (Byte), 'ventilation_speed_output' (Byte), 'ventilation_speed_value' (Byte)

Returns: (return data)


set_rtd10_cooling_configurations

Set multiple rtd10_cooling_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of rtd10_cooling_configurations to set: list of rtd10_cooling_configuration dict: contains 'id' (Id), 'mode_output' (Byte), 'mode_value' (Byte), 'on_off_output' (Byte), 'poke_angle_output' (Byte), 'poke_angle_value' (Byte), 'room' (Byte), 'temp_setpoint_output' (Byte), 'ventilation_speed_output' (Byte), 'ventilation_speed_value' (Byte)

Returns: (return data)


set_rtd10_heating_configuration

Set one rtd10_heating_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The rtd10_heating_configuration to set: rtd10_heating_configuration dict: contains 'id' (Id), 'mode_output' (Byte), 'mode_value' (Byte), 'on_off_output' (Byte), 'poke_angle_output' (Byte), 'poke_angle_value' (Byte), 'room' (Byte), 'temp_setpoint_output' (Byte), 'ventilation_speed_output' (Byte), 'ventilation_speed_value' (Byte)

Returns: (return data)


set_rtd10_heating_configurations

Set multiple rtd10_heating_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of rtd10_heating_configurations to set: list of rtd10_heating_configuration dict: contains 'id' (Id), 'mode_output' (Byte), 'mode_value' (Byte), 'on_off_output' (Byte), 'poke_angle_output' (Byte), 'poke_angle_value' (Byte), 'room' (Byte), 'temp_setpoint_output' (Byte), 'ventilation_speed_output' (Byte), 'ventilation_speed_value' (Byte)

Returns: (return data)


set_scheduled_action_configuration

Set one scheduled_action_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The scheduled_action_configuration to set: scheduled_action_configuration dict: contains 'id' (Id), 'action' (Actions[1]), 'day' (Byte), 'hour' (Byte), 'minute' (Byte)

Returns: (return data)


set_scheduled_action_configurations

Set multiple scheduled_action_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of scheduled_action_configurations to set: list of scheduled_action_configuration dict: contains 'id' (Id), 'action' (Actions[1]), 'day' (Byte), 'hour' (Byte), 'minute' (Byte)

Returns: (return data)


set_sensor_configuration

Set one sensor_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The sensor_configuration to set: sensor_configuration dict: contains 'id' (Id), 'name' (String[16]), 'offset' (SignedTemp(-7.5 to 7.5 degrees)), 'room' (Byte), 'virtual' (Boolean)

Returns: (return data)


set_sensor_configurations

Set multiple sensor_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of sensor_configurations to set: list of sensor_configuration dict: contains 'id' (Id), 'name' (String[16]), 'offset' (SignedTemp(-7.5 to 7.5 degrees)), 'room' (Byte), 'virtual' (Boolean)

Returns: (return data)


set_setting

Configures a setting

Parameters:

parameter type description
setting None None
value json None

Returns: (return data)


set_shutter_configuration

Set one shutter_configuration.


?: :type config: dict

Parameters:

parameter type description
config None The shutter_configuration to set: shutter_configuration dict: contains 'id' (Id), 'group_1' (Byte), 'group_2' (Byte), 'name' (String[16]), 'room' (Byte), 'timer_down' (Byte), 'timer_up' (Byte), 'up_down_config' (Byte)

Returns: (return data)


set_shutter_configurations

Set multiple shutter_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of shutter_configurations to set: list of shutter_configuration dict: contains 'id' (Id), 'group_1' (Byte), 'group_2' (Byte), 'name' (String[16]), 'room' (Byte), 'timer_down' (Byte), 'timer_up' (Byte), 'up_down_config' (Byte)

Returns: (return data)


set_shutter_group_configuration

Set one shutter_group_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The shutter_group_configuration to set: shutter_group_configuration dict: contains 'id' (Id), 'room' (Byte), 'timer_down' (Byte), 'timer_up' (Byte)

Returns: (return data)


set_shutter_group_configurations

Set multiple shutter_group_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of shutter_group_configurations to set: list of shutter_group_configuration dict: contains 'id' (Id), 'room' (Byte), 'timer_down' (Byte), 'timer_up' (Byte)

Returns: (return data)


set_startup_action_configuration

Set the startup_action_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The startup_action_configuration to set: startup_action_configuration dict: contains 'actions' (Actions[100])

Returns: (return data)


set_thermostat_configuration

Set one thermostat_configuration.


?: :type config: dict

Parameters:

parameter type description
config json The thermostat_configuration to set: thermostat_configuration dict: contains 'id' (Id), 'auto_fri' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_mon' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sat' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sun' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_thu' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_tue' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_wed' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'name' (String[16]), 'output0' (Byte), 'output1' (Byte), 'permanent_manual' (Boolean), 'pid_d' (Byte), 'pid_i' (Byte), 'pid_int' (Byte), 'pid_p' (Byte), 'room' (Byte), 'sensor' (Byte), 'setp0' (Temp), 'setp1' (Temp), 'setp2' (Temp), 'setp3' (Temp), 'setp4' (Temp), 'setp5' (Temp)

Returns: (return data)


set_thermostat_configurations

Set multiple thermostat_configurations.


?: :type config: list

Parameters:

parameter type description
config json The list of thermostat_configurations to set: list of thermostat_configuration dict: contains 'id' (Id), 'auto_fri' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_mon' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sat' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_sun' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_thu' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_tue' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'auto_wed' ([temp_n(Temp),start_d1(Time),stop_d1(Time),temp_d1(Temp),start_d2(Time),stop_d2(Time),temp_d2(Temp)]), 'name' (String[16]), 'output0' (Byte), 'output1' (Byte), 'permanent_manual' (Boolean), 'pid_d' (Byte), 'pid_i' (Byte), 'pid_int' (Byte), 'pid_p' (Byte), 'room' (Byte), 'sensor' (Byte), 'setp0' (Temp), 'setp1' (Temp), 'setp2' (Temp), 'setp3' (Temp), 'setp4' (Temp), 'setp5' (Temp)

Returns: (return data)


set_thermostat_mode

Set the global mode of the thermostats. Thermostats can be on or off (thermostat_on),

       can be in cooling or heating (cooling_mode), cooling can be turned on or off (cooling_on).
       The automatic and setpoint parameters are here for backwards compatibility and will be
       applied to all thermostats. To control the automatic and setpoint parameters per thermostat
       use the set_per_thermostat_mode call instead.


?: :type thermostat_on: bool ?: backwards compatibility, use set_per_thermostat_mode instead. ?: :type automatic: bool or None ?: use set_per_thermostat_mode instead. ?: :type setpoint: int or None ?: :type cooling_mode: bool or None ?: :return: 'status': 'OK'. ?: :rtype: dict

Parameters:

parameter type description
thermostat_on bool Whether the thermostats are on
automatic bool Automatic mode (True) or Manual mode (False). This parameter is here for
setpoint int The current setpoint. This parameter is here for backwards compatibility,
cooling_mode bool Cooling mode (True) of Heating mode (False)
cooling_on bool bool or None

Returns: (return data)


set_timezone

Set the timezone for the gateway.


?: :type timezone: str

Parameters:

parameter type description
timezone None in format 'Continent/City'.

Returns: (return data)


set_virtual_sensor

Set the temperature, humidity and brightness value of a virtual sensor.


?: :type sensor_id: int ?: :type temperature: float ?: :type humidity: float ?: :type brightness: int ?: :returns: dict with 'status'. ?: :rtype: dict

Parameters:

parameter type description
sensor_id int The id of the sensor.
temperature float The temperature to set in degrees Celcius
humidity float The humidity to set in percentage
brightness int The brightness to set in percentage

Returns: (return data)


start_power_address_mode

Start the address mode on the power modules.

Parameters:

parameter type description

Returns: (return data)


stop_power_address_mode

Stop the address mode on the power modules.

Parameters:

parameter type description

Returns: (return data)


update

Perform an update.


?: :type version: str ?: :type md5: str ?: :type update_data: multipart/form-data encoded byte string.

Parameters:

parameter type description
version None the new version number.
md5 None the md5 sum of update_data.
update_data None a tgz file containing the update script (update.sh) and data.

Returns: (return data)


ws_metrics

-

Parameters:

parameter type description
token None None
client_id None None
source None None
metric_type None None
interval None None

Returns: (return data)