Traduction en français de l’Api json Domoticz

Traduction de l’ API/JSON de Domoticz

Vous en rêviez, et bien voici la traduction en français des commandes que nous pouvons utiliser pour interroger et piloter Domoticz via les URL
Un rappel général de l’utilisation est ici https://easydomoticz.com/lapi-json-de-domoticz-demythifiee/
Comme d’habitude il s’agira d’une traduction « à ma sauce » de la page ici située https://www.domoticz.com/wiki/Domoticz_API/JSON_URL’s. Cette page anglophone reste la seule source valable et mise à jour régulièrement, merci de vous y reporter en cas de questions.
Si vous constatez des erreurs, merci d’en faire part dans les commentaires.

Contenu

Format

Le format général à respecter est de  la forme :

  • <username:password@> = le login et le password de Domoticz (optionnel).
  • domoticz-ip =l’ IP-adresse de Domoticz.
  • <:port> =le port de votre Domoticz (optionnel).
  • api-call, la chaine à envoyer pour faire le job.

Ici api-call est donc  tout ce qui suit le ? de json.htm, donc type=command….

Mieux afficher les sorties

Par défaut votre navigateur internet affichera les valeurs JSON reçues depuis Domoticz dans un ordre quelconque.

Pour faire plus lisible vous pouvez utiliser des plugins qui affichent et reformatent lisiblement les valeurs.
Pour Google Chrome vous pouvez utiliser JSONView (Chrome web store). Pour les autres navigateurs l’identique doit exister, cherchez dans les extensions/add-on pour votre navigateur.

Il existe également ce site web qui reformate les JSON http://jsonviewer.stack.hu/

Autorisations

Lorsque nous utilisons d’autres méthodes que notre navigateur pour se connecter à Domoticz, il peut être nécessaire de s’identifier.

L’authentification HTTP utilise la requête Autorisation sur HTTP, cette authentification est en base 64 contenant le couple user/password. En utilisant votre propre application/script et si votre domoticz est protégé par mot de passe, il vous faudra vous identifier correctement (voir python requests et la méthode auth à ce sujet). Pensez également que l’on peut autoriser certaines ip à se connecter SANS mot de passe dans le paramétrage Domoticz : réseaux autorisés.

Voici le synopsis de la méthode d’identification :

  • Le nom d’utilisateur et le password sont combinés dans une chaine « username:password »
  • Cette chaine est encodée par RFC2045-MIME version en base64
  • Dans la méthode d’autorisation on envoie « Authorization: » un espace puis « Basic  » puis la chaine encodée ci-dessus.

Comme ceci :

Maintenant sachez que l’envoi des  » http request headers » est dépendant du langage utilisé. Utilisez la documentation appropriée. Python request met à notre disposition des méthodes simples d’authentification.

Réponse

Chaque appel à l’API est suivie d’une réponse : status OK si la commande est réussie , sinon ERR

Fonctions Générales

Retrouver le status d’un dispositif précis

  • IDX = est l’idx de votre périphérique recherché (la colonne IDX dans les dispositifs)

Retrouver tous les dispositifs d’un certain type

Avec le filter=all, vous récupérez la liste de tous les dispositifs. Si vous voulez retrouver les infos de certains types utilisez les filters suivants à la place du filter=all ci dessus .

Retrouver les dispositifs en favoris

Cela vous renvoie un tableau avec les dispositifs marqués en favoris (petite étoile jaune) présents sur la page « Tableau de bord ».

Obtenir les levers/couchers de soleil

Afficher un message dans le log Domoticz

Vous pouvez faire afficher vos propres textes dans le log Domoticz grâce à :

  • MESSAGE = contient le message que vous souhaitez afficher.

Lumières et Interrupteurs

Obtenir la liste de toutes les lumières/switches

ou triés par noms

Exemple :

Allumer une lumière, un switch

Éteindre une lumière, un switch

  • idx = idx de votre dispositif (ici 99).
  • switchcmd = « On » or « Off » (Attention aux majuscules/minuscules !)

Si tout c’est bien passé on a :

Envoyer une valeur à un matériel dimmable

  • Le champ level doit être une valeur entre 1 (0%) et 16 (100%). Si vous voulez utiliser les pourcentages et que 1 à 16 ne marche pas pour vous , utilisez 1 à 100.
  • Lorsque la lampe est à off , elle est passée à On
  • Le retour est :

Basculer un switch d’état

Cette commande permet de passer à On si c’est à Off et vice-versa sans que vous vous occupiez de son état actuel.

Scènes / Groupes

Obtenir toutes les scènes et les groupes

Exemple :

Passer une scène / groupe à on ou off

  • idx = idx de votre scène/group (dans le menu « Dispositifs »).
  • switchcmd = « On » or « Off » (attention majuscules)
  • Les Scènes peuvent seulement être passées à On

Ajout d’une scène (0)

Ajout d’un groupe (1)

Détruire une scène ou un groupe

number est le numéro de la scéne (c.f paramètres)

Lister tous les dispositifs d’une scène

Ajout d’un dispositif à une scène

Supprimer un device d’une scène

Liste des horaires liés à une scène

Exemple :

Ajout d’un horaire à une scène

idx = index de la scène, du groupe.

  • active = true/false
  • timertype = 0 =Avant lever soleil, 1 = Après lever Soleil, 2 =A l’heure indiquée, 3 = Avant coucher soleil, 4 = après coucher soleil, 5 = A une date ou heure précise.
  • date = MM-JJ-YYYY (mois sur 2 caractères-jour sur 2-année sur 4) Ex: 10-03-2016
  • hour = heure
  • min = minute
  • randomness = Aléatoire : avec le paramètre du paramétrage indiquant la dérive autour de cet horaire, pour faire une simulation de présence par exemple.
  • command = On/Off
  • level = 0..100 (%)
  • days = 0x80 = Tous les jours, 0x100 =Jours de semaine uniquement, 0x200 = Weekends, 0x01 = Lundi, 0x02 = Mardi, 0x04 = Mercredi, 0x08 = Jeudi, 0x10 = Vendredi, 0x20 = Samedi, 0x40 = Dimanche

Allez voir dans le bouton « Plannings » d’un interrupteur pour comprendre tous ces paramètres.

Commandes du serveur

Arrêt du système

Reboot

Les commandes de création

Créer un matériel virtuel

Ensuite pour obtenir un id, obtenez la page hardware pour le dernier ID :

Créer un dispositif virtuel

Temp+Humidité (voir plus bas pour les valeurs)

Electricité (voir plus bas pour les valeurs)

et maintenant obtenez les devices id avec la liste :

Pour le RFXMeter, une autre requête est nécessaire pour configurer le mode, l’url est:

dans lequel DEVICE_ID est le nom du device et SUBTYPE_VALUE est une de ces valeurs :

Mettre à jour des capteurs

Soyez prudent en envoyant vos valeurs via JSON.
Il n’est pas exclu que vous crashiez Domoticz, si vos valeurs ne sont pas bonnes ou manquantes

Surtout sur des Domoticz version <=Beta 1.1634 ou stable <=1.1396 qui sont très sensibles. Les versions ultérieures sont plus sécurisées pour cela.

Vous aurez besoin de l’idx de votre capteur, allez le noter dans l’écran des dispositifs.

Temperature

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • TEMP = Température que vous souhaitez affecter à ce capteur.

Humidité

  • IDX =idx de votre capteur. A obtenir depuis l’écrans des dispositifs.
  • HUM = Humidité: 45 par exemple pour 45%
  • HUM_STAT = Humidity_status

Humidity_status peut être :

  • 0=Normal
  • 1=Confortable
  • 2=Sec
  • 3=Humide

Ce paramètre est obligatoire, si vous ne savez pas quoi mettre, mettez 0

Baromètre

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • BAR = Pression barométrique.
  • BAR_FOR = Météo selon la presion baro à choisir dans la liste ci-desous.
  • 0 = Stable
  • 1 = Soleil
  • 2 = Nuageux
  • 3 = Instable
  • 4 = Tempête
  • 5 = Inconnu
  • 6 = Nuageux/pluie

Ce paramètre est obligatoire, si vous ne savez pas quoi mettre, mettez 0

Température /humidité

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • TEMP = Temperature
  • HUM = Humidité
  • HUM_STAT = Status de l’humidité parmi la liste ci-dessous.

 

  • 0=Normal
  • 1=Confortable
  • 2=Sec
  • 3=Humide

Température/humidité/baromètre

Cette instruction permet de donner des valeurs aux capteurs Temp+Humidité+Baromètre

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • TEMP = Temperature
  • HUM = Humidité
  • HUM_STAT = Status d’humidité
  • BAR = Pression barométrique
  • BAR_FOR = Météo selon la presion baro à choisir dans la liste ci-desous :

 

  • 0 = No info
  • 1 = Soleil
  • 2 = Partiellement nuageux
  • 3 = Nuageux
  • 4 = Pluie

Pluie

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • RAINRATE = quantité de pluie depuis la dernière heure
  • RAINCOUNTER = cumul de pluie tombée en mm

Vent

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • WB = Angle du vent (0-359)
  • WD = Direction du vent (S, SW, NNW, etc.)
  • WS = 10 * Vitesse du vent [m/s]
  • WG = 10 * vitesse de la rafale[m/s]
  • 22 = Temperature
  • 24 = Temperature Windchill

les deux dernières valeurs sont TOUJOURS 22 et 24.

UV

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • COUNTER = La valeur de l’UV avec un point décimal (obligatoire : exemple: 2.0)

Attention il y a un « ;0 » à la fin, c’est comme ça , ne l’oubliez pas.

Compteur

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • COUNTER = Un nombre entier qui est votre comptage.

N’oubliez pas que ls compteurs Domoticz peuvent compter dans plusieurs unités :

  • Energie (kWh)
  • Gaz (m3)
  • Eau (m3)
  • Compteur (sans unité)

Et donc bien entendu pour les m 3 si vous passez des litres la valeur sera divisée par 1000 car l’unité est le m3. Le compteur affiche toujours 2 valeurs :

  • Le status est le total cumulé.
  • Le volume ou comptage du jour est affiché dabs le coin en haut à droite.

Électricité (instantané et compteur)

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • POWER = Puissance actuelle consommée.
  • ENERGY = cumul en Watt-heures (Wh) (c’est juste un « compteur virtuel », tous les cumuls doivent être faits par VOUS)

Électricité P1 smart meter

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • USAGE1= Conso en tarif 1
  • USAGE2= Conso en tarif 2
  • RETURN1= energy return meter tariff 1
  • RETURN2= energy return meter tariff 2
  • CONS= actual usage power (Watt)
  • PROD= actual return power (Watt)

USAGE et RETURN sont des compteurs qui ne peuvent que croitre. Vous devez y donner des valeurs en Wh sans virgule. Ainsi si votre valeur est USAGE1= 523,66 KWh vous devez envoyer 523660)

Qualité de l’air

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • PPM = CO2-concentration

Pression

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • BAR = Pression atmosphérique en Bar

Créer ce capteur dans « Matériel »/ »Créer capteur Virtuel »

Pourcentage

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • PERCENTAGE = Le pourcentage à afficher dans le widget

Gaz

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • USAGE= Gaz en litre (1000 litres = 1 m³)

Ainsi si votre compteur de gaz affiche 145,332 m³ vous devez envoyer 145332.
La variable USAGE est le total des litres depuis la nuit des temps et non pas la consommation journalière.

Lux

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • VALUE = valeur de la luminosité en Lux.

Voltage

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • VALUE = valeur de volts a afficher sur le widget

Text sensor

Ceci permet d’afficher un texte sur un widget Domoticz.

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • TEXT = Le texte à afficher.

 

  • Exemple http://IP:PORT/json.htm?type=command&param=udevice&idx=mon_idx&svalue=MONTEXTEAAFFICHER

 

Alert sensor

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • LEVEL = (0=gris, 1=vert, 2=jaune, 3=orange, 4=rouge)
  • TEXT = Le texte à afficher.

 

Distance

 

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • DISTANCE = distance en ce que vous voulez comme unité, la valeur est affichée sans unité. Vous pouvez envoyer des décimales (12.6) avec un point.

Selector Switch

Il s’agit de piloter ce capteur virtuel nomme « Selector switch » ou l’on peut prédéfinir 4 niveaux (pour des dimmables par ex, ou des volets)

inter_sele

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • LEVEL = Un nombre qui fait référence à celui défini dans le menu « Editer » du widget
  • sel_switch

Custom Sensor

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.
  • VALUE = Valeur avec un point décimal (12.345)

Paramètres additionnels (signal level & battery level)

Il y deux paramètres supplémentaires pour toutes les commandes ci dessus pour préciser la qualité de réception (radio) et le niveau de batterie.

Par défaut le niveau de signal est à 12 et le niveau de la batterie est à 255 (pas de batterie) sinon le niveau est entre 0 et 100.

Il faut ajouter ces lignes tout au bout de la chaine

exemple: &rssi=10&battery=89

User variables

Ajouter une nouvelle variable

uservariablename= le nom de la variable, évitez les accents.

  • uservariabletype = le type de valeur à stocker, entre 0 et 4 :

  • uservariablevalue = la valeur à stocker dans cette variable

Tout cela est vérifié par l’API, si la variable n’est pas correcte , elle n’est pas enregistrée par Domoticz.

Par exemple , vous avez défini une variable stockant des nombres entiers et vous essayer d’y écrire 3.0

ici je crée une variable nommée code_porte_garage en type chaine de caractères et j’uy mets « 453aZVT » dedans.

Modifier une variable

  • USERVARIABLENAME, le nom de la variable
  • USERVARIABLETYPE le type (cf ci-dessus)
  • USERVARIABLEVALUE la nouvelle valeur

Liste de toutes les variables

vous affiche toutes les variables.

Pour obtenir une seule variable et ses valeurs:

  • IDX = idx de la variable, allez voir dans les varialbes utilisateur dans »Réglages/Plus d’options » c’est le numéro IDX

Détruire une variable

  • IDX = idx de la variable, allez voir dans les varialbes utilisateur dans »Réglages/Plus d’options » c’est le numéro IDX

Plans

Lister les pièces

Lister tous les devices d’une pièce

  • IDX = idx de votre pièce

Historiques

On affiche gràce à ces instructions l’historique des capteurs. Alluamges,extenction avec les dates pour les switches, températures et dates pour les autres.

  • IDX = idx de votre capteur. A obtenir depuis l’écran des dispositifs.

Switch

Tempèratures

Setpoint

Energie, Gaz, Eau

 

Pas encore documenté

Tous les plannings

Retrouvez tout ce qui est planifié par :

Typical result :

Afficher les plannings que pour les devices

Afficher les plannings que pour les Scenes

Afficher les plannings que pour les Thermostats

Activer un planning spécifique ?

qu’est timerID ?

Désactiver un planning spécifique

 

Pour toute question technique concernant cet article, veuillez utiliser les forum situés à https://easydomoticz.com/forum/

L’API JSON de Domoticz démythifiée

Oui, oui on dit bien « démythifiée » et non pas « démystifiée » puisque il s’agit bien de « détruire » un mythe, celui de la complexité de l’API JSON de Domoticz.

Définissons tout ça et démythifions donc.

Une API qu’est ce ?

Ce sont des commandes que met à notre disposition un logiciel pour pouvoir le piloter.

Ces jeux d’instructions sont prévus par les développeurs du soft. Ils peuvent être soumis à des restrictions de droits, on peut avoir par exemple le droit d’interroger mais pas de commander le logiciel.

De nombreuses plateformes web permettent ainsi de les interroger pour obtenir quelque chose, citons météo france pour les prévisions de pluie, la SNCF pour les horaires de trains, Airparif pour la qualité de l’air et bien d’autres encore. De la même manière Domoticz peut être interrogé pour obtenir l’état d’un switch, la valeur d’un capteur et on peut également par son API, lui faire exécuter des actions comme changer l’état d’un switch, affecter une valeur à un widget.

Tout cela passe par des envois http/https vers Domoticz en interrogeant son API, qui nous répondra par un retour de texte au format JSON.

Cela signifie que les informations que nous devrons échanger entre nous et Domoticz devront respecter un formatage précis: celui de l’API.

Et JSON qu’est ce?

Wikipedia nous dit :

Un document JSON a pour fonction de représenter de l’information accompagnée d’étiquettes permettant d’en interpréter les divers éléments, sans aucune restriction sur le nombre de celles-ci.

il s’agit d’un format de présentation de texte à base d’étiquettes : un exemple fictif de formatage :

On  voit donc que j’ai  l’étiquette soleil puis des « sous-étiquettes » lever/coucher avec les valeurs correspondantes entourées de  {}.

C’est ainsi que Domoticz renverra des valeurs lorsque on l’interrogera.

Il nous faudra donc des outils pour découper ces blocs de résultats et en retirer facilement ce que l’on souhaite,  jq en shell, json.decode en lua, libraire json en python, ce ne sont pas les outils qui manquent.

Mise en œuvre

Voyons comment interroger Domoticz via les URL et l’API.

la page de référence est http://www.domoticz.com/wiki/Domoticz_API/ dont une traduction française est en cours  nous indique que le format à respecter est celui-ci :

 

  • <username:password@> = le login et le mot de passe Domoticz (optionnels).
  • domoticz-ip = l’adresse  IP ou le nom de votre Domoticz .
  • <:port> = le numéro de port (8080 par défaut, optionnel).

la commande API peut être trouvée sur la page en anglais, on y apprend que pour obtenir l’état d’un matériel, je dois envoyer :

avec IDX qui correspond à l’IDX de ce matériel dans Domoticz.

Rappel : on le trouve dans « Réglages » et « Dispositifs »

idx_domoticz

 

me donnera les valeurs actuelles du dispositif 72 nommé ci-dessus « Temp interieur »

Ah, oui d’accord mais ou je tape le http://192……

Déjà,vérifiez que vous avez compris en le tapant DANS LA BARRE D’ADRESSE de votre navigateur web.

api_json

Ensuite des langages tels que shell (curl), python (requests), lua sont capables d’envoyer de telles chaines que vous aurez construites vous même correctement au préalable dans votre script.

On voit ici que le simple appel d’une URL renvoie un pavé de donnée en JSON, dont il faudra extraire la/les couples rubrique:valeur qui m’intéressent.

C’est le rôle d’outils comme ./jq , article ici https://easydomoticz.com/manipuler-les-donnees-json-de-domoticz-en-shell/ vers lequel je vous renvoie pour les bases de l’extraction.

N.B : Pour aider à la lecture de fichiers json il y a ici http://jsonviewer.stack.hu/un outil qui reformate de façon claire les données que vous lui donnerez par un copier/coller.

 

Voila, normalement vous devriez maintenant mieux voir le rôle de l’API JSON de Domoticz, et comprendre comment activer, obtenir des données.

 

Pour toute question technique concernant cet article, veuillez utiliser les forum situés à https://easydomoticz.com/forum/

Domoticz et les url des caméras

Dans une discussion du forum, loops contributeur régulier,  donnait une astuce que je voudrais vous faire partager ici concernant les cameras IP et le fameux champ de Domoticz « URL de l’image » que l’on ne connait donc jamais !

Celui la ici en bas

camera

Il s’agit de l’adresse de la camera que doit appeler Domoticz pour afficher une image ou une vidéo.

La lecture de la page anglophone de Domoticz https://www.domoticz.com/wiki/Camera_Setup permet de nous renvoyer vers uen liste du matèriel ici https://www.domoticz.com/wiki/Hardware#IP-networkcameras ou ici http://www.ispyconnect.com/sources.aspx pour les camera ispy

Concernant les autres champs, il faudra bien entendu activer la camera, la nommer, donner son adresse IP, son port.

Notez que si la camera est branchée par exemple sur un Raspberry vous pouvez donner ici les liens vers celui ci.

Les login/password éventuels si votre caméra est protégée.

Et la fameuse URL de l’image.

Il existe donc un site  http://skjm.com/icam/mjpeg_test.php. qui permet d’introduire l’adresse IP et le port de ta caméra et qui teste pas mal d’URL « Connues ».

Avec un peu de chance, une image devrait apparaitre sur une des lignes testées et permet ainsi de connaitre la bonne URL à utiliser dans Domoticz dans le paramètre « URL de l’image ».

Rappel

Domoticz ne fait pas de détection de mouvement, il faut utiliser un logiciel comme motion https://easydomoticz.com/video-surveillance-a-base-de-raspberry-pi-et-motion/  ou certains paquets des Synology avec surveillance station.

Les alertes détectées par ses logiciels devront être remontées dans Domoticz par activation d’un switch virtuel via l’API JSON Domoticz.

N’oubliez pas d’utiliser les « custom pages » de Vil1driver https://easydomoticz.com/forum/viewtopic.php?f=17&t=331 pour afficher vos flux vidéo dans une belle interface WAF

 

Merci à loops pour l’info et à Vil1driver pour toutes ses contributions à Domoticz.

Pour toute question technique concernant cet article, veuillez utiliser les forum situés à https://easydomoticz.com/forum/

Passage de easydomoticz.com en https

Toutes les pages du blog viennent d’être converties vers https.

Le petit cadenas Résultat de recherche d'images pour "icone https" vous assure une navigation sécure sur  https://easydomoticz.com et https://easydomoticz.com/forum.

Certains sujets du forum peuvent faire afficher non plus le cadenas vert mais un cadenas et un panneau jaune lorsque des images sont hébergées sur des sites d’hébergeurs d’images non https.

Normalement pas de perturbation attendues. Si vous constatez des soucis laissez un message dans le forum ou dans les commentaires de cet article.

Pour toute question technique concernant cet article, veuillez utiliser les forum situés à https://easydomoticz.com/forum/

Debian, Jessie, Wheezy,Stretch, Sid : comment connaitre sa version de Debian

<mémo>

Comment connaitre sa version de Debian ?

Je le met ici car j’en ai marre de le chercher à chaque fois sur Internet.

renvoie

 

avec entre autre la version (VERSION) et le numéro de la version (VERSION_ID), et pis si ca peut servir…

</mémo>

Pour toute question technique concernant cet article, veuillez utiliser les forum situés à https://easydomoticz.com/forum/