Skip to content

Endpoint /devices obselète #564

@AbigailAsselin-Hilo

Description

@AbigailAsselin-Hilo

Helloo

Context

La route /api/Locations/{LocationId}/Devices est obselete. Toute l'information des appareils passe par le DeviceHub, avec un SubscribeToLocation

Information initiales de la liste d'appareil d'une location

DeviceListInitialValuesReceived

Un array des appareils de la location.
L'objet devrait avoir le même format que celui dans le endpoint qui est obselete

[
  {
    "id": 0,
    "assetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "hiloId": "string",
    "identifier": "string",
    "gatewayId": 0,
    "gatewayExternalId": "string",
    "gatewayAssetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "type": "Hub",
    "groupId": 0,
    "category": "Heating",
    "icon": "string",
    "loadConnected": 0,
    "modelNumber": "string",
    "locationId": 0,
    "parameters": "string",
    "externalGroup": "string",
    "provider": 1,
    "providerData": "string",
    "isFavorite": true,
    "eTag": "string",
    "supportedAttributesList": [
      "None"
    ],
    "settableAttributesList": [
      "None"
    ],
    "supportedParametersList": [
      "None"
    ]
  }
]

Pour les mises à jour de la liste des appareils (Ajout et supression)

DeviceAdded

Les informations du device qui à été ajouté (même objet que la liste ci-haut)

  {
    "id": 0,
    "assetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "hiloId": "string",
    "identifier": "string",
    "gatewayId": 0,
    "gatewayExternalId": "string",
    "gatewayAssetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "type": "Hub",
    "groupId": 0,
    "category": "Heating",
    "icon": "string",
    "loadConnected": 0,
    "modelNumber": "string",
    "locationId": 0,
    "parameters": "string",
    "externalGroup": "string",
    "provider": 1,
    "providerData": "string",
    "isFavorite": true,
    "eTag": "string",
    "supportedAttributesList": [
      "None"
    ],
    "settableAttributesList": [
      "None"
    ],
    "supportedParametersList": [
      "None"
    ]
  }

DeviceDeleted

Les ids (deviceId et HiloId) du device qui a été supprimé.

{
  "id": 0,
  "hiloId": "string"
}

Information initiale et mise à jour des valeurs des appareils

DevicesValuesReceived ET GatewayValuesReceived

Les valeurs des appareils ET du gateway, ils sont séparés dans 2 messages mais le format est le même

[
  {
    "deviceId": 0,
    "hiloId": "string",
    "locationId": 0,
    "locationHiloId": "string",
    "timeStampUTC": "2025-02-03T19:06:34.202Z",
    "attribute": "None",
    "value": "string",
    "valueType": "OnOff",
    "operationId": "string"
  }
]

Donc :
Lors d'un SubscribeToLocation, on devrait recevoir 3 messages avec les informations nécessaires pour afficher les états/valeurs des appareils:

  • DeviceListInitialValuesReceived
  • DevicesValuesReceived
  • GatewayValuesReceived

Ensuite, le DeviceHub met à jour les informations reçus avec ces messages:

  • DeviceAdded
  • DeviceDeleted
  • DevicesValuesReceived
  • GatewayValuesReceived

DeviceListInitialValuesReceived, DeviceAdded ET DeviceDeleted servent à bartir la liste d'appareils d'une location
DevicesValuesReceived ET GatewayValuesReceived font juste mettre à jour les états/valeurs des ces appareils.

Metadata

Metadata

Assignees

No one assigned

    Labels

    breakingBreaking ChangesdependenciesPull requests that update a dependency file

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions