Endpoint Entity
Oct 12 2022 at 12:00 AM
Description
An Endpoint is an entity to provide a value output from a selection of different data types. When creating an endpoint, a sub-type must be selected between normal or static. A Static Endpoint (SEP) allows the user to input the value of the endpoint within the system (hard coded), whereas a normal endpoint is an endpoint that is linked to a gateway which allows the user to visualise live data, or manipulate this data further within the Commander Portal toolset.
 |
| The time limit before data is regarded as timed out (or stale data) due to data for the endpoint not coming in at the expected frequency. If this limit is not set, the data on the dashboard will continue to display the last known value of the endpoint. If this value is set and the last time the endpoint got a new value is older than the timeout value, the data on the dashboard will update visually to inform a user that the data has timed out (this visual representation can be configured differently per tenant, default display is “- -“’). |
Configuration
| Data types | Description | Format example |
|---|---|---|
| Boolean | You select between a true or false option. | True/False. |
| CCTV | This can only be a normal endpoint, as it pulls from a live camera feed. | *Event string |
| Date Time | You input the date and time in the format; month, day and year. Time is AM and PM format. | MM/DD/YYYY, HH:MM (AM/PM) |
| Double | Any number with 2 decimal place. | 5.00 |
| Geo Polygon | A set of GPS Coordinates that forms a closed loop on a Geo Map to create a Geo Fence. | [{“lat”:a,”lon’’:b},{“lat”:c,”lon’’:d},{“lat”:e,”lon’’:f},{“lat”:a,”lon’’:b}] - See use case example 1 below for more detail. |
| Gps Coordinate | A point on a Geo Map. | {“lat”:a,”lon’’:b} - See use case example 2 below for more detail. |
| Integer | A number without decimal places. | 15 |
| Kilometer | This is a decimal value with kilometer units embedded. | 65.2KM |
| Livestream Video (deprecated) | This is where you can insert URL’s to view the live stream from any application. | *URL string |
| Location Tracking | This is a collection endpoint which is used for indoor asset location and status tracking. Generally an x and y coordinate would be required, as well as a variable indicating the status of the asset. | {“reset”:{“D6.005.12”:{“x”:0.9160618500000002,”y”:0.30331799999999953,”t”:”J”} |
| Profile (Static) | A set of data over time to be plotted on a time series chart (graph). | See use case example 3 below. |
| RFID Dictionary | A collection endpoint that allows interaction with a grouping of values under one endpoint. RFID Dictionary allows managing several “micro-endpoints” under one logical point. RFID Dictionary types also allow matching metadata to user-defined micro-endpoints through Tag Tracking services. They are designed with a frame data structure in mind. This means the design expects frames and key-frames through the use of “addOrUpdate”, “remove” or “reset” commands, given in the RFID Dictionary packet, in order to update the collection data based on live events. | *Collection string |
| String | A string is any value that should be read as text, both are the same for normal and static endpoints. | Text value |
| Time Span | A time span of data with maximum timespan being 29:59:59. | HH:MM:SS |
Use Case Example(s)
1. Geo polygon provides the user ability to create a geofence or a perimeter on a geo map, it uses a set of latitude and longitude coordinates which is given when creating the perimeter that would you would get from the edge device. Below is what it looks like when built in the platform:
Clip 1 - How to create a geo polygon
2. Gps Coordinate can be used to find the precise location of a place and by using a pin to show that. Below is what it looks like when built in the platform:
Clip 2 - How to create a gps coordinate
3. In this use case a static profile endpoint is being shown, additionally a static profile will not change unless a new csv set of data is uploaded. A static profile requires the user to input the data manually on a csv file to be uploaded.
Clip 3 - How to create a profile endpoint
4. Location Tracking values will pull data for devices from a sensor and provide the asset’s information in a collection string. This endpoint is used in conjunction with Digital Overlay widgets that have been pre-configured with a floor plan.