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

[skeleton] Use real world examples; fix imports (#2270) 

* [skeleton] Use real world examples in thing-types.xml

* Added some examples as many new bindings don't make use of context tags or supported bridges.
* Adapt config DTO, i18n. Add refresh param. Cleanup imports.

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>
pull/2282/head
Fabian Wolter 2021-04-08 16:21:31 +02:00 committed by GitHub
parent 6eba0a0c33
commit 23c367f51e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 31 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
tools/archetype/binding/src/main/resources/archetype-resources/src/main/java/internal/__bindingIdCamelCase__Configuration.java
View File

@ -23,7 +23,9 @@ package ${package}.internal;
public class ${bindingIdCamelCase}Configuration {
/**
* Sample configuration parameter. Replace with your own.
* Sample configuration parameters. Replace with your own.
*/
public String config1;
public String hostname;
public String password;
public int refreshInterval;
}

1
tools/archetype/binding/src/main/resources/archetype-resources/src/main/java/internal/__bindingIdCamelCase__HandlerFactory.java
View File

@ -17,7 +17,6 @@ package ${package}.internal;
import static ${package}.internal.${bindingIdCamelCase}BindingConstants.*;
import java.util.Collections;
import java.util.Set;
import org.eclipse.jdt.annotation.NonNullByDefault;

8
tools/archetype/binding/src/main/resources/archetype-resources/src/main/resources/OH-INF/i18n/__bindingId___xx.properties
View File

@ -9,8 +9,12 @@ thing-type.${bindingId}.sample.label = <Your localized Thing label>
thing-type.${bindingId}.sample.description = <Your localized Thing description>
# thing type config description
thing-type.config.${bindingId}.sample.config1.label = <Your localized config parameter label>
thing-type.config.${bindingId}.sample.config1.description = <Your localized config parameter description>
thing-type.config.${bindingId}.sample.hostname.label = <Your localized config parameter label>
thing-type.config.${bindingId}.sample.hostname.description = <Your localized config parameter description>
thing-type.config.${bindingId}.sample.password.label = <Your localized config parameter label>
thing-type.config.${bindingId}.sample.password.description = <Your localized config parameter description>
thing-type.config.${bindingId}.sample.refreshInterval.label = <Your localized config parameter label>
thing-type.config.${bindingId}.sample.refreshInterval.description = <Your localized config parameter description>
# channel types
channel-type.${bindingId}.sample-channel.label = <Your localized Channel label>

28
tools/archetype/binding/src/main/resources/archetype-resources/src/main/resources/OH-INF/thing/thing-types.xml
View File

@ -6,6 +6,12 @@
<!-- Sample Thing Type -->
<thing-type id="sample">
<!-- Comment this in for Things which need a Bridge to function.
<supported-bridge-type-refs>
<bridge-type-ref id="${bindingIdCamelCase}Bridge" />
</supported-bridge-type-refs>
-->
<label>${bindingIdCamelCase} Binding Thing</label>
<description>Sample thing for ${bindingIdCamelCase} Binding</description>
@ -14,19 +20,27 @@
</channels>
<config-description>
<parameter name="config1" type="text" required="true">
<label>Sample Parameter</label>
<description>This is a sample text configuration parameter</description>
<parameter name="hostname" type="text" required="true">
<context>network-address</context>
<label>Hostname</label>
<description>Hostname or IP address of the device</description>
</parameter>
<parameter name="password" type="text" required="true">
<context>password</context>
<label>Password</label>
<description>Passwort to access the device</description>
</parameter>
<parameter name="refreshInterval" type="integer" unit="s" min="1">
<label>Refresh Interval</label>
<description>Interval the device is polled in sec.</description>
</parameter>
</config-description>
</thing-type>
<!-- Sample Channel Type -->
<channel-type id="sample-channel">
<item-type>${bindingId}Item</item-type>
<label>${bindingIdCamelCase} Binding Channel</label>
<item-type>Number:Temperature</item-type>
<label>Example Temperature</label><!-- Use uppercase words, except prepositions. 2-3 words, max 25 chars -->
<description>Sample channel for ${bindingIdCamelCase} Binding</description>
</channel-type>
</thing:thing-descriptions>