From 15c0379f0c48688e6ad0802d1a98faf8062ae9d8 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 22 May 2022 17:15:28 +0000 Subject: [PATCH] Auto-update README --- README.md | 123 +++++++++++++++++++++++++++++-------------------- README_fr.md | 128 +++++++++++++++++++++++++++++---------------------- 2 files changed, 148 insertions(+), 103 deletions(-) diff --git a/README.md b/README.md index 780adb6..ac0bca9 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,80 @@ + + # Domoticz for YunoHost [![Integration level](https://dash.yunohost.org/integration/domoticz.svg)](https://dash.yunohost.org/appci/app/domoticz) ![](https://ci-apps.yunohost.org/ci/badges/domoticz.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/domoticz.maintain.svg) -[![Install domoticz with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=domoticz) +[![Install Domoticz with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=domoticz) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install domoticz quickly and simply on a YunoHost server. +> *This package allows you to install Domoticz quickly and simply on a YunoHost server. If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview + +Very light weight open sources home automation system that lets you monitor and configure miscellaneous devices + +**Shipped version:** 2020.2~ynh4 + + + +## Disclaimers / important information + Domoticz is a Home Automation system design to control various devices and receive input from various sensors. For example this system can be used with: --Light switches - --Door sensors - --Doorbells - --Security devices - --Weather sensors like: UV/Rain/Wind Meters - --Temperature Sensors - --Pulse Meters - --Voltage / AD Meters - --And more ... +* Light switches +* Door sensors +* Doorbells +* Security devices +* Weather sensors like: UV/Rain/Wind Meters +* Temperature Sensors +* Pulse Meters +* Voltage / AD Meters +* And more ... -**Shipped version:** Always the last stable one. The last compiled version is retrieved from [this directory](https://releases.domoticz.com/releases/?dir=./beta) +**Shipped version:** Always the last stable one. The last compiled version is retrieved from [this directory](https://releases.domoticz.com/releases/?dir=./beta) during install Once installed, **updates from the uptream app are managed from within the app.**. Yunohost upgrade script will only upgrade the Yunohost package. +The MQTT broker mosquitto is integrated into the package. It requires its own domain or subdomain. It's an optional setting: during install if you set the same domaine as your main app domain, it won't be installed. + +## Configuration + +### Broker Mosquitto + +During installation, a [MQTT](https://en.wikipedia.org/wiki/MQTT) broker is installed at the same time as Domoticz. The broker is Mosquitto with documentation available [here](https://mosquitto.org/). The installed version is the one from the official project repo and not from Debian ones. +This broker requires a dedicated domain or subdomain to work (ex : mqtt.your.domain.tld) : creating this domain prior installation is a prerequisite + +####Use + +To use mosquitto, you need to customize the communication between domoticz and the broker by following the [domoticz documentation](https://www.domoticz.com/wiki/MQTT#Installing_Mosquitto), part *Add hardware "MQTT Client Gateway"*. +User and password are automatically generated during installation, you may retrieve them with +```` +sudo yunohost app setting domoticz mqtt_user +sudo yunohost app setting domoticz mqtt_pwd +```` +You can then publish on a device on domoticz with following syntax: +```` +mosquitto_pub -u *user* -P *password* -h mqtt.your.domain.tld -p 443 -t 'domoticz/in' -m '{ "idx" : 1, "nvalue" : 0, "svalue" : "25.0" }' +```` +In the same way, you may subscribe to a topic with +```` +mosquitto_sub -u *user* -P *password* -h mqtt.your.domain.tld -p 443 -t 'domoticz/out' +```` + +#### Upgrade from version without mosquitto +If you have package ynh3 or below, mosquitto is not installed by default. +If you have chosen to not set a domain during initial installation also. +So, if you need to activate mosquitto in retrospect, do following actions: +1/ Create a domain or a subdomain (for example : 'mqtt.your.domain.tld') +2/ Connect to your server in command line +3/ Type following command : `yunohost app setting domoticz mqtt_domain -v mqtt.your.domain.tld` +4/ Upgrade domoticz to last package. +If you're already on the last package version, use the following command : `yunohost app upgrade domoticz --force` ## Configuration @@ -75,45 +116,29 @@ allow ::/1; This will authorized only IPv4 within local network to access your domoticz API. You may add individual IPv6 address in the same way. -## Documentation - - * Official documentation: Please use the [wiki](https://www.domoticz.com/wiki/Main_Page) and [user manual](https://www.domoticz.com/DomoticzManual.pdf) for further info. - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features - -#### Supported architectures - -Both ARM and x86 architectures should be supported. -Compiled sources are directly downloaded by the package. - ## Limitations * No user management nor LDAP integration This function is [not planned to be implemented into the app](https://github.com/domoticz/domoticz/issues/838), hence it's not planned into the package neither. * Backup cannot be restored on a different machine type (arm, x86...) as compiled sources are different +## Documentation and resources -**More info on the documentation page:** -https://yunohost.org/packaging_apps +* Official app website: https://domoticz.com/ +* Official user documentation: https://www.domoticz.com/DomoticzManual.pdf +* Official admin documentation: https://www.domoticz.com/wiki/Main_Page +* Upstream app code repository: https://github.com/domoticz/domoticz +* YunoHost documentation for this app: https://yunohost.org/app_domoticz +* Report a bug: https://github.com/YunoHost-Apps/domoticz_ynh/issues -## Links +## Developer info - * Report a bug: https://github.com/Yunohost-Apps/domoticz_ynh/issues - * App website: https://domoticz.com/ - * Upstream app repository: https://github.com/domoticz/domoticz - * YunoHost website: https://yunohost.org/ - ---- - -Developer info ----------------- - -**Only if you want to use a testing branch for coding, instead of merging directly into master.** -Please send your pull request to the [testing branch](https://github.com/Yunohost-Apps/domoticz_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/domoticz_ynh/tree/testing). To try the testing branch, please proceed like that. ``` -sudo yunohost app install https://github.com/Yunohost-Apps/domoticz_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/domoticz_ynh/tree/testing --debug or -sudo yunohost app upgrade domoticz -u https://github.com/Yunohost-Apps/domoticz_ynh/tree/testing --debug +sudo yunohost app upgrade domoticz -u https://github.com/YunoHost-Apps/domoticz_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index ae7cf44..978fe1a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,43 +1,80 @@ -# App exemple pour YunoHost +# Domoticz pour YunoHost [![Niveau d'intégration](https://dash.yunohost.org/integration/domoticz.svg)](https://dash.yunohost.org/appci/app/domoticz) ![](https://ci-apps.yunohost.org/ci/badges/domoticz.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/domoticz.maintain.svg) -[![Installer domoticz avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=domoticz) +[![Installer Domoticz avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=domoticz) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer domoticz rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* +> *Ce package vous permet d'installer Domoticz rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* ## Vue d'ensemble + +Logiciel open sources et gratuit de domotique qui vous permet de configurer un grand nombre d'appareils + +**Version incluse :** 2020.2~ynh4 + + + +## Avertissements / informations importantes + Domoticz est un système de domotique permettant de controler différents objets et de recevoir des données de divers senseurs Il peut par exemple être utilisé avec : --des interrupteurs +* des interrupteurs +* des senseurs de portes +* des sonnettes d'entrées +* des systèmes de sécurité +* des stations météo pour les UV, la pluie, le vent... +* des sondes de températures +* des sondes d'impulsions +* des voltmètres +* Et bien d'autres --des senseurs de portes - --des sonnettes d'entrées - --des systèmes de sécurité - --des stations météo pour les UV, la pluie, le vent... - --des sondes de températures - --des sondes d'impulsions - --des voltmètres - --Et bien d'autres - -**Version incluse :** Toujours la dernière version stable. La dernière version compilée est récupérée dans [ce répertoire](https://releases.domoticz.com/releases/?dir=./beta) +**Version incluse :** Toujours la dernière version stable. La dernière version compilée est récupérée dans [ce répertoire](https://releases.domoticz.com/releases/?dir=./beta) lors de l'installation Une fois installée, **les mises à jour de l'application sont gérées depuis les menus de l'application elle même.**. Le script de mise à jour Yunohost mettra uniquement à jour de nouvelles version du package. +Le broker MQTT mosquitto est intégré au package et nécessite un sous-domaine ou un domaine distinct. Il est optionnel et si vous indiquez lors de l'installation le même domaine que le domaine principal, il ne sera pas installé. + ## Configuration +### Broker MQTT Mosquitto + +A l'installation, un broker [MQTT](https://fr.wikipedia.org/wiki/MQTT) est installé en même temps que Domoticz. Il s'agit du serveur mosquitto dont la documentation est disponible [ici](https://mosquitto.org/). La version installée est celle du dépot officiel du projet, et non des dépots Debian. +Ce broker nécessite un domaine ou un sous-domaine particulier pour fonctionner (ex : mqtt.your.domain.tld) : il est nécessaire de créer ce domaine auparavant. + +####Utilisation + +Pour pouvoir l'utiliser, vous devez paramétrer la communication avec entre domoticz et le broker en suivant la [documentation de domoticz](https://www.domoticz.com/wiki/MQTT#Installing_Mosquitto) dans la partie *Add hardware "MQTT Client Gateway"* +Les users et mot de passe du broker sont automatiquement générés lors de l'installation. Vous pouvez les récupérer en tapant +```` +sudo yunohost app setting domoticz mqtt_user +sudo yunohost app setting domoticz mqtt_pwd +```` + +Vous pouvez ensuite publier sur ce serveur en utilisant la syntaxe: +```` +mosquitto_pub -u *user* -P *password* -h mqtt.your.domain.tld -p 443 -t 'domoticz/in' -m '{ "idx" : 1, "nvalue" : 0, "svalue" : "25.0" }' +```` +De la même manière, vous pouvez suivre ce qu'il se passe avec +```` +mosquitto_sub -u *user* -P *password* -h mqtt.your.domain.tld -p 443 -t 'domoticz/out' +```` + +####Mise à jour depuis les versions n'ayant pas mosquitto +Si vous êtes sur le package ynh3 ou inférieur, mosquitto n'est pas installé par défaut. +De même si vous avez choisi de ne pas indiquer de domaine pour mosquitto lors de l'installation initiale. +Pour pouvoir l'installer après coup, faites les actions suivantes: +1/ créez un domaine ou sous-domaine pour recevoir les informations (par exemple : 'mqtt.your.domain.tld') +2/ connecter vous en ligne de commande à votre serveur +3/ taper la commande suivante : `yunohost app setting domoticz mqtt_domain -v mqtt.your.domain.tld` +4/ Procédez à la mise à jour. +Si vous êtes déjà sur la dernière version, utiliser la commmande suivante : `yunohost app upgrade domoticz --force` + + ### Senseurs, langue et ce genre de choses Toute la configuration de l'application a lieu dans l'application elle même -Main configuration of the app take place inside the app itself. ### Accès et API Par défaut, l'accès aux [API JSON](https://www.domoticz.com/wiki/Domoticz_API/JSON_URL's) est autorisé sur cette URL `/votredomaine.tld/api_/chemindedomoticz`. @@ -74,46 +111,29 @@ allow ::/1; Ceci autorisera seulement les adresses IPv4 local a accéder aux API de domoticz. Vous pouvez ajouter des adresses IPv6 de la même façon. -## Documentation - - * Documentation officielle : Utilisez le [wiki](https://www.domoticz.com/wiki/Main_Page) et le [manuel utilisateurs](https://www.domoticz.com/DomoticzManual.pdf) pour plus d'informations - * Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. - -## Caractéristiques spécifiques YunoHost - - -#### Architectures supportées - -A la fois les architectures ARM et x86 devraient être supportées. -Les sources compilées sont directement téléchargées par le package. - ## Limitations * Pas de gestion d'utilisateurs ni d'intégration LDAP. L'application ne [prévoit pas de gérer les utilisateurs par LDAP](https://github.com/domoticz/domoticz/issues/838), donc le package non plus. -* Un backup ne peut pas être restauré sur un type de machine différente de celle d'origine (x86, arm...) car les sources compilées doivent être différente +* Un backup ne peut pas être restauré sur un type de machine différente de celle d'origine (x86, arm...) car les sources compilées doivent être différentes +## Documentations et ressources -**Plus d'informations sur la page de documentation :** -https://yunohost.org/packaging_apps +* Site officiel de l'app : https://domoticz.com/ +* Documentation officielle utilisateur : https://www.domoticz.com/DomoticzManual.pdf +* Documentation officielle de l'admin : https://www.domoticz.com/wiki/Main_Page +* Dépôt de code officiel de l'app : https://github.com/domoticz/domoticz +* Documentation YunoHost pour cette app : https://yunohost.org/app_domoticz +* Signaler un bug : https://github.com/YunoHost-Apps/domoticz_ynh/issues -## Liens +## Informations pour les développeurs - * Signaler un bug : https://github.com/Yunohost-Apps/domoticz_ynh/issues - * Site de l'application : https://domoticz.com/ - * Dépôt de l'application principale : https://github.com/domoticz/domoticz - * Site web YunoHost : https://yunohost.org/ - ---- - -Informations pour les développeurs ----------------- - -**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.** Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/domoticz_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. ``` -sudo yunohost app install https://github.com/Yunohost-Apps/domoticz_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/domoticz_ynh/tree/testing --debug ou -sudo yunohost app upgrade domoticz -u https://github.com/Yunohost-Apps/domoticz_ynh/tree/testing --debug +sudo yunohost app upgrade domoticz -u https://github.com/YunoHost-Apps/domoticz_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file