Skip to content

Commit cd70450

Browse files
committed
Update info.md, links, formatting
1 parent b981258 commit cd70450

File tree

11 files changed

+31
-26
lines changed

11 files changed

+31
-26
lines changed

.devcontainer/devcontainer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// See https://aka.ms/vscode-remote/devcontainer.json for format details.
22
{
33
"image": "ludeeus/container:integration-debian",
4-
"name": "LedFX-Remote integration development",
4+
"name": "LedFx-Remote integration development",
55
"context": "..",
66
"appPort": [
77
"9123:8123"

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
__pycache__
22
pythonenv*
3+
.vscode/settings.json

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
![logo](https://user-images.githubusercontent.com/28861537/99007089-cac6e100-2543-11eb-99d3-01bf0b487d29.png)
99

10-
[Custom Integration](https://github.com/hacs/integration) for [Home Assistant](https://github.com/home-assistant) to control any (local/remote) [LedFx-server](https://github.com/ahodges9/LedFx)
10+
[Custom Integration](https://github.com/hacs/integration) for [Home Assistant](https://github.com/home-assistant) to control any (local/remote) [LedFx-server](https://github.com/LedFx/LedFx)
1111

1212
---
1313

@@ -32,11 +32,11 @@
3232

3333
## Requirements:
3434

35-
- [LedFx](https://github.com/ahodges9/LedFx/tree/dev)
36-
- minimum version: v0.84 (so atm you need the dev-branch or ledfx-dev)
35+
- [LedFx](https://github.com/LedFx/LedFx/tree/dev)
36+
- minimum version: v0.9.0 (so atm you need the dev-branch)
3737
- with at least one scene setup
3838
- the ledfx config.yaml file defines your host as 127.0.0.1 by default. The host needs to be changed to 0.0.0.0 in order for this integration to function properly.
39-
- [LedFx Docs](https://ledfx.readthedocs.io/en/docs/)
39+
- [LedFx Docs](https://ledfx.readthedocs.io/en/latest/)
4040
- [hass](https://github.com/home-assistant) - (HomeAssistant)
4141
- [HACS](https://hacs.xyz/) - (HomeAssistantCommunityStore)
4242

@@ -57,7 +57,7 @@
5757

5858
- Add integration to Home Assistant:
5959

60-
- In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "LedFX Remote"
60+
- In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "LedFx Remote"
6161

6262
- Configuration is done in the UI
6363
- Add the IP of the machine running LedFx to the "Host" field
@@ -134,7 +134,7 @@ With Subdevices:
134134

135135
## Credits
136136

137-
[![ledfx-github](https://img.shields.io/badge/Github-LedFX-blue.svg?logo=github&logoColor=white)](https://github.com/ahodges9/LedFx/tree/dev/ledfx) [![ledfx-discord](https://img.shields.io/badge/Discord-LedFX-blue.svg?logo=discord&logoColor=white)](https://discord.gg/wJ755dY) [![wled-github](https://img.shields.io/badge/Github-WLED-blue.svg?logo=github&logoColor=white)](https://github.com/Aircoookie/WLED) [![wled-discord](https://img.shields.io/badge/Discord-WLED-blue.svg?logo=discord&logoColor=white)](https://discord.gg/KuqP7NE)
137+
[![ledfx-github](https://img.shields.io/badge/Github-LedFx-blue.svg?logo=github&logoColor=white)](https://github.com/LedFx/LedFx/tree/dev/ledfx) [![ledfx-discord](https://img.shields.io/badge/Discord-LedFx-blue.svg?logo=discord&logoColor=white)](https://discord.gg/wJ755dY) [![wled-github](https://img.shields.io/badge/Github-WLED-blue.svg?logo=github&logoColor=white)](https://github.com/Aircoookie/WLED) [![wled-discord](https://img.shields.io/badge/Discord-WLED-blue.svg?logo=discord&logoColor=white)](https://discord.gg/KuqP7NE)
138138

139139
[![homeassistant-github](https://img.shields.io/badge/Github-HomeAssistant-blue.svg?logo=github&logoColor=white)](https://github.com/home-assistant) [![hacs-github](https://img.shields.io/badge/Github-HACS-blue.svg?logo=github&logoColor=white)](https://github.com/hacs/) [![blueprint-github](https://img.shields.io/badge/Github-blueprint-blue.svg?logo=github&logoColor=white)](https://github.com/custom-components/blueprint)
140140

custom_components/ledfxrm/binary_sensor.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""Binary sensor platform for ledfxrm."""
2-
from homeassistant.components.binary_sensor import BinarySensorEntity
2+
from homeassistant.components.binary_sensor import BinarySensorEntity
33

44
from custom_components.ledfxrm.const import (
55
BINARY_SENSOR,
@@ -22,10 +22,11 @@ class LedfxrmBinarySensor(LedfxrmEntity, BinarySensorEntity ):
2222
def unique_id(self):
2323
"""Return a unique ID to use for this entity."""
2424
return self.config_entry.entry_id + '_status'
25+
2526
@property
2627
def name(self):
2728
"""Return the name of the binary_sensor."""
28-
return f"LedFX Server-Status"
29+
return f"LedFx Server-Status"
2930

3031
@property
3132
def device_class(self):

custom_components/ledfxrm/const.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""Constants for ledfxrm."""
22
# Base component constants
3-
NAME = "LedFX ReMote"
3+
NAME = "LedFx ReMote"
44
DOMAIN = "ledfxrm"
55
DOMAIN_DATA = f"{DOMAIN}_data"
66
VERSION = "0.2.4"

custom_components/ledfxrm/light.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ def unique_id(self):
8585
@property
8686
def name(self):
8787
"""Return the name of the light."""
88-
return "LedFX Scene-Selector"
88+
return "LedFx Scene-Selector"
8989

9090
@property
9191
def icon(self):

custom_components/ledfxrm/manifest.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"domain": "ledfxrm",
3-
"name": "LedFX Remote",
3+
"name": "LedFx Remote",
44
"documentation": "https://github.com/YeonV/ledfxrm",
55
"issue_tracker": "https://github.com/YeonV/ledfxrm/issues",
66
"dependencies": ["http"],

custom_components/ledfxrm/translations/en.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
"config": {
33
"step": {
44
"user": {
5-
"title": "LedFX Remote - Setup",
6-
"description": "Welcome\nPlease make sure you meet the requirements:\n- LedFX Server >0.7 up and running\n- At lease one scene defined in LedFX\n- Change host in ledfx-confi-yaml from 127.0.0.1 to your IP\n (maybe 0.0.0.0 also work)\n alternativly you can start it with `ledfx --host 0.0.0.0`\n\nIf you need help with the configuration have a look here: https://github.com/YeonV/ledfxrm",
5+
"title": "LedFx Remote - Setup",
6+
"description": "Welcome\nPlease make sure you meet the requirements:\n- LedFx Server >0.7 up and running\n- At lease one scene defined in LedFx\n- Change host in ledfx-confi-yaml from 127.0.0.1 to your IP\n (maybe 0.0.0.0 also work)\n alternativly you can start it with `ledfx --host 0.0.0.0`\n\nIf you need help with the configuration have a look here: https://github.com/YeonV/ledfxrm",
77
"data": {
88
"thehost": "192.168.1.56",
99
"theport": "8888",
@@ -22,7 +22,7 @@
2222
}
2323
},
2424
"user_2": {
25-
"title": "LedFX Remote - Advanced Setup",
25+
"title": "LedFx Remote - Advanced Setup",
2626
"description": "https://github.com/YeonV/ledfxrm",
2727
"data": {
2828
"thehost": "192.168.1.56",
@@ -42,7 +42,7 @@
4242
}
4343
},
4444
"error": {
45-
"auth": "Cannot connect to LedFX."
45+
"auth": "Cannot connect to LedFx."
4646
},
4747
"abort": {
4848
"single_instance_allowed": "Only a single configuration of Ledfxrm is allowed."

docs/lovelace-ui.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ cards:
1313
- entity: sensor.ledfxrm_3
1414
state_color: false
1515
show_name: false
16-
title: LedFX ReMote
16+
title: LedFx ReMote
1717
theme: Caule Black Aqua Glass
1818
- type: horizontal-stack
1919
cards:

hacs.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "LedFX Remote",
2+
"name": "LedFx Remote",
33
"render_readme": true,
44
"domains": [
55
"binary_sensor",

info.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,35 @@
77

88
![logo](https://user-images.githubusercontent.com/28861537/99007089-cac6e100-2543-11eb-99d3-01bf0b487d29.png)
99

10-
[Custom Integration](https://github.com/hacs/integration) for [Home Assistant](https://github.com/home-assistant) to control any (local/remote) [LedFx-server](https://github.com/ahodges9/LedFx)
10+
[Custom Integration](https://github.com/hacs/integration) for [Home Assistant](https://github.com/home-assistant) to control any (local/remote) [LedFx-server](https://github.com/LedFx/LedFx)
1111

1212
---
1313

1414
## Main Features
1515

1616
### LedFx Remote
1717

18-
- Start and stop the LedFx server from inside Home Assistant!
19-
- Select your LedFx scene
20-
- Display the number of devices connected to LedFx
18+
- Select your LedFx scene from inside Home Assistant!
19+
- Display the number of scenes/devices/pixels connected to LedFx
20+
- Start and stop the LedFx server (custom Endpoint required!)
2121

2222
### LedFx Device Remote
2323

2424
- Toggle the power for devices configured in LedFx
25+
- Display number of pixels per device
26+
- Display IP per device
27+
- Display current running effect-name
2528

2629
| Default | With Devices |
2730
|:-------:|:------------:|
2831
| ![tile](https://github.com/YeonV/ledfxrm/raw/main/docs/tile.png) | ![tile_adv](https://github.com/YeonV/ledfxrm/raw/main/docs/tile_adv.png) |
2932

3033
## Requirements:
3134

32-
- [LedFX](https://github.com/ahodges9/LedFx) > v0.7
35+
- [LedFx](https://github.com/LedFx/LedFx/tree/dev) > v0.9.0
3336
- with at least one scene setup
3437
- the ledfx config.yaml file defines your host as 127.0.0.1 by default. The host needs to be changed to 0.0.0.0 in order for this integration to function properly
35-
- [LedFx Docs](https://ledfx.readthedocs.io/en/docs/)
38+
- [LedFx Docs](https://ledfx.readthedocs.io/en/latest/)
3639
- [hass](https://github.com/home-assistant) - (HomeAssistant)
3740
- [HACS](https://hacs.xyz/) - (HomeAssistantCommunityStore)
3841

@@ -42,7 +45,7 @@
4245

4346
- Click "Install"
4447
- Restart Home Assistant for the changes to take effect
45-
- In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "LedFX Remote"
48+
- In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "LedFx Remote"
4649
- Configuration is done in the UI
4750

4851
{% endif %}
@@ -51,7 +54,7 @@
5154

5255
## Credits
5356

54-
[![ledfx-github](https://img.shields.io/badge/Github-LedFX-blue.svg?logo=github&logoColor=white)](https://github.com/ahodges9/LedFx/tree/dev/ledfx) [![ledfx-discord](https://img.shields.io/badge/Discord-LedFX-blue.svg?logo=discord&logoColor=white)](https://discord.gg/wJ755dY) [![wled-github](https://img.shields.io/badge/Github-WLED-blue.svg?logo=github&logoColor=white)](https://github.com/Aircoookie/WLED) [![wled-discord](https://img.shields.io/badge/Discord-WLED-blue.svg?logo=discord&logoColor=white)](https://discord.gg/KuqP7NE)
57+
[![ledfx-github](https://img.shields.io/badge/Github-LedFx-blue.svg?logo=github&logoColor=white)](https://github.com/LedFx/LedFx/tree/dev) [![ledfx-discord](https://img.shields.io/badge/Discord-LedFx-blue.svg?logo=discord&logoColor=white)](https://discord.gg/xyyHEquZKQ) [![wled-github](https://img.shields.io/badge/Github-WLED-blue.svg?logo=github&logoColor=white)](https://github.com/Aircoookie/WLED) [![wled-discord](https://img.shields.io/badge/Discord-WLED-blue.svg?logo=discord&logoColor=white)](https://discord.gg/KuqP7NE)
5558

5659
[![homeassistant-github](https://img.shields.io/badge/Github-HomeAssistant-blue.svg?logo=github&logoColor=white)](https://github.com/home-assistant) [![hacs-github](https://img.shields.io/badge/Github-HACS-blue.svg?logo=github&logoColor=white)](https://github.com/hacs/) [![blueprint-github](https://img.shields.io/badge/Github-blueprint-blue.svg?logo=github&logoColor=white)](https://github.com/custom-components/blueprint)
5760

0 commit comments

Comments
 (0)