Schéma de trait Smart Home EnergyStorage

action.devices.traits.EnergyStorage : ce trait appartient aux appareils qui peuvent stocker de l'énergie dans une batterie et potentiellement la recharger, ou aux appareils qui peuvent recharger un autre appareil.

ATTRIBUTS de l'appareil

Les appareils dotés de ce trait peuvent signaler les attributs suivants dans le cadre de l'opération SYNC. Pour en savoir plus sur la gestion des intents SYNC, consultez Fulfillment d'intent.

Attributs Type Description
queryOnlyEnergyStorage Valeur booléenne

Obligatoire.

La valeur est "true" si cet appareil n'est compatible qu'avec les requêtes sur les niveaux d'énergie stockée et, éventuellement, l'état de recharge actif (selon l'attribut isRechargeable), mais pas avec le démarrage et l'arrêt de la recharge.
energyStorageDistanceUnitForUX String

(Par défaut : "KILOMETERS")

Sera utilisé dans les réponses à l'utilisateur.

Valeurs acceptées :

KILOMETERS
MILES
isRechargeable Valeur booléenne

(Par défaut : false)

Définissez sur "true" si cet appareil est rechargeable. Cela indique que l'appareil peut signaler l'état capacityUntilFull, isCharging et éventuellement isPluggedIn, et qu'il peut accepter la commande Charge.

Exemples

Appareil rechargeable

{
  "isRechargeable": true,
  "queryOnlyEnergyStorage": false
}

Appareil rechargeable qui affiche le niveau de charge actuel en kilomètres

{
  "isRechargeable": true,
  "energyStorageDistanceUnitForUX": "MILES",
  "queryOnlyEnergyStorage": false
}

Appareil non rechargeable qui ne permet que de signaler le niveau de charge actuel

{
  "isRechargeable": false,
  "queryOnlyEnergyStorage": true
}

ÉTATS des appareils

Les entités dotées de ce trait peuvent signaler les états suivants dans le cadre de l'opération QUERY. Pour en savoir plus sur la gestion des intents QUERY, consultez Fulfillment d'intent.

États Type Description
descriptiveCapacityRemaining String

Obligatoire.

Description qualitative du niveau de capacité énergétique. Notez que cela ne s'applique que lorsqu'il n'y a pas de données numériques sur la capacité. Si des données numériques sur la capacité sont également disponibles, elles seront privilégiées par rapport aux données descriptives, dans la mesure du possible.

Valeurs acceptées :

CRITICALLY_LOW
LOW
MEDIUM
HIGH
FULL
capacityRemaining Array

Tableau de paires unité/valeur contenant des informations sur la capacité énergétique actuelle de l'appareil. Par exemple : Combien de kilomètres mon <appareil> a-t-il parcourus actuellement ? ou Quel est le pourcentage de batterie de mon <appareil> ?
[item, ...] Objet

Capacité restante sous forme de paire unité/valeur.
rawValue Entier

Obligatoire.

Valeur de la capacité.
unit String

Obligatoire.

Unité de capacité.

Valeurs acceptées :

SECONDS
MILES
KILOMETERS
PERCENTAGE
KILOWATT_HOURS
capacityUntilFull Array

Tableau de paires unité/valeur contenant des informations sur la capacité jusqu'à ce que l'appareil soit complètement rechargé. Par exemple : Combien de temps reste-t-il avant que <appareil> soit complètement rechargé ?
[item, ...] Objet

Capacité jusqu'à la facturation.
rawValue Entier

Obligatoire.

Valeur de la capacité.
unit String

Obligatoire.

Unité de capacité.

Valeurs acceptées :

SECONDS
MILES
KILOMETERS
PERCENTAGE
KILOWATT_HOURS
isCharging Valeur booléenne

Indique si l'appareil est en charge.
isPluggedIn Valeur booléenne

Indique si l'appareil est actuellement branché. L'appareil peut être branché, mais pas en charge.

Exemples

Appareil rechargeable

{
  "descriptiveCapacityRemaining": "HIGH",
  "capacityRemaining": [
    {
      "rawValue": 36000,
      "unit": "SECONDS"
    },
    {
      "rawValue": 90,
      "unit": "PERCENTAGE"
    }
  ],
  "capacityUntilFull": [
    {
      "rawValue": 120,
      "unit": "SECONDS"
    }
  ],
  "isCharging": true,
  "isPluggedIn": true
}

Appareil rechargeable qui affiche le niveau de charge actuel en kilomètres

{
  "descriptiveCapacityRemaining": "CRITICALLY_LOW",
  "capacityRemaining": [
    {
      "rawValue": 12,
      "unit": "MILES"
    }
  ],
  "capacityUntilFull": [
    {
      "rawValue": 6000,
      "unit": "SECONDS"
    }
  ],
  "isCharging": true,
  "isPluggedIn": true
}

Appareil non rechargeable qui ne permet que de signaler le niveau de charge actuel

{
  "descriptiveCapacityRemaining": "LOW"
}

COMMANDES de l'appareil

Les appareils dotés de ce trait peuvent répondre aux commandes suivantes dans le cadre de l'opération EXECUTE. Pour en savoir plus sur la gestion des intents EXECUTE, consultez Fulfillment d'intent.

action.devices.commands.Charge

Démarrer ou arrêter la recharge.

Cette commande nécessite les attributs suivants : 
{
  "isRechargeable": true
}

Paramètres

Paramètres Type Description
charge Valeur booléenne

Obligatoire.

True pour démarrer la recharge, false pour l'arrêter.

Exemples

Commande de démarrage de la recharge

{
  "command": "action.devices.commands.Charge",
  "params": {
    "charge": true
  }
}

Commande d'arrêt de la recharge

{
  "command": "action.devices.commands.Charge",
  "params": {
    "charge": false
  }
}

ERREURS liées à l'appareil

Consultez la liste complète des erreurs et exceptions.

deviceUnplugged : L'utilisateur a essayé de recharger un appareil qui n'était pas branché.