Skip to content

Commit 4309cba

Browse files
Updated README
1 parent 5a9a4ac commit 4309cba

File tree

1 file changed

+46
-11
lines changed

1 file changed

+46
-11
lines changed

README.md

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<h1 align="center" style="display: block; font-size: 2.5em; font-weight: bold; margin-block-start: 1em; margin-block-end: 1em;">
2-
<a name="logo" href="https://www.aregtech.com"><img align="center" src="https://i.imgur.com/bo7pxoH.png" alt="Panda Status style="width:100%;height:100%"/></a>
2+
<a name="logo" href="https://github.com/ping-localhost/panda-status"><img align="center" src="https://i.imgur.com/bo7pxoH.png" alt="Panda Status" style="width:100%;height:100%"/></a>
33
<br /><br /><strong>Panda Status</strong>
44
</h1>
55

@@ -11,10 +11,15 @@ _Control your BigTreeTech Panda Status via Home Assistant_
1111

1212
---
1313

14-
<!-- markdownlint-disable -->
15-
## Project Status[![](https://raw.githubusercontent.com/ping-localhost/panda-status/master/docs/img/pin.svg)](#project-status)
14+
## Overview
1615

17-
<table class="no-border">
16+
**Panda Status** is a Home Assistant custom integration for monitoring and controlling your BigTreeTech Panda Status device. It connects via WebSocket, parses messages, and exposes device data and controls to Home Assistant.
17+
18+
---
19+
20+
## Project Status
21+
22+
<table>
1823
<tr>
1924
<td><a href="https://github.com/ping-localhost/panda-status/actions/workflows/lint.yml" alt="lint"><img src="https://github.com/ping-localhost/panda-status/actions/workflows/lint.yml/badge.svg" alt="lint build"/></a></td>
2025
<td><a href="https://github.com/ping-localhost/panda-status/actions/workflows/validate.yml" alt="MS Build"><img src="https://github.com/ping-localhost/panda-status/actions/workflows/validate.yml/badge.svg" alt="MS Build"/></a></td>
@@ -23,16 +28,46 @@ _Control your BigTreeTech Panda Status via Home Assistant_
2328

2429
---
2530

26-
## Introduction
31+
## Features
32+
33+
### Sensors
34+
35+
- **WiFi AP SSID**: Shows the SSID of the device's WiFi access point.
36+
- **Device IP address**: Displays the IP address of the Panda Status device.
37+
- **Device hostname**: Shows the hostname.
38+
- **WiFi connection state**: Indicates connection status.
39+
- **Printer name**: Displays the connected printer's name.
40+
- **Printer IP address**: Shows the printer's IP.
41+
- **Printer state**: Indicates printer status.
42+
- **Firmware version**: Shows the firmware version.
43+
44+
### Switches
2745

28-
This is a very simple integration that connects to the Panda Status WebSocket, parses it messages and allows you to change certain settings (currently just the idle light on/off).
46+
- **Enable/disable WiFi AP**
47+
- **Enable/disable RGB Idle Light**
2948

3049
## Installation
3150

32-
Recommended to be installed via [HACS](https://github.com/hacs/integration)
51+
**Recommended:** Install via [HACS](https://hacs.xyz/)
3352

34-
1. Go to HACS -> Integrations
35-
2. [Add this repo to your HACS custom repositories](https://hacs.xyz/docs/faq/custom_repositories)
53+
1. Go to HACS Integrations.
54+
2. [Add this repo to your HACS custom repositories](https://hacs.xyz/docs/faq/custom_repositories).
3655
3. Search for `Panda Status` and install.
37-
4. Restart Home Assistant
38-
5. Setup via the configuration flow (YAML is not supported)
56+
4. Restart Home Assistant.
57+
5. Set up via the configuration flow (YAML is not supported).
58+
59+
## Configuration
60+
61+
After installation, add the integration via Home Assistant UI:
62+
63+
1. Go to **Settings → Devices & Services**.
64+
2. Click **Add Integration** and search for `Panda Status`.
65+
3. Follow the setup prompts.
66+
67+
## Support & Issues
68+
69+
For issues or feature requests, open an [issue on GitHub](https://github.com/ping-localhost/panda-status/issues).
70+
71+
## License
72+
73+
Distributed under the MIT License. See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)