Wouter Born
GitHub
parent
15995937a3
commit
6d42647cb8
|
|
@ -36,7 +36,7 @@ Transformation files need to be placed in the directory `$OPENHAB_CONF/transform
|
|||
|
||||
```
|
||||
|
||||
Usage of Transformations in the [label parameter of Sitemap elements]({{base}}/configuration/sitemaps.html#element-type-text) works the same way.
|
||||
Usage of Transformations in the [label parameter of Sitemap elements]({{base}}/ui/sitemaps.html#element-type-text) works the same way.
|
||||
|
||||
1. Rules
|
||||
|
||||
|
|
|
|||
|
|
@ -18,10 +18,10 @@ In order to represent all of these, openHAB defines the following base component
|
|||
- [Things](things.html) - Your devices represented in openHAB
|
||||
- [Items](items.html) - properties and capabilities of your Things
|
||||
- [Groups](items.html#groups) - collections or categories containing Items
|
||||
- [Transformations](transform.html) - Helper functions to transform your data
|
||||
- [Transformations](transformations.html) - Helper functions to transform your data
|
||||
- [Persistence](persistence.html) - Services to store data over time
|
||||
- [Rules](rules-dsl.html) - Automation logic, the "smart" in your Smart Home!
|
||||
- [Blockly Rules](rules-blockly.html) - Visually define the automation logic of your Smart Home
|
||||
- [Blockly Rules](blockly/) - Visually define the automation logic of your Smart Home
|
||||
- [JSR223 Scripting](jsr223.html) - Define rules and other runtime objects using [Javascript](https://openjdk.java.net/projects/nashorn/), [Jython](https://www.jython.org) or [Groovy](https://www.groovy-lang.org/)
|
||||
|
||||
The individual articles have all the details needed to understand the concepts behind these building blocks for your Smart Home.
|
||||
|
|
|
|||
|
|
@ -204,7 +204,7 @@ Two naming schemes are established in the community for Group names:
|
|||
### Label
|
||||
|
||||
Label text is used to describe an Item in a human-readable way.
|
||||
Graphical UIs will display the label text when the Item is included, e.g. in [Basic UI]({{base}}/configuration/ui/basic.html) in a [Sitemap]({{base}}/configuration/sitemaps.html) definition.
|
||||
Graphical UIs will display the label text when the Item is included, e.g. in Basic UI in a [Sitemap]({{base}}/ui/sitemaps.html) definition.
|
||||
Some I/O services (e.g. the Amazon Alexa skill) also use the label to match an external voice command to an Item.
|
||||
|
||||
In textual configurations the label, in quotation marks, appears next to the optional [state presentation](#state-presentation) field in square brackets (see below).
|
||||
|
|
@ -214,7 +214,7 @@ The label for the Item in the following example is "Temperature" and the optiona
|
|||
Number Livingroom_Temperature "Temperature [%.1f °C]"
|
||||
```
|
||||
|
||||
Channel labels can be overwritten by Item definitions and Item labels can be overwritten in [Sitemaps]({{base}}/configuration/sitemaps.html#element-types).
|
||||
Channel labels can be overwritten by Item definitions and Item labels can be overwritten in [Sitemaps]({{base}}/ui/sitemaps.html#element-types).
|
||||
|
||||
{: #state}
|
||||
|
||||
|
|
@ -433,7 +433,7 @@ For example:
|
|||
- Maintenance Group → All battery states → Individual battery states in percentage
|
||||
- Further examples: all lights, all room temperatures, combined power consumption
|
||||
|
||||
These relationships can be exploited in [Sitemaps]({{base}}/configuration/sitemaps.html) or in [automation rules]({{base}}/configuration/rules-dsl.html) to navigate through the hierarchically organized Items or to perform computations and updates on subsets of similar Items.
|
||||
These relationships can be exploited in [Sitemaps]({{base}}/ui/sitemaps.html) or in [automation rules]({{base}}/configuration/rules-dsl.html) to navigate through the hierarchically organized Items or to perform computations and updates on subsets of similar Items.
|
||||
|
||||
**Example:**
|
||||
|
||||
|
|
@ -700,7 +700,7 @@ There are some built-in Profiles available which are described in the table belo
|
|||
Some Bindings will may offer additional Profiles for Binding-specific use cases.
|
||||
If this is the case, you will find those within the documentation of the Binding.
|
||||
|
||||
Also, all [Transformation Services](/addons/#transform) provide a State Profile which allows you to do the transformation already on item-level instead doing it with a [Sitemap]({{base}}/configuration/sitemaps.html).
|
||||
Also, all [Transformation Services](/addons/#transform) provide a State Profile which allows you to do the transformation already on item-level instead doing it with a [Sitemap]({{base}}/ui/sitemaps.html).
|
||||
You can find the documentation of these Profiles within the [Add-On documentation of the Transformation Service](/addons/#transform) you would like to use.
|
||||
|
||||
| Profile ID | Type | Supported Item Types | Description |
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ From start to finish, the process for fully configuring a physical entity repres
|
|||
1. Define and configure the Thing
|
||||
1. Identify the Channels provided by the Thing
|
||||
1. [Add Items]({{base}}/configuration/items.html) and link them to the Thing's Channels
|
||||
1. At this point Items can be used to control the Thing or consume its information in e.g. [Sitemaps]({{base}}/configuration/sitemaps.html) or [Rules]({{base}}/configuration/rules-dsl.html)
|
||||
1. At this point Items can be used to control the Thing or consume its information in e.g. [Sitemaps]({{base}}/ui/sitemaps.html) or [Rules]({{base}}/configuration/rules-dsl.html)
|
||||
|
||||
There are two methods for defining Things provided by the various bindings:
|
||||
through [discovery]({{base}}/concepts/discovery.html) or by manual definition in configuration text files.
|
||||
|
|
@ -55,7 +55,7 @@ Unlike manually defined Things, if a Thing has configurable properties, these pr
|
|||
**Attention:** It has to be noted, that Things and Items added through the UI / discovery to the internal database will **not** be written to configuration files.
|
||||
Things and Items definitions can be distributed and mixed among the internal database and manually defined text files.
|
||||
|
||||
See the [beginer tutorial]({{base}}/tutorials/things_simple.html) for a step-by-step guide on how to configure Things using discovery.
|
||||
See the [beginner tutorial]({{base}}/tutorial/things_simple.html) for a step-by-step guide on how to configure Things using discovery.
|
||||
|
||||
### Defining Things Using Files
|
||||
|
||||
|
|
|
|||
|
|
@ -189,7 +189,7 @@ The following types are supported for configuration values: `Boolean`, `boolean`
|
|||
|
||||
*Things* can have properties.
|
||||
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.
|
||||
The properties section [here](thing-definition.html#Properties) explains how to specify such properties.
|
||||
The properties section [here](thing-xml.html#properties) explains how to specify such properties.
|
||||
|
||||
To retrieve the properties one can call the operation `getProperties` of the corresponding `org.openhab.core.thing.type.ThingType` instance.
|
||||
If a thing will be created for this thing type then its properties will be automatically copied into the new thing instance.
|
||||
|
|
@ -966,7 +966,7 @@ mDNS discovery is implemented in the framework as `MDNSDiscoveryService`.
|
|||
To facilitate the development, binding developers only need to implement a `MDNSDiscoveryParticipant`.
|
||||
Here the developer only needs to implement four simple methods:
|
||||
|
||||
- `getServiceType` - Defines the [mDNS service type](https://www.dns-sd.org/ServiceTypes.html).
|
||||
- `getServiceType` - Defines the [mDNS service type](http://www.dns-sd.org/ServiceTypes.html).
|
||||
- `getSupportedThingTypeUIDs` - Returns the list of thing type UIDs that this participant supports.
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -230,7 +230,7 @@ C:\openHAB\userdata\bin\openHAB-service.bat remove
|
|||
You can connect to openHAB's console using the the `C:\openHAB\runtime\bin\client.bat` script on the local machine.
|
||||
Alternatively, you can use a standard SSH client:
|
||||
|
||||
1. Install an SSH client application, e.g., [Putty](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html), [KiTTY](http://kitty.9bis.net/) or [Xshell 5](https://www.netsarang.com/products/xsh_overview.html)
|
||||
1. Install an SSH client application, e.g., [Putty](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html), [KiTTY](http://kitty.9bis.net/) or [Xshell](https://www.netsarang.com/en/xshell/)
|
||||
|
||||
1. Setup a session with the following parameters:
|
||||
|
||||
|
|
|
|||
|
|
@ -81,7 +81,7 @@ The following table gives a top-level description of the most important concepts
|
|||
| Channels | are the openHAB (software) connection between “Things” and “Items” (see below) | _see below_ |
|
||||
| Items | are the openHAB (software) generated representation of information about the devices | [click for more info on Items]({{base}}/concepts/items.html) |
|
||||
| Rules | that perform automatic actions (in its simplest form: if "this" happens, openHAB will do "that") | [click for more info on Rules]({{base}}/configuration/rules-dsl.html) |
|
||||
| Sitemap | is the openHAB (software) generated user interface (web site) that presents information and allows for interactions | [click for more info on Sitemaps]({{base}}/configuration/sitemaps.html) |
|
||||
| Sitemap | is the openHAB (software) generated user interface (web site) that presents information and allows for interactions | [click for more info on Sitemaps]({{base}}/ui/sitemaps.html) |
|
||||
|
||||
While the table above gives an overview, please remember that it is incomplete and a simplification of openHAB for the sake of this overview.
|
||||
More elements will be introduced in later chapters of the documentation.
|
||||
|
|
|
|||
|
|
@ -52,11 +52,11 @@ Edit the file per the docs to define the strategies.
|
|||
|
||||
Often, one will not want to use the same persistence strategy for all Items.
|
||||
One may not even want to save all their Items, or may want to save different Items to different databases using different strategies.
|
||||
For example, a common approach would be to use [`MapDB`]({{base}}/addons/persistence/mapdb/) only for those Items that should be restored on startup, [`rrd4j`]({{base}}/addons/persistence/rrd4j) with an `everyChange` and every minute strategy for number and binary (Switch, Contact) type Items that are to be charted, and [`Influxdb`]({{base}}/addons/persistence/influxdb) with an `everyUpdate` strategy for analysis with external tools.
|
||||
For example, a common approach would be to use [`MapDB`](/addons/persistence/mapdb/) only for those Items that should be restored on startup, [`rrd4j`](/addons/persistence/rrd4j) with an `everyChange` and every minute strategy for number and binary (Switch, Contact) type Items that are to be charted, and [`Influxdb`](/addons/persistence/influxdb) with an `everyUpdate` strategy for analysis with external tools.
|
||||
|
||||
## Default Persistence
|
||||
|
||||
openHAB ships with [`rrdj4`]({{base}}/addons/persistence/rrd4j) as the default persistence database and comes with a default persistence strategy of `everyChange`, `everyMinute`, and `restoreOnStartup` for every supported Item.
|
||||
openHAB ships with [`rrdj4`](/addons/persistence/rrd4j) as the default persistence database and comes with a default persistence strategy of `everyChange`, `everyMinute`, and `restoreOnStartup` for every supported Item.
|
||||
The good thing about `rrd4j` is that the database never grows beyond a given size, so you never have to clean it up.
|
||||
However, the way it achieves this (replacing ten readings with the average of the ten readings as the data gets older) makes the database not work for all Item types.
|
||||
If you need to `restoreOnStartup` unsupported Item types, `MapDB` might be a better choice for you.
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ Choose the correct port, alter the name and/or ID of the controller Thing, then
|
|||
Once back on the Things screen, click on the "+" button then on Z-Wave Binding again.
|
||||
Click scan and all the devices already paired with the Zwave controller will be discovered and appear in the Inbox.
|
||||
To pair a new device, while on this screen, perform the procedure specific to the device to include it in your network.
|
||||
Go to the add-ons section of [this site]({{base}}/addons/bindings/zwave/doc/things.html#things-supported-by-the-z-wave-binding) and search for for the device model in the search bar.
|
||||
Go to the add-ons section of [this site](/addons/bindings/zwave/doc/things.html#things-supported-by-the-z-wave-binding) and search for for the device model in the search bar.
|
||||
The page should give you details on the inclusion procedure.
|
||||
Alternatively, look in the device's documentation from the vendor.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue