Différences

Ci-dessous, les différences entre deux révisions de la page.

--- hardware:shelly_ht:mise_en_service [2022/04/19 20:24] – yoann
+++ hardware:shelly_ht:mise_en_service [2023/02/08 00:52] (Version actuelle) – yoann
@@ Ligne 34: / Ligne 34: @@
   * Settings > Device name : définir un nom pour le capteur
+===== L'API HTTP =====
+Le firmware propose une API HTTP permettant d'obtenir des informations et de paramétrer le capteur via le navigateur ou via un client en ligne de commande tel que cURL:
+Si l'authentification est active l'accès est restreint sauf pour la ressource /shelly
+<code bash>
+# Afficher les informations du périphérique
+curl --silent http://shelly-device.lan/shelly | jq
+{
+  "type": "SHHT-1",
+  "mac": "C45BBExxxxxx",
+  "auth": true,
+  "fw": "20221027-092707/v1.12.1-ga9117d3",
+  "discoverable": false,
+  "sleep_mode": true
+}
+# tentative de lecture des paramétrages sans authentification
+curl http://shelly-device.lan/settings
+Unauthorized
+# Pour consulter une ressource restreinte:
+curl http://username:password@shelly-device.lan/settings?sleep_mode_period=12
+</code>
+La première requête permet d'afficher des informations concernant le capteur même sans authentification préalable. On trouve notamment la version du firmware "20221027-092707/v1.12.1-ga9117d3" et on peut y lire également la version de l'API utilisée **1.12.1**
+  * [[https://shelly-api-docs.shelly.cloud/gen1/#common-http-api|Documentation de référence de l'API]];
+  * [[https://shelly-api-docs.shelly.cloud/gen1/#shelly-h-amp-t|Les informations spécifiques au Shelly H&T]].
+La plupart des paramétrages sont accessibles depuis l'interface web cependant certains attributs ne sont pas disponibles. Dans ce cas on peut
+Désactiver INTERNET & SECURITY > Restrict login
+<code bash>
+# Lister les attributs
+curl --silent http://shelly-device.lan/settings
+</code>
+Ci-dessous un extrait de réponse possible:
+<code json>
+{
+  "device": {
+    "type": "SHHT-1",
+    "mac": "C45BBExxxxxx",
+    "hostname": "shellyht-device",
+    "sleep_mode": true
+  },
+  ...
+  "sensors": {
+    "temperature_threshold": 0,
+    "temperature_unit": "C",
+    "humidity_threshold": 0
+  },
+  "sleep_mode": {
+    "period": 12,
+    "unit": "h"
+  },
+  "external_power": 0,
+  "temperature_offset": 0,
+  "humidity_offset": 0
+}
+</code>
+La documentation de référence indique par exemple que l'attribut **mqtt.update_period** définit l'intervalle de mise à jour du status du capteur via MQTT. Cet attribut n'est pas modifiable via l'interface web cependant l'API REST permet de le modifier:
+<code bash>
+# Désactive la transmission périodique de l'état du capteur via MQTT
+curl --silent http://username:passord@shelly-device.lan/settings?mqtt_update_period=0 | jq
+</code>
+===== Transmission périodique des mesures =====
+Le mode de transmission dépend de l'option ''Sensors Settings > external power supply'':
+  * En mode autonome, (Use external power supply décoché) le capteur passe le maximum de temps en sommeil. Il ne transmet des valeurs que toutes les 12 heures maximum ou lorsque les valeurs de seuil de variation sont atteintes;
+  * En mode batterie (external_power=1), le capteur s'éveille et transmet toutes les 10 minutes.
+<note>
+La valeur de l'attribut **sleep_mode.period** est retournée par l'API REST mais il n'est pas modifiable. Certaines anciennes documentations mentionnaient des modification de ce paramètre. Les essais récent n'ont pas fonctionnés.
+</note>
@@ Ligne 104: / Ligne 185: @@
 Lorsque la connexion au Broker MQTT réussi, la diode d'état rouge passe de clignotant à fixe.
 </note>
-===== L'API HTTP =====
-Le firmware propose une API HTTP permettant d'obtenir des informations et de paramétrer le capteur via le navigateur ou via un client en ligne de commande tel que cURL:
-Si l'authentification est active l'accès est restreint sauf pour la ressource /shelly
-<code bash>
-# Afficher les informations du périphérique
-curl http://shelly-device.lan/shelly
-{"type":"SHHT-1","mac":"C45BBEXXXXXX","auth":true,"fw":"20210710-130145/v1.11.0-g12a9327-master","sleep_mode":true}
-# tentative de lecture des paramétrages sans authentification
-curl http://shelly-device.lan/settings
-Unauthorized
-</code>

wikinotes

Outils pour utilisateurs

Outils du site

Différences

Outils de la page