HSWroFlipdotWeather/README.md

48 lines
1.3 KiB
Markdown

![Logo](docs/flipdot.jpg)
# HSWroFlipdotWeather
Proof of concept of Hackerspace Wrocław shitposting infotainment platform service, that is currently knocking straight to [PixelRaspi](https://github.com/domints/PixelRaspi) running on Flipdot Raspi Zero.
## Environment Variables
To run this project, you will need to add the following environment variables to your .env file
`OPENWEATHER_API_KEY`
`LOCATION_ID`
`LUFTDATEN_CLOSEST_SENSOR`
for communicating with openweather and luftdaten
- `FLIPDOT_API`
- `FLIPDOT_SLOTS` - default for HSWro instance is 15
for your [PixelRaspi](https://github.com/domints/PixelRaspi)
there is also `.env.dist` file that you'll find useful that would have all of the above data.
## Deployment
To deploy this project after tweaking `Dockerfile` to fine-tune crontab inside, run
```bash
docker build -t flipdot-weather .
```
and then
```bash
docker run -d --env-file .env flipdot-weather .
```
## Roadmap
- Now it shoots straight to REST api on the flipdot raspi, but plans are to throw the rendered boards into the MQTT stream, and write a interface subscribing on the MQTT stream and shooting requests to the flipdot, and also orchestrator, that would decide what is to be shown. Now it's ready to do a harsh cron driven orchestration