Difference between revisions of "Event criteria"

From LinuxMCE
Jump to: navigation, search
(PK_EventParameter)
(add note that a drop down is available for light devices as well.)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Category: Admin Website]]
 
[[Category: Admin Website]]
 
[[Category: Automation]]
 
[[Category: Automation]]
 
+
{| align="right"
 +
  | __TOC__
 +
  |}
 +
{{versioninfo}}
 
This page will try to list valid parameters that can be used in the Event Criteria section of advanced Events. Note that there may be differences in the behaviour of  "Respond to Events" and "Timed Events". Where nothing is specified, it refers to "Respond to Events"  
 
This page will try to list valid parameters that can be used in the Event Criteria section of advanced Events. Note that there may be differences in the behaviour of  "Respond to Events" and "Timed Events". Where nothing is specified, it refers to "Respond to Events"  
  
 +
For integer criteria and event parameters, you can enter a list of values separated by commas to easily check for all of them.
 
= Day of Month =
 
= Day of Month =
 
Can take a value from 1-31
 
Can take a value from 1-31
Line 27: Line 31:
  
 
= Month =
 
= Month =
 +
1-12
  
 
= PK_Device =
 
= PK_Device =
Line 67: Line 72:
  
 
= State =
 
= State =
Not working
+
This allows you to check the state of a device in your event handler. The device state can be seen on the [[Advanced Pages Devices]] in the State field. The value in the state field is dependent on what type of device it is, so be sure to check before you make a event parameter.
 +
 
 +
Some device types have special handling.
 +
 
 +
If you select a climate or lighting device (since svn 30915), a new drop down will be available where you can select what data you want to compare. For climate devices, On/Off, Mode, Fan, Set Point and Current Temp are available, for lights it is On/Off and Brightness.
  
 
= System =
 
= System =

Latest revision as of 11:37, 21 July 2015

Version Status Date Updated Updated By
710 Unknown N/A N/A
810 Unknown N/A N/A
1004 Unknown N/A N/A
1204 Unknown N/A N/A
1404 Unknown N/A N/A
Usage Information

This page will try to list valid parameters that can be used in the Event Criteria section of advanced Events. Note that there may be differences in the behaviour of "Respond to Events" and "Timed Events". Where nothing is specified, it refers to "Respond to Events"

For integer criteria and event parameters, you can enter a list of values separated by commas to easily check for all of them.

Day of Month

Can take a value from 1-31

Day of Week

Multiple entries can be separated by comma.

Respond to Event

Can take a value from 0-6
0 = Sunday

Timed event

Can take a value from 1-7
1 = Monday

House Mode

Can take a value from 1-6

1 = Unarmed - at home
2 = Armed - away
3 = Armed - at home
4 = Sleeping
5 = Entertaining
6 = Armed - Extended away

Month

1-12

PK_Device

The device PK_EventParameter takes it's values from.

PK_DeviceCategory

PK_DeviceGroup

Not Implemented

PK_DeviceTemplate

PK_EventHandler

PK_EventList

Not working

PK_EventParameter

You can see what parameters each of these Events take by going into web admin, clicking on Advanced > DCE > Events.

Value

This can be an integer

Tripped

1 = Tripped
0 = Not tripped (this value is important if you use a movement sensor that triggers an event when there has been no movement for a set period of time)

PK_Instalation

PK_Room

PK_RoomType

PK_Skin

Room Mode

Not implemented

Specific Date

Not working

State

This allows you to check the state of a device in your event handler. The device state can be seen on the Advanced Pages Devices in the State field. The value in the state field is dependent on what type of device it is, so be sure to check before you make a event parameter.

Some device types have special handling.

If you select a climate or lighting device (since svn 30915), a new drop down will be available where you can select what data you want to compare. For climate devices, On/Off, Mode, Fan, Set Point and Current Temp are available, for lights it is On/Off and Brightness.

System

Time of Day

Timed Event

24hr based time (eks: 15:00).
Multiple entries can be separated by comma.

Respond to Events

Accepts special values
DAY or NIGHT

Or a time given in the
hh:mm or hh:mm:ss format (12:45, 21:22:10 etc).

User Mode