How to configure the Spidertracks Serial API - Spider X

The following article describes how to configure the Spider X to receive and process events from a device compatible with the Spidertracks Serial API.

Note: If for some reason the configuration fails, e.g. if the cable isn’t yet connected, a caution sign will display.

• The SX has one serial port so customers can have an ATU, GPI Cable or a Keypad connected, not more than one at a time.
• The Spidertracks Serial API option is supported on Spider X firmware v5.1.1 and later, and in mobile app versions v5.2.0 and later.

Refer to the 3rd party hardware vendors Installation Manual for instructions on completing the electrical interface (wiring) between their device and the Spider X.

After electrically connecting the Spider X to the 3rd party equipment, the Spider X device needs to be configured to correctly process Serial API event data. This is completed via the Spidertracks mobile app; Please follow these instructions:

1. Open the App.

2. Login with the details that you used to sign up with on app.spidertracks.io.

3. Tap More.

4. Select Spider Connection.

5. Select Advanced Setup.

6. Under the SERIAL DEVICE section, select the Device: (name) row to change the connected device.

7. Select Spidertracks Serial API.

8. Check the device connection status:

Green tick icon		Indicates the Spider X is receiving and successfully processing messages from the external serial device.
Orange exclamation icon		Indicates the Spider X is receiving messages but unable to process them. Check that the device selection is correct.
Red disconnect icon		Indicates the Spider X is not receiving any data from the external device. Check the device is powered and serial wiring is correct.

9. To debug the serial connection, select Device Settings and Diagnostics.

10. The DIAGNOSTICS section shows a real time stream of serial data being exchanged between the external device and Spider X. Messages from the external device are in black, and responses from the Spider X are in red.

Please email us at [e-mail] for further help.