JavaScript API

From MiOS
(Difference between revisions)
Jump to: navigation, search
Line 2: Line 2:
 
== Functions ==
 
== Functions ==
 
==== get_device_state (deviceID, service, variable, dynamic) ====
 
==== get_device_state (deviceID, service, variable, dynamic) ====
===== Input: =====
+
'''Input:'''
 
* deviceID (number)
 
* deviceID (number)
 
* service (string)
 
* service (string)
 
* variable (string)
 
* variable (string)
 
* dynamic (number): if '''1''' the variable value is taken from ''lu_status'', else the variable value is taken from ''user_data'' (recommended). ''user_data'' is read at Luup startup, so for variables that change their value frequently (like Watts, Temperature, etc.) ''dynamic'' should be '''1'''.
 
* dynamic (number): if '''1''' the variable value is taken from ''lu_status'', else the variable value is taken from ''user_data'' (recommended). ''user_data'' is read at Luup startup, so for variables that change their value frequently (like Watts, Temperature, etc.) ''dynamic'' should be '''1'''.
 +
'''Output:'''
 +
* variable value (string, number or ''undefined'')

Revision as of 12:20, 31 March 2011

Variables

Functions

get_device_state (deviceID, service, variable, dynamic)

Input:

  • deviceID (number)
  • service (string)
  • variable (string)
  • dynamic (number): if 1 the variable value is taken from lu_status, else the variable value is taken from user_data (recommended). user_data is read at Luup startup, so for variables that change their value frequently (like Watts, Temperature, etc.) dynamic should be 1.

Output:

  • variable value (string, number or undefined)
Personal tools