diff --git a/README.md b/README.md index ad42b1c073c66453b53dfbccb8d3fa6f9bb7a31a..b582c5e246eb00462bf5158e3c9c419a5d75044b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,79 @@ Flask server for displaying multiple dashboards with custom tiles that refresh periodically. + + +## Available default tiles + +### CurrentWeatherTile +Displays the current weather condition, temperature, felt temperature and wind speed. + + + +### HourlyForecastTile +Displays the forecast for the next 12 hours including condition, temperature, rain probability and wind speed. + + + +### SevenDaysForecastTile +Displays the forecast for the next 7 days including minimum and maximum temperatures as chart as well as the condition. + + + +### SensorLineChartTile +Displays data from a given StorageLeaf sensor as a chart. + + + +### GarbageScheduleTile +Displays the next time a certain garbage type is collected. + + + + +### Additional tiles +- BoardGameTile - Display board games from your private collection grouped by player count and provide a random choice. +- ClockTile - Simple clock +- SimpleSensorValueTile - Display a sensor value from a corresponding StorageLeaf sensor. + + +## Available default services + +- WeatherService - Read data from https://openweathermap.org/ +- StorageLeafService - Retrieve sensor data from a StorageLeaf server +- IcsService - Parse events from an .ics calendar file +- JsonService - Parse information from a json file + +--- +## Credits + +### Icons +- leaf icon - made by Freepik [https://www.flaticon.com/](https://www.flaticon.com/)] +- info solid icon - "fas fa-info" from [https://fontawesome.com/]([https://fontawesome.com/]) + +### Garbage icons +- recycle bin - made by monkik from [https://www.flaticon.com/](https://www.flaticon.com/) +- apple black silhouette with a leaf - made by Freepik from [https://www.flaticon.com/](https://www.flaticon.com/) +- journal - made by Freepik from [https://www.flaticon.com/](https://www.flaticon.com/) +- trash - made by Smashicons [https://www.flaticon.com/](https://www.flaticon.com/)] + +### Fonts +- Roboto - https://fonts.google.com/specimen/Roboto +- weathericons - https://github.com/erikflowers/weather-icons + +### Javascript libraries +- gridstack.js - [https://github.com/gridstack/gridstack.js](https://github.com/socketio/socket.io) +- plotly.js - [https://plotly.com/javascript/](https://github.com/socketio/socket.io) +- weather-icons - [https://github.com/erikflowers/weather-icons](https://github.com/socketio/socket.io) +- socket.io - [https://github.com/socketio/socket.io](https://github.com/socketio/socket.io) + +### Python libraries +See `Pipfile.lock` +(This project uses some personal libraries not available on the official pypi. The source code can be found here [https://thecodelabs.de/TheCodeLabs/PythonLibs](https://thecodelabs.de/TheCodeLabs/PythonLibs)) + +--- +# Documentation + ## Page Holds multiple tiles and displays them in a grid. On mobile devices in portrait orientation the grid will be displayed as a single column. diff --git a/build/showcase/CurrentWeatherTile.PNG b/build/showcase/CurrentWeatherTile.PNG new file mode 100644 index 0000000000000000000000000000000000000000..f25a0984179b40c969a25ef08b1371165191f5fe Binary files /dev/null and b/build/showcase/CurrentWeatherTile.PNG differ diff --git a/build/showcase/GarbageScheduleTile.PNG b/build/showcase/GarbageScheduleTile.PNG new file mode 100644 index 0000000000000000000000000000000000000000..3b7c2650117af96962de42f4cffb470e38603fc6 Binary files /dev/null and b/build/showcase/GarbageScheduleTile.PNG differ diff --git a/build/showcase/HourlyForecastTile.PNG b/build/showcase/HourlyForecastTile.PNG new file mode 100644 index 0000000000000000000000000000000000000000..31dbd833d1e7d1e203ca8efabfed48f07362aa4d Binary files /dev/null and b/build/showcase/HourlyForecastTile.PNG differ diff --git a/build/showcase/SensorLineChartTile.PNG b/build/showcase/SensorLineChartTile.PNG new file mode 100644 index 0000000000000000000000000000000000000000..369697784655f4eabcd09f9295ab52ed3eb8b030 Binary files /dev/null and b/build/showcase/SensorLineChartTile.PNG differ diff --git a/build/showcase/SevenDaysForecastTile.PNG b/build/showcase/SevenDaysForecastTile.PNG new file mode 100644 index 0000000000000000000000000000000000000000..b39458f1871bdd2275e4d8d57de91c050a216817 Binary files /dev/null and b/build/showcase/SevenDaysForecastTile.PNG differ diff --git a/build/Showcase.png b/build/showcase/Showcase.png similarity index 100% rename from build/Showcase.png rename to build/showcase/Showcase.png