Skip to content

Commit

Permalink
New version
Browse files Browse the repository at this point in the history
  • Loading branch information
Dmitry Mamontov committed Jul 25, 2022
1 parent 5b2c07d commit 8ee2975
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 25 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ assignees: dmamontov

<!---
Before creating a Bug report, do the following:
Get the diagnostic data and attach it to the issue: https://github.com/dmamontov/hass-ledfx#diagnostics
Get the diagnostic data and attach it to the issue: https://github.com/dmamontov/hass-ledfx/wiki/Diagnostics
-->

**Describe the bug**
Expand Down
38 changes: 14 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,33 @@
# LedFX for Home Assistant
[![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)
[![CodeQL](https://img.shields.io/badge/CODEQL-Passing-30C854.svg?style=for-the-badge)](https://github.com/dmamontov/hass-miwifi/actions?query=CodeQL)
[![Telegram](https://img.shields.io/badge/Telegram-channel-34ABDF.svg?style=for-the-badge)](https://t.me/hass_miwifi)
[![Telegram](https://img.shields.io/badge/Telegram-channel-34ABDF.svg?style=for-the-badge)](https://t.me/hass_mamontov_tech)

Component for deep integration [LedFx](https://github.com/LedFx/LedFx) from [Home Assistant](https://www.home-assistant.io/).

## Table of Contents
- [FAQ](#faq)
- [Install](#install)
- [Config](#config)
- [Performance](#performance)
## Requirements
* LedFx version [0.10.7](https://github.com/LedFx/LedFx/releases/tag/v0.10.7)

## FAQ
**Q. What versions were tested on?**
## More info

**A.** So far only [0.10.7](https://github.com/LedFx/LedFx/releases/tag/v0.10.7)

**Q. Does it support audio settings?**

**A.** Yes, it supports

**Q. Can I change the effect settings?**

**A.** You can, for this, enable the appropriate mode from the [PRO] section. The required objects will only be available when supported by the effect.

**Q. Is Basic Auth supported?**

**A.** Yes, [OPTIONAL] support.
- [Install](https://github.com/dmamontov/hass-ledfx/wiki/Install)
- [Config](https://github.com/dmamontov/hass-ledfx/wiki/Config)
- [Entities](https://github.com/dmamontov/hass-ledfx/wiki/Entities)
- [Performance](https://github.com/dmamontov/hass-ledfx/wiki/Performance)
- [Diagnostics](https://github.com/dmamontov/hass-ledfx/wiki/Diagnostics)
- [FAQ](https://github.com/dmamontov/hass-ledfx/wiki/FAQ)

## Install
The easiest way to install the `LedFx` integration is with [HACS](https://hacs.xyz/). First install [HACS](https://hacs.xyz/) if you don’t have it yet. After installation you can find this integration in the [HACS](https://hacs.xyz/) store under integrations.
The easiest way to install the LedFx integration is with [HACS](https://hacs.xyz/). First install [HACS](https://hacs.xyz/) if you don’t have it yet. After installation you can find this integration in the [HACS](https://hacs.xyz/) store under integrations.

Alternatively, you can install it manually. Just copy and paste the content of the hass-ledfx/custom_components folder in your config/custom_components directory. As example, you will get the sensor.py file in the following path: /config/custom_components/ledfx/sensor.py. The disadvantage of a manual installation is that you won’t be notified about updates.

## Config
**Via GUI**

`Settings` > `Integrations` > `Plus` > `MiWiFi`
`Settings` > `Integrations` > `Plus` > `LedFx`

For authorization, use the ip of your router and its password
To connect, enter the ip address and port. And also if you use basic auth, enter the user and password.

❗ Via YAML (legacy way) not supported

Expand Down

0 comments on commit 8ee2975

Please sign in to comment.