Difference between revisions of "Action Keywords"

From HSYCO
Jump to navigation Jump to search
Line 26: Line 26:
 
== I/O Servers ==
 
== I/O Servers ==
 
=== IO ===
 
=== IO ===
 +
 +
Writes to I/O servers data points.
 +
 +
{| class="wikitable"
 +
| width=160 | '''Action'''
 +
| '''Description'''
 +
|-
 +
| IO name = value
 +
|
 +
sets the data point to a value.<br>
 +
Values are specific to the type of I/O server
 +
|-
 +
| IO name = FLIP
 +
| inverts the output of the I/O data point. If the status of the output is 0 the new status will be 1, if different from 0 the new status will be 0
 +
|-
 +
| IO name1 = IO name2
 +
| sets the I/O interface output name1 to the current value of the I/O interface name2
 +
|}
 +
 +
 +
'''Parameters:'''
 +
 +
* name - the server id, followed by a single dot and the data point suffix. The EVENTS interpreter converts data points names to lower case
 +
* value - you can use multiple unquoted words, quoted strings and variables, that will be appended to the value string.
 +
 +
 +
'''Examples:'''
 +
 +
IO contacts.c1 contacts.c3= 1
 +
IO sensors.c1 = FLIP
 +
IO contacts.o1 contacts.o2 = IO sensors.flood
  
 
== Leak Detector ==
 
== Leak Detector ==

Revision as of 10:27, 5 February 2014

An action is defined as a keyword that identifies the action type, always followed by one or more parameters and sometimes the equal (assignment) operator.

Every keyword uses a specific syntax that interprets parameters according to its own rules.

System Keywords

DATESET

HAACTIVE

POWER

PROGRAMTIMER

WAIT

Cameras

CAMERA

CAMERAREC

CAMERARECFULL

Data Logger

DATALOGGER

DMX

DMX

Infrared Control

IR

I/O Servers

IO

Writes to I/O servers data points.

Action Description
IO name = value

sets the data point to a value.
Values are specific to the type of I/O server

IO name = FLIP inverts the output of the I/O data point. If the status of the output is 0 the new status will be 1, if different from 0 the new status will be 0
IO name1 = IO name2 sets the I/O interface output name1 to the current value of the I/O interface name2


Parameters:

  • name - the server id, followed by a single dot and the data point suffix. The EVENTS interpreter converts data points names to lower case
  • value - you can use multiple unquoted words, quoted strings and variables, that will be appended to the value string.


Examples:

IO contacts.c1 contacts.c3= 1
IO sensors.c1 = FLIP
IO contacts.o1 contacts.o2 = IO sensors.flood

Leak Detector

LEAK

Log

FILELOG

LOG

Mail

MAIL

Network Services

PING

URL

Public Announcement

AUDIO

Serial Communication Ports

COMM

Squeezebox

MUSIC

User Interface

UISESSIONSET

UISET

USER