diff options
| -rw-r--r-- | README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..939dede --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# DashPanel Android App + +DashPanel is an Android app designed for use as a dedicated dashboard interface. It can display a web dashboard and send real-time battery information to a Home Assistant setup over MQTT. The app supports full-screen mode, allows preventing screen sleep, and allows for the app to be set as the default launcher for a wall-mounted or kiosk-like display setup. + +## Features + +- **WebView Dashboard**: Show a web dashboard (e.g., Home Assistant). +- **Battery Sensor Data**: Send battery information over MQTT (Currently only works with Home Assistant). +- **MQTT Integration**: Supports both MQTT 3.1.1 and MQTT 5 protocols for communication with MQTT brokers. +- **Screen Control**: Prevent the screen from turning off while the app is running. +- **Full-Screen Mode**: Display the app in full-screen mode, taking up the entire screen. +- **Launcher Mode**: Set the app as the default launcher, making it ideal for kiosk-style usage. + +## Requirements + +- **Android Version**: Android 7.0 (Nougat) or higher. + +## Building the Application + +Clone the repository and open the project in Android Studio. + +## License + +This project is licensed under the GNU GPLv2 License - see the [LICENSE](LICENSE) file for details. |