# Uplink Configuration

Within the API section of the Console, there are two input fields in the Uplink section as shown in the following table.

Table 3: Uplink API Fields

Field Description
Uplink URL The URL of the third-party application as defined by the user
Header Authorization Code The user defined authorization code added to the header of the POST request

Both fields in the above table are required. Uplink messages will be sent to the user defined URL with the user defined authorization code in the header.

The parameters that are passed with the uplink request are defined in the following table.

Table 4: Uplink Parameters

Parameter Description
deviceId Unique Device EUI of sensor.
Example: 80000004012067
deviceName Device Name defined in the Console.
Example: “Steves tilt sensor 1”
deviceType Description of the device.
Example: “LoRa High Precision Tilt Sensor”
partNumber The Radio Bridge part number.
Example: “RBS306-TILT-HP”
seqNumber Message Sequence Number.
0x00 to 0x0F and then wraps back to 0x00.
eventType The type of uplink message.
Example: “RESET”
eventDescription Description of the event, used with eventType
Example: “Button 1 and 2 released together”
eventTime Time stamp of the event in UTC
Example: “2019-05-06Z21:01:38”
rawBytes Raw hex data received from the sensor
Example: “150f005e40”
snr Signal to Noise Ratio
Example: “10.3”
rssi Receive Signal Strength Indicator
Example: “-93”
hardwareVersion Hardware version from reset message
Example: “2.0”
firmwareVersion Firmware version from reset message
Example: “1.6”
sensorState Current state of the sensor from the supervisory message
Example: “Door Closed”
battery Battery voltage reported by the supervisory message
Example: “3.0 V”
network LoRaWAN network server
Example: “Senet”
measurement See measurement table
gateway The gateway defined in the console if it is being used
Example: “my gateway 1”

The measurement field is dependent on the sensor type, and is defined in the following table.

Table 5: Measurement Field Definitions

Sensor Measurement field
Water Sensor Relative measurement
Example: “228”
Temperature Sensor Current Temperature
Example: “22 C”
Tilt Sensor Tilt angle from vertical axis
Example: “91.3 Degrees”
Tank Level Sensor Relative measurement
Ambient Light Sensor Current ambient light measurement
Air Temperature Humidity Sensor Current temperature in degrees Celsius
Example: “21.6 C, 34.3 %”
Vibration Sensor Vibration Sensor
Example: “High-frequency vibration peak g-force: 0”
Acceleration Movement Sensor Current sensor state
Example: “Acceleration stopped”
Ultrasonic Level Sensor Current distance
Example: “668 mm”
420mA Current Loop Sensor Current measurement
Example: “8.5 mA”
Voltage Sensor Voltage measurement
Example: “0.03 V”
Thermocouple Temp Sensor Current temperature in degrees Celsius
Example: “10.81 C”
Low Freq Vibration Sensor Current temperature in Celsius
Example: “10.81 C”

Table 6: GPS Specific Fields

Parameter Description
latitude This is available for GPS devices
Example: “39.7567144000”
longitude This param is available for GPS devices only
Example: “105.00442380000”
location This param is available for GPS devices only
Example: Contains HTML markup with google maps link.
<a target="_blank" href="http://maps.google.com/?q=39.7567144000,-105.00442380000">View on Google Maps</a>

Table 7: Honeywell 5800 Bridge Specific Fields

Parameter Description
eventIdentifier Event identifier
Example: “Status Code”
hexId Contains hex id
Example: “0x000341”
decimalId Hex id is converted into decimal values
Example: “833”
sensorPayload Sensor payload in decimal
Example: “2444”
sensorPayloadHex Sensor payload in hex
(Example: “0x00098c”)

Table 8: High Bandwidth Vibration Sensor Specific Fields

Parameter Description
vibrationVelocity High-frequency vibration peak g-force
Example: “0”
acceleratorTemp Temperature
Example: “10.81 C”
sensor Shows the vibration event
Example: “High Frequency Periodic Report”

Table 9: Low Bandwidth Vibration Sensor Specific Fields

Parameter Description
xaxis Low-frequency vibration peak velocity in inches/sec in the x-axis
Example: “0”
yaxis Low-frequency vibration peak velocity in inches/sec in the y-axis
Example: “1”
zaxis Low-frequency vibration peak velocity in inches/sec in the z-axis
Example: “4”
sensor Shows the vibration event Example: “Low Frequency Periodic Report”

Table 10: Weather Station Bridge Specific Fields

Parameter Description
errorEvent Error details
Example: “Some data is marked as invalid”
windDirection Contains sub-array
Example: {"min":"36 Degrees","max":"90 Degrees","avg":"68 Degrees"}
windSpeed Contains sub-array
Example: {"min":"0 m/s","max":"0.001 m/s", "avg":"0.001 m/s "}
pressureTempHumidity Contains sub-array with following element
Example: {"temperature":"26.2 C","pressure":"83,020 Pa","humidity":"24.2 %"}
rain Contains sub-array with element
Example: {"duration ":"0 Seconds","accumulation ":"0 mm","intensity ":"0 mm/h"}
hail Contains sub-array with element
Example: {"duration ":"0 Seconds","accumulation ":"0 mm","intensity ":"0 mm/h"}
stationStatus Contains sub-array with element
Example: {"temperature":"27.8 C", "voltage":"0 V", "supply":"12.2 V","reference":"3.612 V"}