Destination File

Cloud and Server Endpoints

Destinations that send events to remote servers over IP-based transports.

Pegasus

Sends TAIP-formatted events over TCP to a Pegasus Cloud instance. The host follows the pattern pegasus<SITE_ID>.peginstances.com:5001, where SITE_ID comes from your gateway's /api response (for example https://cloud.pegasusgateway.com/api/).

# Pegasus Cloud endpoints
# Protocol: taip
# Syntax: tcp://pegasusSITE_ID.peginstances.com:5000+SITE_ID, the SITE_ID comes from your gateway's /api response
# Example with https://cloud.pegasusgateway.com/api/

define destination pegasus taip tcp://pegasus1.peginstances.com:5001

TCP

A generic TAIP-over-TCP destination pointing at any host and port. Use this for custom collectors that speak TAIP directly.

# TCP endpoint
# Syntax: tcp://host[:port]
# host = domain name or ip address

# Creates a destination for taip protocol over tcp
define destination tcp_endpoint taip tcp://tcpserver.com:5001

HTTPS

Two HTTPS destinations that POST JSON payloads to a web service. The first uses only a content-type header; the second adds a bearer authorization header.

# HTTP(S) endpoints
# Syntax: http[s]://host[:port]/path[?query] [headers.header-name="value"]
# host = domain name or ip address

# Creates a destination that sends json data to an https endpoint
define destination webservice json https://hooks.webservice.com/services/T06CB5NJJ/BQ0US5PK7/sp8x3pgrQ69smy5YxzF2E365 headers.content-type=application/json

# Creates a destination with an authorization header and content-type
define destination auth_webservice json https://api.webservice.io:23424/gateway/syrus4g headers.authorization="Bearer XXXXX" headers.content-type=application/json

MQTT

Publishes JSON events over MQTT to the Pegasus gateway broker. The active definition uses plain TCP on port 1883; commented alternatives show the same broker over MQTTS (8883), WebSocket (80), and secure WebSocket (443). Publish and subscribe topics are keyed to the device IMEI.

# MQTT endpoints
# Syntax: mqtt://host[:port]/path[?query] protocol=[value]
# creates an mqtt destination, check the documentation for examples on the available parameters
# https://syrus.digitalcomtech.com/syrdocs/syrus4/syruslang/#mqtt 

# define destination mqtt_over_tcp json mqtt://mqtt.pegasusgateway.com:1883 protocol="mqtt" publish="dev/{{$modem.imei}}/pub" subscribe="dev/{{$modem.imei}}/sub" commands_pub="dev/{{$modem.imei}}/commands"
# define destination mqtt_over_tcp_ssl json mqtt://mqtt.pegasusgateway.com:8883 protocol="mqtts" publish="dev/{{$modem.imei}}/pub" subscribe="dev/{{$modem.imei}}/sub" commands_pub="dev/{{$modem.imei}}/commands"
# define destination mqtt_over_ws json mqtt://mqtt.pegasusgateway.com:80 protocol="ws" publish="dev/{{$modem.imei}}/pub" subscribe="dev/{{$modem.imei}}/sub" commands_pub="dev/{{$modem.imei}}/commands"
# define destination mqtt_over_wss json mqtt://mqtt.pegasusgateway.com:443 protocol="wss" publish="dev/{{$modem.imei}}/pub" subscribe="dev/{{$modem.imei}}/sub" commands_pub="dev/{{$modem.imei}}/commands"

define destination mqtt_over_tcp json mqtt://mqtt.pegasusgateway.com:1883 protocol="mqtt" publish="dev/{{$modem.imei}}/pub" subscribe="dev/{{$modem.imei}}/sub" commands_pub="dev/{{$modem.imei}}/commands"

Local Storage

Destinations that write events to a file on the device or on removable media.

File Logger

Defines two file destinations that write newline-delimited JSON. logger writes to the internal filesystem under the syrus4g user's home; storage writes to external media such as a uSD card or USB drive (make sure the syrus4g user has write permissions, for example via apx-ext-memory).

# File endpoints
# Syntax: file:///path/to/file

# Creates a destination called 'logger' that can save the events generated on the device filesystem
define destination logger json file:///data/users/syrus4g/output.json

# Creates a destination called 'storage' that saves the contents on an external media like USB hard drive or uSD card
# Make sure user 'syrus4g' has permissions to create the file on any external media (you can use use apx-ext-memory tool)
define destination storage json file:///media/mmcblk0p1/storage/output.json

Peripherals and Accessories

Destinations that send events to nearby accessories over Bluetooth or through a satellite modem.

Bluetooth

Two Bluetooth-based destinations: bluetooth_events broadcasts TAIP messages to the S4GBT event characteristic with acks disabled, and bluetooth_apps targets the S4GBT user application console with sequential acks. Both accept json or taip payloads; only taip supports ack.

# Bluetooth endpoints
# Syntax: bluetooth://[characteristic]:_

# Event broadcast destination
# Protocols: json or taip
# S4GBT Destination Point (00000000-dc74-0280-dc74-a07ba85ee4d6)
define destination bluetooth_events taip bluetooth://_:_ ack=disabled

# User application console for message acknowledgements and queuing over Bluetooth
# Protocols: json or taip (only taip supports ack)
# S4GBT User Application Console (00000000-dc74-0380-dc74-a07ba85ee4d6)
define destination bluetooth_apps taip bluetooth://apps:_ ack=seq

Satellite Modem

Defines a TAIP destination for the satcom accessory. Acks are not supported over satcom, and the destination starts disabled by default so it can be enabled on demand by actions (see the satcom snippets in the configuration file).

# Bluetooth endpoints
# Syntax: satcom://_:_
# Protocols: taip only (note that message acknowledgements is not supported)
# Recommended to be disabled by default and via actions enabled

# Creates a destination compatible with the satcom accessory
define destination satcom_destination taip satcom://_:_ ack=disabled disabled=true