OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Corrected some items in the Bindings section. (#1039) 

Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
pull/1041/head
Stewart Cossey 2019-09-02 01:34:53 +12:00 committed by Jerome Luckenbach
parent 934def3757
commit 09d1627d39
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
developers/bindings/index.md
View File

@ -859,7 +859,7 @@ Here the developer only needs to implement four simple methods:
The discovery service uses this method of all registered discovery participants to return the list of currently supported thing type UIDs. The discovery service uses this method of all registered discovery participants to return the list of currently supported thing type UIDs.
- `getThingUID` - Creates a thing UID out of the mDNS service info or returns `null` if this is not possible. - `getThingUID` - Creates a thing UID out of the mDNS service info or returns `null` if this is not possible.
This method is called from the discovery service during result creation to provide a unique thing UID for the result. This method is called from the discovery service during result creation to provide a unique thing UID for the result.
- `createResult` - Creates the `DiscoveryResult` out of the UPnP result. - `createResult` - Creates the `DiscoveryResult` out of the mDNS result.
This method is called from the discovery service to create the actual discovery result. This method is called from the discovery service to create the actual discovery result.
It uses the `getThingUID` method to create the thing UID of the result. It uses the `getThingUID` method to create the thing UID of the result.
@ -875,12 +875,13 @@ Various binding related questions are answered in our [Binding development FAQ](
Once you are happy with your implementation, you need to integrate it in the Maven build and add it to the official distro. Once you are happy with your implementation, you need to integrate it in the Maven build and add it to the official distro.
* Add a new line in the [binding pom.xml](https://github.com/openhab/openhab2-addons/blob/master/bundles/pom.xml) at the alphabetically correct position. * Add a new line in the [bundle pom.xml](https://github.com/openhab/openhab2-addons/blob/master/bundles/pom.xml).
* Furthermore add it to the [feature.xml](https://github.com/openhab/openhab2-addons/blob/master/features/openhab-addons/src/main/feature/feature.xml), again at the alphabetically correct position. * Add a new line in the [binding pom.xml](https://github.com/openhab/openhab2-addons/blob/master/bom/openhab-addons/pom.xml).
* If you have a dependency on a transport bundle (e.g. upnp, mdns or serial) or an external library, * If you have a dependency on a transport bundle (e.g. upnp, mdns or serial) or an external library,
make sure to add a line for this dependency as well (see the other bindings as an example) make sure to add a line for this dependency in the `/src/main/feature/feature.xml` file in your binding folder. See the other bindings as an example.
* Add your binding to the CODEOWNERS at the alphabetically correct position. * Add your binding to the [CODEOWNERS](https://github.com/openhab/openhab2-addons/blob/master/CODEOWNERS) file so that you get notified by Github when someone adds a pull request towards your binding.
This is so that you get notified by Github when someone adds a pull request towards your binding and hopefully can assist in reviewing that.
> Please make sure you add the above entries at their alphabetically correct position!
Before you create a pull request on GitHub, you should now run Before you create a pull request on GitHub, you should now run