home-assistant-config

:house: My Home Assistant configuration, a bit different that others :) Be sure to :star2: this repository for updates!

2,009

179

2,009

View on GitHub

Top Related Projects

core

89,283

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

hass-config

5,169

✨ A different take on designing a Lovelace UI (Dashboard)

Quick Overview

The frenck/home-assistant-config repository is a comprehensive Home Assistant configuration maintained by Franck Nijhof, a prominent figure in the Home Assistant community. This repository serves as a reference and inspiration for other Home Assistant users, showcasing advanced automation, integrations, and best practices for home automation.

Pros

Extensive and well-organized configuration with numerous examples of advanced automations and integrations
Regularly updated with the latest Home Assistant features and best practices
Includes detailed documentation and explanations for various components and setups
Serves as an excellent learning resource for both beginners and experienced Home Assistant users

Cons

May be overwhelming for newcomers due to its complexity and scale
Some configurations might be specific to Franck's setup and not directly applicable to all users
Requires a deep understanding of Home Assistant to fully utilize and adapt the configurations
The repository's size and frequent updates may make it challenging to keep up with changes

Getting Started

As this is not a code library but a configuration repository, there's no specific code to run. However, users can follow these steps to explore and learn from the repository:

Visit the repository at https://github.com/frenck/home-assistant-config
Browse through the various directories to explore different aspects of the configuration
Read the README.md file for an overview and important information
Check out the documentation folder for detailed explanations of specific setups
Use the repository as a reference when building your own Home Assistant configuration

Remember to adapt any configurations to your specific needs and hardware before implementing them in your own Home Assistant setup.

Competitor Comparisons

core

89,283

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

Pros of Home Assistant Core

Official repository for the core Home Assistant project
Extensive documentation and community support
Regular updates and feature additions

Cons of Home Assistant Core

Steeper learning curve for beginners
Less focused on specific configuration examples

Code Comparison

Home Assistant Core (configuration.yaml):

light:
  - platform: hue
    bridge_ip: 192.168.1.2
    allow_unreachable: true

Frenck's Home Assistant Config (lights.yaml):

- platform: hue
  bridge_ip: !secret hue_bridge_ip
  allow_unreachable: true
  allow_hue_groups: true

Key Differences

Purpose:
- Home Assistant Core: Main project repository
- Frenck's Config: Personal configuration example
Scope:
- Home Assistant Core: Broad, covering all aspects of the platform
- Frenck's Config: Focused on practical implementation and customization
Target Audience:
- Home Assistant Core: Developers and advanced users
- Frenck's Config: Home automation enthusiasts looking for inspiration
Content:
- Home Assistant Core: Source code, documentation, and issue tracking
- Frenck's Config: Configuration files, automations, and custom components
Contribution:
- Home Assistant Core: Open for community contributions
- Frenck's Config: Personal project, not intended for direct contributions

hass-config

5,169

✨ A different take on designing a Lovelace UI (Dashboard)

Pros of hass-config

Minimalist and aesthetically pleasing UI design
Extensive use of custom cards and animations for a polished look
Detailed documentation on setup and customization

Cons of hass-config

Less comprehensive in terms of overall home automation setup
Fewer integrations and devices compared to home-assistant-config
May require more manual configuration for advanced features

Code Comparison

home-assistant-config:

automation:
  - alias: "Turn on lights when motion detected"
    trigger:
      - platform: state
        entity_id: binary_sensor.motion_sensor
        to: "on"
    action:
      - service: light.turn_on
        entity_id: group.living_room_lights

hass-config:

input_select:
  theme:
    name: Theme
    options:
      - Default
      - Dark
      - Light
    icon: mdi:palette

The home-assistant-config example shows a typical automation setup, while hass-config focuses more on UI customization elements like theme selection.

homeassistant

1,473

Example Home Assistant Configs

Pros of homeassistant

More comprehensive documentation and explanations within the configuration files
Includes detailed setup instructions and hardware specifications
Broader range of integrations and automations showcased

Cons of homeassistant

Less frequent updates compared to home-assistant-config
Configuration structure may be more complex for beginners
Fewer custom components and add-ons demonstrated

Code Comparison

home-assistant-config:

automation:
  - alias: "Turn on lights when motion detected"
    trigger:
      platform: state
      entity_id: binary_sensor.motion_sensor
      to: 'on'
    action:
      service: light.turn_on
      entity_id: group.living_room_lights

homeassistant:

automation:
  - alias: "Motion Detected - Turn on lights"
    trigger:
      - platform: state
        entity_id: binary_sensor.motion_sensor_living_room
        to: 'on'
    action:
      - service: light.turn_on
        entity_id:
          - light.living_room_1
          - light.living_room_2

Both repositories offer valuable Home Assistant configurations, but home-assistant-config tends to be more up-to-date and streamlined, while homeassistant provides more detailed explanations and a wider range of examples. The code comparison shows similar approaches to automation, with homeassistant using a more specific entity structure.

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

Frenck's Home Assistant Configuration

Project Maintenance

What is Home Assistant?

Not familiar with Home Assistant? Oh, you're in for a treat! :wink: It's an open source smart home platform that runs locally on, for example, a Raspberry Pi. It connects to over 2,000 different devices and services, from lights and sensors to media players and EVs, all without relying on some cloud. It's one of the most active open source projects on GitHub and is backed by the Open Home Foundation.

About

Hey! :wave: This is my personal Home Assistant configuration. I'm Frenck, the lead of the Home Assistant project and Chair of the Leader Committee at the Open Home Foundation.

I like to keep things tidy, so the whole configuration is modular using Home Assistant's packages pattern. Every integration gets its own file in the integrations/ directory. No giant configuration.yaml here :sweat_smile:

Feel free to poke around, steal ideas, or get inspired. Be sure to hit the :star2: if you find it useful!

Key Features

Fully modular. Each integration lives in its own YAML file under integrations/, loaded as packages. Clean, organized, easy to find stuff.
Tested every night. This config is validated daily against the stable, beta, and dev versions of Home Assistant Core. If something is going to break, I'll know before it hits a release :muscle:
ESPHome ready. Got a dedicated directory and CI workflow for ESPHome device configurations.
Linted to the bone. yamllint, remarklint, Prettier, actionlint, and zizmor all run on every commit. Yes, I take my YAML seriously.
Automations, scripts & scenes. All split into their own directories, making it easy to manage as things grow.

Repository Structure

.
âââ configuration.yaml        # Minimal bootstrap, loads packages
âââ integrations/             # Modular integration configs (packages)
âââ automations/              # Split automation YAML files
âââ scripts/                  # Split script YAML files
âââ scenes/                   # Split scene YAML files
âââ blueprints/               # Automation & script blueprints
âââ esphome/                  # ESPHome device configurations
âââ secrets.yaml              # Secrets (not in repo)
âââ secrets.fake.yaml         # Fake secrets for CI testing

The configuration.yaml is intentionally minimal. It only loads the integrations/ directory as packages. Each integration gets its own file, keeping things clean and easy to navigate.

Contributing

I consider my personal Home Assistant configuration an active open-source project. So if you feel like adding an improvement, feel free to contribute.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! :heart_eyes:

Useful Links

Want to learn more or get involved? Here are some good starting points:

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Top Related Projects

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot