Expert - Version 2.0.0#
Module Summary#
Interacts with an Expert Controller using Pharos HTTP API.
Module Status#
This IO Module is stable and has been tested internally.
If you encounter any issues with this module, or have any feedback regarding its operation, please contact our support team.
Release Notes#
Version 2.0#
Initial release.
Minor point releases (eg. 1.1.x) will be for small fixes and may not be listed here.
Operation#
Instance Properties#
Set the IP Address and Port to that configured for the HTTPS interface on the Expert Controller.
The default Port is 443.
If the remote Controller has security enabled, then the Username and Password should be set. If security is disabled, leave these blank.
The local Controller will auto connect on startup if Auto connect? is enabled, and will automatically reconnect should an issue occur if Auto reconnect? is enabled.
Checking the Extended Logging checkbox will provide more detailed log messages. This is intended for diagnostics and problem solving and should ideally be disabled during normal operation.
Status Variables#
The IO Modules tab of the web interface provides status variables to shows information about the module and monitor its state.
| Controller name | Remote Controller's name, i.e. 'Controller 1' |
| Controller type | Remote Controller's type, i.e. 'Expert Control' |
| Controller serial | Remote Controller's serial number |
| Controller firmware version | Remote Controller's main firmware number |
| Project name | The name of the project currently loaded on the remote Controller |
| Project author | The author's name of the project currently loaded on the remote Controller |
| Project filename | The filename of the project currently loaded on the remote Controller |
| Project UUID | The unique ID of the project currently loaded on the remote Controller |
| Project date | The last save date of the project currently loaded on the remote Controller |
| Cloud state | Current cloud connectivity status of the remote Controller |
Triggers#
Access denied#
Fires if the Username/Password combination is invalid.
Trigger variables:
Variable 1: Access denied reason message (string).
Connected#
Fires when connection to the remote Controller is established.
Disconnected#
Fires when connection to the remote Controller is lost.
Beacon status#
Fires when beacon status of the remote Controller changes to match Status.
Trigger variables:
Variable 1: Beacon on? (boolean).
Cloud status#
Fires when cloud connectivity status of the remote Controller changes to match Status.
Scene recalled#
Fires when a scene is recalled on the remote Controller that matches scene Number, and Space number.
Trigger variables:
Variable 1: Scene number (integer).
Variable 2: Scene name (string).
Variable 3: Space number (integer).
Tag activated#
Fires when a tag is activated on the remote Controller that matches tag set Set, and tag Number.
Trigger variables:
Variable 1: Tag set number (integer).
Variable 2: Tag set name (string).
Variable 3: Tag number (integer).
Variable 4: Tag name (string).
Conditions#
Is connected#
Matches if currently connected to the remote Controller.
Actions#
Connect#
Starts a connection to the remote Controller.
Disconnect#
Initiate a disconnect from the remote Controller.
Toggle beacon#
Requests the remote controller to toggle beacon status.
Channel park#
Requests the remote controller to park an output Channel number on port Universe index of protocol Universe protocol at a Level.
Channel unpark#
Requests the remote controller to unpark an output Channel number on port Universe index of protocol Universe protocol, previously parked.
Scene recall#
Requests the remote controller to recall scene Number.
Space off#
Requests the remote controller to set space Number to off.
Space master intensity#
Requests the remote controller to set space Number to master intensity to Intensity percent.
Tag activate#
Requests the remote controller to activate tag Number in tag set Set.
Support#
If you encounter any issues with this module, please contact our support team.