|
1 | | -# Panda Status |
| 1 | +<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> |
| 3 | + <br /><br /><strong>Panda Status</strong> |
| 4 | +</h1> |
2 | 5 |
|
3 | | -Control your BigTreeTech Panda Status via Home Assistant. |
| 6 | +_Control your BigTreeTech Panda Status via Home Assistant_ |
4 | 7 |
|
5 | | -## What? |
| 8 | +[](https://github.com/hacs/integration) |
| 9 | + |
| 10 | + |
6 | 11 |
|
7 | | -This repository contains multiple files, here is a overview: |
| 12 | +--- |
8 | 13 |
|
9 | | -File | Purpose | Documentation |
10 | | --- | -- | -- |
11 | | -`.devcontainer.json` | Used for development/testing with Visual Studio Code. | [Documentation](https://code.visualstudio.com/docs/remote/containers) |
12 | | -`.github/ISSUE_TEMPLATE/*.yml` | Templates for the issue tracker | [Documentation](https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository) |
13 | | -`custom_components/panda_status/*` | Integration files, this is where everything happens. | [Documentation](https://developers.home-assistant.io/docs/creating_component_index) |
14 | | -`CONTRIBUTING.md` | Guidelines on how to contribute. | [Documentation](https://help.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors) |
15 | | -`LICENSE` | The license file for the project. | [Documentation](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository) |
16 | | -`README.md` | The file you are reading now, should contain info about the integration, installation and configuration instructions. | [Documentation](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) |
17 | | -`requirements.txt` | Python packages used for development/lint/testing this integration. | [Documentation](https://pip.pypa.io/en/stable/user_guide/#requirements-files) |
| 14 | +<!-- markdownlint-disable --> |
| 15 | +## Project Status[](#project-status) |
| 16 | + |
| 17 | +<table class="no-border"> |
| 18 | + <tr> |
| 19 | + <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> |
| 20 | + <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> |
| 21 | + </tr> |
| 22 | +</table> |
| 23 | + |
| 24 | +--- |
| 25 | + |
| 26 | +## Introduction |
| 27 | + |
| 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). |
| 29 | + |
| 30 | +## Installation |
| 31 | + |
| 32 | +Recommended to be installed via [HACS](https://github.com/hacs/integration) |
| 33 | + |
| 34 | +1. Go to HACS -> Integrations |
| 35 | +2. [Add this repo to your HACS custom repositories](https://hacs.xyz/docs/faq/custom_repositories) |
| 36 | +3. Search for `Panda Status` and install. |
| 37 | +4. Restart Home Assistant |
| 38 | +5. Setup via the configuration flow (YAML is not supported) |
0 commit comments