Actions are usefull to trigger an action (usually a notification), depending on the state of a command or a switch.
Ie: You might want to receive an Email when someone ring at the door, or when a Motion sensor is triggered.
Actions are triggered from an URL request like this:
phpMyDomo is not an Home Automation server himself, so you will have to define this automation on your own server, with something like:
WHEN switch_XXX IS ON THEN TRIGGER HTTP_REQUEST "http://pmd_host_or_ip/action?type=ACTION&preset=door_ring"
The syntax, or GUI to define this automation, will obviously depend on the server you're using, and if it is able to send HTTP requests.
Each possible actions are defined in the PMD/www/inc/action/ directory.
Each one need to have its configuration file in the PMD/www/inc/conf/ directory.
Example if you want to use the "email" action, there must be an "action_email.php" file present (and configured) in the PMD/www/inc/conf/ directory.
Sample configurations can be found in the PMD/www/inc/conf_sample/ directory (if they are not already moved in the the PMD/www/inc/conf directory).
Each action require some fields to be set in the configuration file. They are all detailed in the sample configuration file.
Example : "email" action:
All these fields need to be defined either:
$action['presets']['ring_door']['subject']="Someone rings at the door";
Fields defined as global, are used when they are not defined elsewhere ie in the URL or in a preset.
You should mostly want to fill them all.
Preset are just groups of fields , that define their values. You can define as many preset as you want, with the following syntax:
You can define all fields in a preset, or simply some of them that will override those defined in the globals fields.
They will be simply called from an url like:
Most fields are generally required, but they will be initialized in this way:
So all you have to do is to fill all the "globals" fields, and define some presets that will override the fields defined as globals
Then, you will just call a preset with an url like this:
If you may want to override some preset or global fields, you just add them to the URL, ie:
The Debounce time (in seconds) is the minimun time that must elapse between identical actions requests. Ie: if you trigger an action from a PIR sensor (which might send multiple pulses in a short time period ), it could trigger the same action multiple time. To avoid getting multiple notifications for the same trigger, you should set the debounce time to a few seconds.
The debounce time can be set globally, at the application level (from the $conf['app']['actions_debounce'] parameter, in the inc/conf/config.php file), or in each actions at global, preset, or url levels.
Once you have setupped the configuration file of your action, you might make tests by going to:
You will see a JSON encoded response, indicating if it worked or not.
BTW: You can add "&debug" at the end of the URL, to show a HTML view of the response)
Fields are passed as field=value, starting with '?', and then separated by '&.
Call preset 'door_ring' (using to/from defined either in the preset or as globals) :
Call preset 'door_ring', but with a custom text inserted in the content :
Call preset 'door_ring', but send it To firstname.lastname@example.org :
Send a mail to/from emails defined as global, using a custom subject and email:
You get the idea? ;-)