JavaScript API

From MiOS
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 
== Variables ==
 
== Variables ==
 +
==== jsonp.ud ====
 +
* '''Type''': table
 +
* '''Description''': This is the user data.
 +
* '''Members''':
 +
** devices (table)
 +
** scenes (table)
 +
** rooms (table)
 +
 
== Functions ==
 
== Functions ==
 
==== get_device_state (deviceID, service, variable, dynamic) ====
 
==== get_device_state (deviceID, service, variable, dynamic) ====

Revision as of 17:13, 1 April 2011

Contents

Variables

jsonp.ud

  • Type: table
  • Description: This is the user data.
  • Members:
    • devices (table)
    • scenes (table)
    • rooms (table)

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 or undefined)


set_device_state (deviceID, service, variable, value)

Input:

  • deviceID (number)
  • service (string)
  • variable (string)
  • value (string)

Output:

  • true if the operation succeeded, false otherwise


_console (str)

Input:

  • str (string): text to be written in the console. You need to have FireBug installed.

Output:

  • nothing
Personal tools