Skip to content

Commit

Permalink
Tweak documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
renemarc committed Jun 26, 2018
1 parent 0cd8446 commit e1c3bd6
Show file tree
Hide file tree
Showing 14 changed files with 38 additions and 56 deletions.
1 change: 1 addition & 0 deletions .HA_VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
0.72.1
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,5 @@ secrets.yaml
!.github
!.gitignore
!.gitkeep
!/.HA_VERSION
!/.travis.yml
39 changes: 21 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@
[![License][img-license]][link-license]


Configuration for [Home Assistant](https://home-assistant.io/) running [Hass.io](https://home-assistant.io/hassio/) on a Raspberry Pi for a one bedroom apartment, offering convenience automations over lights and climate while providing multiple intuitive user controls.
Configuration for [Home Assistant](https://home-assistant.io/) running [Hass.io](https://home-assistant.io/hassio/) on a [Raspberry Pi](https://www.raspberrypi.org/products/raspberry-pi-3-model-b/) for a one bedroom apartment, offering convenience automations over lights and climate while providing multiple intuitive user controls.

<div align="center">
<p><strong>Be sure to ⭐️ my repo if you find it useful! 😃</strong></p>
<figure>
<div>
<img src="www/screenshots/dashboard-all.gif" alt="Dashboard animation" title="Dashboards">
Expand Down Expand Up @@ -54,7 +55,7 @@ Configuration for [Home Assistant](https://home-assistant.io/) running [Hass.io]

## TL;DR

This is a fully documented working configuration for Home Assistant, with screenshots, hints and comments. [Browse the code](#) to have a look!
This is a fully documented working configuration for Home Assistant, with screenshots, hints and comments. [Browse the code](#) to have a look! 👀


## Overview
Expand All @@ -63,11 +64,11 @@ This is a fully documented working configuration for Home Assistant, with screen
- **Inconspicuous**: I like tech alright, but like any good butlers it should stay out of sight yet stay summonable. Think Fiji villa, not server room.
- **Modular**: Both code and devices should be easily replaceable.
- **Internet independent**: As much local processing as possible for the essential features.
- **Accessible through multiple ways:** Computers, tablet (kiosk), voice, smart phones, wireless buttons.
- **Intuitive user interfaces:** One look at a group of sensors/switches should be sufficient for anyone to understand the current states and how to operate an interface.
- **Accessible through multiple ways:** Computers, tablet (kiosk), voice, smart phones, wireless buttons, remotes.
- **Intuitive user interfaces:** One look at a group of sensors/switches should be sufficient for anyone to understand the current states and how to operate an interface. 💡
- **Redundant controls:** Multiple interfaces should be able to control devices without interference. State changes from manual interventions or dedicated manufacturer apps should be tracked whenever possible.
- **No information overload:** Provide just enough insights to get an idea of what's going on. And no need for data that's best consumed on more interactive devices (like stock prices, Steam community status...)
- **Not everything should be networked:** Bathroom fan, pantry and laundry room lights have their independent motion sensors and that's a good thing. Same independence goes for the smoke detector: I sure don't want to require extensive skin grafts because I forgot an extra space in a YAML file. _Yikes!_
- **Not everything should be networked:** Bathroom fan, pantry and laundry room lights have their independent motion sensors and that's a good thing. Same independence goes for the smoke detector: I sure don't want to require extensive skin grafts because I forgot an extra space in a YAML file. 😱
- **No Alexa/Cortana/Google Voice:** I don't want to have advertising agencies, online stores, or other AI-feeding Big Brother tech-monsters listening in to everything we say _and do_ just for the dubious convenience of switching lights on by voice command. There are offline solutions that are privacy-counscious.

<div align="center">
Expand Down Expand Up @@ -236,11 +237,11 @@ Tasks are defined in the [issue queue][link-issues] and the development progress


### Additional human interfaces
- **[Flic buttons](https://flic.io)** on nightstand and in the kitchen for triggering modes and controlling localized lights, depending on current states and click types.
- **Aeotec Minimote** to quickly control global scenes and modes.
- **[Homebridge](https://github.com/nfarina/homebridge)** for using some key sensors and devices with iPhones.
- **[Home Assistant Companion](https://itunes.apple.com/us/app/home-assistant-companion/id1099568401?mt=8) iPhone app** for full UI access in the palm of my hand. _Muahahaha!_
- **[Flic buttons](https://flic.io)** on nightstand and in the kitchen for triggering modes and controlling localized lights, depending on current states and click types.
- **[HADashboard](https://home-assistant.io/docs/ecosystem/hadashboard/)** for wall-mounted tablet, featuring indoor sensors reports, transit schedules, weather forecast and radar/sattelite maps, wrapped in an obvious navigation scheme for much UX goodness. Have a look at [`/appdaemon/dashboards/`](appdaemon/dashboards), you'll like! 😍
- **[Home Assistant Companion](https://itunes.apple.com/us/app/home-assistant-companion/id1099568401?mt=8) iPhone app** for full UI access in the palm of my hand. _Muahahaha!_
- **[HomeKit](https://www.home-assistant.io/components/homekit)** for using some key sensors and devices with iPhones.


## Setup
Expand All @@ -259,10 +260,10 @@ Tasks are defined in the [issue queue][link-issues] and the development progress


### Supporting hardware choices
- **Ubiquiti router and access point** because forking over some dough for reliable, rock-solid prosumer networking gear makes everything run smoothly. And because hearing one less complaint (dropped wifi signal) from the girlfriend is priceless. \*sigh\*
- **Ubiquiti router and access point** because forking over some dough for reliable, rock-solid prosumer networking gear makes everything run smoothly. And because hearing one less complaint (dropped WiFi signal) from the girlfriend is priceless. 🤕
- **Uninterruptible power supply** to ride over transient power failures.
- **Z-Wave** for reliability and guaranteed interoperability between vendors (unlike Zigbee...)
- **Wifi** for its cheapness, omnipresence and non requirement of vendor-specific hubs.
- **WiFi** for its cheapness, omnipresence and non requirement of vendor-specific hubs.


### Configuration
Expand All @@ -277,7 +278,7 @@ Tasks are defined in the [issue queue][link-issues] and the development progress
- **[Raspberry Pi 3 Model B](https://www.raspberrypi.org/products/raspberry-pi-3-model-b/)** running Hass.io.
- **[Aeotec Z-Stick Gen5](https://aeotec.com/z-wave-usb-stick)** Z-Wave USB dongle.
- **[NooElec NESDR SMArt](http://www.nooelec.com/store/nesdr-smart.html)** RTL-SDR (software-defined radio) USB dongle for reading AcuRite sensors.
- **[Milight iBox2 Wifi Bridge](https://www.futlight.com/productdetails.aspx?id=239&typeid=125)** for kitchen RF LED strip controllers, using [LimitlessLED](https://home-assistant.io/components/light.limitlessled/) integration.
- **[Milight iBox2 WiFi Bridge](https://www.futlight.com/productdetails.aspx?id=239&typeid=125)** for kitchen RF LED strip controllers, using [LimitlessLED](https://home-assistant.io/components/light.limitlessled/) integration.


### Physical devices
Expand All @@ -289,8 +290,8 @@ Tasks are defined in the [issue queue][link-issues] and the development progress
- **[Milight CCT LED RF Controller](https://www.futlight.com/productdetails.aspx?id=293&typeid=146)** for white-adjustable undercabinet kitchen lights (x4), connected to appropriate UL-listed power supplies.
- **[24V 3014 Warm White Cool White LED Strip](http://ledmontreal.com/en/led-strips-without-accessories/24v-led-strips-without-accessories/cct-adjustable-led-strip.html)** encased in custom cut and assembled [light-diffusing aluminum profiles](http://ledmontreal.com/en/led-bars-and-profiles-led-montreal/continuous-lighting-aluminum-profile.html), connected to above RF controllers.
- **[Adalight](https://learn.adafruit.com/adalight-diy-ambient-tv-lighting)** DIY 100-dots TV backlighting controlled by [Lightpack+Prismatik](https://github.com/psieg/Lightpack) on HTPC.
- **Fairy lights** via TP-Link wifi outlets (x3).
- **DIY LED nightstand** via TP-Link wifi outlet.
- **Fairy lights** via TP-Link WiFi outlets (x3).
- **DIY LED nightstand** via TP-Link WiFi outlet.


#### Sensors
Expand All @@ -307,8 +308,8 @@ Tasks are defined in the [issue queue][link-issues] and the development progress

#### Switches and other devices
- **[TP-Link Smart Wi-Fi Plug Mini outlets](http://www.tp-link.com/us/products/details/cat-5516_HS105.html)** to control dumb devices (x6).
- **[Frigidaire dehumidifier](http://www.dehumidifierbuyersguide.com/frigidaire-ffad7033r1-review)** via TP-Link wifi outlet.
- **Oscillating fan** via TP-Link wifi outlet.
- **[Frigidaire dehumidifier](http://www.dehumidifierbuyersguide.com/frigidaire-ffad7033r1-review)** via TP-Link WiFi outlet.
- **Oscillating fan** via TP-Link WiFi outlet.


### Software
Expand All @@ -322,7 +323,6 @@ Tasks are defined in the [issue queue][link-issues] and the development progress
- **[AppDaemon](https://github.com/home-assistant/appdaemon)** for HADashboard tablet UI.
- **[Bluetooth BCM43xx](https://home-assistant.io/addons/bluetooth_bcm43xx)** to use Raspberry Pi's bluetooth.
- **[Flicd](https://github.com/pschmitt/hassio-addons)** to connect with Flic bluetooth buttons.
- **[Homebridge](https://github.com/hassio-addons/addon-homebridge)** to control non-HomeKit compatible devices using iPhones.
- **[Mosquitto MQTT broker](https://home-assistant.io/addons/mosquitto)** for standard IoT messaging.
- **[RTL_433 to MQTT Bridge](https://github.com/james-fry/hassio-addons)** to receive and decode AcuRite radio signals.
- **[Samba share](https://home-assistant.io/addons/samba)** for configuration file sharing.
Expand All @@ -344,8 +344,11 @@ In an empty directory, type:

```shell
git clone --recurse-submodules git@github.com:renemarc/home-assistant-config.git .

cp secrets-dummy.yaml secrets.yaml

cp appdaemon/secrets-dummy.yaml appdaemon/secrets.yaml

echo "secrets.yaml filter=secret merge=keepMine" > .gitattributes
```

Expand All @@ -370,7 +373,7 @@ Image references.
[img-github-release]:https://img.shields.io/github/release/renemarc/home-assistant-config/all.svg
[img-repo-size]:https://img.shields.io/github/repo-size/renemarc/home-assistant-config.svg
[img-code-size]:https://img.shields.io/github/languages/code-size/renemarc/home-assistant-config.svg
[img-ha-version]:https://img.shields.io/badge/tested_on_Home_Assistant-0.72-53c1f1.svg
[img-ha-version]:https://img.shields.io/badge/tested_on_Home_Assistant-0.72.1-53c1f1.svg
[img-hassio]:https://img.shields.io/badge/config_for-Hass.io-53c1f1.svg
[img-license]:https://img.shields.io/github/license/renemarc/home-assistant-config.svg

Expand All @@ -383,5 +386,5 @@ Link references.
[link-board]:https://github.com/renemarc/home-assistant-config/projects/1
[link-travis-ci]:https://travis-ci.org/renemarc/home-assistant-config
[link-hassio]:https://home-assistant.io/hassio/
[link-ha-version]:https://github.com/home-assistant/home-assistant/tree/0.72.0
[link-ha-version]:https://github.com/home-assistant/home-assistant/tree/0.72.1
[link-license]:LICENSE.txt
4 changes: 2 additions & 2 deletions appdaemon/custom_css/modern/variables.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@
#

head_includes:
- <! Refresh every 30 minutes to avoid memory issues with slideshows. ->
- <meta http-equiv="Refresh" content="1800">
- <! Refresh every 15 minutes to avoid memory issues with slideshows. ->
- <meta http-equiv="Refresh" content="900">

#
# Custom body includes - should be a YAML List, e.g.:
Expand Down
6 changes: 3 additions & 3 deletions configuration.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -213,9 +213,9 @@ light: !include_dir_merge_list lights/
logger:
default: warning
logs:
aiohttp.server: critical
custom_components.display: critical
homeassistant.components.camera.generic: fatal
aiohttp.server: critical # EBOX newer component bug.
custom_components.display: critical # When tablet is offline.
homeassistant.helpers.entity: fatal # EBOX legacy component bug.


#
Expand Down
23 changes: 0 additions & 23 deletions customize.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,6 @@ light.bedroom:
entities['sensor.ceiling_effect_loaded'].state
: null;
icon: mdi:led-strip
homebridge_hidden: false
slider_theme:
max: 255
min: 0
Expand All @@ -169,7 +168,6 @@ light.countertop:
Math.round(1000000 / attributes.color_temp / 50) * 50 + ' K @ ' +
Math.round(attributes.brightness / 255 * 100) + '%'
: null;
homebridge_hidden: false
icon: mdi:border-top
assumed_state: false
slider_theme:
Expand All @@ -184,7 +182,6 @@ light.island:
Math.round(1000000 / attributes.color_temp / 50) * 50 + ' K @ ' +
Math.round(attributes.brightness / 255 * 100) + '%'
: null;
homebridge_hidden: false
icon: mdi:table-column
assumed_state: false
slider_theme:
Expand All @@ -199,7 +196,6 @@ light.headboard:
entities['sensor.bed_effect_loaded'].state
: null;
icon: mdi:gate
homebridge_hidden: false
slider_theme:
max: 255
min: 0
Expand All @@ -211,14 +207,12 @@ light.lightpack:
return (state === 'on' && entities['sensor.lightpack_effect_loaded'].state) ?
entities['sensor.lightpack_effect_loaded'].state
: null;
homebridge_hidden: false
icon: mdi:television
light.lounge:
extra_data_template: >-
return (state === 'on' && entities['sensor.ceiling_effect_loaded'].state) ?
entities['sensor.ceiling_effect_loaded'].state
: null;
homebridge_hidden: false
icon: mdi:led-strip
slider_theme:
max: 255
Expand All @@ -232,7 +226,6 @@ light.microwave:
Math.round(1000000 / attributes.color_temp / 50) * 50 + ' K @ ' +
Math.round(attributes.brightness / 255 * 100) + '%'
: null;
homebridge_hidden: false
icon: mdi:gradient
assumed_state: false
slider_theme:
Expand All @@ -246,7 +239,6 @@ light.middle:
return (state === 'on' && entities['sensor.ceiling_effect_loaded'].state) ?
entities['sensor.ceiling_effect_loaded'].state
: null;
homebridge_hidden: false
icon: mdi:led-strip
slider_theme:
max: 255
Expand Down Expand Up @@ -274,7 +266,6 @@ light.sink:
Math.round(1000000 / attributes.color_temp / 50) * 50 + ' K @ ' +
Math.round(attributes.brightness / 255 * 100) + '%'
: null;
homebridge_hidden: false
icon: mdi:water-pump
assumed_state: false
slider_theme:
Expand Down Expand Up @@ -303,7 +294,6 @@ light.underbed:
entities['sensor.bed_effect_loaded'].state
: null;
icon: mdi:hotel
homebridge_hidden: false
slider_theme:
max: 255
min: 0
Expand Down Expand Up @@ -359,7 +349,6 @@ sensor.average_temperature:
group.temperature:
friendly_name: Average
sensor.bedroom_humidity:
homebridge_hidden: false
icon: mdi:water-percent
group:
group.bedroom:
Expand All @@ -368,7 +357,6 @@ sensor.bedroom_humidity:
friendly_name: Bedroom
icon: mdi:hotel
sensor.bedroom_temperature:
homebridge_hidden: false
icon: mdi:thermometer
group:
group.bedroom:
Expand All @@ -377,7 +365,6 @@ sensor.bedroom_temperature:
friendly_name: Bedroom
icon: mdi:hotel
sensor.lounge_humidity:
homebridge_hidden: false
icon: mdi:water-percent
group:
group.lounge:
Expand All @@ -386,7 +373,6 @@ sensor.lounge_humidity:
friendly_name: Lounge
icon: mdi:sofa
sensor.lounge_temperature:
homebridge_hidden: false
icon: mdi:thermometer
group:
group.lounge:
Expand Down Expand Up @@ -530,13 +516,10 @@ sensor.disk_use_percent:
entities['sensor.disk_free_home'].attributes['unit_of_measurement'] +
' available';
sensor.ebox_download_before_offpeak:
homebridge_hidden: false
friendly_name: Downloads
sensor.ebox_upload_before_offpeak:
homebridge_hidden: false
friendly_name: Uploads
sensor.ebox_usage:
homebridge_hidden: false
friendly_name: Monthly usage
sensor.ipv4_address_eth0:
friendly_name: Local IP Address
Expand Down Expand Up @@ -655,27 +638,21 @@ script.wake_up:
# Switches
#
switch.bedroom_fan:
homebridge_hidden: false
icon: mdi:fan
group:
group.bedroom:
friendly_name: Fan
switch.bedside_light:
homebridge_hidden: false
icon: mdi:creation
switch.dehumidifier:
homebridge_hidden: false
icon: mdi:water-off
confirm_controls_show_lock: true
switch.nightstand_light:
homebridge_hidden: false
icon: mdi:page-layout-body
switch.souvenirs_light:
homebridge_hidden: false
friendly_name: Souvenirs Light
icon: mdi:trophy
switch.window_light:
homebridge_hidden: false
icon: mdi:creation


Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ version: '3'
services:
hass:
container_name: homeassistant
image: homeassistant/home-assistant:0.72.0
image: homeassistant/home-assistant:0.72.1
restart: unless-stopped
env_file:
- docker/env
Expand Down
Loading

0 comments on commit e1c3bd6

Please sign in to comment.