Skip to content

Commit 36d2494

Browse files
authored
Update readme.md
1 parent 7b14e11 commit 36d2494

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

readme.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Then to use this in a card place the following in your entity card:
2424
| type | String | Yes | none | custom:fan-control-entity-row |
2525
| name | String | No | none | A custom name for the entity in the row |
2626
| customTheme | Boolean | No | false | set to true to use a custom theme |
27+
| sensStateWithSpeed | Boolean | No | false | Used only for certain firmware that requires the Statre command be sent with the speed command |
2728
| customIsOffColor | String | No | '#f44c09' | Sets the color of the 'Off' button if fan is off |
2829
| customIsOnLowColor | String | No | '#43A047' | Sets the color of the 'Low' button if fan is on low |
2930
| customIsOnMedColor | String | No | '#43A047' | Sets the color of the 'Med' button if fan is on Medium |
@@ -33,6 +34,8 @@ Then to use this in a card place the following in your entity card:
3334

3435
The values for the colors can be any valid color string in "HEX", "RGB" or by color name.
3536

37+
The optional "sendStateWithSpeed" config entry is only needed to be set to true if for some reason your fan needs the state command of "on" to be sent along with the desired speed command. As far as I know this is only needed for use with fans flashed with the ESPHome Firmware.
38+
3639
<b>Comfguration Examples:</b>
3740

3841
```
@@ -61,6 +64,11 @@ The values for the colors can be any valid color string in "HEX", "RGB" or by co
6164
customIsOnHiColor: '#222222'
6265
customIsOffSpdColor: '#aaaaaa'
6366
customIsOffColor: 'purple'
67+
## USE THIS CONFIG FOR USE WITH THE ESPHOME FIRMWARE (ALONG WITHE THE THEME SETTING ABOVE IF DESIRED)
68+
- entity: fan.master_bedroom_fan
69+
type: custom:fan-control-entity-row
70+
name: MBR Fan Not Custom
71+
sendStateWithSpeed: true
6472
```
6573

6674
This is with the default Lovelace frontend theme set:

0 commit comments

Comments
 (0)