Version: 4.2 (beta)

JavaScript Callback Functions API

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.

Thanks to this function, you can 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.

Returns:

numeric - if PowerEvent() returns -1 or doesn't return a value, HSYCO status is updated with the detected power value, the value returned by PowerEvent() is otherwise used.

note

The JavaScript PowerEvent function is always called, but its return value is used only when the Java PowerEvent callback is not defined or returned -1.

programTimerEvent

programTimerEvent(name)

Called when a program timer is activated.

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

Parameters:

name: string - program timer name, uppercase.

SchedulerEvent

SchedulerEvent(groupname, schedulename)

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

Schedules are defined 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()

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)

Called when the Sun changes its height with respect to the horizon or its angle from true north.

Parameters:

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

TimeEvent

TimeEvent(time)

Called every 60 seconds.

HSYCO tries to synchronize the execution at the beginning of the minute, executing this method at seconds 0 of every minute.

note

However, the execution is not guaranteed. In case of heavy load HSYCO might not be able to execute the call with accurate timing. In extreme cases, it could occasionally skip some calls.

Parameters:

time: numeric - the current time in milliseconds.

varEvent

varEvent(name, value)

Triggered by the change of value of a program variable.

Parameters:

name: string - the variable name, uppercase.
value: string - the value to be assigned to the program variable.

Cameras

CameraCommandEvent

CameraCommandEvent(camerafunction, action, camera)

Triggered by a camera control input from the Web interface.

It can be used to execute arbitrary actions when the user clicks on the active areas of the camera view, or to replace some or all of the standard PTZ commands with custom actions.

Parameters:

camerafunction: string - see the table below
action: string - see the table below
camera: string - the camera name.

Returns:

numeric - if CameraCommandEvent() returns -1 or doesn't return a value, the standard PTZ command associated to the PTZ driver is skipped, otherwise it is executed normally.

note

The JavaScript CameraCommandEvent camerafunction is always called, but its return value is used only when the Java CameraCommandEvent callback is not defined or returned -1.

Icon	Function	Action
	focus	far
	focus	near
	zoom	tele
	zoom	wide
	move	left
	move	right
	move	up
	move	down
	move	stop

CameraMotionEvent

CameraMotionEvent(event, time)

Called when HSYCO starts recording video from a camera.

Recording starts when a camera notifies a recording request with the recording HTTP API call (the zone=id portion is optional):

http://192.168.0.50/x/camerarec?camera=name&zone=id

Recording can also be triggered by the CameraRecTrigger() Java method or JavaScript function, or the CAMERAREC or CAMERARECFULL actions in EVENTS.

Parameters:

event: string - the event identification string, either the camera name only or name:id if recording is triggered by a camerarec HTTP call with the optional zone=id parameter
time: numeric - the current time in milliseconds.

CameraViewEvent

CameraViewEvent(camera, active)

CameraViewEvent() is called on changes of the live view status of cameras.

When at least one web client is showing the live feed from a camera, the camera is marked as active.

When no live feed request is received for a several consecutive seconds, the camera is marked as not active.

Parameters:

camera: string - the camera name
active: boolean - true if active, false if not.

Datasources

See Data Sources for an overview of data sources, and how to implement custom data sources with these callbacks.

dataSourceQuery

dataSourceQuery(session, userid, dataSourceId, columns)

Called when datasource data is requested.

Parameters:

session: string - session id string that uniquely identifies the client session.
userid: string - the user id.
dataSourceId: string - the identifier of the datasource from which data is requested.
columns: Array - an array of column identifiers specifying the fields requested by the client. Contains "*" if all columns are requested.

Returns:

JSON Object - either the requested data or error information.

Success Response Structure:

columns: Array - an array of objects describing each column’s metadata:
- name: string - the column name. It has to be unique within the datasource.
- type: string - the column data type, which can be varchar, integer, decimal, boolean, date, time or timestamp.
- key: boolean - indicates whether the column is a primary key. Optional, default is false.
- size: number - the column size, in bytes. Optional.
- nullable: (0|1) - indicates whether the column can contain null values. Optional, default is 0 (false).
- readonly: (0|1) - indicates whether the column is read-only. Optional, default is 0 (false).
rows: Array - rows, where each row contains values corresponding to the specified columns. If "*" is received in the columns parameter, all available columns should be included in the response.

Error Response Structure:

error: a JSON object returned when the query fails:
- code: int - a standard Command API error code. Optional.
- message: string - a descriptive message explaining the error. Optional.
- display: string - set to popup to display the error in a modal popup. Optional.

Query errors are shown as non-blocking toasts by default; use display: "popup" for a modal. The browser developer console logs the datasource id and any returned error code or message.

Response Example:

Successful Query:

{
  "columns": [
    { "name": "username", "type": "string", "key": true },
    { "name": "password", "type": "string" }
  ],
  "rows": [
    ["user1", "abc12"],
    ["user2", "xyz34"]
  ]
}

Error Example:

{
  "error": {
    "code": 500
  }
}

dataSourceInsert

dataSourceInsert(session, userid, dataSourceId, columns, data, before)

Called when an insert operation is attempted, before and/or after executing the SQL statement, based on the dataSourceOption configuration (callback.before and callback.after).

Before: If null is returned, the SQL statement executes normally. If a JSONObject is returned, the SQL statement is skipped, and the returned object is sent to the client UI.
After Execution (callback.after): This is triggered only when the SQL statement executes successfully. If a JSONObject is returned, it is sent to the client UI, replacing the SQL result.

It automatically triggers a global refresh of the data source if it returns a not null value, or a session refresh if the data source's refresh option is set to false with dataSourceOption().

The returned JSON object can also include the standard Command API response keys. When the callback returns a custom response while the current form or table edit popup remains open, the top-level fields property can modify the current fields, for example to display field errors or change field values. This is mainly useful in before callbacks, or whenever the callback skips or replaces the SQL operation and keeps the editor open.

Parameters:

session: string - session id string that uniquely identifies the client session.
userid: string - the user id.
dataSourceId: string - the datasource id.
columns: Array - array of column ids.
data: JSON Object - { "rows": [["<col 1 value>", "<col 2 value>", ...], ...] };
before : boolean - true if the callback was called before the execution of SQL code, false otherwise.

Returns:

JSON Object - inserted rows. Triggers a data source refresh.
- inserted: int - The number of rows successfully inserted.
null - no action is taken.

Response Example:

{
  "inserted": 3
}

dataSourceUpdate

dataSourceUpdate(session, userid, dataSourceId, columns, data, before)

Called when an update operation is attempted, before and/or after executing the SQL statement, based on the dataSourceOption configuration (callback.before and callback.after).

Before: If null is returned, the SQL statement executes normally. If a JSONObject is returned, the SQL statement is skipped, and the returned object is sent to the client UI.
After Execution (callback.after): This is triggered only when the SQL statement executes successfully. If a JSONObject is returned, it is sent to the client UI, replacing the SQL result.

It automatically triggers a global refresh of the data source if it returns a not null value, or a session refresh if the data source's refresh option is set to false with dataSourceOption().

To support table CSV imports, update callbacks should also include the keys of rows not found in the datasource in not_found. During import, keyed rows are tried as updates first; rows returned in not_found are then inserted. This protects filtered or stale datasource views, where a row that looks new to the client may already exist in the datasource. Returning only an update count is not enough for the insert fallback, because the table needs the specific missing keys.

Parameters:

session: string - session id string that uniquely identifies the client session
userid: string - the user id
dataSourceId: string - the datasource id
columns: Array - array of column ids.
data: JSONObject - contains the data to update.
- rows: Array – An array of objects, each representing a row to update:
  - <key value>: string – the key value identifying the row to update. This is the property name.
  - Value (Array): an array of column values corresponding to the column IDs specified in the columns parameter.

{
  "rows": [
    {
      "<key value>": ["<col 1 value>", "<col 2 value>", ...]
    },
    ...
  ]
}

before : boolean - true if the callback was called before the execution of SQL code, false otherwise

Returns:

JSON Object - updated rows. Triggers a data source refresh.
- updated: int - The number of rows successfully updated.
- not_found: Array - An array of keys not found in the datasource. Optional; required for table CSV import fallback.

Response Example:

{
  "updated": 2,
  "not_found": ["key1"]
}

dataSourceDelete

dataSourceDelete(session, userid, dataSourceId, data, before)

Called when a delete operation is attempted, before and/or after executing the SQL statement, based on the dataSourceOption configuration (callback.before and callback.after).

Before: If null is returned, the SQL statement executes normally. If a JSONObject is returned, the SQL statement is skipped, and the returned object is sent to the client UI.
After Execution (callback.after): This is triggered only when the SQL statement executes successfully. If a JSONObject is returned, it is sent to the client UI, replacing the SQL result.

It automatically triggers a global refresh of the data source if it returns a not null value, or a session refresh if the data source's refresh option is set to false with dataSourceOption().

The returned JSON object can also include the standard Command API response keys.

Parameters:

session: string - session id string that uniquely identifies the client session
userid: string - the user id
dataSourceId: string - the datasource id
data: JSON Object - { "rows": ["key 1>", "key 2>", ... ] }
before: boolean - true if the callback was called before the execution of SQL code, false otherwise

Returns:

JSONObject - deleted rows. Triggers a data source refresh.
- deleted: int - the number of rows successfully deleted.
- not_found: Array - An array of keys not found in the datasource. Optional.
null - no action is taken.

Response Example:

{
  "deleted": 1,
  "not_found": ["key1"]  
}

I/O Servers

IOEvent

IOEvent(name, value)

Triggered by the value change of any data point of an I/O server.

Parameters:

id: string - the server id and the name of the data point. According to the type of server, the format changes but it generally appears as server name, as declared the ioServers parameter in hsyco.ini, followed by a specific name representing the data point within the system
value: string - the new value. For binary inputs or outputs, the returned values are 0 or 1.

IOStartupEvent

IOStartupEvent(serverName)

Triggered by the start of the communication thread of each I/O server - once for each server at the beginning of the execution of HSYCO, and also after every reboot of the communication thread, for example after communication errors.

note

This is a blocking method. The I/O server driver will start after this function returns.

Parameters:

serverName: string - the I/O server name, as defined in hsyco.ini

Modbus

For detailed information about the Modbus protocol, and the response PDU formats, you should refer to the MODBUS Application Protocol Specification V1.1b documentation at: http://www.modbus.org/docs/Modbus-Application-Protocol-V1-1b.pdf

ModbusEvent

ModbusEvent(name, addr, unitid, pdu)

Called by the Modbus Server I/O Server on every Modbus request received from a Modbus client.

The returned byte array is used as the Modbus response PDU (function code and data).

Parameters:

name: string - the name of the Modbus Server I/O server
addr: string - IP address of the Modbus client
unitid: numeric - the unit id set in the received Modbus request
pdu: string - the request PDU data, in hexadecimal string format.

Returns:

string - the response PDU data, in hexadecimal string format.

note

The JavaScript ModbusEvent function is called only when the Java ModbusEvent callback is not defined or returned a null value.

Location Services

LocationEvent

LocationEvent(mac, ip, zoneId)

Called, if the location service is active, when a variation in the association of a client to the Wi-Fi Access Points is detected.

Parameters:

mac: string - the MAC address of the client, in decimal format
ip: string - the IP address of the client, if available, or null (the IP address could be null if the associated device is not connected to the HSYCO Web interface)
zoneId: numeric - in case of association, it is the Access Point sequence number, according to the order defined in the LocationBases parameter in hsyco.ini; -1 if the client was de-associated from the Wi-Fi network.

LocationBeaconEvent

caution

WARNING! The Beacons functionality for iOS is experimental and subject to changes.

LocationBeaconEvent(session, address, userid, zone, distance, background)

Called when the HSYCO App detects a change in the proximity of one of the configured beacons. See [[Beacons on HSYCO App for iOS]] for additional information.

There is no guarantee that the event would be fired.

Network delays or errors could cause delayed triggering of this event.

Parameters:

session: string - session id string that uniquely identifies the client session
address: string - the beacon's address
userid: string - the user id
zone: string - the beacon's zone
distance: string - far, near, immediate or off
background: boolean - true if the app called the server while in background mode (app closed).

LocationGeoEvent

LocationGeoEvent(session, address, userid, lat, lon, alt, speed, course, ah, av, as, ac, background)

Called when a geographic location notification is sent by an HSYCO iOS or Android app.

Parameters:

session: string - session id string that uniquely identifies the client session
address: string - the beacon's address
userid: string - the user id
lat: numeric - geographic coordinates latitude, in decimal degrees (positive east, negative west)
lon: numeric - geographic coordinates longitude, in decimal degrees (positive north, negative south)
alt: numeric - altitude, in meters
speed: numeric - speed, in meters per second
course: numeric - course, in decimal degrees
ah: numeric - radius of uncertainty for the location, in meters
av: numeric - accuracy of the altitude value, in meters
as: numeric - accuracy of the speed value, in meters per second
ac: numeric - accuracy of the course value, in degrees
background: boolean - true if the app called the server while in background mode (app closed).

Network Services

httpCallEvent

httpCallEvent(address, secure, query)

Called when the HSYCO HTTP server receives a GET request with the following path:

/x/httpcall?query

note

The HTTP client's IP address must be in the trusted network range, or the httpcall request will be rejected, unless HTTPServerLowSecurityEnabled is true and the request is sent using HTTPS

This function shoud return a string, that will be sent as the text/plain answer to the HTTP client (with HTTP response code 200).

HSYCO will return a 404 Not Found response code if all of the following conditions are true:

no HTTP event matches the query in EVENTS
the httpCallEvent JavaScript callback is not defined in EVENTS, or doesn't return a value
the httpCallEvent Java callback is not defined in any plugins, or returns null.

If the httpCallEvent is defined both in JavaScript and Java, the Java version return value (unless null) will be used in the HTTP response.

Parameters:

address: string - the IP address of the HTTP client
secure: boolean - true if the request is sent to the HTTPS server, false if the request is sent to the HTTP server
query: string - the string following the ? in the URL path.

Returns:

string - the string to send as the text/plain answer to the HTTP client.

httpRawEvent

httpRawEvent(host, secure, version, httpmethod, gzip, contenttype, query, session, userid, indata)

Called when the HSYCO HTTP server receives a GET, POST, PUT, PATCH or DELETE request with the following path:

/x/raw

note

The httpRawEvent function is invoked only if:

the request has a valid user authentication cookie or
the HTTP client's IP address is in the trusted network range and the request is sent using HTTPS or
the HTTP client's IP address is in the trusted network range and the HTTPServerLowSecurityEnabled option is true

The application code inside the httpRawEvent() must return a complete HTTP response (all headers and body).

If multiple httpRawEvent() functions or callbacks are defined, only one must return the HTTP response.

Parameters:

host: string - the IP address of the HTTP client
secure: boolean - true if the request is sent to the HTTPS server, false if the request is sent to the HTTP server
version: string - the HTTP version, as passed in the HTTP request header
httpmethod: string - the HTTP request's method, "GET", "HEAD", "POST", "PUT", "PATCH" or "DELETE"
gzip: boolean - true if the client accepts compressed content (the Accept-Encoding header contains "gzip")
contenttype: string - the HTTP request's content type (value of Content-Type header)
query: string - the string following the ? in the URL path, or null if not present
session: string - the authenticated session id, or null
userid: string - the user id for requests having a valid authentication cookie, null otherwise
indata: string - The request body for POST / PUT / PATCH / DELETE, or an empty string for GET or HEAD

Returns:

string - the application code should return the full HTTP response, including all headers.

Example:

function httpRawEvent(host, secure, version, httpmethod, gzip, contenttype, query, session, userid, indata) : {
 	messageLog("host: " + host);
 	messageLog("secure: " + secure);
 	messageLog("version: " + version);
 	messageLog("httpmethod: " + httpmethod);
 	messageLog("gzip: " + gzip);
 	messageLog("contenttype: " + contenttype);
 	messageLog("query: " + query);
 	messageLog("session: " + session);
 	messageLog("userid: " + userid);
 	messageLog("in: " + indata);

	// Build response body depending on method
	var content;
	
	if (httpmethod === "GET") {
		content = "GET received from host [" + host + "]\r\nQuery: " + query + "\r\n";
	} else if (httpmethod === "POST" || httpmethod === "PUT" || httpmethod === "PATCH" || httpmethod === "DELETE") {
		content = httpmethod + " data received from host [" + host + "]:\r\n" + indata + "\r\n";
	} else if (httpmethod === "HEAD") {
		// HEAD responses have no body
		content = "";
	} else {
		var reply405 = version + " 405 Method Not Allowed\r\n";
		reply405 += "Server: HSYCO\r\n";
		reply405 += "Content-length: 0\r\n";
		reply405 += "Content-type: text/plain\r\n";
		reply405 += "Cache-Control: no-store, no-cache\r\n\r\n";
		return reply405;
	}
	
	// Build complete HTTP response
	var reply = version + " 200 OK\r\n";
	reply += "Server: HSYCO\r\n";
	reply += "Content-length: " + content.length + "\r\n";
	reply += "Content-type: text/plain\r\n";
	reply += "Cache-Control: no-store, no-cache\r\n\r\n";
	
	if (httpmethod !== "HEAD") {
		reply += content;
	}
	
	return reply;
 }

SysLogEvent

SysLogEvent(address, log)

Called when the HSYCO SYSLOG server receives a log message from a network client.

Note that this is a blocking call. The SYSLOG server will not process further messages until the last call has been processed.

Parameters:

address: string - the IP address of the SYSLOG client
log: string - SYSLOG log message.

PBX

PBXCallEvent

PBXCallEvent(host, caller, called)

Called when a call notification is sent to HSYCO by the PBX system.

If the method returns true, the request is recorded on the log file with the [OK] status, with [ERROR] otherwise.

The PBX should generate HTTP requests to the HSYCO Web Server, using the following formats:

http://192.168.0.50/x/vcall/<from>/<to>

or:

http://192.168.0.50/x/vcall?from=<from>&to=<to>

For example, the HTTP request:

http://192.168.0.50/x/vcall?from=21&to=25

is interpreted as a call notification from internal number 21 to number 25.

note

The HTTP client's IP address must be in the trusted network range, or the httpcall request will be rejected.

Parameters:

host: string - the IP address of the PBX server
caller: string - the caller number
called: string - the called number.

Returns:

boolean - return true to generate a log entry with [OK] status, false for [ERROR] status.

Timers and Schedulers

UserTimerEvent

UserTimerEvent(name, active)

Called when a user timer or scheduler’s rule should be activated, and before executing the associated action in EVENTS.

It is also executed at the timer or scheduler’s rule deactivation.

This method must return a true value in order to make the timer or rule actually active and the associated actions executed.

Whenever the method returns false, the timer will not be activated, and the method will be called again once a minute for the scheduled duration of the timer.

In the same way, if the method returns false when the timer or rule is deactivated, the timer or rule will not be deactivated, extending the timer activation beyond the scheduled duration.

This is a blocking method.

Parameters:

name: string - timer name or scheduler’s rule name
active: boolean - true when activating and false when deactivating the timer or scheduler’s rule.

Returns:

boolean - true to confirm the timer event, false to block the event.

note

The JavaScript UserTimerEvent function is alway called, but its return value is used only when the Java UserTimerEvent callback is not defined or returned true.

User Interface

pageEvent

pageEvent(address, session, userid, project, page)

Called when a Web client initially loads a project and when navigating between pages. Popup and overlay pages do not trigger this event.

There is no guarantee that the event would be fired the exact moment the page is loaded.

Network delays or errors could cause delayed triggering of this event.

Parameters:

address: string - the client’s IP address
session: string - session id string that uniquely identifies the client session
userid: string - the user id
project: string - project’s id
page: string - the page id, with the #landscape or #portrait suffix when the project's pages or overlays have an orientation. A page without an orientation is reported with the #landscape suffix.

loginEvent

loginEvent(address, session, userid)

Called when a user authenticates with a valid PIN or PIN/PUK.

Note that, while the session string passed to the pageEvent callback contains the browser global session id followed by a web view id, the session string passed to loginEvent only contains the global session id. The global session id is the portion of session id that is common between multiple web views open concurrently on the same web browser.

Parameters:

address: string - the client’s IP address string in textual presentation
session: string - session id string that uniquely identifies the client session
userid: string - the user id.

logoutEvent

logoutEvent(address, session, userid, lock)

Called when a user logs out or locks the user interface.

Note that, while the session string passed to the pageEvent callback contains the browser global session id followed by a web view id, the session string passed to logoutEvent only contains the global session id. The global session id is the portion of session id that is common between multiple web views open concurrently on the same web browser.

Parameters:

address: string - the client’s IP address string in textual presentation
session: string - session id string that uniquely identifies the client session
userid: string - the user id
lock: boolean - false when logging out; true when the user locks the user interface.

uiClearEvent

uiClearEvent(session)

Called, following an explicit call of uiClear() or after the client session inactivity timeout expires, if the client session becomes active again (i.e. the client starts handshaking again with the server with the same session id).

Parameters:

session: string - session id string that uniquely identifies the client session.

userCommand

userCommand(session, userid, name, param)

Called by user clicks on buttons created in the Web interface with the Button object in Command action mode, by a USER action in EVENTS, or by the user() Java method and JavaScript function. Also triggered by by the screensaver.

This function can optionally return a command response. See the Command API for supported response strings and JSON responses, including status logging, navigation, app actions, clipboard/share, downloads, toasts, popups, and errors.

JSON responses can be returned directly as objects.

note

As this callback may return data synchronously to the Web interface in response to a user command, its execution should be fast enough to avoid the timeout of the browser's request. To ensure a safe margin, it should complete in no more than one second.

Parameters:

session: string - a session id string that uniquely identifies the client session
userid: string - the user id
name: string - the name field of the Button object in command action mode
param: string - the parameter of the Button object in command action mode

Returns:

string or object - optional command response, using the response syntax described in the Command API. If this function doesn't return a value, an [ERROR] status is logged in the log file. Any returned response logs an [OK] status by default.

note

The JavaScript userCommand function is alway called, but its return value is used only when the Java userCommand callback is not defined or returned null or an empty string.

userSubmit

userSubmit(session, userid, name, fields)

This function is similar to userCommand(session, userid, name, param).

When userSubmit() is defined, it will be called when a Button in Submit action mode is pressed, while userCommand() will continue to be called on Button in Command action mode.

userSubmit() provides a more convenient access to the values of multiple input fields in a form.

JSON responses can be returned directly as objects.

note

Parameters:

session: string - a session id string that uniquely identifies the client session
userid: string - the user id
name: string - the id of the Button object in submit action mode
fields: array - the array of all input fields in the container where the (Button object in submit action mode) object is located.

Returns:

string or object - optional command response, using the response syntax described in the Command API. If this function doesn't return a value, an [ERROR] status is logged in the log file. Any returned response logs an [OK] status by default.

note

The JavaScript userSubmit function is alway called, but its return value is used only when the Java userCommand or userSubmit callback are not defined or returned null or an empty string.

Examples:

The following code shows how to retrieve all field names and values of a submitted form.

function userSubmit(session, user, name, values) : {
	if (session.length > 0) {
		messageLog(user + ', ' + name + '=' + values);
		var keys = values.keySet().toArray();
		for (var i = 0; i < keys.length; i++) {
			messageLog(user + ', ' + keys[i] +  ' = ' + values.get(keys[i]));
		}
		return "";
	}
}

Create a project with a form and a few input fields in a container. Pressing the submit button should return something like this in the log file:

01.31 13:54:32.034 - staff, submit1={keypad1=344, date1=20140131, input1=this is a text field}
01.31 13:54:32.038 - staff, keypad1 = 344
01.31 13:54:32.039 - staff, date1 = 20140131
01.31 13:54:32.042 - staff, input1 = this is a text field
01.31 13:54:32.043 - WEB USER COMMAND [submit1]: input1@this is a text field@date1@20140131@keypad1@344 [OK]

WebRootRequestEvent

WebRootRequestEvent(addr, secure, useragent)

This method is called when the Web server receives a root URL request. It can return a string to redirect the browser to a valid URL, or null to prevent redirection.

note

As this callback returns data synchronously to the Web interface in response to the HTTP request, its execution should be fast enough to avoid the timeout of the browser's request. To ensure a safe margin, it should complete in no more than one second.

Parameters:

addr: string - the HTTP client’s address
secure: boolean - true if this is an HTTPS request
useragent: string - the Web browser’s user agent information.

Returns:

string - optional return string containing a valid absolute or relative URL

Examples:

The following code redirects any root HTTP request received by the HSYCO server to the manager page.

function WebRootRequestEvent(addr, secure, useragent) : {
	return "hsycoserver/manager";
}

System Functions​

DaylightEvent​

haActiveEvent​

PowerEvent​

programTimerEvent​

SchedulerEvent​

StartupEvent​

SunPositionEvent​

TimeEvent​

varEvent​

Cameras​

CameraCommandEvent​

CameraMotionEvent​

CameraViewEvent​

Datasources​

dataSourceQuery​

dataSourceInsert​

dataSourceUpdate​

dataSourceDelete​

I/O Servers​

IOEvent​

IOStartupEvent​

Modbus​

ModbusEvent​

Location Services​

LocationEvent​

LocationBeaconEvent​

LocationGeoEvent​

Network Services​

httpCallEvent​

httpRawEvent​

SysLogEvent​

PBX​

PBXCallEvent​

Timers and Schedulers​

UserTimerEvent​

User Interface​

pageEvent​

loginEvent​

logoutEvent​

uiClearEvent​

userCommand​

userSubmit​

WebRootRequestEvent​

System Functions

DaylightEvent

haActiveEvent

PowerEvent

programTimerEvent

SchedulerEvent

StartupEvent

SunPositionEvent

TimeEvent

varEvent

Cameras

CameraCommandEvent

CameraMotionEvent

CameraViewEvent

Datasources

dataSourceQuery

dataSourceInsert

dataSourceUpdate

dataSourceDelete

I/O Servers

IOEvent

IOStartupEvent

Modbus

ModbusEvent

Location Services

LocationEvent

LocationBeaconEvent

LocationGeoEvent

Network Services

httpCallEvent

httpRawEvent

SysLogEvent

PBX

PBXCallEvent

Timers and Schedulers

UserTimerEvent

User Interface

pageEvent

loginEvent

logoutEvent

uiClearEvent

userCommand

userSubmit

WebRootRequestEvent