xs1_api_client
master
API
xs1_api_client
Docs
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
A
AB400 (xs1_api_client.api_constants.SystemType attribute)
AB500 (xs1_api_client.api_constants.SystemType attribute)
AB601 (xs1_api_client.api_constants.SystemType attribute)
ABSOLUT (xs1_api_client.api_constants.FunctionType attribute)
ACTUATOR (xs1_api_client.api_constants.Node attribute)
ActuatorType (class in xs1_api_client.api_constants)
ADDRESS (xs1_api_client.api_constants.UrlParam attribute)
AIR_QUALITY (xs1_api_client.api_constants.SensorType attribute)
ALARMMAT (xs1_api_client.api_constants.SensorType attribute)
AUTO (xs1_api_client.api_constants.FunctionType attribute)
B
BAROMETER (xs1_api_client.api_constants.SensorType attribute)
BGJ (xs1_api_client.api_constants.SystemType attribute)
BLIND (xs1_api_client.api_constants.ActuatorType attribute)
BLIND_ABS (xs1_api_client.api_constants.FunctionType attribute)
BSQUIGG (xs1_api_client.api_constants.SystemType attribute)
BUTTON_LONG (xs1_api_client.api_constants.FunctionType attribute)
BUTTON_SHORT (xs1_api_client.api_constants.FunctionType attribute)
C
call_actuator_function() (xs1_api_client.api.XS1 method)
call_function() (xs1_api_client.device.actuator.XS1Actuator method)
CMD_TYPE_MISSING (xs1_api_client.api_constants.ErrorCode attribute)
Command (class in xs1_api_client.api_constants)
COMMAND (xs1_api_client.api_constants.UrlParam attribute)
COUNTER (xs1_api_client.api_constants.SensorType attribute)
COUNTERDIFF (xs1_api_client.api_constants.SensorType attribute)
D
description() (xs1_api_client.device.actuator.XS1Function method)
DEVICE_BOOTLOADER_VERSION (xs1_api_client.api_constants.Node attribute)
DEVICE_FIRMWARE_VERSION (xs1_api_client.api_constants.Node attribute)
DEVICE_HARDWARE_VERSION (xs1_api_client.api_constants.Node attribute)
DEVICE_MAC (xs1_api_client.api_constants.Node attribute)
DEVICE_NAME (xs1_api_client.api_constants.Node attribute)
DEVICE_UPTIME (xs1_api_client.api_constants.Node attribute)
DIM_ABSOLUT (xs1_api_client.api_constants.FunctionType attribute)
DIM_DOWN (xs1_api_client.api_constants.FunctionType attribute)
DIM_UP (xs1_api_client.api_constants.FunctionType attribute)
DIMMER (xs1_api_client.api_constants.ActuatorType attribute)
DISABLED (xs1_api_client.api_constants.ActuatorType attribute)
(xs1_api_client.api_constants.FunctionType attribute)
(xs1_api_client.api_constants.SensorType attribute)
DOOR (xs1_api_client.api_constants.ActuatorType attribute)
DOORBELL (xs1_api_client.api_constants.SensorType attribute)
DOOROPEN (xs1_api_client.api_constants.SensorType attribute)
DUPLICATE (xs1_api_client.api_constants.ErrorCode attribute)
E
EM (xs1_api_client.api_constants.SystemType attribute)
enabled() (xs1_api_client.device.XS1Device method)
ERROR (xs1_api_client.api_constants.Node attribute)
ErrorCode (class in xs1_api_client.api_constants)
execute() (xs1_api_client.device.actuator.XS1Function method)
F
FA20RF (xs1_api_client.api_constants.SystemType attribute)
FACTOR (xs1_api_client.api_constants.UrlParam attribute)
FC1 (xs1_api_client.api_constants.SystemType attribute)
FENCEDETECTOR (xs1_api_client.api_constants.SensorType attribute)
FHT (xs1_api_client.api_constants.SystemType attribute)
FS10 (xs1_api_client.api_constants.SystemType attribute)
FS20 (xs1_api_client.api_constants.SystemType attribute)
FUNCTION (xs1_api_client.api_constants.Node attribute)
(xs1_api_client.api_constants.UrlParam attribute)
FUNCTION1_DSC (xs1_api_client.api_constants.UrlParam attribute)
FUNCTION1_TYPE (xs1_api_client.api_constants.UrlParam attribute)
FUNCTION2_DSC (xs1_api_client.api_constants.UrlParam attribute)
FUNCTION2_TYPE (xs1_api_client.api_constants.UrlParam attribute)
FUNCTION3_DSC (xs1_api_client.api_constants.UrlParam attribute)
FUNCTION3_TYPE (xs1_api_client.api_constants.UrlParam attribute)
FUNCTION4_DSC (xs1_api_client.api_constants.UrlParam attribute)
FUNCTION4_TYPE (xs1_api_client.api_constants.UrlParam attribute)
FunctionType (class in xs1_api_client.api_constants)
G
GAS_BUTAN (xs1_api_client.api_constants.SensorType attribute)
GAS_CO (xs1_api_client.api_constants.SensorType attribute)
GAS_CONSUMP (xs1_api_client.api_constants.SensorType attribute)
GAS_METHAN (xs1_api_client.api_constants.SensorType attribute)
GAS_PEAK (xs1_api_client.api_constants.SensorType attribute)
GAS_PROPAN (xs1_api_client.api_constants.SensorType attribute)
get_actuator() (xs1_api_client.api.XS1 method)
get_all_actuators() (xs1_api_client.api.XS1 method)
get_all_sensors() (xs1_api_client.api.XS1 method)
GET_CONFIG_ACTUATOR (xs1_api_client.api_constants.Command attribute)
get_config_actuator() (xs1_api_client.api.XS1 method)
GET_CONFIG_INFO (xs1_api_client.api_constants.Command attribute)
GET_CONFIG_MAIN (xs1_api_client.api_constants.Command attribute)
get_config_main() (xs1_api_client.api.XS1 method)
GET_CONFIG_SENSOR (xs1_api_client.api_constants.Command attribute)
get_config_sensor() (xs1_api_client.api.XS1 method)
get_function_by_id() (xs1_api_client.device.actuator.XS1Actuator method)
get_function_by_type() (xs1_api_client.device.actuator.XS1Actuator method)
get_functions() (xs1_api_client.device.actuator.XS1Actuator method)
get_gateway_bootloader_version() (xs1_api_client.api.XS1 method)
get_gateway_firmware_version() (xs1_api_client.api.XS1 method)
get_gateway_hardware_version() (xs1_api_client.api.XS1 method)
get_gateway_mac() (xs1_api_client.api.XS1 method)
get_gateway_name() (xs1_api_client.api.XS1 method)
get_gateway_uptime() (xs1_api_client.api.XS1 method)
GET_LIST_ACTUATORS (xs1_api_client.api_constants.Command attribute)
GET_LIST_FUNCTIONS (xs1_api_client.api_constants.Command attribute)
get_list_functions() (xs1_api_client.api.XS1 method)
GET_LIST_RFMODES (xs1_api_client.api_constants.Command attribute)
GET_LIST_SENSORS (xs1_api_client.api_constants.Command attribute)
GET_LIST_SYSTEMS (xs1_api_client.api_constants.Command attribute)
get_list_systems() (xs1_api_client.api.XS1 method)
get_message() (xs1_api_client.api_constants.ErrorCode static method)
GET_PROTOCOL_INFO (xs1_api_client.api_constants.Command attribute)
get_protocol_info() (xs1_api_client.api.XS1 method)
get_sensor() (xs1_api_client.api.XS1 method)
GET_STATE_ACTUATOR (xs1_api_client.api_constants.Command attribute)
get_state_actuator() (xs1_api_client.api.XS1 method)
GET_STATE_SENSOR (xs1_api_client.api_constants.Command attribute)
get_state_sensor() (xs1_api_client.api.XS1 method)
GET_TYPES_ACTUATORS (xs1_api_client.api_constants.Command attribute)
get_types_actuators() (xs1_api_client.api.XS1 method)
GET_TYPES_SENSORS (xs1_api_client.api_constants.Command attribute)
get_types_sensors() (xs1_api_client.api.XS1 method)
H
HE (xs1_api_client.api_constants.SystemType attribute)
HEATDETECTOR (xs1_api_client.api_constants.SensorType attribute)
HMS (xs1_api_client.api_constants.SystemType attribute)
HYGROMETER (xs1_api_client.api_constants.SensorType attribute)
I
id() (xs1_api_client.device.actuator.XS1Function method)
(xs1_api_client.device.XS1Device method)
IMPULS (xs1_api_client.api_constants.FunctionType attribute)
INFO (xs1_api_client.api_constants.Node attribute)
INITVALUE (xs1_api_client.api_constants.UrlParam attribute)
INVALID_COMMAND (xs1_api_client.api_constants.ErrorCode attribute)
INVALID_DATE_TIME (xs1_api_client.api_constants.ErrorCode attribute)
INVALID_FUNCTION (xs1_api_client.api_constants.ErrorCode attribute)
INVALID_SYSTEM (xs1_api_client.api_constants.ErrorCode attribute)
INVALID_TIME_RANGE (xs1_api_client.api_constants.ErrorCode attribute)
IT (xs1_api_client.api_constants.SystemType attribute)
IT2 (xs1_api_client.api_constants.SystemType attribute)
L
last_update() (xs1_api_client.device.XS1Device method)
LEAFWETNESS (xs1_api_client.api_constants.SensorType attribute)
LEARN (xs1_api_client.api_constants.FunctionType attribute)
LIGHT (xs1_api_client.api_constants.SensorType attribute)
LIGHTBARRIER (xs1_api_client.api_constants.SensorType attribute)
LOG (xs1_api_client.api_constants.UrlParam attribute)
LONG_OFF (xs1_api_client.api_constants.FunctionType attribute)
LONG_ON (xs1_api_client.api_constants.FunctionType attribute)
M
MAIL (xs1_api_client.api_constants.SensorType attribute)
MANUAL (xs1_api_client.api_constants.FunctionType attribute)
MARMI (xs1_api_client.api_constants.SystemType attribute)
MOTION (xs1_api_client.api_constants.SensorType attribute)
N
NAME (xs1_api_client.api_constants.UrlParam attribute)
name() (xs1_api_client.device.XS1Device method)
NAME_PATTERN_VALID (xs1_api_client.device.XS1Device attribute)
new_value() (xs1_api_client.device.XS1Device method)
Node (class in xs1_api_client.api_constants)
NOT_FOUND (xs1_api_client.api_constants.ErrorCode attribute)
NUMBER (xs1_api_client.api_constants.UrlParam attribute)
O
OASEFM (xs1_api_client.api_constants.SystemType attribute)
OBJECT_NOT_FOUND (xs1_api_client.api_constants.ErrorCode attribute)
OFF (xs1_api_client.api_constants.FunctionType attribute)
OFF_WAIT_OFF (xs1_api_client.api_constants.FunctionType attribute)
OFF_WAIT_ON (xs1_api_client.api_constants.FunctionType attribute)
OFFSET (xs1_api_client.api_constants.UrlParam attribute)
OIL_CONSUMP (xs1_api_client.api_constants.SensorType attribute)
OIL_PEAK (xs1_api_client.api_constants.SensorType attribute)
ON (xs1_api_client.api_constants.FunctionType attribute)
ON_WAIT_OFF (xs1_api_client.api_constants.FunctionType attribute)
ON_WAIT_ON (xs1_api_client.api_constants.FunctionType attribute)
OTHER (xs1_api_client.api_constants.SensorType attribute)
P
PARAM_DESCRIPTION (xs1_api_client.api_constants.Node attribute)
PARAM_FUNCTION (xs1_api_client.api_constants.Node attribute)
PARAM_ID (xs1_api_client.api_constants.Node attribute)
PARAM_NAME (xs1_api_client.api_constants.Node attribute)
PARAM_NEW_VALUE (xs1_api_client.api_constants.Node attribute)
PARAM_NUMBER (xs1_api_client.api_constants.Node attribute)
PARAM_TYPE (xs1_api_client.api_constants.Node attribute)
PARAM_UNIT (xs1_api_client.api_constants.Node attribute)
PARAM_UTIME (xs1_api_client.api_constants.Node attribute)
PARAM_VALUE (xs1_api_client.api_constants.Node attribute)
PASSWORD (xs1_api_client.api_constants.UrlParam attribute)
PRESENCE (xs1_api_client.api_constants.SensorType attribute)
PROTOCOL_VERSION_MISMATCH (xs1_api_client.api_constants.ErrorCode attribute)
PWR_CONSUMP (xs1_api_client.api_constants.SensorType attribute)
PWR_PEAK (xs1_api_client.api_constants.SensorType attribute)
PYRANOMETER (xs1_api_client.api_constants.SensorType attribute)
R
RAIN (xs1_api_client.api_constants.SensorType attribute)
RAIN_1H (xs1_api_client.api_constants.SensorType attribute)
RAIN_24H (xs1_api_client.api_constants.SensorType attribute)
RAININTENSITY (xs1_api_client.api_constants.SensorType attribute)
RELATIVE (xs1_api_client.api_constants.FunctionType attribute)
REMOTECONTROL (xs1_api_client.api_constants.SensorType attribute)
RETRY_STRATEGY (xs1_api_client.api.XS1 attribute)
REV (xs1_api_client.api_constants.SystemType attribute)
RGBLED1 (xs1_api_client.api_constants.SystemType attribute)
RS200 (xs1_api_client.api_constants.SystemType attribute)
RS862 (xs1_api_client.api_constants.SystemType attribute)
RSL (xs1_api_client.api_constants.SystemType attribute)
S
SCHALK (xs1_api_client.api_constants.SystemType attribute)
send_request() (xs1_api_client.api.XS1 method)
SENSOR (xs1_api_client.api_constants.Node attribute)
SensorType (class in xs1_api_client.api_constants)
set_actuator_value() (xs1_api_client.api.XS1 method)
SET_CONFIG_ACTUATOR (xs1_api_client.api_constants.Command attribute)
set_config_actuator() (xs1_api_client.api.XS1 method)
SET_CONFIG_SENSOR (xs1_api_client.api_constants.Command attribute)
set_config_sensor() (xs1_api_client.api.XS1 method)
set_connection_info() (xs1_api_client.api.XS1 method)
set_name() (xs1_api_client.device.actuator.XS1Actuator method)
(xs1_api_client.device.XS1Device method)
(xs1_api_client.device.sensor.XS1Sensor method)
set_sensor_value() (xs1_api_client.api.XS1 method)
set_state() (xs1_api_client.device.XS1Device method)
SET_STATE_ACTUATOR (xs1_api_client.api_constants.Command attribute)
SET_STATE_SENSOR (xs1_api_client.api_constants.Command attribute)
set_temperature() (xs1_api_client.device.actuator.thermostat.XS1Thermostat method)
set_value() (xs1_api_client.device.actuator.XS1Actuator method)
(xs1_api_client.device.XS1Device method)
(xs1_api_client.device.sensor.XS1Sensor method)
SHUTTER (xs1_api_client.api_constants.ActuatorType attribute)
SMOKEDETECTOR (xs1_api_client.api_constants.SensorType attribute)
SOILMOISTURE (xs1_api_client.api_constants.SensorType attribute)
SOILTEMP (xs1_api_client.api_constants.SensorType attribute)
SOUND (xs1_api_client.api_constants.ActuatorType attribute)
SPECIAL (xs1_api_client.api_constants.FunctionType attribute)
STOP (xs1_api_client.api_constants.FunctionType attribute)
SUN_BLIND (xs1_api_client.api_constants.ActuatorType attribute)
SWITCH (xs1_api_client.api_constants.ActuatorType attribute)
SYNTAX_ERROR (xs1_api_client.api_constants.ErrorCode attribute)
SYSTEM (xs1_api_client.api_constants.Node attribute)
(xs1_api_client.api_constants.UrlParam attribute)
SystemType (class in xs1_api_client.api_constants)
T
TEMPERATURE (xs1_api_client.api_constants.ActuatorType attribute)
(xs1_api_client.api_constants.SensorType attribute)
TIMERSWITCH (xs1_api_client.api_constants.ActuatorType attribute)
TOGGLE (xs1_api_client.api_constants.FunctionType attribute)
turn_off() (xs1_api_client.device.actuator.switch.XS1Switch method)
turn_on() (xs1_api_client.device.actuator.switch.XS1Switch method)
TYPE (xs1_api_client.api_constants.UrlParam attribute)
type() (xs1_api_client.device.actuator.XS1Function method)
(xs1_api_client.device.XS1Device method)
TYPE_NOT_VIRTUAL (xs1_api_client.api_constants.ErrorCode attribute)
U
unit() (xs1_api_client.device.XS1Device method)
UNIT_BOOLEAN (in module xs1_api_client.api_constants)
UNKNOWN (xs1_api_client.api_constants.FunctionType attribute)
update() (xs1_api_client.device.actuator.XS1Actuator method)
(xs1_api_client.device.XS1Device method)
(xs1_api_client.device.sensor.XS1Sensor method)
update_config_info() (xs1_api_client.api.XS1 method)
UrlParam (class in xs1_api_client.api_constants)
USER (xs1_api_client.api_constants.UrlParam attribute)
UV_INDEX (xs1_api_client.api_constants.SensorType attribute)
V
VALUE (xs1_api_client.api_constants.UrlParam attribute)
value() (xs1_api_client.device.XS1Device method)
VALUE_DISABLED (in module xs1_api_client.api_constants)
VENT831 (xs1_api_client.api_constants.SystemType attribute)
VERSION (xs1_api_client.api_constants.Node attribute)
VIRTUAL (xs1_api_client.api_constants.SystemType attribute)
W
WAIT (xs1_api_client.api_constants.FunctionType attribute)
WAREMA (xs1_api_client.api_constants.SystemType attribute)
WATERDETECTOR (xs1_api_client.api_constants.SensorType attribute)
WATERLEVEL (xs1_api_client.api_constants.SensorType attribute)
WINDDIRECTION (xs1_api_client.api_constants.SensorType attribute)
WINDGUST (xs1_api_client.api_constants.SensorType attribute)
WINDOW (xs1_api_client.api_constants.ActuatorType attribute)
WINDOWBREAK (xs1_api_client.api_constants.SensorType attribute)
WINDOWOPEN (xs1_api_client.api_constants.SensorType attribute)
WINDSPEED (xs1_api_client.api_constants.SensorType attribute)
WINDVARIANCE (xs1_api_client.api_constants.SensorType attribute)
WMR200 (xs1_api_client.api_constants.SystemType attribute)
WS300 (xs1_api_client.api_constants.SystemType attribute)
WS433 (xs1_api_client.api_constants.SystemType attribute)
WTR_CONSUMP (xs1_api_client.api_constants.SensorType attribute)
WTR_PEAK (xs1_api_client.api_constants.SensorType attribute)
X
XS1 (class in xs1_api_client.api)
xs1_api_client (module)
xs1_api_client.api (module)
xs1_api_client.api_constants (module)
xs1_api_client.device (module)
xs1_api_client.device.actuator (module)
xs1_api_client.device.actuator.switch (module)
xs1_api_client.device.actuator.thermostat (module)
xs1_api_client.device.sensor (module)
XS1Actuator (class in xs1_api_client.device.actuator)
XS1Device (class in xs1_api_client.device)
XS1Function (class in xs1_api_client.device.actuator)
XS1Sensor (class in xs1_api_client.device.sensor)
XS1Switch (class in xs1_api_client.device.actuator.switch)
XS1Thermostat (class in xs1_api_client.device.actuator.thermostat)
Read the Docs
v: master
Versions
latest
stable
2.0.0
1.0.1
set_configurations
master
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.