Zum Hauptinhalt springen
CloudStudio

Batterie- und RSSI-Status

Melden des RSSI-Status und/oder Batteriestands eines Geräts

Diese Methode speichert keinen Verlauf des Status; sie übernimmt nur den zuletzt gemeldeten Wert und zeigt ihn auf der Plattform an. Das heißt, wenn in der ersten Anfrage 3 Batterien gemeldet wurden und in der zweiten Anfrage nur eine gemeldet wird, wird davon ausgegangen, dass das Gerät jetzt nur noch eine Batterie hat. Dasselbe gilt für RSSI. Wenn leere Arrays gesendet werden, wird davon ausgegangen, dass kein Batteriestand oder RSSI-Datensatz vorhanden ist, und zuvor gemeldete Daten werden gelöscht.

Die HTTP-Integration für RSSI-Status und Batteriestand verwendet die folgende Struktur:

POST /services/gear/DeviceIntegrationService.svc/UpdateDeviceStatus HTTP/1.1
Host: gear-dev.cloud.studio
Content-Type: application/json

{
	"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"deviceID": 1,
	"battery": [
		{
			"type": 2,
			"percentage": 30,
			"voltage": 3.5
		},
		{
			"type": 3,
			"percentage": 100,
			"voltage": 5
		}
	],
	"rssi": [
		{
			"type": 2,
			"quality": 100,
			"strength": -40
		}
	]
}

Parameter

NameDescriptionData Type
accessTokenAccess token with permissions to update endpoint information. See this page for more information.text
deviceIDUnique device identifier or device address in format [deviceAddress] (e.g.: [device-1234]). These values can be found on the device management page.number
batteryList of statuses for the device's different batteries. One or more can be sent. Property descriptions for this parameter can be found below.array
rssiList of statuses for the device's different wireless connections. One or more can be sent. Property descriptions for this parameter can be found below.array

Array-Parameter "battery"

In jedem Element dieses Arrays muss mindestens "percentage" oder "voltage" gemeldet werden. Type ist obligatorisch.

NameDescriptionData Type
typeType of battery being reported. Allowed types are: 0: Unknown. If this value is sent, it will automatically be changed to 1. 1: Default. 2: Primary. 3: Secondary. 4: Backup. Types cannot be repeated in the same array.number
percentageNumeric value of the remaining battery percentage.number
voltageNumeric value of the current battery voltage.number

Array-Parameter "rssi"

In jedem Element dieses Arrays muss mindestens "quality" oder "strength" gemeldet werden. Type ist obligatorisch.

NameDescriptionData Type
typeRepresents a type of wireless technology where RSSI can be measured. Allowed values are: 0: Unknown. If this value is sent, it will automatically be changed to 1. 1: Default. 2: WiFi. 3: LoRaWAN. 4: Cellular (2G/3G/4G/5G/Cat-M/NB-IoT/etc). 5: ZigBee. 6: Custom RF. Types cannot be repeated in the same array.number
qualityNumeric value representing signal quality. From 0 to 100. If this value is not provided but the "strength" parameter is, this parameter's value will be auto-calculated.number
strengthNumeric value representing signal strength in dBm (negative). If the provided value is positive, its sign will be changed. If this value is not provided but the "quality" parameter is, this parameter's value will be auto-calculated.number

Zuletzt aktualisiert am

Auf dieser Seite