[Documentation] Markdown improvements f to m (#13866)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
committed by
GitHub
GitHub
parent
3c236b3103
commit
0e68936663
@@ -6,9 +6,9 @@ They can be very easy to build with no soldering needed.
|
||||
|
||||
Advantages to using this DIY bridge over the OEM bridge:
|
||||
|
||||
+ Almost unlimited groups to give individual control over an entire house of Milight globes without needing multiple bridges.
|
||||
+ If using the Milight remotes to control the globes, this binding can update the openHAB controls the moment a key is pressed on the physical remotes.
|
||||
+ Supports auto discovery.
|
||||
- Almost unlimited groups to give individual control over an entire house of Milight globes without needing multiple bridges.
|
||||
- If using the Milight remotes to control the globes, this binding can update the openHAB controls the moment a key is pressed on the physical remotes.
|
||||
- Supports auto discovery.
|
||||
|
||||
## Setup the hardware
|
||||
|
||||
@@ -16,16 +16,16 @@ In depth details on how to build and what the bridge is can be found here: <http
|
||||
|
||||
A quick overview of the steps to get the hardware going are:
|
||||
|
||||
+ Connect a nodemcu/D1 mini/esp8266 to your computer via a USB cable.
|
||||
+ Download the latest BIN file from here <https://github.com/sidoh/esp8266_milight_hub/releases>
|
||||
+ Download esp8266flasher if you are on windows <https://github.com/nodemcu/nodemcu-flasher>
|
||||
+ Check the blog above on more info for Mac or Linux.
|
||||
+ Open the flasher tool and make sure the flash size is 4mb or whatever your esp8266 board has.
|
||||
+ Flash the bin and press the reset button on the board when it completes.
|
||||
+ Connect to the wifi access point of the esp directly with your phone/tablet and setup wifi details.
|
||||
+ Login by using the IP address of the esp8266 in a web browser and the control panel will show up.
|
||||
+ Connect 7 wires between the two ready made PCBs as shown in the blog.
|
||||
+ Setup a MQTT broker as this method uses the faster and lightweight MQTT protocol and not UDP.
|
||||
- Connect a nodemcu/D1 mini/esp8266 to your computer via a USB cable.
|
||||
- Download the latest BIN file from here <https://github.com/sidoh/esp8266_milight_hub/releases>
|
||||
- Download esp8266flasher if you are on windows <https://github.com/nodemcu/nodemcu-flasher>
|
||||
- Check the blog above on more info for Mac or Linux.
|
||||
- Open the flasher tool and make sure the flash size is 4mb or whatever your esp8266 board has.
|
||||
- Flash the bin and press the reset button on the board when it completes.
|
||||
- Connect to the wifi access point of the esp directly with your phone/tablet and setup wifi details.
|
||||
- Login by using the IP address of the esp8266 in a web browser and the control panel will show up.
|
||||
- Connect 7 wires between the two ready made PCBs as shown in the blog.
|
||||
- Setup a MQTT broker as this method uses the faster and lightweight MQTT protocol and not UDP.
|
||||
|
||||
## Setup the Firmware
|
||||
|
||||
@@ -45,13 +45,13 @@ Leave this blank.
|
||||
**group_state_fields:**
|
||||
IMPORTANT: Make sure only the following are ticked:
|
||||
|
||||
+ state
|
||||
+ level
|
||||
+ hue
|
||||
+ saturation
|
||||
+ mode
|
||||
+ color_temp
|
||||
+ bulb_mode
|
||||
- state
|
||||
- level
|
||||
- hue
|
||||
- saturation
|
||||
- mode
|
||||
- color_temp
|
||||
- bulb_mode
|
||||
|
||||
Fill in the MQTT broker fields with the correct details so the hub can connect and then click **save**.
|
||||
Now when you use any Milight remote control, you will see MQTT topics being created that should include `level` and `hsb` in the messages.
|
||||
@@ -59,7 +59,7 @@ If you see `brightness` and not `level`, then go back and follow the above setup
|
||||
|
||||
You can use this Linux command to watch all MQTT topics from Milight:
|
||||
|
||||
```
|
||||
```shell
|
||||
mosquitto_sub -u usernamehere -P passwordhere -p 1883 -v -t 'milight/#'
|
||||
```
|
||||
|
||||
@@ -89,7 +89,7 @@ This binding should then detect the new device the moment the control is moved a
|
||||
|
||||
To remove a saved state from your MQTT broker that causes an entry in your INBOX you can use this command or use the ignore feature of openHAB.
|
||||
|
||||
```
|
||||
```shell
|
||||
mosquitto_pub -u username -P password -p 1883 -t 'milight/states/0x0/rgb_cct/1' -n -r
|
||||
```
|
||||
|
||||
@@ -106,7 +106,7 @@ Note that the group 0 (or ALL group) is not auto discovered as a thing and thus
|
||||
| `oneTriggersNightMode` | Night mode is a much lower level of light and this feature allows it to be auto selected when your fader/slider moves to 1%. NOTE: Night mode by design locks out some controls of a physical remote, so this feature is disabled by default. | Y | false |
|
||||
| `powerFailsToMinimum` | If lights loose power from the power switch OR a power outage, they will default to using the lowest brightness if the light was turned off before the power failure occurred. | Y | true |
|
||||
| `whiteThreshold` | This feature allows you to use a color control to change to using the real white LEDs when the saturation is equal to, or below this threshold. -1 will disable this feature. | Y | 12 |
|
||||
| `duvThreshold` | This feature allows you to use a color control to change to using the real warm/cool white LEDs to set a white color temperature if the color is within a certain threshold of the block body curve. 1 will effectively disable this feature. The default settings maps well to Apple's HomeKit that will allow you to choose a color temperature, but sends it as an HSB value. See https://www.waveformlighting.com/tech/calculate-duv-from-cie-1931-xy-coordinates/ for more information. | Y | 0.003 |
|
||||
| `duvThreshold` | This feature allows you to use a color control to change to using the real warm/cool white LEDs to set a white color temperature if the color is within a certain threshold of the block body curve. 1 will effectively disable this feature. The default settings maps well to Apple's HomeKit that will allow you to choose a color temperature, but sends it as an HSB value. See <https://www.waveformlighting.com/tech/calculate-duv-from-cie-1931-xy-coordinates/> for more information. | Y | 0.003 |
|
||||
|
||||
## Channels
|
||||
|
||||
@@ -129,10 +129,10 @@ You can reduce the packet repeats to speed up the response of this binding and t
|
||||
Settings can be found on the radio tab in the esp control panel using your browser.
|
||||
Suggested settings are as follows:
|
||||
|
||||
+ Packet repeats = 12 (if you only turn 1 globe on or off it uses this value)
|
||||
+ Packet repeat throttle threshold = 200
|
||||
+ Packet repeat throttle sensitivity = 0
|
||||
+ Packet repeat minimum = 8 (When turning multiple globes on and off it will use this value as it throttles the repeats back to reduce latency/delay between each globe)
|
||||
- Packet repeats = 12 (if you only turn 1 globe on or off it uses this value)
|
||||
- Packet repeat throttle threshold = 200
|
||||
- Packet repeat throttle sensitivity = 0
|
||||
- Packet repeat minimum = 8 (When turning multiple globes on and off it will use this value as it throttles the repeats back to reduce latency/delay between each globe)
|
||||
|
||||
## Important for Textual Configuration
|
||||
|
||||
@@ -178,14 +178,14 @@ The first line in the things file will create a `broker` thing and this can be r
|
||||
|
||||
*.things
|
||||
|
||||
```
|
||||
```java
|
||||
Bridge mqtt:broker:myBroker [ host="localhost", secure=false, password="*******", qos=1, username="user"]
|
||||
Thing mqtt:rgb_cct:myBroker:0xE6C4 "Hallway" (mqtt:broker:myBroker) @ "MQTT"
|
||||
```
|
||||
|
||||
*.items
|
||||
|
||||
```
|
||||
```java
|
||||
Dimmer Hallway_Level "Front Hall" {channel="mqtt:rgb_cct:myBroker:0xE6C4:level"}
|
||||
Dimmer Hallway_ColourTemperature "White Color Temp" {channel="mqtt:rgb_cct:myBroker:0xE6C4:colourTemperature"}
|
||||
Color Hallway_Colour "Front Hall" ["Lighting"] {channel="mqtt:rgb_cct:myBroker:0xE6C4:colour"}
|
||||
@@ -197,15 +197,15 @@ String Hallway_BulbMode "Bulb Mode" {channel="mqtt:rgb_cct:myBroker:0xE6C4:bulbM
|
||||
|
||||
*.sitemap
|
||||
|
||||
```
|
||||
Text label="Hallway" icon="light"
|
||||
{
|
||||
Switch item=Hallway_Level
|
||||
Slider item=Hallway_Level
|
||||
Slider item=Hallway_ColourTemperature
|
||||
Colorpicker item=Hallway_Colour
|
||||
Selection item=Hallway_DiscoMode
|
||||
Text item=Hallway_BulbMode
|
||||
Switch item=Hallway_BulbCommand mappings=[next_mode='Mode +', previous_mode='Mode -', mode_speed_up='Speed +', mode_speed_down='Speed -', set_white='White', night_mode='Night' ]
|
||||
}
|
||||
```perl
|
||||
Text label="Hallway" icon="light"
|
||||
{
|
||||
Switch item=Hallway_Level
|
||||
Slider item=Hallway_Level
|
||||
Slider item=Hallway_ColourTemperature
|
||||
Colorpicker item=Hallway_Colour
|
||||
Selection item=Hallway_DiscoMode
|
||||
Text item=Hallway_BulbMode
|
||||
Switch item=Hallway_BulbCommand mappings=[next_mode='Mode +', previous_mode='Mode -', mode_speed_up='Speed +', mode_speed_down='Speed -', set_white='White', night_mode='Night' ]
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user