Skip to content

Latest commit

 

History

History
152 lines (115 loc) · 4.74 KB

File metadata and controls

152 lines (115 loc) · 4.74 KB

Functions

RTAssetCheckGeofence()

Performs real-time geofence functionalities

Triggered by /location topic

Status of a tag (inside or outside) is published the GEOFENCE_ALERT_TOPIC

RTAssetHTTPIntegration()

Opportunity to integrate with a REST endpoint using location data

Triggered by /location topic

RTAssetLogLocation()

Insert a row into COLLECTION_NAME upon a publish message to /location

Triggered by /location topic

RTAssetRESTIntegration()

Opportunity to implement a REST-based integration to your Real-Time IoT Solution

A placeholder URL is used as an example

Triggered by /location topic

RTAssetUpdateTagLocation()

Keeps track of a tag's most recent location

Triggered by /location topic

If a Tag with the corresponding ID is not found in the COLLECTION_NAME, a new row is created

Typedefs

Message
GeofenceBounds
Point
CoordinateSystem
RTAssetConfiguration
RTAssetUtil

RTAssetCheckGeofence()

Performs real-time geofence functionalities

Triggered by /location topic

Status of a tag (inside or outside) is published the GEOFENCE_ALERT_TOPIC

Kind: global function

RTAssetHTTPIntegration()

Opportunity to integrate with a REST endpoint using location data

Triggered by /location topic

Kind: global function

RTAssetLogLocation()

Insert a row into COLLECTION_NAME upon a publish message to /location

Triggered by /location topic

Kind: global function

RTAssetRESTIntegration()

Opportunity to implement a REST-based integration to your Real-Time IoT Solution

A placeholder URL is used as an example

Triggered by /location topic

Kind: global function

RTAssetUpdateTagLocation()

Keeps track of a tag's most recent location

Triggered by /location topic

If a Tag with the corresponding ID is not found in the COLLECTION_NAME, a new row is created

Kind: global function

Message

Kind: global typedef
Properties

Name Type Description
id string ID for a tag
lat number Latitude in decimal degrees, ex. 30.266822
long number Longitude in decimal degrees, ex -97.742462

GeofenceBounds

Kind: global typedef
Properties

Name Type Description
NWCorner Point Northwest Corner
NECorner Point Northeast Corner
SECorner Point Southeast Corner
SWCorner Point Southwest Corner

Point

Kind: global typedef
Link: geo library Point Object

CoordinateSystem

Kind: global typedef
Link: geo library Coordinate System

RTAssetConfiguration

Kind: global typedef
Properties

Name Type Description
messageSchema Message Schema for MQTT JSON Message
geofenceBounds GeofenceBounds Bounds for the geofence
Polar CoordinateSystem coordinate system, can be changed to Cartesian

RTAssetUtil

Kind: global typedef

RTAssetUtil.verifyMessageSchema(unparsed) ⇒ Message | false

Kind: static method of RTAssetUtil
Returns: Message | false - parsed message, false if failed

Param Type Description
unparsed string message body, needs to be JSON format