iot-backend/README.md

53 lines
1.5 KiB
Markdown
Raw Normal View History

2023-02-07 16:55:21 +01:00
# IoT Platform
## Docker
First install DockerDesktop and `docker-compose`:
2023-02-15 09:50:11 +01:00
- https://www.docker.com/products/docker-desktop/
- https://docs.docker.com/compose/install/
Then you can export a path to mount as a volume and spin up the containers:
2023-02-07 16:55:21 +01:00
```sh
export DATA_DIR = /some/path/to/mount
2023-02-07 16:55:21 +01:00
docker-compose --file software/container/docker-compose.yml up
```
2023-02-15 09:50:11 +01:00
### Mosquitto
```sh
mosquitto_sub -h localhost -t '#' -p 1883
mosquitto_pub -h localhost -p 1883 -t '/' -m $(date --utc +%s)
```
2023-02-27 18:15:46 +01:00
There is also a *very* usefuly tool to debug MQTT: [MQTT Explorer](https://github.com/thomasnordquist/MQTT-Explorer/), that is also available at [mqtt-explorer.com](https://mqtt-explorer.com/).
### Node-RED
NodeRed is running here: http://localhost:1880/
A simple introduction to Node-RED can be found - along with the nodes / the code - in [this repository, please have a look](./software/flow/README.md)!
2023-02-23 17:54:25 +01:00
### InfluxDB
2023-02-23 17:53:38 +01:00
2023-02-23 17:54:25 +01:00
InfluxDb is running here: http://localhost:8086/
### Grafana
You can login to Grafana: http://localhost:3000/login (admin:admin)
2023-02-23 17:34:43 +01:00
Have a look at the [HowTo in this repository](./software/dashboard/README.md).
2023-02-22 16:18:17 +01:00
## Hardware
We are using HelTec Automation Wirelsess Sticks ESP32 Dev-Boards.
2023-02-23 17:46:16 +01:00
See the [documentation in this repository](./hardware/README.md).
2023-02-13 18:45:43 +01:00
2023-02-18 17:22:40 +01:00
## Hardware sensors
2023-02-20 18:22:27 +01:00
* [Energy Monitor](./software/firmware/energy-monitor/README.md)
2023-02-26 18:28:15 +01:00
* [Plant Monitor](./software/firmware/plant-monitor/README.md)
2023-02-23 16:50:38 +01:00
* [Shelly Example](./software/firmware/shelly-monitor/README.md)