Giter VIP home page Giter VIP logo

home-automation's Introduction

Home Automation

Introduction

Here is my future home automation setup I'm working on. Everything is managed by a Home Assistant. I'm planning on using Sonoff Basic switches flashed with a custom firmware I'll soon make available on Github.

This project will be hosted on a Raspberry Pi made available through NAT/PAT rules and a dynamic DNS on my router.

Prerequisites

What you'll need to successfuly install and run this project is :

  • Git
  • Ansible
  • Python 3.x
  • A registered domain name which points to your server running Home Assistant

Installation

Start by cloning the project

git clone https://github.com/k2r79/home-automation.git

Tweak the configuration files

Before launching the main playbook, start by tweaking the configuration files in the ansible/config/ folder.
Sample files are given to guide you, they must be copied without the .sample extension to be used as a configuration baseline.

Setup your Ansible hosts

Edit the /etc/ansible/hostsfile to add your Home Assistant server as so :

[home-assistant]
<server_ip> ansible_user=root home_assistant_password=<frontend_password> domain_name=<your_domain_name> letsencrypt_email=<your_letsencrypt_email> [telegram_api_key=<telegram_api_key>]

For the two last Telegram parameters see this tutorial.

Setup a dynamic DNS and NAT/PAT rules

Before launching the Ansible playbooks you must setup a dynamic DNS and some NAT/PAT rules on your router.

You'll need to map the following ports to your server :

  • 8123 -> 443 for HTTPS
  • 1883 -> 1883 for the MQTT Broker

Launch the Ansible playbook

By running the following command ansible-playbook ansible/playbooks/main.yml from the project's root directory.

home-automation's People

Contributors

vincentkelleher avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.