User Tools

Site Tools


actions

This is an old revision of the document!


Actions

Switch

Version
Available since pilight v6.0

Description
Changes the state of a switch, relay of dimmer.

Options

pilight v6.0

namerequiredmultiple valuesdescription
DEVICExxDevice(s) to change state of
TOx New state

pilight nightly

namerequiredmultiple valuesdescription
FOR Determine how long this new state lasts before we change back to the previous state
AFTER After how long do we want the new state to be set

Examples

pilight v6.0

IF 1 == 1 THEN switch DEVICE light TO on
IF 1 == 1 THEN switch DEVICE mainlight AND bookshelve AND hall TO on

pilight nightly

IF 1 == 1 THEN switch DEVICE light TO on FOR 10
IF 1 == 1 THEN switch DEVICE light TO on AFTER 30
IF 1 == 1 THEN switch DEVICE light TO off FOR 10 AFTER 30

Toggle

Version
Available since pilight v6.0

Description
Toggles a device between state X and state Y. This action is especially made for 'one-shot' devices such as a remote control button where a normal separate 'switch-on' and separate 'switch-off' rule doesn't apply. This action will check what the current state of a device is, and will change it to the non-current state.

Options

namerequiredmultiple valuesdescription
DEVICExxDevice(s) to change state of
BETWEENx State 1
ANDx State 2

Examples

IF 1 == 1 THEN toggle DEVICE television BETWEEN on AND off

Program

Version

Description
Start and stop a program.

Options pilight v6.0

namerequiredmultiple valuesdescription
DEVICExxProgram to change the state
TOx Running / stopped

Examples

pilight v6.0

IF 1 == 1 THEN switch DEVICE xbmcProgram TO running
IF 1 == 1 THEN switch DEVICE xbmcProgram TO stoped

Dim

Version
Available since pilight v6.0

Description
Dims a device to a new dimlevel or start a sequence from one dimlevel to another.

Options

pilight v6.0

namerequiredmultiple valuesdescription
DEVICExxDevice(s) to change state of
TOx New dimlevel

pilight nightly

namerequiredmultiple valuesdescription
FOR Determine how long this new dimlevel lasts before we change back to the previous dimlevel + state
AFTER After how long do we want the new state to be set
IN To be combined with FROM. In what time do we want to change the dimlevel FROM x TO y
FROM To be combined with IN. From what dimlevel do we want to start a sequence to the target dimlevel

Examples

pilight v6.0

IF 1 == 1 THEN dim DEVICE mainlight TO 15
IF 1 == 1 THEN dim DEVICE mainlight AND bookshelve AND hall TO 10

pilight nightly

IF 1 == 1 THEN dim DEVICE mainlight TO 15 FOR 10
IF 1 == 1 THEN dim DEVICE mainlight TO 15 AFTER 30
IF 1 == 1 THEN dim DEVICE mainlight TO 15 AFTER 30 FOR 10
IF 1 == 1 THEN dim DEVICE mainlight TO 15 FROM 0 IN 2700
IF 1 == 1 THEN dim DEVICE mainlight TO 15 FROM 0 IN 2700 FOR 60 AFTER 10

Pushover

Version
Available since pilight v6.0

Description
Send a message to your mobile phone with the pushover API

Options

namerequiredmultiple valuesdescription
TITLEx Self-explanatory
MESSAGEx Self-explanatory
TOKENx Unique user account token from the pushover website
USERx Unique username from the pushover website

Examples

IF 1 == 1 THEN pushover TITLE \"Doorbell rang\" MESSAGE \"Doorbell rang\" TOKEN abcd123abc USER pilight

Pushbullet

Version
Available since in the pilight nightly

Description
Send a message to your mobile phone with the pushbullet API

Options

namerequiredmultiple valuesdescription
TITLEx Self-explanatory
BODYx Self-explanatory
TOKENx Unique user account token from the pushbullet
TYPEx Message type

Examples

IF 1 == 1 THEN pushbullet TITLE \"Doorbell rang\" BODY \"Doorbell rang\" TOKEN abcd123abc USER TYPE note
actions.1427188859.txt.gz · Last modified: 2015/11/27 21:08 (external edit)