docs(generic): improve documentation

xaviml · Dec 5, 2020 · 7a208e5 · 7a208e5
1 parent 2dadcbc
commit 7a208e5
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 12 deletions.
diff --git a/docs/others/integrations.md b/docs/others/integrations.md
@@ -101,16 +101,31 @@ livingroom_controller:
   light: light.bedroom
 ```
 
-By doing this, ControllerX will be listening directly from MQTT rather than Home Assistant (which listens from MQTT). Not only can you use this with zigbee2mqtt, but also with any other MQTT integration. However, it comes with the limitation that it expects the payload from the topic to be the action and not a JSON, this is why the example above we use `zigbee2mqtt/livingroom_controller/action` and not `zigbee2mqtt/livingroom_controller`. Last but not least, MQTT needs to be configured on `appdaemon.yaml` by adding the `MQTT` plugin, apart from the `HASS` plugin:
+By doing this, ControllerX will be listening directly from MQTT rather than Home Assistant (which listens from MQTT). Not only can you use this with zigbee2mqtt, but also with any other MQTT integration. However, it comes with the limitation that it expects the payload from the topic to be the action and not a JSON, this is why the example above we use `zigbee2mqtt/livingroom_controller/action` and not `zigbee2mqtt/livingroom_controller`. Last but not least, MQTT needs to be configured on `appdaemon.yaml` by adding the `MQTT` plugin, apart from the `HASS` plugin. The whole file should look like the following:
 
 ```yaml
-plugins:
-  HASS:
-    type: hass
-  MQTT:
-    type: mqtt
-    namespace: mqtt # This is important
-    client_host: <Host without indicating the port (e.g. 192.168.1.10)>
-    client_user: XXXXX
-    client_password: XXXXX
+---
+secrets: /config/secrets.yaml
+appdaemon:
+  latitude: X.XXXXXXX
+  longitude: X.XXXXXXX
+  elevation: XXXX
+  time_zone: XXXXXXXX
+  # You can add `missing_app_warnings` if you don't want any
+  # warning spam from ControllerX when starting AppDaemon
+  missing_app_warnings: 1
+  plugins:
+    HASS:
+      type: hass
+    MQTT:
+      type: mqtt
+      namespace: mqtt # This is important
+      client_host: <Host without indicating the port (e.g. 192.168.1.10)>
+      client_user: XXXXX
+      client_password: XXXXX
+http:
+  url: http://127.0.0.1:5050
+admin:
+api:
+hadashboard:
 ```
diff --git a/docs/others/run-appdaemon.md b/docs/others/run-appdaemon.md
@@ -6,4 +6,4 @@ layout: page
 AppDaemon let's you run Home Assistant automation with Python code, instead of yaml configuration.
 When it comes simple automations, yaml or the Automation editor are great, but if the automation gets more complicated, then it gets more difficult to control through yaml, this is where AppDaemon comes into place.
 
-This is the reason this project is built on top of AppDaemon. Now you might be convinced, but you have no idea of how to install it and set it up. If you are using Home Assistant (FKA hassio), you can install the addon called `AppDaemon 4`. You can follow then the instructions and once is up and running, you can check the [installation](../start/installation) page.
+This is the reason this project is built on top of AppDaemon. Now you might be convinced, but you have no idea of how to install it and set it up. If you are using Home Assistant with the Supervisor, you can install the addon called `AppDaemon 4` from the addon store. You can follow the addon instructions and once is up and running, you can check the [installation](../start/installation) page.
diff --git a/docs/start/installation.md b/docs/start/installation.md
@@ -5,7 +5,9 @@ title: Installation
 
 # AppDaemon installation
 
-Before installing ControllerX, we will previously need to install AppDaemon. For this, you can follow the [official documentation](https://appdaemon.readthedocs.io/en/latest/INSTALL.html) for it. I personally recommend to install the `AppDaemon 4` addon from the `Add-on store`. Once the addon is install, you can run it and it will set up everything for you. It will create a folder in `/config/appdaemon` with the needed structure for AppDaemon to run.
+Before installing ControllerX, we will need to install AppDaemon first. For this, you can follow the [official documentation](https://appdaemon.readthedocs.io/en/latest/INSTALL.html) for it. I personally recommend to install the `AppDaemon 4` addon from the `Add-on store`. Once the addon is install, you can run it and it will set up everything for you. It will create a folder in `/config/appdaemon` with the needed structure for AppDaemon to run.
+
+_You can read [here](/controllerx/others/run-appdaemon) what's AppDaemon and why is needed._
 
 # ControllerX installation