PHP_SMART_HOME_V3/README.md

183 lines
4.6 KiB
Markdown
Raw Normal View History

2019-10-12 19:45:12 +00:00
<!--
*** Smart_Home by JonatanRek
*** README by revox, 2019
-->
<!-- LOGO -->
2019-10-13 18:46:52 +00:00
<br />
2019-08-23 11:43:46 +00:00
<p align="center">
2019-10-13 18:46:52 +00:00
<a href="https://github.com/GamerClassN7/Smart_Home">
<img src="./app/templates/images/icon-192x192.png" height="100" width="100">
</a>
<h3 align="center">Make your own Smart Home automation system</h3>
2019-10-30 14:19:34 +00:00
<p align="center">
2019-10-13 18:46:52 +00:00
<br>
<a href="https://github.com/GamerClassN7/Smart_Home">Explore wikis</a>
<sub><sup></sub></sup>
<a href="https://github.com/GamerClassN7/Smart_Home">Report bugs</a>
<br>
</p>
</p>
2019-10-12 19:36:52 +00:00
2019-10-13 18:46:52 +00:00
2019-10-12 19:27:41 +00:00
[![PHP](https://img.shields.io/badge/PHP-brightgreen.svg)](https://github.com/GamerClassN7/Smart_Home/search?l=php)
[![JS](https://img.shields.io/badge/JS-red.svg)](https://github.com/GamerClassN7/Smart_Home/search?l=js)
[![HTML](https://img.shields.io/badge/HTML-blue.svg)](https://github.com/GamerClassN7/Smart_Home/search?l=html)
2019-08-23 11:39:42 +00:00
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
2019-11-02 19:04:03 +00:00
[![Discord](https://img.shields.io/discord/604697675430101003.svg?color=Blue&label=Discord&logo=Discord)](https://discord.gg/XJpT3UQ)
2019-08-23 11:39:42 +00:00
2019-10-12 19:45:12 +00:00
<!-- ABOUT THE PROJECT -->
## About Smart_Home
**Smart_Home** is a home automation project suited for **ESP boards** family (including NodeMCU). It supports PWA; supports tons of sensors; has modern and elegant UI; is easily customizable; is multilangual.
#### What works with Smart_Home?
2019-10-12 19:55:55 +00:00
* temperature sensors (e.g. DHT11/22)
* humidity sensors (e.g. DHT11/22)
* light detectors
* water leak sensors
* voltage meters
* electricity consumption meters
* switches
* and many more!
2019-10-12 19:45:12 +00:00
<!-- TABLE OF CONTENTS -->
## Table of Contents
* [About Smart_Home](#about-smart_home)
* [Screenshots](#screenshots)
* [Installation](#instalation)
2019-10-13 18:46:52 +00:00
* [API](#api)
2019-10-12 19:45:12 +00:00
* [Contributing](#contributing)
* [License](#license)
* [Built With](#built-with)
* [Authors](#authors)
2019-08-23 11:39:42 +00:00
2019-10-13 18:46:52 +00:00
<!-- SCREENSHOTS -->
2019-10-12 19:36:52 +00:00
## Screenshots
### Browser (Desktop PWA)
2019-08-23 11:39:42 +00:00
2019-10-16 16:47:27 +00:00
<img src="./_README_IMG/desktop1.png" height="250" width="250"> <img src="./_README_IMG/desktop2.png" height="250" width="250"> <img src="./_README_IMG/desktop3.png" height="250" width="250">
2019-08-23 11:39:42 +00:00
### Mobile (PWA)
2019-08-23 11:39:42 +00:00
2019-10-16 16:47:27 +00:00
<img src="./_README_IMG/mobile1.png" height="250" width="250"> <img src="./_README_IMG/mobile2.png" height="250" width="250"> <img src="./_README_IMG/mobile3.png" height="250" width="250">
2019-08-23 11:39:42 +00:00
2019-10-13 18:46:52 +00:00
<!-- INSTALLATION -->
## Installation
See [Wikis](https://github.com/GamerClassN7/Smart_Home/wiki) for help about installation, usage and troubleshooting.
<!-- API -->
2019-10-12 19:36:52 +00:00
## API
2019-10-13 18:46:52 +00:00
#### POST Message (switch)
2019-08-23 11:39:42 +00:00
```
{
"token":"2"
}
```
2019-10-13 18:46:52 +00:00
#### Answer (switch)
2019-08-23 11:39:42 +00:00
```
{
"device":{
"hostname":"2",
"sleepTime":0
},
"state":"succes",
"value":"0"
}
}
```
2019-10-13 18:46:52 +00:00
#### POST Message (sensor)
2019-08-23 11:39:42 +00:00
```
{
"token":"4",
"values":{
"door":{
"value":1
}
}
}
```
2019-10-12 19:28:58 +00:00
2019-10-13 18:46:52 +00:00
#### Answer (sensor)
2019-08-23 11:39:42 +00:00
```
{
}
```
2019-10-12 20:22:24 +00:00
<!-- CONTRIBUTING -->
## Contributing
2019-10-13 07:29:11 +00:00
Contributions are what make the open source community such an amazing place to be learn, inspire, and create.
2019-10-12 20:22:24 +00:00
If you know how to fix, improve or optimze something, go ahead and contribute! Help is greatly appreciated.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Make sure everything works as intended
2019-10-13 18:46:52 +00:00
6. Open a Pull Request
2019-10-12 20:22:24 +00:00
<!-- LICENSE -->
## License
Distributed under the MIT License. See `LICENSE` for more information.
<!-- AUTHORS -->
2019-10-12 19:36:52 +00:00
## Authors
2019-10-12 19:55:55 +00:00
* [GamerClassN7](https://github.com/GamerClassN7) - Lead developer
* [Silentis](https://github.com/Silentis) - Developer
* [Xinatorus](https://github.com/Xinatorus) - Developer
* [revoxhere](https://github.com/revoxhere/) - ReadMe & Wikis
Project Link: [https://github.com/GamerClassN7/Smart_Home/](https://github.com/GamerClassN7/Smart_Home/) <br> <br>
2019-10-30 14:19:34 +00:00
<sup><sub>Tags (ignore): ESP32 ESP12 ESP08 ESP01 ESP Smart Home Automation System PWA PHP HTML JS DHT11 DHT22
2020-04-20 19:49:30 +00:00
2021-02-10 15:12:51 +00:00
## Code Statistics
Type | Files | Lines
-----|-------|-----------
php | 2 | 2298 (89%)
md | 1 | 171 (7%)
js | 1 | 64 (2%)
sh | 1 | 34 (1%)
json | 1 | 10 (0.4%)
-----|-------|-----------
All | 6 | 2577
2020-04-20 19:49:30 +00:00
## Folder structure
2020-04-27 17:36:58 +00:00
```
- /app # app specific files
2020-04-20 19:49:30 +00:00
- /controllers
- UserController.php
2020-04-27 17:36:58 +00:00
- /library # helpers etc.
2020-04-20 19:49:30 +00:00
- /models
2020-04-27 17:36:58 +00:00
- /types
- Units.php
2020-04-20 19:49:30 +00:00
- UserModal.php
- /views
- /layouts
- default.phtml
- /templates
- /components
- /pages
- Bootstrap.php
- Db.php
- Routes.php
2020-04-27 17:36:58 +00:00
- /library # framework, 3rd libraries etc.
2020-04-20 19:49:30 +00:00
- /vendor
- Controller.php
- Db.php
- Router.php
- config
- config.php /
- public
- /css
- /images
- /js
- .htaccess
- index.php
2020-04-27 17:36:58 +00:00
```