Google s'est engagé à promouvoir l'équité raciale pour les communautés noires. Regarde comment.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

API d'alarme de fumée + CO

L'API Nest fonctionne avec tous les modèles de détecteurs de fumée et de monoxyde de carbone Nest Protect ™.

Les utilisateurs peuvent ajouter plusieurs Nest devices/smoke_co_alarms groupe devices/smoke_co_alarms , jusqu'au maximum par structure . Lorsque vous passez un appel vers cet emplacement de données, vous pouvez accéder aux données Nest Protect (valeurs de données pour les appareils de la structure).

Toutes les valeurs ci-dessous se trouvent sous chaque devices/smoke_co_alarms/ device_id dans le document JSON.

Reference de l'appareil

Identifiant unique du Nest Protect.

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /device_id
Retour string
Exemple: "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs"
Accès lecture seulement
Disponible en Fumée + CO lecture / v1-v5

lieu

Spécifie la préférence de langue et de région (ou pays).

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /locale
Retour string
Exemples: "en-GB", "en-US", "es-US", "fr-CA", "fr-CA", "nl-NL"
Accès lecture seulement
Disponible en Fumée + CO lecture / v1-v5

une version de logiciel

Une version de logiciel.

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /software_version
Retour string
Exemple: "1.0.1"
Accès lecture seulement
Disponible en Fumée + CO lecture / v1-v5

structure_id

Identifiant unique de la structure.

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /structure_id
Retour string
Exemple: "VqFabWH21nw ..."
Accès lecture seulement
Disponible en Fumée + CO lecture / v1-v5

Nom

Afficher le nom de l'appareil; peut être n'importe quel nom de salle d'une liste que nous fournissons, ou un nom personnalisé.

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /name
Retour string
Exemple: "Hallway"
Accès lecture seulement
Disponible en Fumée + CO lecture / v1-v5

nom_long

Nom d'affichage long de l'appareil. Comprend une (étiquette) personnalisée, créée par l'utilisateur ou via des wheres .

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /name_long
Retour string
Exemple: "Protéger le couloir (à l'étage)"
Accès lecture seulement
Disponible en Fumée + CO lecture / v1-v5

last_connection

Horodatage de la dernière interaction réussie avec le service Nest, au format ISO 8601 .

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /last_connection
Retour string
Exemple: "2016-12-31T23: 59: 59.000Z"
Accès lecture seulement
Disponible en Fumée + CO lecture / v1-v5

est en ligne

État de la connexion de l'appareil avec le service Nest.

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /is_online
Retour boolean
Valeurs: vrai, faux
Accès lecture seulement
Disponible en Fumée + CO lecture / v1-v5

battery_health

Durée de vie / santé de la batterie; estimation du niveau de puissance restante de la batterie.

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /battery_health
Retour string enum
Valeurs: "ok", "replace"
Accès lecture seulement
Disponible en Fumée + CO lecture / v1-v5

co_alarm_state

État d'alarme de monoxyde de carbone (CO).

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /co_alarm_state
Retour string enum
Valeurs: "ok", "warning", "Emergency"
Accès lecture seulement
Disponible en Fumée + CO lecture / v1-v5

smoke_alarm_state

État du détecteur de fumée.

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /smoke_alarm_state
Retour string enum
Valeurs: "ok", "warning", "Emergency"
Accès lecture seulement
Disponible en Fumée + CO lecture / v1-v5

is_manual_test_active

État du test manuel des détecteurs de fumée et de CO.

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /is_manual_test_active
Retour boolean
Valeurs: vrai, faux
Accès lecture seulement
Disponible en Fumée + CO lecture / v2-v5

last_manual_test_time

Horodatage du dernier test manuel réussi du détecteur de fumée et de CO, au format ISO 8601 .

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /last_manual_test_time
Retour string
Exemple: "2016-12-31T23: 59: 59.000Z"
Accès lecture seulement
Disponible en Fumée + CO lecture / v2-v5

ui_color_state

Indique l'état de l'appareil par couleur dans l'interface utilisateur de l'application Nest. Il s'agit d'une condition globale pour les états batterie + fumée + CO et reflète les indicateurs de couleur réels affichés dans l'application Nest.

Pour plus d’informations sur les indicateurs de couleur, voir les lumières du Nest Protect et le niveau de la batterie du Nest Protect .

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /ui_color_state
Retour string enum
Valeurs: "gris", "vert", "jaune", "rouge"
Accès lecture seulement
Disponible en Fumée + CO lecture / v1-v5

where_id

Identifiant unique généré par Nest qui représente le name , le nom d'affichage de l'appareil.

En savoir plus sur les noms des thermostats Nest , des Nest Protect et des Nest Cam .

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /where_id
Retour string
Exemple: "d6reb_OZTM ..."
Accès lecture seulement
Disponible en Fumée + CO lecture / v3-v5

où_nom

Le nom d'affichage de l'appareil. Associé au Nest Protect where_id . Il peut s'agir de n'importe quel nom de salle d'une liste que nous fournissons ou d'un nom personnalisé. En savoir plus sur les noms des thermostats Nest , des Nest Protect et des Nest Cam .

Détails
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /where_name
Retour string
Exemple: "Hallway"
Accès lecture seulement
Disponible en Fumée + CO lecture / v5