JavaScript API

Revision as of 10:25, 13 June 2011

Usage

"Tabs": [
       {
           "Label": {
               "lang_tag": "users",
               "text": "Users" 
           },
           "Position": "0",
           "TabType": "javascript",
           "ScriptName": "I_HomeCare.js",
           "Function": "showUsers"
       }, 

To generate a tab using your JavaScript functions you need to specify this by setting TabType to javascript. Then, you need to specify the script file's name and which function in this file will be used to draw the tab's content. That function will have one argument, which is the device number.

<functionName> (deviceNumber)

This is the tab rendering function. The set_panel_html function must be called at the end.

Input:

• deviceNumber (number)
  

Output:

• nothing

Variables

jsonp.ud

This is the user data.

• Type: object
• Members:
  • devices (array)
  • scenes (array)
  • users (array)
  • rooms (array)
  • eventList (array)
  • etc.

jsonp.ud.devices

• Type: array
• Members:
  • id (number)
  • device_type (string)
  • room (number)
  • name (string)
  • category_num (number)
  • etc.

jsonp.ud.scenes

• Type: array
• Members:
  • id (number)
  • name (string)
  • room (number)
  • Timer_ids (array)
  • Timer (object)
  • etc.

Functions

variable_get (serviceId, variable, deviceId, dynamic)

(wrapper for get_device_state (deviceId, serviceId, variable, dynamic))

Input:

• serviceId (string)
• variable (string)
• deviceId (number)
• dynamic (number): if 1, the variable's value is taken from lu_status, else, the variable's value is taken from user_data. 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)

variable_set (serviceId, variable, value, deviceId, dynamic)

(wrapper for set_device_state (deviceId, serviceId, variable, value, dynamic))

Input:

• serviceId (string)
  
• variable (string)
• value (string)
• deviceId (number)
• dynamic (number): if 1, the variable's value is saved to lu_status (the value is lost after Luup is restarted), else, the variable's value is saved to user_data (requires restart to save the new value).

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 to have a console.

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