I/O Handler Setup#

_images/Screenshot_IoHandler.png

Runtime Elements#

  • Controller IP

    • IP address of the controller

    • 0.0.0.0 (default)

  • HTTP Port

    • HTTP = 80

    • HTTPS = 443 (default)

    • The assigned port can be changed if needed

  • HTTP Mode

    • HTTP

    • HTTPS (default)

  • Test API

    • Send/receive to/from the controller to verify bidirectional communication is occurring

    • Commands can be sent using the following format

      • Method;Path;Body Data;Query Data

      • Command Examples

        • GET system information : GET;/api/system;{}

        • POST toggle timeline 101 : POST;/api/timeline;{"action":"toggle","num":101,"fade": 2}

      • Please refer to the API documentation for a complete list of commands

  • HTTP Status (read only)

    • Displays communication errors and successful command execution

  • Authentication

    • If authentication is enabled on the controller you will need to obtain the username and password to gain access

    • Once the correct username and password is entered will send an auth token to Q-SYS

      • By default the controller authentication timeout is set to 5 minutes

      • The controller authentication timeout can be changed from 1-60 minutes by the system programmer

      • Be sure to set the Auth. Timeout (Mins) property within the I/O Handler to the same authentication timeout as the controller (default 5 mins)

        • The I/O Handler has a built in 10 second grace period

        • If the auth. timeout is set to 5 minutes the I/O Handler will request a new token from the controller every 4 minutes and 50 seconds as long as the user has not manually logged out of the session

  • Login/Logout Button

    • The I/O Handler will automatically login to the controller provided the correct username and password have been entered

    • The user can login/logout to/from the controller by pressing the button or triggering the appropriate pin

    • It is recommended to logout from the controller during a configuration upload/download

Designtime Properties#

  • Plugin Group ID

  • Auth. Timeout (mins)

    • Default is set to 5 minutes and needs to match the authentication timeout set within the Controller

  • I/O Max. Retries (default: disabled)

    • Number of times the core will try to reconnect if there is an interruption with the HTTP connection

    • The core will stop trying to reconnect once the maximum retries set within properties has been met or an HTTP connection has been established

    • Choices

      • 0-100 retries (default 0)

  • I/O Retry Interval (secs)

    • Delay time between retries

    • Choices

      • 30-300 retries (default 60)

  • On, Off & Pushed Button State

  • Print to Event Log

    • Sends received/transmitted data details to the core’s webserver event log

    • After troubleshooting be sure to set this property to NO and reload the design to the core

      • Choices

        • No (default)

        • Yes

  • Show Debug

Control Pins#

Pin Name

Input

Output

Values

Disable

✅

✅

0/false, 1/true

Login/Logout

✅

✅

Momentary true/false

HTTP Mode

❌

✅

string

HTTP Status

❌

✅

string

HTTP Port

✅

✅

string

IP Address

✅

✅

string

Password

✅

✅

string

Username

✅

✅

string

Test API

✅

✅

string