Event Keywords

From HSYCO
Revision as of 17:49, 4 February 2014 by Hsyco (talk | contribs) (→‎IOSTART)
Jump to navigation Jump to search

An event is defined as a keyword that identifies the event type, usually followed by one or more parameters and conditional operators. Every keyword uses a specific syntax that interprets parameters according to its own rules.


System Events

DAY

HAACTIVE

HSYCOSTART

NIGHT

POWER

PROGRAMTIMER

SUNAZIMUTH

SUNELEVATION

TIME

Cameras

CAMERA

CAMERACOMMAND

CAMERAVIEW

DMX

DMX

DMXSTART

Infrared Control

IR

I/O Servers

IO

Triggered by a status change of any data port of an I/O server.


Event State Description
IO name transient any change of an I/O variable
IO name = value

IO name > value
IO name < value
IO name >= value
IO name <= value

stable the value is equal, greater, greater or equal, less, less or equal to the given value.

Note The names and values of the I/O variables are specifically related to the type of I/O server. Values can be numeric or strings.


Parameters:

  • name - the data point name of the input or output port. According to the type of server, the format changes but it generally appears as server name, as declared with the ioServers parameter in hsyco.ini, followed by a dot and the input/output port name. See the Application Notes for more information.


Examples:

IO tempmeter.indoor > 25.5
IO contacts.c1 = 1

IOSTART

This event indicates that the connection with an I/O server has been correctly established.

It should be safe to associate this event with actions that set the I/O server writable variables.


Event State Description
IOSTART id transient 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


Parameters:

  • id - the I/O server number, starting from 0, based on the listing order of the ioServers parameter in hsyco.ini; If only one I/O server is available, it can be omitted.


Examples:

IOSTART: IO contacts.c1 = 1
IOSTART 2: IO relays.door = 1

Leak Detector

LEAK

Network Services

LOCATION

PING

URL

PBX

PBX

Squeezebox

MUSIC

Timers and Schedulers

TIMER

User Interface

PAGE

USER