eclipse-archived / smarthome

Eclipse SmartHome™ project
https://www.eclipse.org/smarthome/
Eclipse Public License 2.0
862 stars 783 forks source link

Improve documentation on tradfri #6691

Open PanderMusubi opened 5 years ago

PanderMusubi commented 5 years ago

Please, improve documentation in README.md for tradfri:

Fixing this would help https://github.com/eclipse/smarthome/issues/6483 and https://github.com/eclipse/smarthome/issues/6269

maggu2810 commented 5 years ago

Would you like to provide a PR with the fixes?

PanderMusubi commented 5 years ago

If I would be more familiar with this, I would. So this is better done by people actively involved in Trådfri support.

davidgraeff commented 5 years ago

@PanderMusubi Please try to help out. The maintainer of the Tradfri binding is also the maintainer of the entire project and quite busy.

PanderMusubi commented 5 years ago

Sorry, I'm really not enough into this binding and contribute to other bindings.

bofhdk commented 5 years ago

Here's a suggestion:

diff --git a/extensions/binding/org.eclipse.smarthome.binding.tradfri/README.md b/extensions/binding/org.eclipse.smarthome.binding.tradfri/README.md
index 1cadf6684..e68e85a15 100644
--- a/extensions/binding/org.eclipse.smarthome.binding.tradfri/README.md
+++ b/extensions/binding/org.eclipse.smarthome.binding.tradfri/README.md
@@ -16,23 +16,25 @@ These are:

 | Device type                     | ZigBee Device ID | Thing type |
 |---------------------------------|------------------|------------|
+| Control Outlet                  | 0x0010           | 0010       |
 | Dimmable Light                  | 0x0100           | 0100       |
+| Occupancy/Motion Sensor         | 0x0107           | 0107       |
 | Colour Temperature Light        | 0x0220           | 0220       |
 | Extended Colour Light           | 0x0210           | 0210       |
-| Occupancy Sensor                | 0x0107           | 0107       |
 | Non-Colour Controller           | 0x0820           | 0820       |
 | Non-Colour Scene Controller     | 0x0830           | 0830       |

 The following matrix lists the capabilities (channels) for each of the supported lighting device types:

-| Thing type  | Brightness | Color | Color Temperature | Battery Level | Battery Low |
-|-------------|:----------:|:-----:|:-----------------:|:-------------:|:-----------:|
-|  0100       |     X      |       |                   |               |             |
-|  0220       |     X      |       |         X         |               |             |
-|  0210       |            |   X   |         X         |               |             |
-|  0107       |            |       |                   |       X       |      X      |
-|  0820       |            |       |                   |       X       |      X      |
-|  0830       |            |       |                   |       X       |      X      |
+| Thing type  |  Power  | Brightness | Color | Color Temperature | Battery Level | Battery Low |
+|-------------|:-------:|:----------:|:-----:|:-----------------:|:-------------:|:-----------:|
+|  0010       |    X    |            |       |                   |               |             |
+|  0100       |    X    |     X      |       |                   |               |             |
+|  0220       |    X    |     X      |       |         X         |               |             |
+|  0210       |         |            |   X   |         X         |               |             |
+|  0107       |         |            |       |                   |       X       |      X      |
+|  0820       |         |            |       |                   |       X       |      X      |
+|  0830       |         |            |       |                   |       X       |      X      |

 ## Thing Configuration

@@ -58,6 +60,7 @@ Refer to the matrix above.

 | Channel Type ID   | Item Type | Description                                      |
 |-------------------|-----------|--------------------------------------------------|
+| power             | Switch    | On or Off                                        |
 | brightness        | Dimmer    | The brightness of the bulb in percent            |
 | color_temperature | Dimmer    | color temperature from 0% = cold to 100% = warm  |
 | color             | Color     | full color                                       |

(Nope, can't be arsed to go through the rigmarole of becoming an eclipse contributor, but feel free to use the above diff. Also, I don't care about being credited or not, so that's not an issue)

cweitkamp commented 5 years ago

Is PR #6709 sufficient for your needs?