JavaScript API
From MiOS
(Difference between revisions)
m (→set_panel_html (html)) |
|||
| Line 1: | Line 1: | ||
== Variables == | == Variables == | ||
==== jsonp.ud ==== | ==== jsonp.ud ==== | ||
| + | This is the user data. | ||
* '''Type''': table | * '''Type''': table | ||
| − | |||
* '''Members''': | * '''Members''': | ||
** devices (table) | ** devices (table) | ||
| Line 10: | Line 10: | ||
** eventList (table) | ** eventList (table) | ||
** etc. | ** etc. | ||
| + | |||
| + | |||
| + | ==== jsonp.ud.devices ==== | ||
| + | * '''Type''': table | ||
| + | * '''Members''': | ||
| + | ** id (number) | ||
| + | ** device_type (string) | ||
| + | ** room (number) | ||
| + | ** name (string) | ||
| + | ** category_num (number) | ||
| + | ** etc. | ||
| + | |||
== Functions == | == Functions == | ||
Revision as of 11:18, 4 April 2011
Contents |
Variables
jsonp.ud
This is the user data.
- Type: table
- Members:
- devices (table)
- scenes (table)
- rooms (table)
- users (table)
- eventList (table)
- etc.
jsonp.ud.devices
- Type: table
- Members:
- id (number)
- device_type (string)
- room (number)
- name (string)
- category_num (number)
- etc.
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
set_panel_html (html)
Used in the tab rendering functions.
Input:
- html (string): The html to be used for generating the tab content.
Output:
- nothing
