MyZone
| Module Rating | |
|---|---|
| Quality of API | 3/3 |
| Implementation | 3/3 |
| Status | Complete |
See the Modules Overview article for more information about how Module Ratings are calculated.
Module Settings
- MyZone Patch - Select an HTTP patch (IP address) from the Module Settings.
- Username - Username to provide to the MyZone webhook Settings.
- Password - Password to provide to the MyZone webhook Settings.
- Port - The port number to receive events from MyZone. (This port number must not be in use else where on your computer - It must match the port set within the MyZone applicaton).
- Webhook URL - The web URL to be entered into MyZone's settings. The URL or URLs shown will include all accessible network interfaces in use for the current main Ctrl Engine. - Make sure to provide MyZone with the network interface you plan to use. - If running MyZone and Ctrl Engine on the same computer use the 127.0.0.1 network interface.
Process Block
After creating a MyZone node, a block will be generated for it within Ctrl Suite's Process editor for integration as part of a process flow.
Each block contains sub-modules grouped to specific functions:
All Events and Endpoints
Ths block provides all MyZone Events and Endpoints. Use the dropdown within this block to select a specific function to use.
Events
Each Event features a single Triggered outlet that sends a pulse when the Parameter it reflects is met.
| Endpoint | Notes |
|---|---|
| State Changed | Sends a command when anything changes within the MyZone session (Any Will Change or Did Change). |
| Zone Will Change | Sends a command approx 5s ahead of a MyZone zone colour changing. |
| Zone Did Change | Sends a command when a zone has changed anything changes within the MyZone session. |
| Class Did Start | Sends a command when the class starts. |
| Class Did Pause | Sends a command when the class Pauses. |
| Class Did Resume | Sends a command when the class Resumes. |
| Zone Did End | Sends a command when the class ends. |
| Zone Will Grey | Sends a command approx 5s ahead of a MyZone zone to change to grey. |
| Zone Will Red | Sends a command approx 5s ahead of a MyZone zone to change to red. |
| Zone Will Green | Sends a command approx 5s ahead of a MyZone zone to change to green. |
| Zone Will Blue | Sends a command approx 5s ahead of a MyZone zone to change to blue. |
| Zone Will Yellow | Sends a command approx 5s ahead of a MyZone zone to change to yellow. |
| Zone Did Grey | Sends a command when a MyZone zone to changes to grey. |
| Zone Did Red | Sends a command when a MyZone zone to changes to red. |
| Zone Did Green | Sends a command when a MyZone zone to changes to green. |
| Zone Did Blue | Sends a command when a MyZone zone to changes to blue. |
| Zone Did Yellow | Sends a command when a MyZone zone to changes to yellow. |
Endpoints
Each Endpoint features two outlets:
- Triggered - This sends a pulse from the block every time it receives an input and the block (note this doesn't mea that the data is received).
- Error - Sends a pulse if the command was not acknowledged or there was an error in transmitting the command.
| Endpoint | Notes |
|---|---|
| List Classes | Sends a pulse if the command was not acknowledged. |
| Start Class | Starts the selected class within MyZone. |
| Pause Class | Pauses the selected class within MyZone. |
| Stop Class | Stops the selected class within MyZone. |
| List Belts | Lists all connected belts within the MyZone session. |
| Change Belt Status | Lists all connected belts. |
| List Videos | Lists all videos within the MyZone Ultron. |
| Start Video | Starts the selected video within MyZone. |
State Did Change
The State did Change block features five outlets. Each sends a pulse that can be used to trigger actions or other logic blocks in a process when the relevant criteria is met in the connected MyZone session.
Outlets:
- Any State -
- Start Class -
- Pause Class -
- Resume Class -
- End Class -
Zone Will Change
The Zone will Change block features five outlets. Each sends a pulse that can be used to trigger actions or other logic blocks in a process ~5s ahead of a Zone colour within MyZone in the connected MyZone session.
Outlets:
- Any - Triggered ~5 prior to any Zone changing.
- Grey - Triggered ~5 prior to the Zone colour changing to grey.
- Red - Triggered ~5 prior to the Zone colour changing to red.
- Green - Triggered ~5 prior to any Zone changing to green.
- Blue - Triggered ~5 prior to the Zone colour changing to blue.
- Yellow - Triggered ~5 prior to the Zone colour changing to yellow.
Zone Did Change
The Zone did Change block features five outlets. Each sends a pulse that can be used to trigger actions or other logic blocks in a process when the relevant criteria is met in the connected MyZone session.
Outlets:
- Any - Triggered when any Zone changes colour.
- Grey - Triggered when the Zone changes to grey.
- Red - Triggered when the Zone changes to red.
- Green - Triggered when the Zone changes to green.
- Blue - Triggered when the Zone changes to blue.
- Yellow - Triggered when the Zone changes to yellow.
Troubleshooting
Ensure HTTP remote control is enabled within the MyZone software and the PC running MyZone is set within the correct network range.
Reference the Ctrl Suite MyZone module settings and ensure that the port number in Ctrl Suite matches the port used within MyZone.
If all points above have been checked, move the port to another number i.e. 5010 on MyZone and Ctrl Suite to ensure your current port selection isn't clashing with something else on the device.