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

Removed some references to Eclipse SmartHome (#1070) 

And reformatted some tables.

Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
pull/1073/head
Hilbrand Bouwkamp 2019-11-06 22:43:10 +01:00 committed by Jerome Luckenbach
parent 2f5b9a0f63
commit c211fbe8d0
9 changed files with 41 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.vuepress/components/EditPageLink.vue
View File

@ -1,11 +1,6 @@
<template>
<div class="editLink" v-if="editUrl">
<em>Caught a mistake or want to contribute to the documentation? <a target="_blank" :href="editUrl">Edit this page on GitHub<OutboundLink /></a></em>
<div v-if="isEsh" class="esh-note"><br />
&#128712; This page comes from the Eclipse SmartHome project, which has specific
<a target="_blank" href="https://github.com/eclipse/smarthome/blob/master/CONTRIBUTING.md">legal and technical<OutboundLink /></a>
requirements for accepting contributions, please read them before submitting a change.
</div>
</div>
</template>
@ -26,9 +21,6 @@
<script>
export default {
computed: {
isEsh () {
return (this.$page.frontmatter.source.indexOf('eclipse/smarthome') > 0)
},
editUrl () {
if (!this.$page || !this.$page.frontmatter.source) return null
return this.$page.frontmatter.source.replace('/blob/', '/edit/').replace('/developer/', '/developers/')

3
README.md
View File

@ -48,9 +48,8 @@ You can read a bit more below about our external ressources and how we get them.
### Automatically Generated Parts
Those parts include __all__ add-on documentation files, no matter if they are from the Eclipse SmartHome repo, the
Those parts include __all__ add-on documentation files, no matter if they are from the `openhab-core` repo, the
`openhab1-addons` repo, the `openhab2-addons` repo or any special binding repo like *habmin*, *zwave* or the *alexa skill*.
The "Concepts" articles also come from Eclipse SmartHome and are maintained there.
We are keeping all those files at their original location, because it simply doesn't make sense to keep them here.
Imagine you want to do an improvement of the zwave binding and have to update the readme file in a completely different place.

2
addons/bindings.md
View File

@ -20,7 +20,7 @@ Bindings connect your smart home's devices and technologies to openHAB.
</td>
<td>
<p>
Bindings developed for openHAB 2 use the <a href="https://www.eclipse.org/smarthome/" target="_blank">Eclipse SmartHome</a> APIs.
Bindings developed for openHAB 2 use the openHAB APIs.
They support <a href="{{base}}/concepts/things.html">things and channels</a>, and many support automatic discovery of things.
These newer bindings can be the easiest to use.
</p>

13
appendix/contributing.md
View File

@ -18,13 +18,12 @@ More people will see your issue when it is posted in the forum and community mem
When no solution was found, use the table below to determine where your issue should be reported:
| Issue | Where to report |
|--------------------------------------------------------------------------------|--------------------------------------------------------------------|
| Problems and feature requests for openHAB 1 add-ons | [openHAB](https://github.com/openhab/openhab/issues) |
| Problems and feature requests for openHAB 2 add-ons | [openHAB2](https://github.com/openhab/openhab2/issues) |
| Issues related to the runtime environment, IDE and packaging | [openHAB-distro](https://github.com/openhab/openhab-distro/issues) |
| Issues related to the core openHAB bundles that are not from Eclipse SmartHome | [openHAB-core](https://github.com/kaikreuzer/openhab-core/issues) |
| Issues related to Eclipse SmartHome add-ons and core runtime | [Eclipse SmartHome](https://github.com/eclipse/smarthome/issues) |
| Issue | Where to report |
|--------------------------------------------------------------|--------------------------------------------------------------------|
| Problems and feature requests for openHAB 1 add-ons | [openHAB](https://github.com/openhab/openhab/issues) |
| Problems and feature requests for openHAB 2 add-ons | [openHAB2](https://github.com/openhab/openhab2/issues) |
| Issues related to the runtime environment, IDE and packaging | [openHAB-distro](https://github.com/openhab/openhab-distro/issues) |
| Issues related to the core openHAB bundles | [openHAB-core](https://github.com/kaikreuzer/openhab-core/issues) |
But do not worry - if you are not clear, which category your issue belongs to - we will redirect you, if necessary.

2
concepts/audio.md
View File

@ -9,7 +9,7 @@ title: Audio & Voice
Audio and voice features are an important aspect of any smart home solution as it is a very natural way to interact with the user.
Eclipse SmartHome comes with a very modular architecture that enables all kinds of different use cases.
openHAB comes with a very modular architecture that enables all kinds of different use cases.
At its core, there is the notion of an *audio stream*.
Audio streams are provided by *audio sources* and consumed by *audio sinks*.

14
concepts/categories.md
View File

@ -7,7 +7,7 @@ title: Categories
# Categories
Categories in Eclipse SmartHome are used to provide meta information about Things, Channels, etc. UIs can use this information to render specific icons or provide a search functionality to for example filter all Things for a certain category.
Categories in openHAB are used to provide meta information about Things, Channels, etc. UIs can use this information to render specific icons or provide a search functionality to for example filter all Things for a certain category.
## Differences between categories
@ -21,9 +21,9 @@ User interfaces can parse this category to get an idea how to render this Thing.
A Binding can classify each Thing into one of the existing categories.
The list of all predefined categories can be found in our categories overview:
| Category | Description | Icon Example |
|-----------------|-------------|{% for category in site.data.categories_thing %}
|{{category.name}}|{{category.description}}|![{{category.icon}}](/iconsets/classic/{{category.icon}}){:height="36px" width="36px"}|{% endfor %}
| Category | Description | Icon Example | |
|-------------------|--------------------------|-{% for category in site.data.categories_thing %}---------------------------------------|--------------|
| {{category.name}} | {{category.description}} | ![{{category.icon}}](/iconsets/classic/{{category.icon}}){:height="36px" width="36px"} | {% endfor %} |
### Channel Group Categories
@ -43,7 +43,7 @@ There are different types of categories for Channels, which are listed below.
{% for type in types %}
#### {{ type }}
| Category | Icon Example |
|-----------------|--------------|{% for category in site.data.categories %}{% if category.type == type %}
|{{category.name}}|![{{category.name | downcase}}](/iconsets/classic/{{category.name | downcase }}.png){:height="36px" width="36px"}|{% endif %}{% endfor %}
| Category | Icon Example | | | |
|-------------------|-------------------|-{% for category in site.data.categories %}{% if category.type == type %}-|-----------------------------------------------|-------------------------|
| {{category.name}} | ![{{category.name | downcase}}](/iconsets/classic/{{category.name | downcase }}.png){:height="36px" width="36px"} | {% endif %}{% endfor %} |
{% endfor %}

4
concepts/discovery.md
View File

@ -9,7 +9,7 @@ title: Thing Discovery
Many devices, technologies and systems can be automatically discovered on the network or browsed through some API. It therefore makes a lot of sense to use these features for a smart home solution.
In Eclipse SmartHome bindings therefore implement _Discovery Services_ for Things, which provide _Discovery Results_. All _Discovery Results_ are regarded as suggestions to the user and are put into the _inbox_.
In openHAB bindings therefore implement _Discovery Services_ for Things, which provide _Discovery Results_. All _Discovery Results_ are regarded as suggestions to the user and are put into the _inbox_.
### Background Discovery
@ -27,7 +27,7 @@ Each discovery result also has a timestamp when it was added to or updated in th
Discovery results can either be ignored or approved, where in the latter case a Thing is created for them and they become available in the application.
If an entry is ignored, it will be hidden in the inbox without creating a Thing for it.
Eclipse SmartHome 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.
openHAB 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.
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.
This service is enabled by default but can be disabled by setting `org.eclipse.smarthome.inbox:autoIgnore=false`.

44
concepts/items.md
View File

@ -7,28 +7,28 @@ title: Items
# Items
Eclipse SmartHome has a strict separation between the physical world (the "Things", see below) and the application, which is built around the notion of "Items" (also called the virtual layer).
openHAB has a strict separation between the physical world (the "Things", see below) and the application, which is built around the notion of "Items" (also called the virtual layer).
Items represent functionality that is used by the application (mainly user interfaces or automation logic).
Items have a state and are used through events.
The following Item types are currently available (alphabetical order):
| Item Name | Description | Command Types |
|--------------------|-------------|---------------|
| Color | Color information (RGB) | OnOff, IncreaseDecrease, Percent, HSB |
| Contact | Item storing status of e.g. door/window contacts | OpenClosed |
| DateTime | Stores date and time | - |
| Dimmer | Item carrying a percentage value for dimmers | OnOff, IncreaseDecrease, Percent |
| Group | Item to nest other Items / collect them in Groups | - |
| Image | Holds the binary data of an image | - |
| Location | Stores GPS coordinates | Point |
| Number | Stores values in number format, takes an optional dimension suffix | Decimal |
| Number:<dimension> | like Number, additional dimension information for unit support | Quantity |
| Player | Allows to control players (e.g. audio players) | PlayPause, NextPrevious, RewindFastforward |
| Rollershutter | Typically used for blinds | UpDown, StopMove, Percent |
| String | Stores texts | String |
| Switch | Typically used for lights (on/off) | OnOff |
| Item Name | Description | Command Types |
|--------------------|--------------------------------------------------------------------|--------------------------------------------|
| Color | Color information (RGB) | OnOff, IncreaseDecrease, Percent, HSB |
| Contact | Item storing status of e.g. door/window contacts | OpenClosed |
| DateTime | Stores date and time | - |
| Dimmer | Item carrying a percentage value for dimmers | OnOff, IncreaseDecrease, Percent |
| Group | Item to nest other Items / collect them in Groups | - |
| Image | Holds the binary data of an image | - |
| Location | Stores GPS coordinates | Point |
| Number | Stores values in number format, takes an optional dimension suffix | Decimal |
| Number:<dimension> | like Number, additional dimension information for unit support | Quantity |
| Player | Allows to control players (e.g. audio players) | PlayPause, NextPrevious, RewindFastforward |
| Rollershutter | Typically used for blinds | UpDown, StopMove, Percent |
| String | Stores texts | String |
| Switch | Typically used for lights (on/off) | OnOff |
## Group Items
@ -85,11 +85,11 @@ Examples for derived states on Group Items when declared in the Item DSL:
4. `yyyy-MM-dd'T'HH:mm:ssz`
5. `yyyy-MM-dd'T'HH:mm:ss`
Literal | Standard | Example
--------|----------|--------
z | General time zone | Pacific Standard Time; PST; GMT-08:00
Z | RFC 822 time zone | -0800
X | ISO 8601 time zone | -08; -0800; -08:00
| Literal | Standard | Example |
|---------|--------------------|---------------------------------------|
| z | General time zone | Pacific Standard Time; PST; GMT-08:00 |
| Z | RFC 822 time zone | -0800 |
| X | ISO 8601 time zone | -08; -0800; -08:00 |
### DecimalType, PercentType
@ -147,7 +147,7 @@ Such metadata can be attached to Items using disjunct namespaces so they won't c
Each metadata entry has a main value and optionally additional key/value pairs.
There can be metadata attached to an Item for as many namespaces as desired, like in the following example:
Switch "My Fan" { homekit="Fan.v2", alexa="Fan" [ type="oscillating", speedSteps=3 ] }
Switch MyFan "My Fan" { homekit="Fan.v2", alexa="Fan" [ type="oscillating", speedSteps=3 ] }
The metadata can be maintained via a dedicated REST endpoint and is included in the `EnrichedItemDTO` responses.

2
installation/index.md
View File

@ -7,7 +7,7 @@ title: Installation Overview
# Installation Overview
openHAB 2 is based on the Eclipse SmartHome framework and is fully written in Java.
openHAB 2 is fully written in Java.
As such, it only depends on a Java Virtual Machine, which is available for many platforms.
openHAB can be executed on different versions of **macOS** and **Windows** and many different variants of **Linux** (Ubuntu, Raspbian, ...).