README
¶
The Smart Home
| Branch | Status |
|---|---|
| master |  |
| dev |  |
| docs |  |
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
- Docker
- Support
- Contributors
- See also
- License
Features
- The ultimate smart thing solution - server, configurator, gateway
- Free and open source
- Cross-platform Linux, MacOS, Windows ...
- Convenient WEB-configurator for fine-tuning
- Powerful visual interface editor
- Organization of remote access without white IP FREE
- Role system for separation of access rights
- Plugin system
- Programs in javaScript, coffeeScript, typeScript
- Notification system SMS, Email, Slack, Telegram, Web push, html5
- Embedded MQTT server/client/bridge
- MODBUS, ZIGBEE2MQTT, rpc calling, etc
- Autonomous system.
- Telegram bots
- Automation scenarios
- Quick backup/recovery
- Have Docker images to enhance system security
- Minimum consumption of resources.
- Optimized for embedded devices like Raspberry Pi
- 100% local home automation
- Create and restore full backups of your whole configuration with ease
- Management web interface integrated into Smart home
Demo access
dashboard:
dashboard (https://gate.e154.ru:8443)
server id:
cf4463fc-2f39-4271-a034-5c0c8087c56c
user: admin@e154.ru
pass: admin
user: user@e154.ru
pass: user
openapi v3 spec:
swagger (https://gate.e154.ru:8443/#/etc/swagger)
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
Database postgresql
Editing configuration files
cp conf/config.dev.json conf/config.json
Main server install
Download the latest server version from releases
show help options
./server-linux-amd64 help
run the server
./server-linux-amd64
Docker
git clone https://github.com/e154/smart-home
cd smart-home
docker-compose up
It's all
Support
Smart home Wiki: e154.github.io/smart-home Bugs and feature requests: GitHub issues
Contributors
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
LICENSE
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
stub
Package Swagger
|
Package Swagger |
|
cmd
|
|
|
cli/commands/client
Package client The following command will run pingmq as a client, subscribing to /ping/failure/+ topic and receiving any failed ping attempts.
|
Package client The following command will run pingmq as a client, subscribing to /ping/failure/+ topic and receiving any failed ping attempts. |
|
cli/commands/server
The following commands will run pingmq as a server, pinging the 8.8.8.0/28 CIDR block, and publishing the results to /ping/success/{ip} and /ping/failure/{ip} topics every 30 seconds.
|
The following commands will run pingmq as a server, pinging the 8.8.8.0/28 CIDR block, and publishing the results to /ping/success/{ip} and /ping/failure/{ip} topics every 30 seconds. |
|
system
|
|
|
tests
|
|