‌WebSocket Get Location

Protocol: WebSocket (ws)

Interaction Flow

After the connection is successfully established, the client can send commands to the server to retrieve location data. Currently, the supported command types are:
All Map Data
Single Map Data
Single Tag Data
Support for marking a focused tag is available. Single tags are focused by default, and the display effect is controlled by the frontend.
The parameter groupType is used to differentiate the type of data requested. Details are as follows:

Example parameters for retrieving all map data:
{"groupType":-1,"focusedDeviceCode":"xxxx"} or {"groupType":-1}

Example parameters for retrieving single map data：
{"groupType":0,"mapId":"1803304704358449154","focusedDeviceCode":"xxxx"}
or
{"groupType":0,"mapId":"1803304704358449154"}

Example parameters for retrieving single tag data:
{"groupType":1,"deviceCode":"xxx"}

Location Data Push Example：

{
	"type": "FeatureCollection",
	"features": [{
		"id": "00D489",
		"geometry": {
			"type": "Point",
			"coordinates": [14.48, -10.45]
		},
		"properties": {
			"deviceCode": "00D489",
			"deviceName": "ces",
			"deviceType": "staff",
			"bindingName": "张三",
			"bindingId": "1773302071795351553",
			"bindingCode": "dkB1711623122425",
			"deptId": 103,
                        "focusing": false,
			"mapId": "1779792490184015874",
			"positioningTime": "2024-07-11 15:30:53.555",
			"deviceBattery": "46%",
			"typeId": 0,
			"typeName": "系统默认",
			"typeColor": "#67C23A",
			"typeIcon": "icona-bianzu67",
			"typeResource": "unbound"
		},
		"type": "Feature"
	}]
}

Field	Type	Description
`type`	`string`	Always `FeatureCollection`, indicating this is a feature collection.
`features`	`Array`	An array containing multiple features.

Feature Object Properties

Field	Type	Description
`features[n].id`	`string`	The unique identifier for the feature.
`features[n].type`	`string`	Always `Feature`, indicating this is a feature object.
`features[n].geometry.type`	`string`	Always `Point`, indicating this is a point feature.
`features[n].geometry.coordinates`	`Array<number>`	The coordinates `[longitude, latitude]` of the point feature.
`features[n].properties.deviceCode`	`string`	Device code.
`features[n].properties.deviceName`	`string`	Device name.
`features[n].properties.deviceType`	`string`	Device type (e.g., `staff`, `visitor`).
`features[n].properties.bindingName`	`string`	The bound name (e.g., person's name).
`features[n].properties.bindingId`	`string`	The unique identifier of the binding.
`features[n].properties.bindingCode`	`string`	The code of the binding.
`features[n].properties.deptId`	`number`	Department ID.
`features[n].properties.focusing`	`boolean`	Focus flag.
`features[n].properties.mapId`	`string`	Map ID.
`features[n].properties.positioningTime`	`string`	Positioning time in `YYYY-MM-DD HH:mm:ss.SSS` format.
`features[n].properties.deviceBattery`	`string`	Device battery level (e.g., `46%`).
`features[n].properties.typeId`	`number`	Resource type ID.
`features[n].properties.typeName`	`string`	Resource type name.
`features[n].properties.typeColor`	`string`	Icon color in HEX format (e.g., `#67C23A`).
`features[n].properties.typeIcon`	`string`	Icon identifier.
`features[n].properties.typeResource`	`string`	Resource type (e.g., `unbound`, `staff`).

Statistical Data Push

The server pushes various types of statistical data periodically or upon specific events.

Current Layer Statistics （Pushed immediately after location data, if location data exists.）

    {
	"data": {
		"all": 3, // Total (including unbound)
		"staff": 1, // Staff
		"unbound": 1, // Unbound (not displayed on the frontend in the current iteration)
		"material": 0, // Material
		"visitor": 1, // Visitor
		"vehicle": 0 // Vehicle
	},
	"type": "currentStatistics"
}

Global Statistics
Pushed at intervals; the backend calculates every 10 seconds, with a push frequency of 10-15 seconds.

   {
	"data": [
		{
			"type": "anchor", // Base Station
			"offline": 0,
			"online": 15,
			"total": 15
		},
		{
			"type": "gateway", // Gateway
			"offline": 0,
			"online": 0,
			"total": 0
		},
		{
			"type": "staff", // Staff
			"offline": 0,
			"online": 1,
			"total": 1
		},
		{
			"type": "material", // Material
			"offline": 0,
			"online": 0,
			"total": 0
		},
		{
			"type": "vehicle", // Vehicle
			"offline": 0,
			"online": 0,
			"total": 0
		},
		{
			"type": "visitor", // Visitor
			"offline": 0,
			"online": 1,
			"total": 1
		}
	],
	"type": "statistics"
}

Map Statistics
Pushed at intervals; the backend calculates every 10 seconds, with a push frequency of 10-15 seconds.

{
	"type": "mapStatistics",
	"data": [
		{
			"mapId": 1805127037090004993,
			"mapName": "Hall Map",
			"mapInfo": [
				{
					"type": "anchor",
					"offline": 0,
					"online": 0,
					"total": 0
				},
				{
					"type": "gateway",
					"offline": 0,
					"online": 0,
					"total": 0
				},
				{
					"type": "staff",
					"offline": 0,
					"online": 0,
					"total": 0
				},
				{
					"type": "material",
					"offline": 0,
					"online": 0,
					"total": 0
				},
				{
					"type": "vehicle",
					"offline": 0,
					"online": 0,
					"total": 0
				},
				{
					"type": "visitor",
					"offline": 0,
					"online": 0,
					"total": 0
				}
			]
		},
		{
			"mapId": 1772542251450466305,
			"mapName": "Woxu Office Area 1",
			"mapInfo": [
				{
					"type": "anchor",
					"offline": 0,
					"online": 0,
					"total": 0
				},
				{
					"type": "gateway",
					"offline": 0,
					"online": 0,
					"total": 0
				},
				{
					"type": "staff",
					"offline": 0,
					"online": 0,
					"total": 0
				},
				{
					"type": "material",
					"offline": 0,
					"online": 0,
					"total": 0
				},
				{
					"type": "vehicle",
					"offline": 0,
					"online": 0,
					"total": 0
				},
				{
					"type": "visitor",
					"offline": 0,
					"online": 0,
					"total": 0
				}
			]
		}
	]
}

Field	Type	Description
`type`	`string`	Always `mapStatistics`.
`data`	`Array`	An array of statistics objects for each map.
`data[n].mapId`	`number\|string`	The unique identifier for the map.
`data[n].mapName`	`string`	The name of the map.
`data[n].mapInfo`	`Array`	An array of statistics for different device types on this map.
`data[n].mapInfo[m].type`	`string`	The type of device or resource (e.g., `anchor`, `staff`).
`data[n].mapInfo[m].offline`	`number`	Count of offline devices/resources of this type.
`data[n].mapInfo[m].online`	`number`	Count of online devices/resources of this type.
`data[n].mapInfo[m].total`	`number`	Total count of devices/resources of this type.

‌WebSocket Get Location

Interaction Flow#

Statistical Data Push#

Request

Interaction Flow

Statistical Data Push