Difference between revisions of "JavaScript Callback Functions API"

From HSYCO
Jump to navigation Jump to search
Line 52: Line 52:
  
 
=== SchedulerEvent ===
 
=== SchedulerEvent ===
 +
 +
SchedulerEvent(groupname, schedulename)
 +
 +
This callback blocking method allows to call user methods at configurable intervals.
 +
 +
You define schedules using a group name and a schedule name.
 +
 +
Schedules under the same group run in the same thread and are executed sequentially, based on their interval in milliseconds. Schedules in different groups run in parallel.
 +
 +
'''Parameters:'''
 +
* groupname: string - the scheduler’s group name
 +
* schedulename: string - the scheduler’s name.
 +
  
 
=== StartupEvent ===
 
=== StartupEvent ===
 +
 +
StartupEvent
 +
 +
This method is called only once when HSYCO starts, after the initialization and HTTP server start-up, but before the execution of the different field interface threads. It is not executed in a thread, it is therefore a blocking method, that must complete its execution before all other HSYCO services can be started.
 +
  
 
=== SunPositionEvent ===
 
=== SunPositionEvent ===
 +
 +
SunPositionEvent(azimuth, elevation)
 +
 +
This method is called when the Sun changes its height with respect to the horizon or its angle from true north.
 +
 +
'''Parameters:'''
 +
*azimuth - the current Sun angle from true north, in decimal degrees
 +
*elevation - the current Sun elevation in decimal degrees from the horizon. Elevation is negative at night.
  
 
=== TimeEvent ===
 
=== TimeEvent ===

Revision as of 18:58, 30 January 2014

Callback Functions

System Functions

DaylightEvent

DaylightEvent(day)

Called at sunrise and sunset, according to the latitude and longitude values set in hsyco.ini, and the optional SunriseOffsetMinutes and SunsetOffsetMinutes parameters.

Parameters:

  • day: boolean - true at sunrise, false at sunset.


haActiveEvent

haActiveEvent(active)

Triggered by the change of state of an HSYCO server in a master/slave high availability configuration.

Parameters:

  • active: boolean - true if the server is active, false if not active.


PowerEvent

PowerEvent(power)

Triggered by a change of the current power load level, as set using the powerSet() Java API or the POWER action.

If PowerEvent() returns -1 or if not defined, HSYCO status is updated with the detected power value, the value returned by PowerEvent() is otherwise used.

Note The JavaScript PowerEvent return value is used only if the Java PowerEvent callback is not defined or returned -1.

Thanks to this method it is possible to alter the power value shown in the Web interface, for example to aggregate power readings acquired from other sensors.

Parameters:

  • power: numeric - the power level, in Watts.


programTimerEvent

programTimerEvent(name)

This method is called when a program timer is activated.

Program timers are set using programTimerSet(), programTimerReset(), programTimerRepeat(), or using the corresponding actions in the EVENTS.

Parameters:

  • name: string - program timer name.


SchedulerEvent

SchedulerEvent(groupname, schedulename)

This callback blocking method allows to call user methods at configurable intervals.

You define schedules using a group name and a schedule name.

Schedules under the same group run in the same thread and are executed sequentially, based on their interval in milliseconds. Schedules in different groups run in parallel.

Parameters:

  • groupname: string - the scheduler’s group name
  • schedulename: string - the scheduler’s name.


StartupEvent

StartupEvent

This method is called only once when HSYCO starts, after the initialization and HTTP server start-up, but before the execution of the different field interface threads. It is not executed in a thread, it is therefore a blocking method, that must complete its execution before all other HSYCO services can be started.


SunPositionEvent

SunPositionEvent(azimuth, elevation)

This method is called when the Sun changes its height with respect to the horizon or its angle from true north.

Parameters:

  • azimuth - the current Sun angle from true north, in decimal degrees
  • elevation - the current Sun elevation in decimal degrees from the horizon. Elevation is negative at night.

TimeEvent

varEvent

Cameras

CameraCommandEvent

CameraMotionEvent

CameraViewEvent

DMX

DmxEvent

DmxFilter

DmxStartupEvent

Infrared Control

IREvent

I/O Servers

IOEvent

IOStartupEvent

Network Location Services

LocationEvent

Modbus

ModbusEvent

PBX

PBXCallEvent

Squeezebox

SlimPowerEvent

SlimStatusEvent

SlimVolumeEvent

Timers and Schedulers

UserTimerEvent

User Interface

pageEvent

uiClearEvent

userCommand

userSubmit

WebRootRequestEvent

Command and Utility Functions