🏡 Gentoo Overlay: Home Assistant on Gentoo Linux without virtualenv or docker.
Go to file
Andreas Billmeier 607d5c97e0
clean up jsonrpc (works now with pykodi-0.2.0)
2020-09-12 18:23:13 +02:00
acct-group sort KEYWORDS where complained by repoman 2020-02-13 22:01:33 +01:00
acct-user minor code cleanups 2020-02-04 19:59:34 +01:00
app-crypt/acme add old app-crypt/acme-1.4.0 for nabucasa compatibility 2020-07-25 15:34:10 +02:00
app-misc clean up jsonrpc 2020-09-12 17:51:43 +02:00
dev-embedded update esphome-1.15.0_beta4, esphome-9999 (without src_prepare()) 2020-09-12 15:19:48 +02:00
dev-libs/protobuf add the forgotten protobuf-3.12 patches 2020-08-02 10:59:58 +02:00
dev-python update pykodi-0.2.0 2020-09-12 17:31:05 +02:00
etc show my current portage files 2020-01-11 20:48:18 +01:00
media-libs update mutagen-1.45.1 2020-09-09 21:24:19 +02:00
metadata removed older ebuilds 2019-03-19 23:44:38 +01:00
net-analyzer/speedtest-cli remove 0.11.1-r3 (not needed anymore) 2020-09-12 09:43:55 +02:00
profiles fixed repo_name 2018-12-07 00:07:23 +01:00
virtual/mqtt homeassistant-0.109.0 2020-05-02 11:56:29 +02:00
www-servers/tornado clean up PYTHON_COMPAT & KEYWORDS outside dev-python 2020-02-11 19:26:15 +01:00
.gitignore homeassistant-0.105.4 2020-02-15 08:06:41 +01:00
CHANGELOG.txt clean up jsonrpc (works now with pykodi-0.2.0) 2020-09-12 18:23:13 +02:00
LICENSE Change License 2019-02-13 21:10:21 +01:00
README.md some more upgrade tips 2020-09-12 11:29:15 +02:00
metadata.dtd fix some DESCRIPTION.toolong from RepoMan 2020-02-13 22:45:33 +01:00
requirements_all.txt requirements_all.txt 2020-08-01 15:23:26 +02:00

README.md

Home Assistant Gentoo Overlay

Home Assistant without Docker & Virtual Environments

https://www.home-assistant.io/ https://github.com/home-assistant/home-assistant

"Open source home automation that puts local control and privacy first."

Origin: Ireland, Home: Bavaria

Once this was a fork of Paul Healy's https://cgit.gentoo.org/user/lmiphay.git/tree/app-misc/homeassistant-bin, which seemed unmaintained to me. First I just wanted to compile it for my personal use. This happed at Home Assistant 0.77 in September 2018. Some friends told me they wanted to use/see it, so I placed it on my public git server, and was caught by surprise of several hundred page views in the very first days. I'll do my best to keep it close to the official releases, might get slower during summers. After 3 months it had ~170 ebuilds, now (Nov 2019) > 1599 ebuilds in > 830 packages are on file, 970 Packes in 2380 Ebuilds in September 2020. As long as I certainly do not count automatically consolidated collections, this Overlay has grown to one of the largest Gentoo Repos during the last year.

If you have questions or suggestions: contact me, any help is very welcome. If you want to help or contribute, please join me.

Reporting Issues

First, please also check if your issue is already reported at git.edevau.net.

If not, please report it here or at GitHub.

Please let me know if anything is wrong or dependencies are missing, since I use only some of the components myself.

From time to time a fresh compile test on empty boxes (one with Python 3.8 and one with Python 3.7) is run to catch general faults, last good (full) compile test was September 2020 with v0.115.0. It was not possible to fix everything, work is in progress, some open problems remain.

Authors welcome

If you are author of an integration / component or other stuff related to Home Assistant and if I have your stuff not already added, please file a pull request, or just drop me a note. For adding a component, I need a release file in tar.gz or zip format. Tagged releases on Github are OK, but a Pypi SDIST tar.gz source release would be preferred, because I can automatically merge it and it will use Gentoo's mirror system. Most of the integrations/components do both. I cannot add packages only available in wheels format. Please make sure you have a proper license assigned, selected license should be unique on all platforms (Pypi/Github/Sourceforge).

Python 3.8 Support

Since 0.114.4 (09/2020) everything compiles fine on Python 3.8. Still cleaning up, I did not yet any production test on Python 3.8, but I will very soon. Everything looks good. I am doing most of the tests/work on a box with Python 3.8 only. Before a new release of the app-misc/homeassistant Ebuild is made, I make sure all important components also compile on...

... Python 3.7

You will need at least Python 3.7.7 for running Home assistant on Gentoo Linux. By user request, I have populated an ~arm64 KEYWORD on all ebuilds, which is (currently) completely untested. I know about at least 2 guys using it, but I had no feedback yet. I will some day prepare a cross compile environment to build a public binary repo for Home Assistant on Sakakis-'s Image.

I am still running my productive box with Python 3.7. Anyway, it still has 2.7, but this can be removed now. Even ESPHome runs on the same box with some small patches (included in my Ebuild). I try to compile all Ebuilds from time to time.

Python 2.7 on Gentoo

In August 2020 I discovered that it is now possible to remove Python 2.7 completely. I have done this on all my test servers and my Home Assistant Box. All still work like a charm.

Nearly all Home Assistant Components are now included

Except some modules with uncorrectable errors (e.g. hard drive crashes, lost sources) I believe all possible integrations for Home Assistant and their stated dependencies are included as ebuilds, based on the integrations list from /usr/lib/python3.7/site-packages/homeassistant/components/*/manifest.json. Many fixed dependencies (necessary or not) to old releases forbid installation of packages requiring newer ones, but I filed all dependencies strict as they have been declared in setup.py or requirements.txt (sometimes other sources) anyway. The exception proves the rule.

In some cases I added small patches to the ebuilds, some packages have versions pinned without any reason. For me it's OK, if the packages compile and complete their own tests in the sandbox. Please let me know if you encounter problems. I will continuously expand my tests and do more cleanups.

Why don't we use a virtual environment for Home Assistant

On Gentoo, we have a very powerful package manager. So I (now) try to put everything Home Assistant uses into Ebuilds.

Some years ago I started with only those packages Home Assitant needed absolutely to start. Home Assistant then downloads and installs modules it requires and cannot find. After some time, /etc/homeassitant/deps grew larger and larger, things messed up, I had a well maintained system, except the directory where a lot of packages (also outdated ones) live without our knowledge.

So I started to add more important components as Ebuilds, I did not touch the internal requirement check. If a package is installed via portage and Home Assistants constraints match, Home Assitant does not download it's own copy.

You can find the current constraints in:

You should take a look in /etc/homeassistant/deps/ from time to time, I do this after every upgrade, if is not empty, install the missing package, emtpy this directory, restart Home Assistant, if it's still downloaded, possibly the wrong (mostly too new) version of a component or a library is installed. eix, /etc/portage/package.accept_keywords and --autounmask=y are your friends. You should not unmask too much, and think about the next releases when you unmask packages.

Sources Missing, older release tags

Some packages with missing or hidden older releases have been forked after the originating author has been queried and notified. I did not touch any source, no changes except adding the missing release tags have been made. If patches are needed, these will be applied during the compile process. As soon as another usable release will be available, I'll swap the SRC_URI back to Pypi, the original Github or wherever it came from. For every fork in use I have an open ticket at git.edevau.net. Please drop me a note if you find something wrong.

Other things

Aside from Home Assistant's stuff this repo contains some ebuilds I use with my Home Assistant, some have to be explicitly mentioned:

ESPHome

Thanks to @OttoWinter for his fabulous idea and great work, really cool stuff, as soon as your name server accepts dynamic names from DHCP, a lot of ESP devices are very easy to deploy. Its integration in Home Assistant is easy and reacts fast on state changes. I love its Integration in Home Assistant, you have one single point where you define and name a switch or a sensor (instead of > three points using MQTT). Together with the possibility of OTA updates my sensors now have a unique name everywhere in the system, and names can be changed very easily. I have the dashboard installed in HA's Gui, so updates and changes are made with a few clicks. In the meantime I migrated all my Magichome Controllers, very happy with it, and I have a couple of binary input arrays running with it without any problems. However, my Sonoff POW and POW R2 are still running with various versions of Tasmota. Some required libraries are too old for Home Assistants environment, and I do NOT use virtual environments, so I simply patched it, it runs on my productive system without any problems. Please report any problems. You can also use the dev ebuild (dev-embedded/esphome-9999.ebuild), this uses newer libraries, but will be compiled every time you run a world update, it is also very stable most of the time.

Platformio

Platformio is needed for ESPHome and other stuff.

Git Server & Mirrors

You will find this Repository at

Location Web Clone me here
Main https://git.edevau.net/onkelbeh/HomeAssistantRepository https://git.edevau.net/onkelbeh/HomeAssistantRepository.git
Mirror https://github.com/onkelbeh/HomeAssistantRepository https://github.com/onkelbeh/HomeAssistantRepository.git

Sorry, due to technical reasons, I currently cannot offer ssh access to my git server.

Sure, you can submit issues and pull requests on both sites, but I prefer them on my own server (requires registration).

Installation on Python 3.7 or Python 3.8

Since Python 3.7 is default target since 05/2020, installation is very easy now.

But, before installing on 3.7, please think about using 3.8, this will save you the migration from 3.7 -> 3.8. And, as my first test show, you will notice a slight improvement in performance. For using 3.8, simply increase all version numbers in the manual below by 1.

First add the Overlay to /etc/portage/repos.conf/homeassistant.conf, make sure not to interfere with your main Gentoo repo, which is at /usr/portage/gentoo in my boxes, because I always have more than one repo active by default. others use /usr/local/portage/homeassistant

[HomeAssistantRepository]
location = /usr/portage/homeassistant
sync-type = git
sync-uri = https://git.edevau.net/onkelbeh/HomeAssistantRepository.git
auto-sync = yes
sync-rsync-verify-metamanifest = no

Sync it:

$ emerge --sync

Make sure you have a proper locale setting. I use

$ cat /etc/locale.gen
de_DE ISO-8859-1
de_DE@euro UTF-8

It will make things easier if you take the example files from /etc/portage/package.accept_keywords/99_homeassistant and /etc/portage/package.use/60_homeassistant and copy it to your /etc/portage.

Check your /etc/portage/make.conf for the corret Python Targets:

USE_PYTHON="3.7"
PYTHON_TARGETS="python3_7"
PYTHON_SINGLE_TARGET="python3_7"

Run eselect python to put Python 3.7 on position 1

Finally install Home Assistant:

$ emerge -tav app-misc/homeassistant
$ rc-update add homeassistant

I could be necessary to install some components by hand, there are too many components to mask all in use flags. If you use a component which you want to be added as a use flag, send a pull request, or just let me know.

Upgrading to Python 3.8 from a pre 3.8 system

Same as it was from Python 3.6 to 3.7.

The fastest way:

  • Throw away app-misc/homeassistant
  • run emerge --depclean -a, this will remove all dependent packages
  • update your naked core system as described below
  • reinstall app-misc/homeassistant with only the new Python Version

This avoids a lot of recompiling all Home Assistant deps, and a lot of dependency trouble. Very recommended. I did not, but I just wanted to see if it works ;-)

The upgrade steps:

Make sure your system is up to date:

$ emerge -tauvDUN @world

Install Python 3.8:

$ emerge -tav dev-lang/python:3.8

Edit your /etc/portage/make.conf to set the new Python Targets, make sure you have now both versions active:

USE_PYTHON="3.8 3.7"
PYTHON_TARGETS="python3_8 python3_7"
PYTHON_SINGLE_TARGET="python3_8"

Run eselect python to put Python 3.8 on position 1, perhaps you have to edit /etc/python-exec/python-exec.conf.

Run the Update:

$ emerge --depclean
$ emerge -1vUD @world
$ emerge --depclean

If everthing is clean, double check with:

  • eix --installed-with-use python_targets_python3_7 (<- old version)
  • eix --installed-without-use python_targets_python3_8 (<- new version)

or

  • diff <(equery h python_targets_python3_7) <(equery h python_targets_python3_8)
  • diff <(equery h python_single_target_python3_7) <(equery h python_single_target_python3_8)

Help it with:

eix -I# --installed-without-use python_targets_python3_8 | xargs emerge -1tv

Now you have all Python packages for both versions installed

Time to get rid of the packages compiled for the old Python:

Edit your /etc/portage/make.conf to remove old Python Targets:

USE_PYTHON="3.8"
PYTHON_TARGETS="python3_8"
PYTHON_SINGLE_TARGET="python3_8"

Run the Update again:

# emerge --depclean
# emerge -1vUD @world
# emerge --depclean

Sometimes I had dependencies portage didn't respect, in some cases it seems not to know in which Python's site-packages modules are already installed. Install them manually (after compile errors). Once all packages are updated, you can remove the older python targets in package.use and run another upgrade to remove now obsolete support for Python 3.7. This will save hard disk space and compile time.

It does not make sense to compile all this stuff for more than one python.

Check if all is gone:

# eix --installed-with-use python_targets_python3_7

Recompile all packages which are still present in the old Python.

Remove the old Python

# emerge -cav /dev-lang/python:3.7

Tools that might help to clean up:

$ eix --installed-with-use python_targets_python3_7
$ diff <(equery h python_targets_python3_7) <(equery h python_targets_python3_8)

Todos

  • If it moves, compile it :-)
  • Map more, perhaps all important components to use flags
  • Publish my Home Assistant Configuration
  • Publish my ESPHome Configurations
  • Add test support for Python 3.8 and 3.9 in new dev branches
  • Add libraries if I need it or someone asks for
  • Create a better mechanism to check requirements_all.txt against this repo. A very early version of it was used to create the v9999 dev ebuild with nearly all components framed into USE flags. Someone blame me for 800 use flags ;-)
  • Write an real good installation page for the home-assistant.io Documentation an get it added there.
  • Convince more people to not run Home Assistant with Docker (see https://xkcd.com/1988/)

Experiments in progress:

  • grafana with influxdb, will have to use it at work soon and have to get used to it anyway, fits much better for irregular measurements than Cacti/RRD.
  • remote IOS authentication with haproxy and client certificates.
  • play with Node-RED, there are users requests for it, but my skills are to low for this Ebuild :-)

some Background...

I have Home Assistant running on a virtual X64 box, 4GB RAM, 3 Cores of an older Xeon E5-2630 v2 @ 2.60GHz and 30GB Disk from a small FC SAN (HP MSA). Recorder writes to a local mariadb socket, moved this from my 'big' mariadb machine because of some performance issues. currently 10.2.29 without problems. Influxdb and Graphana are also on the same box. Find a list of the integrations I use myself on my production box here.

Some of my devices are connected via Eclipse Mosquitto (https://mosquitto.org/), I use the stable version coming with the original distribution (1.6.8), no SSL inside my isolated IOT Vlan, so no need to upgrade. Along MQTT I am actively using (and therefore testing) the following platforms/components:

  • some (~9) Z-Wave devices, mostly Fibaro Roller Shutter 3 with a ZMEEUZB1 Stick connected to my VM with ser2net, socat & OpenZWave. I would not buy the Fibaro stuff again, because of their weird firmware policy. You need to have their expensive gateway to make an update. The cheap chinese stuff would do it better.
    • in the vm run socat pty,link=/dev/ttyUSB0,raw,user=homeassistant,group=dialout,mode=777 tcp:[ip of usbhost]:3333
    • at the usb host run ser2net with 3333:raw:0:/dev/ttyACM0:115200 8DATABITS NONE 1STOPBIT
  • some Zigbee devices from Xioami, via an CC2531 USB stick from Amazon -> zigbee2mqtt
  • a bunch of OneWire and I2C Sensors (mostly via ESPHome and MQTT) and
  • ESPHome - see description above - (https://esphome.io/ & https://github.com/esphome/esphome/)
  • ESPEasy (https://www.letscontrolit.com/wiki/index.php/ESPEasy/). I formerly used it to avoid some serious design problems in Tasmota, but since I use ESPHome, these devices live only until they have to be touched for some reason, their firmware will get replaced with ESPHome.
  • Sonoff/Tasmota (mostly via MQTT) (https://github.com/arendst/Sonoff-Tasmota), same here: as soon a device has to be touched, it's firmware will be replaced with Otto Winter's ESPHome.
    • Sonoff S20
    • Sonoff 4ch
    • Sonoff Dual
    • Sonoff RF Bridge with remote Switches
    • Sonoff Touch
    • Sonoff Basic (Wifi not working well with EPHome or Tasmota in newer versions)
    • Sonoff Pow R2 The Sonoff Pow (and R2) will stay with Tasmota for a while, because I have no good implementation of Tasmota's energy summary in ESPHome.
  • Experimenting with Shelly Devices, a friend has some Shelly 1/2, bought a Pro, but this one has a Chip form TI, no ESP, so we'll have to use the original Firmware.
  • Now all of my HC-SR501 PIR Sensors and some of my traditional light switches are connected to two big input arrays I built into old CAT6 patch panels with an ESP12 and 4 PCF8574 I2C I/O Expanders, this makes 24 I/O lines per panel. All these panels run ESPHome.
  • Yamaha RXV (4 devices)
  • SamsungTV (partly not working anymore due to Samsung's newest firmware 'improvements', at least I can read it's status for controlling lights & the shutters)
  • Some Tradfri lights
  • 4 IKEA Shutters, finally they can now be bought. A bit expensive, but nice and easy to install.
  • Sonos (had many, sold most of them, because they destroyed a formerly very cool Gui, only two boxes left)
  • Calendar (connected to a locally run ownCloud, OC not in this Repository) (https://owncloud.org/)
  • Kodi on Raspberry (3, all with OSMC) (https://osmc.tv/download/)
  • Enigma2 on Dreambox (2 left) (https://wiki.blue-panel.com/index.php/Enigma2)
  • Hyperion with APA102 (very cool stuff) (https://hyperion-project.org/)
  • EQ3-Max! (I accidently bought some, so I have to use them until they die, 8 devices and a cube). Currently the integration maxcube-api is broken, added a hack to keep them running, just add maxcube_hack use flag to home assistant, then the patch will be applied before installation. Recently I saw some other interesting soft for this hardware. Perhaps I'll try one of these, and forget about maxcube-api.
  • Axis Camera (1, a few more to come)
  • yr.no weather (best reliable forecast you can get for low money) (https://www.yr.no/)

Privacy

I have no Google, Amazon or Apple involved in my privacy (at least in this case) and I am not planning to let them in.

Some thoughts

  • Be aware that all dependent libraries could be marked as stable here as soon as they compile. Outside HA dependencies execpt portage are not tested.
  • Since I use Gentoo mostly on servers, I do not use systemd, the most important reason to run Gentoo is that you are NOT forced to run this incredible crap.
  • I use an own profile based on "amd64/17.1/no-multilib"
  • python-3.8.5 is set as default target.
  • I do no tests anymore on Python 3.6.

Licenses

The repository itself is released under GPL-3, all work on the depending components under the licenses they came from, which could be (as my grep told me on 12.3.2020):

grep -r "LICENSE=" | cut -d ":" -f2 | sort | uniq -c | sed 's;LICENSE=";|;' | sed 's;";|;' | sed 's/ //g' | xargs -L1 printf '|%s\n'
Count License
2 AGPL-3
1 AGPL-3+
19 all-rights-reserved
384 Apache-2.0
3 Apache-2.0
1 Apache-2.0 MIT
2 Artistic-2
1 Boost-1.0
156 BSD
6 BSD-2
5 BSD-2 Unlicense
7 BSD-4
1 BSD
4 CC0-1.0
1 CC-BY-NC-SA-3.0
2 CC-BY-NC-SA-4.0
2 ECL-2.0
11 EPL-1.0
2 GPL-1
22 GPL-2
5 GPL-2+
180 GPL-3
22 GPL-3+
2 ISC
1 LGPL-2
10 LGPL-2+
14 LGPL-2.1
2 LGPL-2.1+
28 LGPL-3
15 LGPL-3+
1346 MIT
5 MPL-2.0
1 NEWLIB
12 PSF-2
3 PSF-2.4
4 public-domain
14 Unlicense
5 ZPL

I did my best to keep these clean. If a valid license was published on Pypi, it has been automatically merged. Otherwise I took it from Github or alternatively from comments in the source. Sometimes these differed and have been not unique. All license strings have been adjusted to the list in /usr/portage/gentoo/licenses/. Some packages do not have any license published. Authors have been asked for clarification, some still did not respond. These were added with an all-rights-reserved license and RESTRICT="mirror" was set. Find the appropriate Licenses referenced in the ebuild files and in the corresponding homepages or sources.

Last update of this text: 12.9.2020