openhab-addons/bundles/org.openhab.binding.airparif

AirParif Binding

Give some details about what this binding is meant for - a protocol, system, specific device.

If possible, provide some resources like pictures (only PNG is supported currently), a 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.

Put each sentence in a separate line to improve readability of diffs.

Supported Things

Please describe the different supported things / devices including their ThingTypeUID 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 src/main/resources/OH-INF/thing of your binding.

• bridge: Short description of the Bridge, if any
• sample: Short description of the Thing with the ThingTypeUID sample

Discovery

Describe the available auto-discovery features here. Mention for what it works and what needs to be kept in mind when using it.

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:

# Configuration for the AirParif Binding
#
# Default secret key for the pairing of the AirParif Thing.
# It has to be between 10-40 (alphanumeric) characters.
# This may be changed by the user for security reasons.
secret=openHABSecret

Note that it is planned to generate some part of this based on the information that is available within src/main/resources/OH-INF/binding of your binding.

If your binding does not offer any generic configurations, you can remove this section completely.

Thing Configuration

Describe what is needed to manually configure a thing, either through the UI or via a thing-file. This should be mainly about its mandatory and optional configuration parameters.

Note that it is planned to generate some part of this based on the XML files within src/main/resources/OH-INF/thing of your binding.

sample Thing Configuration

Name	Type	Description	Default	Required	Advanced
hostname	text	Hostname or IP address of the device	N/A	yes	no
password	text	Password to access the device	N/A	yes	no
refreshInterval	integer	Interval the device is polled in sec.	600	no	yes

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 src/main/resources/OH-INF/thing of your binding.

Channel	Type	Read/Write	Description
control	Switch	RW	This is the control channel

Full Example

Provide a full usage example based on textual configuration files. *.things, *.items examples are mandatory as textual configuration is well used by many users. *.sitemap examples are optional.

Thing Configuration

Example thing configuration goes here.

Item Configuration

Example item configuration goes here.

Sitemap Configuration

Optional Sitemap configuration goes here.
Remove this section, if not needed.

Any custom content here!

Feel free to add additional sections for whatever you think should also be mentioned about your binding!