aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 939dedee5f37cf3b5b8373c0e4e00e5487d1f50d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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.