lametric_homeassisatnt_doc.md düzenlemesi

Erreur32 bu gisti düzenledi 2 years ago. Düzenlemeye git

1 file changed, 106 insertions

lametric_homeassisatnt_doc.md

			@@ -10,9 +10,115 @@ Ce script Bash permet d'afficher des informations provenant de Home Assistant su
10	10		- Une machine linux
11	11		- Un appareil LaMetric.
12	12		- Une instance de Home Assistant.
	13	+	- Script bash
13	14		- Un fichier de configuration JSON pour définir les paramètres nécessaires, à créer !.
14	15		- `jq` pour manipuler les données JSON, `apt install jq`.
15	16
	17	+	## Script bash
	18	+	```bash
	19	+	#!/bin/bash
	20	+
	21	+	# Emplacement du fichier de configuration
	22	+	CONFIG_PATH="/home/www/html/lametric/script/config.json"
	23	+
	24	+	# Vérification si le fichier de configuration existe
	25	+	if [ ! -f "$CONFIG_PATH" ]; then
	26	+	echo "Erreur : le fichier de configuration '$CONFIG_PATH' est introuvable."
	27	+	exit 1
	28	+	fi
	29	+
	30	+	# Charger la configuration depuis le fichier JSON
	31	+	HOME_ASSISTANT_URL=$(jq -r '.home_assistant_url' "$CONFIG_PATH")
	32	+	HOME_ASSISTANT_TOKEN=$(jq -r '.home_assistant_token' "$CONFIG_PATH")
	33	+	LAMETRIC_URL=$(jq -r '.lametric_url' "$CONFIG_PATH")
	34	+	LAMETRIC_USER=$(jq -r '.lametric_user' "$CONFIG_PATH")
	35	+	LAMETRIC_PASSWORD=$(jq -r '.lametric_password' "$CONFIG_PATH")
	36	+	SENSOR_ENTITY_IDS=($(jq -r '.sensor_entity_ids[]' "$CONFIG_PATH"))
	37	+
	38	+	# Fonction pour récupérer les données de Home Assistant
	39	+	get_home_assistant_data() {
	40	+	response=$(curl -s -H "Authorization: Bearer $HOME_ASSISTANT_TOKEN" -H "Content-Type: application/json" "$HOME_ASSISTANT_URL")
	41	+	echo "$response"
	42	+	}
	43	+
	44	+	# Fonction pour envoyer une notification à LaMetric
	45	+	send_notification_to_lametric() {
	46	+	local title="$1"
	47	+	local message="$2"
	48	+	local icon="$3"
	49	+
	50	+	read -r -d '' data <<EOF
	51	+	{
	52	+	"model": {
	53	+	"frames": [
	54	+	{"text": "$title", "icon": "$icon"},
	55	+	{"text": "$message", "icon": "$icon"}
	56	+	],
	57	+	"sound": {
	58	+	"category": "notifications",
	59	+	"id": "notification"
	60	+	}
	61	+	}
	62	+	}
	63	+	EOF
	64	+
	65	+	curl -s -u "$LAMETRIC_USER:$LAMETRIC_PASSWORD" -H "Content-Type: application/json" -d "$data" "$LAMETRIC_URL"
	66	+	}
	67	+
	68	+	# Intégration pour afficher les sensors de Home Assistant sur LaMetric
	69	+	update_lametric_with_sensor_data() {
	70	+	home_assistant_data=$(get_home_assistant_data)
	71	+	if [ -n "$home_assistant_data" ]; then
	72	+	for entity_id in "${SENSOR_ENTITY_IDS[@]}"; do
	73	+	sensor_data=$(echo "$home_assistant_data" \| jq -c ".[] \| select(.entity_id == \"$entity_id\")")
	74	+	if [ -n "$sensor_data" ]; then
	75	+	title=$(echo "$sensor_data" \| jq -r ".attributes.friendly_name // \"$entity_id\"")
	76	+	state=$(echo "$sensor_data" \| jq -r ".state")
	77	+	unit=$(echo "$sensor_data" \| jq -r ".attributes.unit_of_measurement // \"\"")
	78	+	message="$state $unit"
	79	+	icon="3579" # Icône par défaut
	80	+	send_notification_to_lametric "$title" "$message" "$icon"
	81	+	fi
	82	+	done
	83	+	fi
	84	+	}
	85	+
	86	+
	87	+	# Exécution de la mise à jour des données
	88	+	update_lametric_with_sensor_data
	89	+
	90	+
	91	+	# Détails supplémentaires
	92	+	#
	93	+	# Configuration des notifications sur LaMetric :
	94	+	# - LaMetric permet d'afficher des informations via des "notifications" qui sont envoyées à l'appareil.
	95	+	# - Les notifications sont envoyées en utilisant une requête POST à l'URL de l'appareil LaMetric (LAMETRIC_URL).
	96	+	# - L'application peut être personnalisée avec différents "frames", chaque frame contenant du texte et une icône.
	97	+	#
	98	+	# Pour obtenir les tokens :
	99	+	# - Home Assistant : Crée un token depuis ton profil utilisateur dans Home Assistant https://homeassistant/profile/security.
	100	+	# - LaMetric : Récupérez la clef API sur https://developer.lametric.com/user/devices.
	101	+	#
	102	+	# Pour l'icône des notifications :
	103	+	# - Les icônes peuvent être sélectionnées parmi une liste prédéfinie par LaMetric, identifiées par un ID d'icône (par exemple, "a4157" ou "a11100").
	104	+	# - https://developer.lametric.com/icons
	105	+	#
	106	+	#
	107	+	# Mise à jour des données toutes les 15 minutes via crontab
	108	+	# Configuration du cron pour exécuter le script toutes les 15 minutes
	109	+	# (crontab -e
	110	+	# /15 * * * /chemin/vers/ce/script.sh"
	111	+
	112	+
	113	+	```
	114	+
	115	+	## Crontab
	116	+	A rajouter pour l'execution toutes les 15 minutes.
	117	+
	118	+	```
	119	+	/15 * * * /chemin/vers/ce/script.sh"
	120	+	```
	121	+
16	122
17	123		## Configuration
18	124

Erreur32 bu gisti düzenledi 2 years ago. Düzenlemeye git

1 file changed, 180 insertions

lametric_homeassisatnt_doc.md(dosya oluşturuldu)

		@@ -0,0 +1,180 @@
1	+	# Documentation d'Utilisation du Script pour LaMetric et Home Assistant
2	+
3	+	## Introduction
4	+
5	+	Ce script Bash permet d'afficher des informations provenant de Home Assistant sur un appareil LaMetric. Il s'intègre avec l'API de Home Assistant pour récupérer les valeurs de différents capteurs et envoyer ces informations à LaMetric sous forme de notifications.
6	+
7	+	## Prérequis
8	+
9	+	- Etre dans le même réseau local
10	+	- Une machine linux
11	+	- Un appareil LaMetric.
12	+	- Une instance de Home Assistant.
13	+	- Un fichier de configuration JSON pour définir les paramètres nécessaires, à créer !.
14	+	- `jq` pour manipuler les données JSON, `apt install jq`.
15	+
16	+
17	+	## Configuration
18	+
19	+	### Création du Fichier de Configuration
20	+
21	+	Avant d'exécuter le script, créez un fichier `config.json` à l'endroit approprié avec le contenu suivant :
22	+
23	+	Pour créer le fichier de configuration `config.json` changez les `url` / `token` ET `/chemin/vers/ce/config.json`, utilisez la commande suivante :
24	+
25	+	```bash
26	+	echo '{
27	+	"home_assistant_url": "http://192.168.x.x:8123/api/states",
28	+	"home_assistant_token": "...",
29	+	"lametric_url": "http://192.168.x.x:8080/api/v2/device/notifications",
30	+	"lametric_user": "dev",
31	+	"lametric_password": "...",
32	+	"sensor_entity_ids": [
33	+	"sensor.station_temperature",
34	+	"sensor.station_humidity",
35	+	"sensor.system_monitor_load_1m",
36	+	"sensor.smappee_1006002667_local_total_consumption_active_power",
37	+	"sensor.system_monitor_disk_use"
38	+	],
39	+	"sensor_custom_icons": {
40	+	"sensor.station_temperature": "8044",
41	+	"sensor.station_humidity": "2423"
42	+	}
43	+	}' > /chemin/vers/ce/config.json
44	+	```
45	+
46	+	### Fichier de Configuration : config.json
47	+
48	+	Le script utilise un fichier `config.json` pour récupérer les différents paramètres requis, tels que les URL des services et les informations d'authentification. Chaque paramètre joue un rôle essentiel :
49	+
50	+	- home\_assistant\_url : L'URL de l'API Home Assistant, utilisée pour récupérer l'état des capteurs. Cette URL doit être accessible depuis le réseau où est exécuté le script.
51	+	- home\_assistant\_token : Jeton d'authentification nécessaire pour accéder aux données de Home Assistant. Ce token garantit une connexion sécurisée.
52	+	- lametric\_url : L'URL de l'appareil LaMetric, utilisée pour envoyer des notifications. Cette URL est spécifique à votre appareil LaMetric.
53	+	- lametric\_user et lametric\_password : Identifiants nécessaires pour se connecter à l'appareil LaMetric et envoyer des notifications. Assurez-vous que ces informations sont correctes pour garantir la communication avec LaMetric.
54	+	- sensor\_entity\_ids : Liste des identifiants de capteurs Home Assistant dont les données doivent être affichées. Ces identifiants doivent correspondre à ceux configurés dans Home Assistant.
55	+	- sensor\_custom\_icons : (Facultatif) Permet de définir des icônes personnalisées pour certains capteurs spécifiques. Cela rend les notifications plus informatives et esthétiques sur l'appareil LaMetric. Voici un exemple de ce fichier :
56	+
57	+	```json
58	+	{
59	+	"home_assistant_url": "http://192.168.x.x:8123/api/states",
60	+	"home_assistant_token": "...",
61	+	"lametric_url": "http://192.168.x.x:8080/api/v2/device/notifications",
62	+	"lametric_user": "dev",
63	+	"lametric_password": "...",
64	+	"sensor_entity_ids": [
65	+	"sensor.station_temperature",
66	+	"sensor.station_humidity",
67	+	"sensor.system_monitor_load_1m",
68	+	"sensor.smappee_1006002667_local_total_consumption_active_power",
69	+	"sensor.system_monitor_disk_use"
70	+	],
71	+	"sensor_custom_icons": {
72	+	"sensor.station_temperature": "8044",
73	+	"sensor.station_humidity": "2423"
74	+	}
75	+	}
76	+	```
77	+
78	+	### Description des Champs
79	+
80	+	- home\_assistant\_url : URL de l'API Home Assistant pour récupérer l'état des capteurs.
81	+	- home\_assistant\_token : Jeton d'authentification pour accéder à Home Assistant.
82	+	- lametric\_url : URL de l'appareil LaMetric pour envoyer des notifications.
83	+	- lametric\_user et lametric\_password : Identifiants pour se connecter à l'appareil LaMetric.
84	+	- sensor\_entity\_ids : Liste des capteurs de Home Assistant dont les données doivent être affichées.
85	+	- sensor\_custom\_icons : (Facultatif) Définir des icônes personnalisées pour certains capteurs.
86	+
87	+	## Utilisation
88	+
89	+	### Lancement du Script
90	+
91	+	Pour exécuter le script, assurez-vous qu'il est exécutable :
92	+
93	+	```bash
94	+	chmod +x /chemin/vers/ce/script.sh
95	+	```
96	+
97	+	Puis lancez le script avec la commande suivante :
98	+
99	+	```bash
100	+	./script.sh
101	+	```
102	+
103	+	### Configuration des Notifications sur LaMetric
104	+
105	+	- Les notifications LaMetric sont envoyées via une requête POST.
106	+	- Chaque notification contient des "frames", chaque frame peut être personnalisée avec du texte et une icône.
107	+
108	+	## Planification via Crontab
109	+
110	+	Pour planifier la mise à jour automatique des données toutes les 15 minutes, ajoutez une tâche cron :
111	+
112	+	```bash
113	+	crontab -e
114	+	```
115	+
116	+	Ajoutez la ligne suivante :
117	+
118	+	```bash
119	+	/15 * * * /chemin/vers/ce/script.sh
120	+	```
121	+
122	+	Cela exécutera le script toutes les 15 minutes.
123	+
124	+	## Points Importants
125	+
126	+	- Authentification Home Assistant : Utilisez un token que vous pouvez générer depuis votre profil utilisateur dans Home Assistant, sous l'onglet "Sécurité".
127	+	- Icônes pour LaMetric : Les icônes peuvent être trouvées sur [LaMetric Icon Gallery](https://developer.lametric.com/icons).
128	+
129	+	## Exemples de Fonctionnalités
130	+
131	+	### Récupérer les Données de Home Assistant
132	+
133	+	Le script récupère les données des capteurs en effectuant une requête HTTP :
134	+
135	+	```bash
136	+	response=$(curl -s -H "Authorization: Bearer $HOME_ASSISTANT_TOKEN" -H "Content-Type: application/json" "$HOME_ASSISTANT_URL")
137	+	```
138	+
139	+	### Envoyer une Notification à LaMetric
140	+
141	+	Une notification peut être envoyée en utilisant la fonction `send_notification_to_lametric` :
142	+
143	+	```bash
144	+	send_notification_to_lametric "Température" "25°C" "8044"
145	+	```
146	+
147	+	Cela enverra une notification avec un titre, un message et une icône.
148	+
149	+	## Conclusion
150	+
151	+	Ce script permet de facilement intégrer des capteurs de Home Assistant avec un appareil LaMetric, afin de fournir des informations pertinentes de manière visible et conviviale.
152	+
153	+	### Erreurs Communes et Comment les Résoudre
154	+
155	+	- Erreur de Connexion à Home Assistant : Assurez-vous que l'URL et le token de Home Assistant sont corrects. Vérifiez aussi que votre serveur Home Assistant est accessible depuis le réseau.
156	+	- Problèmes d'Authentification LaMetric : Si les notifications ne sont pas envoyées, vérifiez les identifiants (utilisateur et mot de passe) pour l'accès à l'appareil LaMetric.
157	+	- Données de Capteurs Manquantes : Vérifiez que les identifiants des capteurs dans `config.json` sont valides et que ces capteurs sont disponibles dans Home Assistant.
158	+	- Erreurs de Requête JSON : Assurez-vous que le fichier `config.json` est bien formé. Utilisez `jq` pour vérifier la validité du fichier JSON.
159	+	Assurez-vous de bien configurer le fichier `config.json` pour que les URL, les tokens et les identifiants correspondent à votre environnement.
160	+
161	+	Pour toute question ou problème, consultez les documentations officielles de Home Assistant et de LaMetric, et vérifiez que vos informations d'authentification et de configuration sont correctement paramétrées.
162	+
163	+
164	+
165	+	## Pour obtenir les tokens :
166	+
167	+	\- Home Assistant : Crée un token depuis ton profil utilisateur dans Home Assistant
168	+
169	+	lien de votre Home Assistant: https\://homeassistant/profile/security
170	+
171	+	\- LaMetric : Récupérez la clef API sur [https://developer.lametric.com/user/devices](https://developer.lametric.com/user/devices).
172	+
173	+
174	+
175	+	### Pour les icônes des notifications :
176	+
177	+	\- Les icônes peuvent être sélectionnées parmi une liste prédéfinie par LaMetric, identifiées par un ID d'icône (par exemple, "a4157" ou "11100").
178	+
179	+	- Toutes les icons : [https://developer.lametric.com/icons](https://developer.lametric.com/icons)
180	+

Daha yeni Daha eski