physical-interface/README.md

31 lines
990 B
Markdown
Raw Normal View History

2020-05-06 13:58:48 +02:00
# Physical Interface
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
Software to build up an REST-API on an Arduino based microcontroller, to interact with hardware and the physical environment.
2020-05-06 17:26:39 +02:00
## Setup
First update the necessary software via typing in:
```bash
bash ./scripts/library-update.sh
bash ./scripts/board-update.sh
```
2020-05-06 14:51:58 +02:00
2020-05-07 10:32:52 +02:00
## Maintaining
### Links
The following links can be helpful for maintaining this code and understanding the domain:
#### Hardware
- https://smarthome-blogger.de/wp-content/uploads/2018/03/nodemcu-esp8266-pinout.png
#### IR
- https://github.com/crankyoldgit/IRremoteESP8266
- https://github.com/z3t0/Arduino-IRremote/blob/master/examples/IRrecvDumpV2/IRrecvDumpV2.ino
- https://daniel-ziegler.com/arduino/esp/mikrocontroller/2017/07/28/arduino-universalfernbedienung/
#### Serial Monitor
2020-05-06 13:58:48 +02:00
## License
The ["GNU AFFERO GENERAL PUBLIC LICENSE"](./LICENSE.txt) applies to this project.