Sorama Smart Stadium - Version 2.0.0#
Module Summary#
Connects to a Sorama smart stadium server, and returns area ‘intensity’ values. ‘Intensity’ is calculated as mean of the current areas low and high decimal, scaled and normalised to a either a float, percentage, or byte.
Note: The operating Controller should be spec’d with the number of reporting areas in mind.
The basic din-rail Controller may not be suitable for your requirements. Please consult with our support team for further hardware advice.
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#
Instance Properties#
Set the Host address and Host address to that of the Sorama smart stadium server. Host address can be either a hostname or IP address. Access credentials should be entered into Username and Password.
The Websocket endpoint if left empty will use the default, otherwise a new endpoint can be specified.
Ticking Auto connect on startup will automatically connect ot the server on startup. Auto reconnect will reconnect, after a ‘cooling off’ delay, to the server on error.
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.
Default scale minimum and Default scale maximum set the default decibel scaling values to be used during normalisation. This can be changed during run-time using the action Set scale.
Default scale mixer, expressed as a byte (0-255), is the liner ratio between user supplied scale minimum/maximum and the Sorama supplied frame minimum/maximum. This can be changed during run-time using the action Set mixer.
Value range determinates if the returned value is a float (0-1), percentage (0-100%), -or byte (0-255).
Status Variables#
The IO Modules tab of the web interface provides status variables to shows information about the module and monitor its state.
| Host address | Host name or IP address of the currently connected server |
| Connection status | Current bridge connection status.
|
| Last error | Last connection error, if any, prepended with the date/time of the error |
| Number of areas | Number of areas last reported on by the server |
| Scaling range | Currently applied value scaling range |
| Scaling mixer | Currently applied scale mixer |
Triggers#
Area value#
Fires when the Controller receives an area value update from the server.
Matching properties:
Area: Matching area number, or ‘any’.
Trigger variables (‘Any’ Area):
Variable 1: Area count (variant).
Variable 2: Area value 1 (variant).
Variable n: Area value n (variant).
Trigger variables (Single Area):
Variable 1: Area number (variant).
Variable 2: Area value (variant).
Conditions#
Connected#
Matches if the Controller is currently connected to the server.
Actions#
Connect#
Starts a connection to the Sorama server
Disconnect#
Ends an existing connection with the Sorama server
Set scale#
Update the scaling range used for normalisation.
Properties:
Minimum: Minimum scale.
Maximum: Maximum scale.
Set mixer#
Update the scaling mixer used for normalisation.
Properties:
Value: Mixer value.
Support#
If you encounter any issues with this module, please contact our support team.