andrew-codes/home-automation

Various home automation services in containers automatically deployed via local GitHub actions; all within a local k8s cluster.

My Home Automation

This mono-repo consists of several applications and services I use to create my home automation. Most services/applications run in a local Kubernetes cluster.

Topics

1. Code, Architecture, and Deployment Overview
2. Installation guide
3. Kubernetes cluster backup and restore
4. Testing/running apps/services locally

Apps/Services

• Home Assistant
  • Home Assistant
  • MQTT
• Guest Presence Detection
  • Captive Portal
  • Guest wifi renewal
• Dyanmic Guest Lock PINs from Calender Events
  • Guest Pin Codes

Packages

• Burning Installation Images to USB
• Automating the Addition of Github Secrets

home-automation's Issues

Enable local testing of services

Enable running services locally, that depend on other services in the cluster.

• Run individual apps locally, with them connecting to other services that exist in the production cluster
• Run multiple apps locally
• Document feature

Prevent starting multiple games at same time

Starting a game prevents starting another game until the game is turned off.

• Save game playing state when starting a game
• Stopping game on pc update the game state
• Changing ps source updates game playing state
• Turning off ps update game state
• Turning off pc update game state
• Playing game mutation respects stored game state

Home assistant configuration forced push

Auto-renew registered guest devices each day

This will prevent them from having to go through the captive portal any additional times.

• given no guests, publishing topic will no-op
• given one guest, publishing topic will renew single guest lease
• given registered guests, publishing topic will renew each lease
• HA publishes the topic daily
• returns device tracker data

GraphQL subscription for game library data

• Updates when game library db has received an import of games

Enable putting Gaming PC to sleep

Try to do this via SSH.

Notes

• via PowerShell
• via Cmd
• Enable SSH key based authentication

Ensure pushing/pulling from private docker registry occurs through local network only

This will ensure that bandwidth caps from ISP are not overloaded due to pulling/pushing images.

• Use self issued ssl certificate
• Basic authentication

Sort games alphabetically by name

Document GraphQL API

Media player reports on when it’s off

Likely due to avr power state.

Playnite plug-in to serve game data

• Expose mqtt to gaming PC
• Publish all game data via mqtt when receiving topic request
• Publish all game data via mqtt when library syncs

Deploy only changed apps to cluster

This will be used to determine what needs to be deployed to the Kubernetes cluster.

---

Notes

yarn lerna deploy --since $SHA

Automate required GitHub secrets

Automate the addition of required repo secrets for the GitHub action runners to function properly.

• Necessary GitHub secrets are automatically added to the repository when calling set_secrets.sh
• Feature is documented
• Existing secrets are overwritten with their new values

Setup home assistant app for family members

Create basic site/UI for game browser

The game browser will be a web UI. Stand up a deployable site that will be used for the game browser. The site should be internal, but accessible via the LAN.

Docs for mqtt app

Secrets

Install new google TV for shield

Guide

Withings integration

Automate back up of cluster

• How frequently?
• How long should old backups be kept?

Nvidia Shield Pro HA integration

https://selfhostedhome.com/integrating-nvidia-shield-with-home-assistant/

GraphQL API

Used to query any data of the home automation; including:

• Home Assistant API
• Video game library
  • Playnite, Steam API, etc.

Criteria

• Update tests
• Cache HA API per request
• Home Assistant entities
• Home Assistant areas (rooms)
• Home assistant domains
• Use and test with guest tracker captive portal
• Secured by via secret token
• Only allow from internal IPs

Make a master list of automation items for testing/regression testing purposes

Private docker registry

• Not publicly accessible
• Can push and pull images

Enable automated deploys

Via GitHub action runners.

Denon integration is broken in HA

Waiting for an upstream fix.

Home assistant app daemon

• appdaemon runs
• appdaemon admin web UI
• appdaemon admin UI password protected

Game cache updates are atomic

Enable loading all metadata for each game and saving it one at a time. In the case of an error, it can pick back up where it left off or continue to save the rest; i.e. it is not all or nothing.

Docs for appdaemon

Pressing a game will start the game

Guest presence tracking

Presence tracking for guest devices.

• Guests do not have to install any software on any of their devices
• HA knows when a guest is home
• HA knows when all guests are not_home
• Only phone devices are considered when determining guest presence.
• Feature is well documented

Stopping games

When a game is stopped, then HA turns off the media player for the gaming system; including TV, etc.

• When stopping PC game, PC is not put to sleep and TV is not turned off
• When stopping a PS game, PS is not put to rest mode, and TV is not turned off
• Stopping a PS game, updates db with game state

Secure TCP tunneling

Get the inlets-operator working.

Game GraphQL

Query games

• can query games
  • artwork
  • cover art
  • Platform
  • source
  • genre
  • game mode
  • multiplayer mode
  • playtime
  • release year
  • name and summary
  • Playnite ID
  • ID
  • favorited
  • hidden
• can query platforms
• query genres
• query gameModes/multiplayer modes
• Batch loads for better performance

Game library cache

Application to receive game data mqtt payloads and cache it. Consider using redis.

• Subscribes to game data topic and caches payload
• Replaces cache with each payload
• Publish mqtt topic that cache was updated on every update
• On application start, publish mqtt request for game data

WAN bandwidth monitor

Monthly.

TV turns on for when restarting NUC

The TV should not turn on when restarting the NUC.

Revisit TypeScript build of dependency packages

Ensure Grafana persists after a node restart

Currently, username/password is wiped along with all imported dashboards.

GraphQL API serves game images

An endpoint to serve any game images; by their ID.

Game cache and IGDB lookups

Cache games from Playnite and also cross-reference game data (by name) on IGDB's API. Cache game data combined with Playnite data to be sourced by GraphQL queries elsewhere.

• persist cache after restarts/deployments
• password protect game cache
• limit to 1 request per 350ms so as not to hit the API rate limits
• save up game info
• save cover art info
• save keywords
• save the franchise
• artworks
• save collection
• savegame modes
• save multiplayer modes
• only look up games that are not already in the database
• download cover art save to db
• download artwork images to db
• save games not found in IGDB for later/further review

Home assistant mqtt

Play a game GraphQL mutation

PC

• Turn on the gaming pc for pc games
• Publish MQTT topic to play pc game
• Published topic to play PC game turns on the game on the PC
• When the PC game is not installed, will install the game and then turn it on
• When turning off the game manually, then a topic is published
• Stopping via topic will kill Playnite application
• Stopping graphql API mutation publishes stop game topic
• Published topics for playing games will update the game state in the DB

PS4

• Turn on PS4 for ps4 games
• Start PS4 game for ps4 games
• Publish MQTT topic to play ps game
• Turning off PS4 publishes stop PS4 gameplay

DNS server IP address misconfiguration

DNS server oscillates its IP address from several values. This is causing issues with Internet/network connectivity.

May need to re-install pihole. If so, this should happen via an automated process with Ansible.

Turning on media player doesn’t turn on tv or set avr source

Docs for prometheus monitoring

View library games within the game browser.

Each game should display

• game title
• game image

Every game should be the same size as the others.

Playnite plug-in automated installation/upgrades

Automate the installation of new versions of plugin.

Bug reporting to GitHub from home assistant

Enable family members to report issues they experience with the home automation directly to GitHub from within the Home Assistant mobile app.

Secure installation secrets

Automate setting up appropriate secrets from a freshly pulled down repo.

Remove sensitive info from history