Skip to content
Snippets Groups Projects
Commit 60798f00 authored by René Schöne's avatar René Schöne
Browse files

Working on README for bindings.

parent 7a88e94b
No related branches found
No related tags found
No related merge requests found
# <bindingName> Binding
# OpenLicht Binding
Currently, the additional package `org.eclipse.smarthome.io.transport.mqtt` is needed for this binding to work.
It can be exported as a plugin from the OpenHAB Eclipse.
_Give some details about what this binding is meant for - a protocol, system, specific device._
_If possible, provide some resources like pictures, a YouTube video, etc. to give an impression of what can be done with this binding. You can place such resources into a `doc` folder next to this README.md._
This binding is used as a collection of bindings developed with the project [OpenLicht](http://openlicht.de).
All bindings use MQTT for communication between the device and openHAB.
## Supported Things
- SkyWriterHAT
- Polar M600
- Samsung S6 (or actually any smart phone)
Name | Description | Handler | Sub topic
-----|-------------|---------|----------
SkyWriterHAT | [Product-Page](https://shop.pimoroni.com/products/skywriter-hat) - [Documentation](http://docs.pimoroni.com/skywriter/#) | [SkyWriterHATHandler](https://git-st.inf.tu-dresden.de/OpenLicht/org.openhab.binding.openlicht/blob/master/src/main/java/org/openhab/binding/openlicht/handler/SkyWriterHATHandler.java) | `skywriter`
Polar M600 | [Product-Page](https://www.polar.com/de/produkte/sport/M600-Fitness-Smartwatch) | [PolarM600Handler](https://git-st.inf.tu-dresden.de/OpenLicht/org.openhab.binding.openlicht/blob/master/src/main/java/org/openhab/binding/openlicht/handler/PolarM600Handler.java) | `polar`
Moto 360 | from CyPhyMan, [Product-Page](https://www.motorola.com.au/products/moto-360) | [Moto360Handler](https://git-st.inf.tu-dresden.de/OpenLicht/org.openhab.binding.openlicht/blob/master/src/main/java/org/openhab/binding/openlicht/handler/Moto360Handler.java) | `moto360`
Samsung S6 | Could actually be any smart phone | [SamsungS6Handler](https://git-st.inf.tu-dresden.de/OpenLicht/org.openhab.binding.openlicht/blob/master/src/main/java/org/openhab/binding/openlicht/handler/SamsungS6Handler.java) | `samsung`¹
_Please describe the different supported things / devices within this section._
_Which different types are supported, which models were tested etc.?_
_Note that it is planned to generate some part of this based on the XML files within ```ESH-INF/thing``` of your binding._
¹:warning: The topic is currently set in `AbstractSmartphoneHandler`. This is a bug.
## Discovery
Not implemented yet.
Not implemented (yet).
## Binding Configuration
_If your binding requires or supports general configuration settings, please create a folder ```cfg``` and place the configuration file ```<bindingId>.cfg``` inside it. In this section, you should link to this file and provide some information about the options. The file could e.g. look like:_
*None*
```
# Configuration for the Philips Hue Binding
#
# Default secret key for the pairing of the Philips Hue Bridge.
# It has to be between 10-40 (alphanumeric) characters
# This may be changed by the user for security reasons.
secret=EclipseSmartHome
```
## Thing Configuration
_Note that it is planned to generate some part of this based on the information that is available within ```ESH-INF/binding``` of your binding._
All bindings share the same configuration, with the following options (copied from `ESH-INF/config/config.xml`:
_If your binding does not offer any generic configurations, you can remove this section completely._
Name | Label | Description | Default
-----|-------|-------------|--------
`brokerName` | Broker Name | Name of the broker as defined in the &lt;broker&gt;.url in services/mqtt.cfg. See the MQTT Binding for more information on how to configure MQTT broker connections. | `mosquitto`²
`base-topic` | Base-Topic | Base topic for publishing updates. Do not include a trailing slash. | `sensors`
`unsupported-category-reset` | MQTT Unsupported Category Reset Timeout (optional) | Timeout in seconds to log again unsupported MQTT categories. Set to zero to disable (default). | `0`
## Thing Configuration
²:warning: This must match the configured MQTT broker within openHAB, see `services/mqtt.cfg`.
_Describe what is needed to manually configure a thing, either through the (Paper) UI or via a thing-file. This should be mainly about its mandatory and optional configuration parameters. A short example entry for a thing file can help!_
## Channel Types
_Note that it is planned to generate some part of this based on the XML files within ```ESH-INF/thing``` of your binding._
Type-Name | Kind | Label | Description | Category
----------|------|-------|-------------|---------
`flick-type` | Text | Last Flick | Last Flick detected (and its direction) | Motion
`brightness-type` | Number | Brightness | Brightness (Lux) | Light
`acceleration-type` | Number | Acceleration | Acceleration in one direction in meters per second. | Motion
`rotation-type` | Number | Rotation | Rotation around one axis (unitless). | <category>Motion</category>
`activity-type` | String | Activity | Current recognized activity, one of Runnning, Walking, Resting, Unknown. | -
`heart-rate-type` | Number | Heart Rate | Heart rate in beats per minute. | -
`steps-type` | Number | Steps | Steps run today. | -
## Channels
_Here you should provide information about available channel types, what their meaning is and how they can be used._
_Note that it is planned to generate some part of this based on the XML files within ```ESH-INF/thing``` of your binding._
## Full Example
Supported by Binding | Type-Name | Id | Label
---------------------|-----------|----|------
SkyWriterHAT | `flick-type` | `flick` | -
Polar M600, Moto 360, Samsung S6 | `brightness-type` | `brightness` | -
Polar M600, Moto 360 | `acceleration-type` | `acceleration-x` | Acceleration X
Polar M600, Moto 360 | `acceleration-type` | `acceleration-y` | Acceleration Y
Polar M600, Moto 360 | `acceleration-type` | `acceleration-z` | Acceleration Z
Polar M600, Moto 360, Samsung S6 | `rotation-type` | `rotation-x` | Rotation X
Polar M600, Moto 360, Samsung S6 | `rotation-type` | `rotation-y` | Rotation Y
Polar M600, Moto 360, Samsung S6 | `rotation-type` | `rotation-z` | Rotation Z
Polar M600, Moto 360 | `activity-type` | `activity` | -
Polar M600, Moto 360 | `heart-rate-type` | `heart-rate` | -
Polar M600, Moto 360 | `steps-type` | `steps` | -
_Provide a full usage example based on textual configuration files (*.things, *.items, *.sitemap)._
## Data flow
## Any custom content here!
_Feel free to add additional sections for whatever you think should also be mentioned about your binding!_
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment