Skip to content

Commit dae121e

Browse files
authored
Doc Changes 3 (#5)
Update docs
1 parent 651800d commit dae121e

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

docs/src/main/resources/markdown/developers/bindings/index.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Bindings
44

55
# Overview
66

7-
A binding is an extension to openHAB that integrates an external system like a software service or a hardware device.
7+
A binding is an extension to OpenSmartHouse that integrates an external system like a software service or a hardware device.
88
The external system is represented as a set of *Things* and sometimes *Bridges* with *Channels*.
99

1010
This chapter covers everything to know about binding development.
@@ -17,19 +17,19 @@ During development you might come back with specific questions.
1717
# Structure of a Binding
1818

1919
Every binding needs to define a `binding.xml` file.
20-
Find more information in the respective [binding XML reference](binding-xml.html).
20+
Find more information in the respective [binding XML reference](binding-xml.md).
2121

2222
# Describing Things
2323

24-
External systems are represented as *Things* in openHAB.
24+
External systems are represented as *Things* in OpenSmartHouse.
2525
When starting the implementation of a binding, you should think about the abstraction of your external system.
2626
Different services or devices should be represented as individual *Things*.
2727
Each functionality of the *Thing* should be modelled as a `Channel`.
2828

29-
*Thing* and *Channel* structures need to be explained to the openHAB runtime.
29+
*Thing* and *Channel* structures need to be explained to the OpenSmartHouse runtime.
3030
This is done in a declarative way via XML files, so called *ThingTypes* and *ChannelTypes*.
3131

32-
Find more information in the respective [Thing & Channel XML reference](thing-xml.html).
32+
Find more information in the respective [Thing & Channel XML reference](thing-xml.md).
3333

3434
# The ThingHandlerFactory
3535

@@ -39,7 +39,7 @@ The `ThingHandlerFactory` is responsible for creating `ThingHandler` instances.
3939

4040
Every binding must implement a `ThingHandlerFactory` and register it as OSGi service so that the runtime knows which class needs to be called for creating and handling things.
4141

42-
When a new *Thing* is added, the openHAB runtime queries every `ThingHandlerFactory` for support of the *ThingType* by calling the `supportsThingType` method.
42+
When a new *Thing* is added, the OpenSmartHouse runtime queries every `ThingHandlerFactory` for support of the *ThingType* by calling the `supportsThingType` method.
4343
When the method returns `true`, the runtime calls `createHandler`, which should then return a proper `ThingHandler` implementation.
4444

4545
A weather bindings `WeatherHandlerFactory` for example supports only one *ThingType* and instantiates a new `WeatherHandler` for a given thing:
@@ -124,10 +124,10 @@ The `ThingManager` creates for each Thing a `ThingHandler` instance using a `Thi
124124
Therefore, it tracks all `ThingHandlerFactory`s from the binding.
125125

126126
The `ThingManager` determines if the `Thing` is initializable or not.
127-
A `Thing` is considered as *initializable* if all *required* configuration parameters (cf. property *parameter.required* in [Configuration Description](config-xml.html)) are available.
127+
A `Thing` is considered as *initializable* if all *required* configuration parameters (cf. property *parameter.required* in [Configuration Description](config-xml.md)) are available.
128128
If so, the method `ThingHandler.initialize()` is called.
129129

130-
Only Things with status (cf. [Thing Status](../../concepts/things.html#thing-status)) *UNKNOWN*, *ONLINE* or *OFFLINE* are considered as *initialized* by the framework and therefore it is the handler's duty to assign one of these states sooner or later.
130+
Only Things with status (cf. [Thing Status](../../concepts/things.md#thing-status)) *UNKNOWN*, *ONLINE* or *OFFLINE* are considered as *initialized* by the framework and therefore it is the handler's duty to assign one of these states sooner or later.
131131
To achieve that, the status must be reported to the framework via the callback or `BaseThingHandler.updateStatus(...)` for convenience.
132132
Furthermore, the framework expects `initialize()` to be non-blocking and to return quickly.
133133
For longer running initializations, the implementation has to take care of scheduling a separate job which must guarantee to set the status eventually.
@@ -195,7 +195,7 @@ Bindings implementing device configuration should consider providing `ConfigStat
195195

196196
*Things* can have properties.
197197
If you would like to add meta data to your thing, e.g. the vendor of the thing, then you can define your own thing properties by simply adding them to the thing type definition.
198-
The properties section [here](thing-definition.html#Properties) explains how to specify such properties.
198+
The properties section [here](thing-definition.md#Properties) explains how to specify such properties.
199199

200200
To retrieve the properties one can call the operation `getProperties` of the corresponding `org.eclipse.smarthome.core.thing.type.ThingType` instance.
201201
If a thing will be created for this thing type then its properties will be automatically copied into the new thing instance.
@@ -331,7 +331,7 @@ It is binding specific when the channel should be triggered.
331331

332332
## Updating the Thing Status
333333

334-
The *ThingHandler* must also manage the thing status (see also: [Thing Status Concept](../../concepts/things.html#thing-status)).
334+
The *ThingHandler* must also manage the thing status (see also: [Thing Status Concept](../../concepts/things.md#thing-status)).
335335
If the device or service is not working correctly, the binding should change the status to *OFFLINE* and back to *ONLINE*, if it is working again.
336336
The status can be updated via an inherited method from the BaseThingHandler class by calling:
337337

@@ -340,7 +340,7 @@ updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.COMMUNICATION_ERROR)
340340
```
341341

342342
The second argument of the method takes a `ThingStatusDetail` enumeration value, which further specifies the current status situation.
343-
A complete list of all thing statuses and thing status details is listed in the [Thing Status](../../concepts/things.html#thing-status) chapter.
343+
A complete list of all thing statuses and thing status details is listed in the [Thing Status](../../concepts/things.md#thing-status) chapter.
344344

345345
The binding should also provide additional status description, if available.
346346
This description might contain technical information (e.g. an HTTP status code, or any other protocol specific information, which helps to identify the current problem):
@@ -468,7 +468,7 @@ The Hue gateway is an IP device with an HTTP API, which communicates over the Zi
468468
In the openHAB model the Hue gateway is represented as a *Bridge* with connected *Things*, that represent the Hue bulbs.
469469
*Bridge* inherits from *Thing*, so that it also has *Channels* and all other features of a thing, with the addition that it also holds a list of things.
470470

471-
We have a FAQ, dicussing [Thing, Bridge and Channel modelling](faq.html#structuring-things-and-thing-types).
471+
We have a FAQ, dicussing [Thing, Bridge and Channel modelling](faq.md#structuring-things-and-thing-types).
472472

473473
When implementing a binding with *Bridges*, the logic to communicate with the external system is often shared between the different `ThingHandler` implementations.
474474
In that case it makes sense to implement a handler for the *Bridge* and delegate the actual command execution from the *ThingHandler* to the *BridgeHandler*.
@@ -549,7 +549,7 @@ Sub-classes of these handlers must only override the operation `getConfigStatus`
549549

550550
The framework will take care of internationalizing messages.
551551

552-
For this purpose there must be an [i18n](../utils/i18n.html) properties file inside the bundle of the configuration status provider that has a message declared for the message key of the `ConfigStatusMessage`.
552+
For this purpose there must be an [i18n](../utils/i18n.md) properties file inside the bundle of the configuration status provider that has a message declared for the message key of the `ConfigStatusMessage`.
553553
The actual message key is built by the operation `withMessageKeySuffix(String)` of the message´s builder in the manner that the given message key suffix is appended to *config-status."config-status-message-type."*.
554554

555555
As a result depending on the type of the message the final constructed message keys are:
@@ -652,7 +652,7 @@ TODO
652652

653653
# Implementing a Discovery Service
654654

655-
Bindings can implement the `DiscoveryService` interface and register it as an OSGi service to inform the framework about devices and services, that can be added as things to the system (see also [Inbox & Discovery Concept](../../concepts/discovery.html)).
655+
Bindings can implement the `DiscoveryService` interface and register it as an OSGi service to inform the framework about devices and services, that can be added as things to the system (see also [Inbox & Discovery Concept]../discovery/index.md)).
656656

657657
A discovery service provides discovery results.
658658
The following table gives an overview about the main parts of a `DiscoveryResult`:
@@ -792,7 +792,7 @@ If this behavior is not appropriate for the implemented discovery service, one c
792792
## Internationalization
793793

794794
The framework will take care of internationalizing labels of discovery results if you extend the `AbstractDiscoveryService`.
795-
See [i18n](../utils/i18n.html#discovery) for more information.
795+
See [i18n](../utils/i18n.md#discovery) for more information.
796796

797797
::: tip Hint!
798798
To make it work you have to inject references to the `LocaleProvider` and the `TranslationProvider` services into your implementation.
@@ -886,4 +886,4 @@ TODO
886886

887887
# Frequently asked questions / FAQ
888888

889-
Various binding related questions are answered in our [Binding development FAQ](faq.html).
889+
Various binding related questions are answered in our [Binding development FAQ](faq.md).

docs/src/main/resources/markdown/developers/bindings/thing-xml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Bindings may optionally set the version of a thing type. This may be used within
5959

6060
### Thing Categories
6161

62-
A description about thing categories as well as an overview about which categories exist can be found in our [categories overview](../../concepts/categories.html).
62+
A description about thing categories as well as an overview about which categories exist can be found in our [categories overview](../fundamentals/categories.md).
6363

6464
## Channels
6565

docs/src/main/resources/markdown/developers/discovery/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,11 @@ If an entry is ignored, it will be hidden in the inbox without creating a Thing
6464

6565
OpenSmartHouse offers a service to automatically ignore discovery results in the inbox, whenever a Thing is created manually, that represents the same Thing, as the respective discovery result would create.
6666
This Thing would either have the same Thing UID or the value of its representation property is equal to the representation property's value in the discovery result.
67-
This service is enabled by default but can be disabled by setting `org.eclipse.smarthome.inbox:autoIgnore=false`.
67+
This service is enabled by default but can be disabled by setting `org.openhab.inbox:autoIgnore=false`.
6868

6969
## Auto Approve
7070

7171
If the manual acceptance of discovery results by the user is not desired, it is possible to turn on the auto-approval feature of the inbox.
7272
In this case, every new entry gets automatically approved immediately (unless it has been marked as ignored as a duplicate).
7373

74-
The auto approval can be enabled by the setting `org.eclipse.smarthome.inbox:autoApprove=true`; the default is false.
74+
The auto approval can be enabled by the setting `org.openhab.inbox:autoApprove=true`; the default is false.

0 commit comments

Comments
 (0)