Skip to content

AppDaemon installation

This installation guide assumes that ControllerX runs on AppDaemon addon, which can be found in the addon store. If you prefer to use your own AppDaemon instance, you can find the latest ControllerX code in the Manual section.

You can read here what's AppDaemon and why is needed.

AppDaemon addon

First, we will need to install the AppDaemon from the Add-on store. This will create the following folder in your system /addon_configs/a0d7b954_appdaemon, which we will need to modify the /addon_configs/a0d7b954_appdaemon/appdaemon.yaml (e.g. File Editor addon):

---
secrets: /homeassistant/secrets.yaml # (1)
appdaemon:
  latitude: X.XXXXXXX # (2)
  longitude: X.XXXXXXX
  elevation: XXXX
  time_zone: XXXXXXXX
  missing_app_warnings: 0 # (3)
  app_dir: /homeassistant/appdaemon/apps # (4)
  plugins:
    HASS:
      type: hass
http:
  url: http://127.0.0.1:5050
admin:
api:
hadashboard:
  1. This line is important for AppDaemon to get the secrets from the correct path.
  2. Substitute with the correct values, or leave the default ones.
  3. Extra tip: you can add missing_app_warnings if you don't want any warning spam from ControllerX when starting AppDaemon.
  4. This line is important for AppDaemon to get the correct apps path where HACS install ControllerX in.

Note that by this point the addon might fail since /homeassistant/appdaemon might not exists yet, but you can keep following the installation steps.

You can read more about these changes in this GitHub discussion.

ControllerX installation

You can proceed to install ControllerX either manually or through HACS in the /homeassistant/appdaemon/apps/ folder.

HACS

The easiest way to add this to your Home Assistant installation is using HACS with Enable AppDaemon apps discovery & tracking checked. If you don't have it enabled, go to Configuration > Integrations > HACS (Options). You will find ControllerX in the Automation section on HACS. This will automatically add ControllerX in /homeassistant/appdaemon/apps/, and updates will be tracked by HACS and update within the same folder.

Manual

Download the latest version, and then place the controllerx folder in your machine /homeassistant/appdaemon/apps/controllerx. The controllerx.py needs to be in /homeassistant/appdaemon/apps/controllerx/controllerx.py.

Setup apps.yaml

Once we have the addon and ControllerX installed, we can create /homeassistant/appdaemon/apps/apps.yaml, where we can configure ControllerX in.