Documentation SignalR

[nlz242]

Bonjour,

Voici un peu de documentation à propos des messages qu'Hilo envoie via SignalR (qui sont traités par l'integration dans on_websocket_event de __init__.py). Si vous avez des questions n'hesitez pas à les formuler dans ce fil de discussion.

• GatewayValuesReceived -> [DeviceAttributeValue]
  Contient les valeurs qui ont changées, associées à la passerelle, comme la Version du Firmware, son état (connecté), le cannal de communication zigbee, etc.

• DevicesValuesReceived -> [DeviceAttributeValue]
  Contient les valeurs qui ont changées, associées aux appareils, comme la température des thermostats, la couleurs assigné à une ampoule rgb, etc

• DevicesListChanged -> [int64]
  Contient le location_id d'une location pour laquelle des appareils ont été supprimés

• DeviceListUpdatedValuesReceived -> [DeviceUpdate]
  Contient les valeurs associées aux changements de parametre d'appareils dans l'application Hilo, comme le nom d'un appareil, l'icone associé, si il est en favoris, etc

• DeviceListInitialValuesReceived -> [Device]
  Suite à l'inscription (via "SubscribeToLocation"), contient une liste complete de tous les appareils et toutes leurs valeurs (pas seulement celles qui ont changées)

• DeviceDeleted -> DeviceDelete
  Contient l'ID d'un appareil supprimé.

• DeviceAdded -> Device
  Contient le details d'un appareil qui vient d'être ajouté (pairing zigbee ou via un lien cloud (OneLink, Resideo, etc)

• Heartbeat -> DateTime
  Contient l'heure actuel, utilisé comme ping.

Voici les schemas en notation "OpenAPI"-ish

"DeviceAttributeValue": {
	"required": [
		"attribute",
		"deviceId",
		"locationId"
	],
	"type": "object",
	"properties": {
		"deviceId": {
			"type": "integer",
			"format": "int64"
		},
		"locationId": {
			"type": "integer",
			"format": "int64"
		},
		"timeStampUTC": {
			"type": "string",
			"format": "date-time",
			"nullable": true
		},
		"attribute": {
			"$ref": "#/components/schemas/DeviceAttributes"
		},
		"value": {
			"nullable": true
		},
		"valueType": {
			"$ref": "#/components/schemas/DeviceAttributeType"
		},
		"operationId": {
			"type": "string",
			"nullable": true
		}
	},
	"additionalProperties": false
},
"DeviceAttributes": {
	"enum": [
		"None",
		"OnOff",
		"Intensity",
		"CurrentTemperature",
		"TargetTemperature",
		"Power",
		"Status",
		"Heating",
		"BatteryPercent",
		"BatteryStatus",
		"ActiveAlarm",
		"WaterLeakStatus",
		"MotorTargetPosition",
		"MotorPosition",
		"AlertLowBatt",
		"AlertWaterLeak",
		"AlertLowTemp",
		"MaxTempSetpoint",
		"MinTempSetpoint",
		"StateTemperatures",
		"LoadConnected",
		"Icon",
		"Category",
		"Disconnected",
		"ColorMode",
		"Hue",
		"Saturation",
		"LockKeypad",
		"BackLight",
		"LoadConnectedDB",
		"Humidity",
		"ColorTemperature",
		"DrmsState",
		"Noise",
		"Pressure",
		"Co2",
		"WifiStatus",
		"GrapState",
		"DeltaTemperature",
		"DrmsStateReason",
		"Version",
		"ZigbeeVersion",
		"FloorMode",
		"FloorLimit",
		"ZigbeeChannel",
		"LastUpdate",
		"WillBeConnectedToSmartMeter",
		"ZigbeePairingActivated",
		"LastStatusTime",
		"Unpaired",
		"CoolTemperatureSet",
		"FanMode",
		"FanSpeed",
		"Thermostat24VMode",
		"CurrentState",
		"HeatDemand",
		"MaxCoolSetpoint",
		"MinCoolSetpoint",
		"Thermostat24VAllowedMode",
		"Thermostat24VAllowedFanMode",
		"GatewayDsn",
		"GatewaySdi"
	],
	"type": "string"
},
"DeviceAttributeType": {
	"enum": [
		"OnOff",
		"Integer",
		"Decimal",
		"Percentage",
		"Celcius",
		"Fahrenheit",
		"Watt",
		"Volt",
		"KiloWatt",
		"KWH",
		"WH",
		"Money",
		"BatteryStatus",
		"WaterLeakStatus",
		"SmartEnergyStatus",
		"LockKeypad",
		"BackLight",
		"Minutes",
		"Text",
		"Category",
		"PPM",
		"MBar",
		"DB",
		"Array"
	],
	"type": "string"
},
"DeviceUpdate": {
	"required": [
		"id"
	],
	"type": "object",
	"properties": {
		"id": {
			"type": "integer",
			"format": "int64"
		},
		"name": {
			"type": "string",
			"nullable": true
		},
		"groupId": {
			"type": "integer",
			"format": "int64",
			"nullable": true
		},
		"category": {
			"$ref": "#/components/schemas/DeviceCategory"
		},
		"icon": {
			"type": "string",
			"nullable": true
		},
		"parameters": {
			"type": "string",
			"nullable": true
		},
		"isFavorite": {
			"type": "boolean",
			"nullable": true
		}
	},
	"additionalProperties": false
},
"DeviceCategory": {
	"enum": [
		"Heating",
		"Light",
		"Entertainment",
		"Appliances",
		"Ac",
		"Ventilation",
		"Safety",
		"Water",
		"Other"
	],
	"type": "string"
},
"DeviceDelete": {
	"required": [
		"id"
	],
	"type": "object",
	"properties": {
		"id": {
			"type": "integer",
			"format": "int64"
		}
	},
	"additionalProperties": false
},
"Device": {
	"required": [
		"category",
		"id",
		"provider",
		"settableAttributesList",
		"supportedAttributesList",
		"type"
	],
	"type": "object",
	"properties": {
		"id": {
			"type": "integer",
			"format": "int64"
		},
		"assetId": {
			"type": "string",
			"format": "uuid",
			"nullable": true
		},
		"hiloId": {
			"type": "string",
			"nullable": true
		},
		"identifier": {
			"type": "string",
			"nullable": true
		},
		"gatewayId": {
			"type": "integer",
			"format": "int64",
			"nullable": true
		},
		"gatewayExternalId": {
			"type": "string",
			"nullable": true
		},
		"gatewayAssetId": {
			"type": "string",
			"format": "uuid",
			"nullable": true
		},
		"name": {
			"type": "string",
			"nullable": true
		},
		"type": {
			"$ref": "#/components/schemas/DeviceType"
		},
		"groupId": {
			"type": "integer",
			"format": "int64",
			"nullable": true
		},
		"category": {
			"$ref": "#/components/schemas/DeviceCategory"
		},
		"icon": {
			"type": "string",
			"nullable": true
		},
		"loadConnected": {
			"type": "integer",
			"format": "int32",
			"nullable": true
		},
		"modelNumber": {
			"type": "string",
			"nullable": true
		},
		"locationId": {
			"type": "integer",
			"format": "int64",
			"nullable": true
		},
		"parameters": {
			"type": "string",
			"nullable": true
		},
		"externalGroup": {
			"type": "string",
			"nullable": true
		},
		"provider": {
			"$ref": "#/components/schemas/DeviceProvider"
		},
		"providerData": {
			"type": "string",
			"nullable": true
		},
		"isFavorite": {
			"type": "boolean",
			"nullable": true
		},
		"eTag": {
			"type": "string",
			"nullable": true
		},
		"supportedAttributes": {
			"type": "string",
			"nullable": true,
			"readOnly": true,
			"deprecated": true
		},
		"supportedAttributesList": {
			"type": "array",
			"items": {
				"$ref": "#/components/schemas/DeviceAttributes"
			},
			"readOnly": true
		},
		"settableAttributes": {
			"type": "string",
			"nullable": true,
			"readOnly": true,
			"deprecated": true
		},
		"settableAttributesList": {
			"type": "array",
			"items": {
				"$ref": "#/components/schemas/DeviceAttributes"
			},
			"readOnly": true
		},
		"supportedParameters": {
			"type": "string",
			"nullable": true,
			"readOnly": true,
			"deprecated": true
		},
		"supportedParametersList": {
			"type": "array",
			"items": {
				"$ref": "#/components/schemas/DeviceAttributes"
			},
			"nullable": true,
			"readOnly": true
		}
	},
	"additionalProperties": false
},
"DeviceProvider": {
	"enum": [
		1,
		2,
		3,
		5,
		6
	],
	"type": "integer",
	"format": "int32"
},
"DeviceType": {
	"enum": [
		"Hub",
		"Meter",
		"Thermostat",
		"LightSwitch",
		"LightDimmer",
		"Relay",
		"Valve",
		"LightBulb",
		"Plug",
		"WaterDetector",
		"ColorBulb",
		"IndoorWeatherStation",
		"OutdoorWeatherStation",
		"SmokeDetector",
		"WhiteBulb",
		"WhiteBulbDimmer",
		"ChargingPoint",
		"Ccr",
		"Cee",
		"FloorThermostat",
		"Thermostat24V",
		"Other"
	],
	"type": "string"
},
"DeviceDelete": {
	"required": [
		"id"
	],
	"type": "object",
	"properties": {
		"id": {
			"type": "integer",
			"format": "int64"
		}
	},
	"additionalProperties": false
},