Backstage Control - Kiss the Frog - Version 2.0.0.BETA4#

Module Summary#

Integrate with Kiss the Frog MQTT servers.

Module Status#

Note: Please be aware that this is a beta version of this IO Module which has not yet been fully tested. We recommend testing before use.

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#

Module Properties#

Set the Controller ID as required to uniquely identify the controller on the MQTT broker. If omitted then the controller’s type and serial number will be used.

Set the MQTT Broker Hostname and MQTT Broker Port to that configured on the MQTT broker.
Tick Use SSL if the broker requires a SSL/TLS encrypted connection.
Tick Verify SSL Certificate to verify, when using an encrypted connection, that the broker’s certificate is valid.

Set the Username and Password as required.

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.

Instance Properties#

Set the Instance ID as to uniquely identify this instance on the MQTT broker.

Mode 1 to Mode 16 are used to assign names to the settable modes, these are use for logging and returned with trigger variables.

Status Variables#

The IO Modules tab of the web interface provides status variables to shows information about the module and monitor its state.

Current Mode The currently set mode name and mode number
Current Intensity The currently set intensity
Last Mode Change Date and time of the last mode change

Triggers#

Mode changed#

Fires when the mode has changed, matching Mode or “Any”.

Trigger variables:

  •  Variable 1: Mode number /16 (integer).

  •  Variable 2: Mode name (string).

  •  Variable 3: Source of change (“mqtt” or “internal”).

Current mode#

Fires in response to the action Get current mode.

Trigger variables:

  •  Variable 1: Mode number /16 (integer).

  •  Variable 2: Mode name (string).

Intensity changed#

Fires when the intensity has changed, matching Value or “Any”.

Trigger variables:

  •  Variable 1: Intensity value /255 (integer).

Conditions#

Mode is#

Returns true if Mode matches the current mode.

Actions#

Set mode#

Changes the current mode to Mode.

Get current mode#

Requests the current mode via the trigger Current mode.

Set intensity#

Changes the current intensity to Value.

Support#

If you encounter any issues with this module, please contact our support team.