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

Fixed some links. (#741) 

* Fixed some links. Closes #732.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Added Anchors.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
pull/742/head
Jerome Luckenbach 2018-07-13 22:14:47 +02:00 committed by GitHub
parent 40948f9766
commit c2293a1eff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
configuration/items.md
View File

@ -236,7 +236,7 @@ This section provides information about what a user can expect regarding the beh
- A Binding may set the state of an Item to `UNDEF` if it looses communications with a Thing (for example, a Z-wave doorbell with a dead battery). - A Binding may set the state of an Item to `UNDEF` if it looses communications with a Thing (for example, a Z-wave doorbell with a dead battery).
The Binding may also set the state to `UNDEF` if an error exists in the binding configuration, or under other conditions The Binding may also set the state to `UNDEF` if an error exists in the binding configuration, or under other conditions
*N.B.* Many openHAB users find that it can be very useful to use [Persistence]({{base}}/addons/persistence.html) and [System started]({{base}}/configuration/rules-dsl.html#system-based-triggers) rules so that their systems behaves in a predictable way after an openHAB restart. *N.B.* Many openHAB users find that it can be very useful to use [Persistence](/addons/#persistence) and [System started](/docs/configuration/rules-dsl.html#system-based-triggers) rules so that their systems behaves in a predictable way after an openHAB restart.
{: #command-vs-status} {: #command-vs-status}
#### Command vs. Status #### Command vs. Status
@ -297,7 +297,7 @@ In the example below, the entry `MAP(window_esp.map)` causes the output of the `
Contact Livingroom_Window "Ventana del salón [MAP(window_esp.map):%s]" Contact Livingroom_Window "Ventana del salón [MAP(window_esp.map):%s]"
``` ```
Please refer to the article on [Transformations](transform.html) for more usage details and a list of available transformation services. Please refer to the article on [Transformations](/docs/configuration/transformations.html) for more usage details and a list of available transformation services.
{: #icons} {: #icons}
### Icons ### Icons
@ -533,7 +533,7 @@ See the [Hue Emulation]({{base}}/addons/ios/hueemulation/readme.html) or [HomeKi
### Binding Configuration ### Binding Configuration
One of the greatest strengths of an openHAB automation system is the sheer number of devices you can interact with. One of the greatest strengths of an openHAB automation system is the sheer number of devices you can interact with.
See "[currently available Bindings]({{base}}/addons/bindings.html)" for a list of available Bindings. See "[currently available Bindings](/addons/#binding)" for a list of available Bindings.
This capability of interacting with real-world things is enabled through the association of Bindings with Items. This capability of interacting with real-world things is enabled through the association of Bindings with Items.
Once an Item is associated with a Binding, the state of one aspect of a device is reflected in openHAB (e.g., you can see if a light is on or off in one of the user interfaces). Once an Item is associated with a Binding, the state of one aspect of a device is reflected in openHAB (e.g., you can see if a light is on or off in one of the user interfaces).
@ -561,7 +561,7 @@ Switch Phone_Mobile {ns="192.168.1.123:80"}
Where "ns" is the namespace for a certain Binding like "network", "netatmo", "zwave" etc. Where "ns" is the namespace for a certain Binding like "network", "netatmo", "zwave" etc.
Every Binding defines what values must be given in the Binding configuration string. Every Binding defines what values must be given in the Binding configuration string.
That can be the id of a sensor, an ip or mac address or anything else. That can be the id of a sensor, an ip or mac address or anything else.
The information required for each binding is specified in the configuration information provided for each of the available [Bindings]({{base}}/addons/bindings.html). The information required for each binding is specified in the configuration information provided for each of the available [Bindings](/addons/#binding).
Examples: Examples:
@ -595,7 +595,7 @@ Once accepted, the new Thing will appear under Configuration > Things.
Other Bindings support defining Things in a `.things` file located in the `OPENHAB_CFG/things/` folder. Other Bindings support defining Things in a `.things` file located in the `OPENHAB_CFG/things/` folder.
See the [Bindings]({{base}}/addons/bindings.html) configuration section for more information on how to discover or manually define Things for a given Binding. See the [Bindings](/addons/#binding) configuration section for more information on how to discover or manually define Things for a given Binding.
##### Paper UI Linking ##### Paper UI Linking

4
configuration/multimedia.md
View File

@ -9,7 +9,7 @@ title: Multimedia
## Audio ## Audio
openHAB is able to play sound either from the file system (files need to be put in the folder `conf/sounds`), from URLs (e.g. Internet radio streams) or generated by text-to-speech engines (which are available as optional [Voice add-ons]({{base}}/addons/voices.html)). openHAB is able to play sound either from the file system (files need to be put in the folder `conf/sounds`), from URLs (e.g. Internet radio streams) or generated by text-to-speech engines (which are available as optional [Voice add-ons](/addons/#voice)).
There are different options for output devices (so called audio sinks): There are different options for output devices (so called audio sinks):
@ -53,7 +53,7 @@ playSound("sonos:PLAY5:kitchen", "doorbell.mp3", 25)
### Text-to-Speech ### Text-to-Speech
In order to use text-to-speech, you need to install at least one [TTS service]({{base}}/addons/voices.html). In order to use text-to-speech, you need to install at least one [TTS service](/addons/#voice).
Once you have done so, you will find voices available in your system: Once you have done so, you will find voices available in your system:
```text ```text

4
configuration/persistence.md
View File

@ -13,9 +13,9 @@ The data may be retrieved at a later time, for example to restore your system af
openHAB persists Item states in a database, and most popular databases are supported. openHAB persists Item states in a database, and most popular databases are supported.
You may have more than one persistence add-on loaded, and each of these may be configured independently. You may have more than one persistence add-on loaded, and each of these may be configured independently.
A complete list of supported persistence add-ons may be found in the [persistence]({{base}}/addons/persistence.html) section of the on-line openHAB documentation. A complete list of supported persistence add-ons may be found in the [persistence]({/addons/#persistence) section of the on-line openHAB documentation.
Please refer to the [available persistence service add-on]({{base}}/addons/persistence.html) documentation for your selected persistence add-on for configuration instructions. Please refer to the [available persistence service add-on](/addons/#persistence) documentation for your selected persistence add-on for configuration instructions.
## Default Persistence Service ## Default Persistence Service

12
configuration/rules-dsl.md
View File

@ -125,7 +125,7 @@ Item <item> received update [<state>]
Item <item> changed [from <state>] [to <state>] Item <item> changed [from <state>] [to <state>]
``` ```
A simplistic explanation of the differences between `command` and `update` can be found in the article about [openHAB core actions](../addons/actions.html). A simplistic explanation of the differences between `command` and `update` can be found in the article about [openHAB core actions](/docs/configuration/actions.html#event-bus-actions).
{: #time-based-triggers} {: #time-based-triggers}
### Time-based Triggers ### Time-based Triggers
@ -190,8 +190,8 @@ Thing <thingUID> changed [from <status>] [to <status>]
``` ```
The status used in the trigger and the script is a string (no quotes). The status used in the trigger and the script is a string (no quotes).
You can find all the possible values for status from [Thing Status]({{base}}/concepts/things.html). You can find all the possible values for status from [Thing Status](/docs/concepts/things.html).
And refer to [Thing Status Action]({{base}}/addons/actions.html) to find how to get thing status in the script. And refer to [Thing Status Action](/addons/#action) to find how to get thing status in the script.
The `thingUID` is the identifier assigned to the Thing, manually in your configuration or automatically during auto discovery. The `thingUID` is the identifier assigned to the Thing, manually in your configuration or automatically during auto discovery.
You can find it from PaperUI or from Karaf remote console. You can find it from PaperUI or from Karaf remote console.
@ -343,7 +343,7 @@ For example, `Group:Switch` will return an OnOffType for its state.
Each State Type provides a number of convenience methods that will greatly aid in conversion and calculations. Each State Type provides a number of convenience methods that will greatly aid in conversion and calculations.
There are two ways to discover these methods: There are two ways to discover these methods:
- Use the [Eclipse SmartHome Designer]({{base}}/installation/designer.html) and the `<ctrl><space>` key combo to list all the available methods - Use the [openHAB VS Code Extension](/docs/configuration/editors.html#editors.html#openhab-vs-code-extension) and the `<ctrl><space>` key combo to list all the available methods
- Look at the JavaDocs for the given type. - Look at the JavaDocs for the given type.
For example, the [JavaDoc for HSBType](http://www.eclipse.org/smarthome/documentation/javadoc/index.html?org/eclipse/smarthome/core/library/types/HSBType.html) shows getRed, getBlue, and getGreen methods. For example, the [JavaDoc for HSBType](http://www.eclipse.org/smarthome/documentation/javadoc/index.html?org/eclipse/smarthome/core/library/types/HSBType.html) shows getRed, getBlue, and getGreen methods.
Thse methods can be called in Rules-DSL without the "get" part in name as in `(MyColorItem.state as HSBType).red)`. Thse methods can be called in Rules-DSL without the "get" part in name as in `(MyColorItem.state as HSBType).red)`.
@ -696,7 +696,7 @@ end
{: #transformations} {: #transformations}
### Transformations ### Transformations
openHAB [Transformation services]({{base}}/addons/transformations.html) can be used in rules to transform/translate/convert data. openHAB [Transformation services](/addons/#transform) can be used in rules to transform/translate/convert data.
The general syntax is as follows: The general syntax is as follows:
@ -737,7 +737,7 @@ finally {
} }
``` ```
For all available Transformation services please refer to the list of [Transformation Add-ons]({{base}}/addons/transformations.html). For all available Transformation services please refer to the list of [Transformation Add-ons](/addons/#transform).
{: #logging} {: #logging}

4
configuration/sitemaps.md
View File

@ -524,13 +524,13 @@ This limits the possible input values, which is yet another often occurring use
## Dynamic Sitemaps ## Dynamic Sitemaps
All Sitemap elements can be configured to be hidden, color highlighted or to have a [dynamic icon]({{base}}/items.md#icons-dynamic), depending on certain Item states. All Sitemap elements can be configured to be hidden, color highlighted or to have a [dynamic icon](/docs/configuration/items.html#icons-dynamic), depending on certain Item states.
A few practical use cases are: A few practical use cases are:
- Show a battery warning if the voltage level of a device is below 30% - Show a battery warning if the voltage level of a device is below 30%
- Hide further control elements for the TV if it is turned off - Hide further control elements for the TV if it is turned off
- Highlight a value with a warning color if it is outside accepted limits - Highlight a value with a warning color if it is outside accepted limits
- Present a special icon, depending on the state of an item (a [dynamic icon]({{base}}/items.md#icons-dynamic)) - Present a special icon, depending on the state of an item (a [dynamic icon](/docs/configuration/items.html#icons-dynamic))
### Visibility ### Visibility

4
configuration/things.md
View File

@ -10,7 +10,7 @@ title: Things
[Things]({{base}}/concepts/things.html) represent the physical layer of an openHAB system. [Things]({{base}}/concepts/things.html) represent the physical layer of an openHAB system.
From a configuration standpoint, Things tell openHAB which **physical entities** (devices, web services, information sources, etc.) are to be managed by the system. From a configuration standpoint, Things tell openHAB which **physical entities** (devices, web services, information sources, etc.) are to be managed by the system.
Things are connected to openHAB through [bindings]({{base}}/addons/bindings.html). Things are connected to openHAB through [bindings](/addons/#binding).
In order to add a Thing to the system, you must first identify the appropriate binding which will provide the type of Thing you wish to add. In order to add a Thing to the system, you must first identify the appropriate binding which will provide the type of Thing you wish to add.
For example, before adding a Thing for a Z-Wave device, the Z-Wave binding must first be installed. For example, before adding a Thing for a Z-Wave device, the Z-Wave binding must first be installed.
@ -90,7 +90,7 @@ Looking at the first example:
- the physical location of the Thing is "Living Room" - the physical location of the Thing is "Living Room"
- the values inside the `[]` brackets are the Thing's configuration parameters, these are partly mandatory and optional - the values inside the `[]` brackets are the Thing's configuration parameters, these are partly mandatory and optional
Please check each individual binding's [documentation]({{base}}/addons/bindings.html) for details on what and how to define Things using the `*.things` configuration text files. Please check each individual binding's [documentation](/addons/#binding) for details on what and how to define Things using the `*.things` configuration text files.
### Linking Items ### Linking Items