Home Assistant Addon Implementation

Describe the solution you’d like Being able to run RaspberryMatic on Home Assistant OS (https://github.com/home-assistant/operating-system) as an installable Addon

cf. https://github.com/home-assistant/addons/issues/1751

Add-on status

• Jan 2021: First working technology preview
• Feb 2021: Beta version (no RPI-RF-MOD/HM-MOD-RPI-PCB support) released with 3.55.10.20210213: https://github.com/jens-maus/RaspberryMatic/wiki/Installation-HomeAssistant https://github.com/jens-maus/RaspberryMatic/tree/master/home-assistant-addon
• Mar 2021: Experimental RPI-RF-MOD/HM-MOD-RPI-PCB + HB-RF-XXX support: https://github.com/jens-maus/RaspberryMatic/issues/1087#issuecomment-788913737 ~https://github.com/jens-maus/operating-system/releases/tag/rm-testversion~
• Apr 2021: Home Assistant OS developers integrated the proposed PR (cf. https://github.com/home-assistant/operating-system/pull/1266). Support for RPI-RF-MOD/HM-MOD-RPI-PCB will be part of the upcoming 6.0 release of Home Assistant OS 🎉
• May 2021: Home Assistant OS 6.0.rc1 and 6.0.rc2 release candidate with support for RPI-RF-MOD/HM-MOD-RPI-PCB released: https://github.com/home-assistant/operating-system/releases

Installation/Test HOWTO

!! The following HOWTO is highly experimental. Use at your own risk !!

Please find here a short howto for installing the latest developer versions of Home-Assistant OS for testing the RaspberryMatic HomeAssistant Add-on integration and functionality related to a RPI-RF-MOD or HM-MOD-RPI-PCB connected either via GPIO on a RaspberryPi/Tinkerboard or via a HB-RF-USB-2/HB-RF-ETH.

Installation HOWTO:

1. Download the latest haos_XXXX-6.0.. file for your hardware platform from https://github.com/home-assistant/operating-system/releases
2. Perform a fresh install on microSD card (via Etcher) or import fresh OVA in your virtual environment
3. If you use a RaspberryPi, Tinkerboard or ODROID and want to use a RPI-RF-MOD/HM-MOD-RPI-PCB directly connected to the GPIO bus, make sure to…
   • either mount the flashed sd card locally to be able to access the config.txt file located on the boot partition.
   • or use a SSH Login later on to log in via SSH remotely
   • or connect a HDMI Monitor+keyboard and login in the console
   • On RaspberryPi: edit the /mnt/boot/config.txt file and uncomment the following lines at the bottom:

   # Uncomment this to enable GPIO support for RPI-RF-MOD/HM-MOD-RPI-PCB
   enable_uart=1
   dtparam=i2c_arm=on
   dtoverlay=miniuart-bt
   dtoverlay=rpi-rf-mod
   

   • On Tinkerboard or ORDOID: edit the /mnt/boot/haos-config.txt file and uncomment the following lines at the bottom:

   # Uncomment this to enable GPIO support for RPI-RF-MOD/HM-MOD-RPI-PCB
   overlays=rpi-rf-mod
   

4. Boot-up HAos and wait until basic installation is finished and the system is accessible via http://homeassistant.local:8123/
5. Switch to Supervisor -> Add-on store and select Repositories by clicking on the three vertical dots on the top right corner.
6. Add the URL https://github.com/jens-maus/ha-addon-raspmatic as a new experimental add-on store
7. Scroll down and make sure to install the normal (non-strict) version of RaspberryMatic HA add-on
8. Enable the sidebar
9. Make sure you disable protection mode to allow the add-on to access all necessary hardware resources
10. If you want to use a HB-RF-USB or HB-RF-USB-2 to connect your HomeMatic RF module via USB connect it now.
11. Start the add-on and monitor the bootup messages where during the Identifying Homematic RF-Hardware... step it should identify the RPI-RF-MOD/HM-MOD-RPI-PCB rf module accordingly.
12. If you want to use a HB-RF-ETH to connect your Homematic RF-Hardware via Ethernet make sure to follow the documentation here: https://github.com/jens-maus/RaspberryMatic/wiki/Experten-Features#hb-rf-eth-anbindung
13. Enjoy full HomeMatic/homematicIP dualstack support.
14. Give some feedback!

Tasks

• Integrate Home Assistant OS (HAos) changes for RPI-RF-MOD/HM-MOD-RPI-PCB -> @jens-maus
  • Fork+Integrate necessary kernel module changes: https://github.com/jens-maus/operating-system/tree/rpi-rf-mod-support
  • Get changes integrated for real-time scheduling support in HAos: https://github.com/home-assistant/operating-system/issues/1235
  • Submit PullRequest to Home Assistant OS project: https://github.com/home-assistant/operating-system/pull/1266
  • Get PullRequest accepted
• Create an add-on to deploy the RaspberryMatic OCI -> @angelnu
  • First draft in github
  • Add-on starts
  • Can connect to UI -> does not work with HA nginx!
  • Add all ports and descriptions
  • Make /usr/local persistent
  • Try with rfd HW
  • Logo and icon has little contract in dark background
• Get feedback
• Finalize + Publish stable version officially

Latest Screenshot

[jens-maus]

Now that 3.57.5.20210525 has been released and seems to run significantly stable enough with recent HAos 6.0rc versions I am going to close this issue and would like to ask anyone to open up new dedicated issues in case problems / enhancement ideas might arise for the ha-addon platform.

And of course thanks to anyone having contributed to the overall success of the ha-addon integration of RaspberryMatic. Special thanks have to go to @angelnu for the initial work on converting RaspberryMatic into a docker container which paved the way to get the ha-addon story going. But of course also thanks to all testers in here! Hope you all have a great HomeAssistant experience with RaspberryMatic as an add-on!

[jens-maus]

@chillje As we lack some own detailed documentation on the homematic integration part here, would you please be so kind in addition the necessary documentation steps to https://github.com/jens-maus/RaspberryMatic/wiki/Installation-HomeAssistant#home-assistant-integration-setup so that users can follow your steps in getting the homematic integration going without having to wade through this issue ticket? thanks!