smart-home

README

The program complex Smart House

Project site | Configurator | Mobile Gate | Node | Smart home Socket | Modbus device controller | Mobile app

Branch	Status
master
dev
docs

Attention! The project is under active development.

Overview

With the help of the software package Smart Home you can control many devices. Distributed network of devices based on software package Smart Home has no geographical boundaries and allows manage devices anywhere in the Internet through a system of nodes - microservices. You will be able to interact with these devices as if they were on your local network. Create scripts and reactions to events in the web interface of the configurator through a flexible scripting system.

The system does not require a permanent connection to the Internet, it is completely autonomous and has no dependencies on external services.

The basic principles underlying the system being developed are ease of setup, low cost of content and accessibility of the component base.

• Features
• Demo access
• Supported system
• Quick installation
  • Postgresql
• Installation for development
  • Server
• Docker
• Testing
• Support
• Contributors
• See also
• License

Features

1. The ultimate smart thing solution - server, configurator, nodes, gateway, mobile application
2. Free and open source
3. Cross-platform Linux, MacOS, Windows ...
4. Convenient WEB-configurator for fine-tuning
5. Mobile application for equipment management
6. Role system for separation of access rights
7. Programs in javaScript, coffeeScript, typeScript
8. Notification system SMS, Email, Slack, Telegram
9. modbus, mqtt, zigbee2mqtt, rpc calling
10. Autonomous system.
11. Quick backup of all data, and recovery
12. Have Docker images to enhance system security
13. Minimum consumption of resources.
14. Optimized for embedded devices like Raspberry Pi
15. 100% local home automation
16. Create and restore full backups of your whole configuration with ease
17. Management web interface integrated into Smart home
18. Alexa skills

Demo access

outdated version, not supported:
dashboard (https://board.e154.ru)

outdated version, not supported:
swagger (https://sh.e154.ru/api/v1/swagger)

user: admin@e154.ru
pass: admin

user: user@e154.ru
pass: user

Supported system

• macOS 386 10.6
• macOS amd64 10.6
• linux 386
• linux amd64
• linux arm-5
• linux arm-6
• linux arm-7
• linux arm-64
• linux mips64
• linux mips64le
• windows 386
• windows amd64

Schematic smart home map

Quick installation

Database postgresql

System Smart Home works with Postgresql database. Create a database and database user with full rights to this database. Connection parameters to the database must be specified in the configuration file. Updating the server version may require updating the database. , migrations will start automatically, manual intervention is not required.

sudo -u postgres psql
postgres=# create database mydb;
postgres=# create user myuser with encrypted password 'mypass';
postgres=# grant all privileges on database mydb to myuser;

Installation for development

install brew

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Run these two commands in your terminal to add Homebrew to your PATH:

(echo; echo 'eval "$(/opt/homebrew/bin/brew shellenv)"') >> /Users/delta54/.zprofile
eval "$(/opt/homebrew/bin/brew shellenv)"

install protobuf v3

brew update && brew install protobuf

go install \
    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway \
    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2 \
    google.golang.org/protobuf/cmd/protoc-gen-go \
    google.golang.org/grpc/cmd/protoc-gen-go-grpc

generate api stub

make server

main server install

git clone https://github.com/e154/smart-home $GOPATH/src/github.com/e154/smart-home

cd $GOPATH/src/github.com/e154/smart-home

go mod vendor

go build

./smart-home -reset
./smart-home

editing configuration files

cp conf/config.dev.json conf/config.json
cp conf/dbconfig.dev.yml conf/dbconfig.yml

run server

./smart-home

Docker

git clone https://github.com/e154/smart-home
cd smart-home
docker-compose up

connect to the database, create two smart-home databases, smart-home-gate

It's all

Testing

The system supports self-testing of internal components, and is started by the command

go test -v ./tests/...

Support

Smart home Wiki: e154.github.io/smart-home Bugs and feature requests: GitHub issues

Contributors

• Alex Filippov

All the contributors are welcome. If you would like to be the contributor please accept some rules.

• The pull requests will be accepted only in "develop" branch
• All modifications or additions should be tested

Thank you for your understanding!

See also

• OpenHub
• iridiummobile
• amx
• Home Assistant
• Majordomo

LICENSE

GPLv3 Public License