smarties

所属分类:快速开发平台
开发工具:JavaScript
文件大小:0KB
下载次数:0
上传日期:2023-11-23 09:08:45
上 传 者sh-1993
说明:  覆盆子pi、本地数据和开源的家庭自动化中心
(Home automation hub for raspberry pi, local data and open source)

文件列表:
.eslintignore (31, 2023-11-23)
.eslintrc.json (1877, 2023-11-23)
.nodemon.json (88, 2023-11-23)
LICENSE (1293, 2023-11-23)
SmartiesRunner.js (4042, 2023-11-23)
SmartiesRunnerConstants.js (234, 2023-11-23)
data/ (0, 2023-11-23)
data/config.json.default (1228, 2023-11-23)
data/ssl/ (0, 2023-11-23)
data/ssl/cert.pem (985, 2023-11-23)
data/ssl/key.pem (1704, 2023-11-23)
doc/ (0, 2023-11-23)
doc/DOCUMENTATION.md (487297, 2023-11-23)
doc/PLUGIN.md (35004, 2023-11-23)
doc/PUBLIC-APIS.md (173268, 2023-11-23)
doc/architecture.png (21581, 2023-11-23)
doc/camera.png (6932465, 2023-11-23)
doc/dashboard-light.png (817290, 2023-11-23)
doc/dashboard.png (1161106, 2023-11-23)
doc/loading.png (145792, 2023-11-23)
doc/login.png (3851396, 2023-11-23)
doc/logo-gitlab.png (85308, 2023-11-23)
doc/logo.png (43116, 2023-11-23)
doc/scenario.png (789398, 2023-11-23)
doc/sensors.png (438721, 2023-11-23)
doc/signals.png (601500, 2023-11-23)
doc/stats.png (486202, 2023-11-23)
docker/ (0, 2023-11-23)
docker/app/ (0, 2023-11-23)
docker/app/Dockerfile (2037, 2023-11-23)
docker/app/build-publish.sh (734, 2023-11-23)
docker/app/run.sh (234, 2023-11-23)
docker/ci/ (0, 2023-11-23)
docker/ci/Dockerfile-buster (655, 2023-11-23)
docker/ci/Dockerfile-stretch (593, 2023-11-23)
docker/ci/build-publish.sh (1131, 2023-11-23)
installer/ (0, 2023-11-23)
... ...

# smarties.io *This project is archived* [smarties.le-programmeur.com](https://smarties.le-programmeur.com) Smarties.io is a **complete home automation system**. It allows you to **use multiple devices brands and orchestrate them together**, *for example you can turn on your Philips Hue lights with a Chacon switch*. It is free and open source and use Node.JS which is light, powerful and accessible. Smarties.io use Ngrok secured tunnel and can be accessed from everywhere without configuring your router, even over a 4G router. No cloud - **All data is stored on the local device** ! Yes, your privacy is very important. The system will only transmit smarties ID, boot date and tunnel url to a gateway. Those informations are needed to access system anywhere around the world. The application can easily run on a **Raspberry PI** which implies a **really cheap home automation system**. For developers, you can easily **create plugins**, lot of APIs are available and you can add a specific camera model or new light system. The most important informations are presented with tiles on a personal dashboard. ![](doc/dashboard.png) ## Installation on Linux Debian / Raspbian ### Requirements - Linux Raspberry PI 2 or 3 (armv7+ arch) or a x86_64 PC - Debian or Raspbian stretch and above curl -sSL https://smarties.le-programmeur.com/install-rep.sh | bash ## Supported features #### Radio communication devices (433.92 - Chacon, Zigbee - Philips, Xiaomi aqara, Ikea Trfri, ...) Using a RFLink will allow you to control lights and sensors for a really interesting price. Note that you'll need to buy a USB Gateway (http://www.rflink.nl) to access this feature. Using a Conbee II USB key will allow you to control Zigbee lights, sensors and switches. ##### Philips Hue Control Philips Hue lights, state and colors, for example in combination with 433 Mhz switches. ##### Aqara Supports most of Aqara devices ##### Nuki Nuki lock compatibility ##### Tuya Control Tuya outlets and lights ##### Cameras Keep an eye on your house. OpenCV is used to detect locally pre-trained models. You can be alerted when a model is detected. You can check camera history over 5 days, and 2 timelapses are generated every day : * Last 24 hours : Check in 60 sec whole past day (one picture per minute over 24h) * Season : Contemplate the evolution of seasons (one picture per day over one year) ##### Communication / messaging Receive notifications and never forget to put the trash out. Be alerted when a suspect activity occurred at home. This may need a USB Dongle with SIM card. Interact with the system by sending messages (french only). ##### Sensors Get daily / monthly / yearly statistics on your sensors : temperature, humidity, Internet throughput, ... ##### Alarm Stay cool in holidays, Smarties will keep housebreakers out. ##### Scenarios Create scenarios to automate home. For example, you can turn off all lights when nobody is at home, or prepare your coffee every morning at 7AM. Send a message if the wind blows above 35 mph. ##### IOTs Create your own cheap sensors or anything else using ESP8266 or Arduino. An Arduino framework is provided and is very easy to use. Over The Air updates available. ##### HomeKit Siri and Alexa support Use voice command to control home devices. ##### IFTTT Basic IFTTT usage with scenario triggering URL (both way). ## Developers ### Requirements #### If you need to run / compile * Node.js 14.15.1 or upper version * Mac or Linux. *Windows is not yet supported.* - On Mac, brew must be installed - On Linux, only Debian system supported, tested on x86 and ARM architectures #### If you need to run on Raspberry PI A Raspberry PI with ethernet cable plugged, or WiFI already configured. For installation in this mode, refer to the "Deployment" section of this documentation. ### Installation In console, type `npm install` and everything should go on. ### Start `npm start` Once app is started, open your browser and type https://me.smarties.le-programmeur.com/. Then, you have to login with default username `admin` and default password `admin`. *Note : If you can't log in, check logs - If dependencies installation is finished, you may retrieve your `Smarties ID` which is a 4 hexadecimal code. This information is logged just after starting. Then open browser and type https://me.smarties.le-programmeur.com/XXXX/ where `XXXX` is your smarties ID.* The web site can also be added as a progressive web app (pwa) on your smartphone. For iOS : - Open the web site with Safari - Click on 'Share' button - Click on 'Add to Home Screen' - Click on 'Add' - The app is now on available on the springboard For Android : - Open the web site with Google Chrome - Click on the three dots on the top right to unfold menu - Click on 'Add to Home screen' - The app is now on available on the springboard ### Rest API access You can list the available rest APIS with https://me.smarties.le-programmeur.com/XXXX/api/infos/ where `XXXX` is your smarties ID. ### Dev commands * `npm update` : Update dependencies * `npm run start` : Start smarties.io * `npm run dev` : Run dev server with lint * `npm run test` : Run all unit test * `npm run lint` : Check code issues * `npm run coverage` : Generate test coverage * `npm run test-ci` : Execute tests and generate test coverage * `npm run doc` : Generate code documentation * `npm run doc-apis` : Generate Public APIs documentation * `npm run build` : Build for current architecture * `npm run build-deb` : Build the deb from the build folder ## Global architecture

## Documentation ### Plugin tutorial [Read](doc/PLUGIN.md) #### Web Services API registration [Read](src/services/webservices/README.md) #### Configuration manager [Read](src/modules/confmanager/README.md) #### Threads manager [Read](src/modules/threadsmanager/README.md) #### Services [Read](src/services/README.md) #### Database manager [Read](src/modules/dbmanager/README.md) #### Translate manager [Read](src/modules/translatemanager/README.md) #### Form manager [Read](src/modules/formmanager/README.md) ### Auto generated documentation #### Public APIs [Read](doc/PUBLIC-APIS.md) #### Code documentation [Read](doc/DOCUMENTATION.md) ### Troubleshooting Nothing reported yet # License ## MIT Copyright 2020, WoodySlum 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 X 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. Except as contained in this notice, the name of the WoodySlum shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from WoodySlum.

近期下载者

相关文件


收藏者