Remove paper ui references. (#1457)
* Remove paper uii references. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Fix Markdown errors. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Remove target param from markdownlint pr trigger. Signed-off-by: Jerome Luckenbach <github@luckenba.ch>pull/1458/head
Jerome Luckenbach
GitHub
parent
e550bc0c1c
commit
e3e0e3679d
|
|
@ -10,7 +10,7 @@ on:
|
|||
tags-ignore:
|
||||
- '**'
|
||||
|
||||
pull_request_target:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
types:
|
||||
|
|
|
|||
113
addons/index.md
113
addons/index.md
|
|
@ -1,112 +1,7 @@
|
|||
---
|
||||
layout: documentation
|
||||
layout: redirected
|
||||
sitemap: false
|
||||
redirect_to: /configuration/addons.html
|
||||
---
|
||||
|
||||
# Add-ons
|
||||
|
||||
All add-ons for openHAB 2 are part of the distribution.
|
||||
This includes all 2.x Bindings as well as all 1.x add-ons that were reported to be compatible.
|
||||
There are several ways you can install an add-on.
|
||||
These are described under *Installation of Add-ons* below
|
||||
|
||||
| Add-on Type | Description |
|
||||
|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
|
||||
| [Bindings](/addons/#bindings) | Bindings integrate physical hardware, external systems and web services in openHAB |
|
||||
| [User Interfaces]({{base}}/configuration/#versatility) | User interfaces are either native smartphone apps or web applications that access the openHAB server through the REST API |
|
||||
| [Persistence](/addons/#persistence) | Persistence services allow openHAB to store time series data for history-based actions or statistics |
|
||||
| [Actions](/addons/#actions) | Actions are predefined methods for openHAB rules and scripts |
|
||||
| [Transformations](/addons/#transform) | Transformations are used to translate between technical and human-readable values for Items |
|
||||
| [Voice Services](/addons/#voice) | Services that provide voice enabling features, such as text-to-speech, speech-to-text etc. |
|
||||
| [3rd Party System Integration](/addons/#ios) | Expose openHAB to external systems |
|
||||
|
||||
## Installation of Add-ons
|
||||
|
||||
Depending on the [package]({{base}}/configuration/packages.html) you have chosen during your first time setup, there are already some pre-installed add-ons.
|
||||
Additional add-ons can be installed in the different ways, described below.
|
||||
|
||||
### Through Paper UI
|
||||
|
||||
Navigate to the add-ons section.
|
||||
Search for the desired add-on in the categories and press install.
|
||||
|
||||
|
||||
|
||||
### Through Configuration Files
|
||||
|
||||
For this installation option you need to know the `id` of the desired add-on, e.g., network or mqtt1.
|
||||
|
||||
You can find it out with the following command within [openHAB console]({{base}}/administration/console.html):
|
||||
|
||||
```sh
|
||||
feature:list | grep ^openhab
|
||||
```
|
||||
|
||||
A list of all available add-ons starting with "openhab" will be returned.
|
||||
It could look similar to this example:
|
||||
|
||||
```text
|
||||
...
|
||||
openhab-transformation-xslt | 0.9.0.SNAPSHOT | | Uninstalled | openhab-aggregate-xml | XSLT Transformation
|
||||
openhab-voice-mactts | 0.9.0.SNAPSHOT | | Uninstalled | openhab-aggregate-xml | macOS Text-to-Speech
|
||||
openhab-binding-amazondashbutton | 2.0.0.SNAPSHOT | | Uninstalled | openhab-aggregate-xml | Amazon Dash Button Binding
|
||||
openhab-binding-astro | 2.0.0.SNAPSHOT | | Uninstalled | openhab-aggregate-xml | Astro Binding
|
||||
openhab-binding-autelis | 2.0.0.SNAPSHOT | | Uninstalled | openhab-aggregate-xml | Autelis Binding
|
||||
openhab-binding-avmfritz | 2.0.0.SNAPSHOT | | Uninstalled | openhab-aggregate-xml | AVM Fritz!Box Binding
|
||||
...
|
||||
openhab-binding-network │ 2.2.0 │ │ Uninstalled │ openhab-addons-2.2.0 │ Network Binding
|
||||
...
|
||||
```
|
||||
|
||||
According to the [naming convention for bundles]({{base}}/administration/bundles.html#naming-convention-for-bundles) the *id* for the shown example is *network*.
|
||||
|
||||
Another way to find the correct `id` is to look at the URL of the add-on documentation page.
|
||||
For example the url for the [mqtt Binding documentation]({{base}}/addons/bindings/mqtt1/readme.html) is
|
||||
|
||||
```text
|
||||
https://docs.openhab.org/addons/bindings/mqtt1/readme.html
|
||||
```
|
||||
|
||||
In this case, the `id` would be "mqtt1".
|
||||
Did you notice the trailing *1* in this id?
|
||||
This is because the mqtt Binding is a 1.x add-on.
|
||||
|
||||
The trailing `1` has to be appended for `binding`- and `misc`-addons.
|
||||
It is *not needed* for other addon types like `persistence`.
|
||||
|
||||
With this information we can now edit the *addons.cfg* file in the `$OPENHAB_CONF/services` folder on the machine you are running openHAB on.
|
||||
The path is depending on your installation.
|
||||
You can find out the correct locations on the corresponding documentation pages, e.g. [Linux]({{base}}/installation/linux.html#file-locations) or [Windows]({{base}}/installation/windows.html#file-locations).
|
||||
|
||||
The file could look like this (depending on your chosen package and already installed add-ons):
|
||||
|
||||
```text
|
||||
package = standard
|
||||
ui = basic,paper,habpanel
|
||||
action = pushover
|
||||
binding = astro,mqtt1
|
||||
transformation = jsonpath
|
||||
persistence = influxdb
|
||||
misc = restdocs
|
||||
```
|
||||
|
||||
To install the network Binding like we want in this example, we just need to add the id *network* to the Binding section.
|
||||
|
||||
```text
|
||||
binding = astro,mqtt1,network
|
||||
```
|
||||
|
||||
After saving the file, the add-on will be installed.
|
||||
|
||||
### Through manually provided add-ons
|
||||
|
||||
> Attention:
|
||||
> This option is adressed to advanced users.
|
||||
> Installing add-os with a `.jar`file can lead to problems, because add-on dependencies may not be installed.
|
||||
> Please make sure to use this option only in special cases (like add-on testing for an upcoming version) or when you know what you are doing.
|
||||
|
||||
For this installation option you need a bundles `.jar` file.
|
||||
One way of retrieving those files is mentiones above in the openHAB console part.
|
||||
|
||||
Place the `.jar` file in the `addons` folder on the machine you are running openHAB on.
|
||||
As described already for the addons.cfg option, the path is depending on your installation.
|
||||
Place the .jar file in the folder Additional add-on files as described in File Locations ([Linux]({{base}}/installation/linux.html#file-locations), [Windows]({{base}}/installation/windows.html#file-locations) or [macOS]({{base}}/installation/macos.html#file-locations)).
|
||||
<!-- Note to authors: This file was created in January 2021. Feel free to remove it after a few months... -->
|
||||
|
|
@ -9,7 +9,7 @@ title: System Integrations
|
|||
|
||||
openHAB supports services that enable integration with various technologies that don't fall into other add-on categories.
|
||||
|
||||
Most of the systems mentioned below are integrated via a *Misc* add-on, installed e.g. through Paper UI.
|
||||
Most of the systems mentioned below are integrated via a *Misc* add-on, installed e.g. through UI.
|
||||
Detailed instructions and requirements may be found in the corresponding documentation pages.
|
||||
|
||||
<!-- selection not needed for now table id="ios-select" class="striped">
|
||||
|
|
|
|||
|
|
@ -1,37 +1,7 @@
|
|||
---
|
||||
layout: documentation
|
||||
title: User Interfaces
|
||||
layout: redirected
|
||||
sitemap: false
|
||||
redirect_to: /configuration/editors.html
|
||||
---
|
||||
|
||||
{% include base.html %}
|
||||
|
||||
# User Interfaces
|
||||
|
||||
openHAB offers a variety of frontends for user interaction, from administrative web frontends to dedicated smartphone apps.
|
||||
|
||||
| Web Application | Description |
|
||||
|-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [Basic UI]({{base}}/addons/uis/basic/readme.html) | The Basic UI is an HTML5 web application in Material Design, designed for operating openHAB. |
|
||||
| [Classic UI]({{base}}/addons/uis/classic/readme.html) | The Classic UI is the original openHAB 1.x webui, designed for operating openHAB. |
|
||||
| [HABmin]({{base}}/addons/uis/habmin/readme.html) | HABmin is a modern, professional and portable user interface for openHAB, providing both user and administrative functions. |
|
||||
| [HABPanel]({{base}}/addons/uis/habpanel/readme.html) | HABPanel is a lightweight dashboard interface for openHAB. |
|
||||
| [Paper UI]({{base}}/addons/uis/paper/readme.html) | The Paper UI is an AngularJS-based HTML5 web application in Material Design, designed for setup and administration purposes. |
|
||||
|
||||
| App | Description |
|
||||
|---------------------------------------------------------|--------------------------------------------------------|
|
||||
| [Android App]({{base}}/addons/uis/apps/android.html) | The native Android app to access openHAB on the go. |
|
||||
| [iOS App]({{base}}/addons/uis/apps/ios.html) | The native iOS app to access openHAB on the go. |
|
||||
| [Windows 10 App]({{base}}/addons/uis/apps/windows.html) | The native Windows 10 app to access openHAB on the go. |
|
||||
|
||||
## Iconsets
|
||||
|
||||
Basic UI, Classic UI and all openHAB apps present a graphical user interface as defined in [Sitemaps]({{base}}/configuration/sitemaps.html), with the help of [Items]({{base}}/configuration/items.html).
|
||||
Each Item as well as each Sitemap element may be associated with an icon visible next to it.
|
||||
Currently only the Classic Icon Set is provided.
|
||||
|
||||
Addition of personal icons and customization of the existing ones is supported and encouraged.
|
||||
See the instructions about [Custom Icons and Custom Dynamic Icons]({{base}}/configuration/items.html#icons) for more details.
|
||||
|
||||
| Iconset | Description |
|
||||
|-----------------------------------------------------------|---------------------------------------------------------------------|
|
||||
| [Classic Icons]({{base}}/configuration/iconsets/classic/) | This is a modernized version of the original icon set of openHAB 1. |
|
||||
<!-- Note to authors: This file was created in January 2021. Feel free to remove it after a few months... -->
|
||||
|
|
@ -12,7 +12,7 @@ Log into your admin account (if not already done).
|
|||
Navigate to `Settings` and have a look for the add-ons section.
|
||||
Search for the desired add-on in the categories and press install.
|
||||
|
||||
|
||||
|
||||
|
||||
## Through Configuration Files
|
||||
|
||||
|
|
|
|||
|
|
@ -5,13 +5,14 @@ title: openHAB API tokens
|
|||
|
||||
# openHAB API tokens
|
||||
|
||||
API tokens are an authentication method, like an username and password.
|
||||
API tokens are an authentication method, like an username and password.
|
||||
Usually you would use an API token to authenticate an external service or script.
|
||||
|
||||
## Generate an API token
|
||||
|
||||
Sign in to openHAB with your administrator username and password, by clicking on the sign-in button (bottem left).
|
||||
|
||||
After signing in, click again on the profile button to access your profile page.
|
||||
After signing in, click again on the profile button to access your profile page.
|
||||
Click on Create new API token.
|
||||
|
||||
|
||||
|
|
@ -20,7 +21,7 @@ Use your admin username and password and fill in the token name (e.g. the servic
|
|||
|
||||
|
||||
|
||||
Now the token is created.
|
||||
Now the token is created.
|
||||
Copy the complete token.
|
||||
|
||||
|
||||
|
|
@ -31,8 +32,8 @@ As example, below in NodeRed configuration the generated token is used as userna
|
|||
|
||||
|
||||
## Overview of generated tokens
|
||||
In your profile overview page you can find an overview of generated tokens.
|
||||
|
||||
In your profile overview page you can find an overview of generated tokens.
|
||||
Additionally, they can be deleted here.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ To switch from the local storage to a server-hosted panel configuration, go to t
|
|||
|
||||
Even when there is an active panel configuration, HABPanel uses the browser's storage to sync a locally-managed copy. With the **Edit the local panel configuration (experts only)** link under the _"Local storage"_ storage configuration option in the settings screen, the raw structure of the panel configuration can be inspected, modified, and exported or imported from/to a .json file. It is also an alternative way to backup, restore and share the configuration.
|
||||
|
||||
HABPanel uses service configuration variables to store its data on the openHAB server. They can be accessed using Paper UI (_Configuration > Services > UI > HABPanel > Configure_) or in the openHAB Karaf console:
|
||||
HABPanel uses service configuration variables to store its data on the openHAB server. They can be accessed using UI (_Settings > UI > HABPanel > Configure_) or in the openHAB Karaf console:
|
||||
|
||||
```shell
|
||||
openhab> config:edit org.openhab.habpanel
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ The distribution comes with these options built-in:
|
|||
|---------------------|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `javasound` | System Speaker | This uses the JRE sound drivers to play audio to the local sound interface. |
|
||||
| `enhancedjavasound` | System Speaker (with mp3 support) | This uses the JRE sound drivers plus an additional 3rd party library, which adds support for mp3 files. |
|
||||
| `webaudio` | Web Audio | Convenient, if sounds should not be played on the server, but on the client: This sink sends the audio stream through HTTP to web clients, which then cause it to be played back by the browser. Obviously, the browser needs to be opened and have a compatible openHAB UI running. Currently, this feature is supported by Paper UI and HABPanel. |
|
||||
| `webaudio` | Web Audio | Convenient, if sounds should not be played on the server, but on the client: This sink sends the audio stream through HTTP to web clients, which then cause it to be played back by the browser. Obviously, the browser needs to be opened and have a compatible openHAB UI running. Currently, this feature is supported by UI and HABPanel. |
|
||||
|
||||
Additionally, certain bindings register their supported devices as audio sinks, e.g. Sonos speakers.
|
||||
|
||||
|
|
@ -46,7 +46,7 @@ javasound
|
|||
webaudio
|
||||
```
|
||||
|
||||
You can define the default audio sink either by textual configuration in `$OPENHAB_CONF/services/runtime.cfg` or in the Paper UI in `Configuration->System->Audio`.
|
||||
You can define the default audio sink either by textual configuration in `$OPENHAB_CONF/services/runtime.cfg` or in the UI in `Settings->Audio`.
|
||||
|
||||
In order to play a sound, you can use the following command on the console:
|
||||
|
||||
|
|
@ -99,7 +99,7 @@ mactts:Ioana Ioana (ro_RO)
|
|||
mactts:Kanya Kanya (th_TH)
|
||||
```
|
||||
|
||||
You can define a default TTS service and a default voice to use either by textual configuration in `$OPENHAB_CONF/services/runtime.cfg` or in the Paper UI in `Configuration->System->Voice`.
|
||||
You can define a default TTS service and a default voice to use either by textual configuration in `$OPENHAB_CONF/services/runtime.cfg` or in the UI in `Settings->Voice`.
|
||||
|
||||
In order to say a text, you can enter such a command on the console (The default voice and default audio sink will be used):
|
||||
|
||||
|
|
|
|||
|
|
@ -22,8 +22,8 @@ Please refer to the [available persistence service add-on](/addons/#persistence)
|
|||
It is important to select a default persistence service.
|
||||
You should do this even if you have only one persistence add-on installed.
|
||||
|
||||
To select a default persistence service, in paper UI, select Configuration and then System from the side menu.
|
||||
Scroll down to "Persistence", and select your default service from the drop-down list.
|
||||
To select a default persistence service, in UI, select `Settings->Persistence`.
|
||||
Select your default service from the drop-down list.
|
||||
Note that you must first install a persistence add-on before you make this selection.
|
||||
Be sure to save your choice once you have selected your default service.
|
||||
|
||||
|
|
|
|||
|
|
@ -241,7 +241,7 @@ You can find all the possible values for status from [Thing Status](/docs/concep
|
|||
And refer to [Thing Status Action](/docs/configuration/actions.html#thing-status-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.
|
||||
You can find it from PaperUI or from Karaf remote console.
|
||||
You can find it from UI or from Karaf remote console.
|
||||
For example, one z-wave device can be "zwave:device:c5155aa4:node14".
|
||||
|
||||
::: tip Note
|
||||
|
|
|
|||
|
|
@ -234,11 +234,11 @@ If you decide not to, then the label from the referenced channel type definition
|
|||
|
||||
### Linking Items
|
||||
|
||||
Items can be linked to Channels of discovered or manually defined Things inside Paper UI or inside configuration files.
|
||||
Items can be linked to Channels of discovered or manually defined Things inside UI or inside configuration files.
|
||||
For more details about Item definition and usage, please refer to the [Items configuration article]({{base}}/configuration/items.html).
|
||||
|
||||
It is important to note, that Channels of discovered Things can also be linked to Items defined in `.items` files.
|
||||
In order to link a Thing to an Item in an `.items` file, open the Thing in Paper UI under *Configuration → Things*.
|
||||
In order to link a Thing to an Item in an `.items` file, open the Thing in UI under `Settings → Things`.
|
||||
In the list of Thing Channels, look for the Channel you wish to link to an Item and copy the Channel's ID.
|
||||
For instance, a Z-Wave switch might have a Switch Channel that has an ID like this:
|
||||
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ The distribution comes with these built-in audio sinks options:
|
|||
|-------------------|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| javasound | System Speaker | This uses the JRE sound drivers to play audio to the local sound interface. |
|
||||
| enhancedjavasound | System Speaker (with mp3 support) | This uses the JRE sound drivers plus an additional 3rd party library, which adds support for mp3 files. |
|
||||
| webaudio | Web Audio | If sounds should not be played on the server but on the client: This sink sends the audio stream through HTTP to web clients, which then cause it to be played back by the browser. The browser needs to be opened and have a compatible UI running. Currently this feature is supported by Paper UI and HABPanel. |
|
||||
| webaudio | Web Audio | If sounds should not be played on the server but on the client: This sink sends the audio stream through HTTP to web clients, which then cause it to be played back by the browser. The browser needs to be opened and have a compatible UI running. Currently this feature is supported by UI and HABPanel. |
|
||||
|
||||
The framework is able to play sound either from the file system, from URLs (e.g. Internet radio streams) or generated by text-to-speech engines (which are available as optional Voice add-ons).
|
||||
|
||||
|
|
|
|||
|
|
@ -818,7 +818,7 @@ There is no explicit end to an active scan and discovery results can be provided
|
|||
If you would like assistance with enforcing a scan end pass a timeout to the `AbstractDiscoveryService` constructor.
|
||||
`stopScan` will then be called on your discovery service upon timeout expiration allowing you to stop your scan however needed.
|
||||
If a timeout is specified the scan will be considered active until the timeout expires even if `startScan` completed beforehand.
|
||||
In particular UIs such as the Paper UI will show the scan as in progress throughout the timeout.
|
||||
In particular UIs the scan will be shown as in progress throughout the timeout.
|
||||
If you override `stopScan` don't forget to call `super.stopScan` as `AbstractDiscoveryService` performs some cleanup in its version.
|
||||
If the timeout is set to 0 `stopScan` will not be called.
|
||||
|
||||
|
|
|
|||
|
|
@ -88,7 +88,7 @@ If you already have Eclipse installed it is recommended to perform a separate Ec
|
|||
## Working with Add-ons
|
||||
|
||||
To easily run, modify and debug an add-on the `openHAB Development` setup installs and imports a demo project that contains a complete openHAB environment to run and debug an add-on.
|
||||
This mechanism replaces the add-on installation process via the PaperUI that you would use outside the IDE.
|
||||
This mechanism replaces the add-on installation process via the UI that you would use outside the IDE.
|
||||
|
||||
### Running Add-ons
|
||||
|
||||
|
|
@ -146,11 +146,11 @@ The following files are of interest for the execution environment:
|
|||
|
||||
1. Start openHAB from the IDE by clicking "Run OSGi" (upper right of the `app.bndrun` window).
|
||||
|
||||
1. You can check that openHAB is running with your browser by going to: `http://localhost:8080/paperui/` (the last `/` is important!)
|
||||
1. You can check that openHAB is running with your browser by going to: `http://localhost:8080/` (the last `/` is important!)
|
||||
|
||||
1. You can check log output in the `Console` tab at the bottom.
|
||||
|
||||
1. Check the chosen binding is active in `Paper UI > Configuration > Bindings`
|
||||
1. Check the chosen binding is active in `UI > Settings > Bindings`
|
||||
|
||||
View all the above steps in a single animation:
|
||||
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ The id is provided through a static method and can be retrieved through
|
|||
|
||||
The `NetworkAddressService` is an OSGi service that can be used like any other OSGi service by adding a service reference to it.
|
||||
Its OSGi service name is `org.openhab.core.network`.
|
||||
A user can configure his default network address via Paper UI under `Configuration -> System -> Network Settings`.
|
||||
A user can configure his default network address via UI under `Settings -> Network Settings`.
|
||||
One can obtain the configured address via the `getPrimaryIpv4HostAddress()` method on the service.
|
||||
This service is useful for example in the `ThingHandlerFactory` or an `AudioSink` where one needs a specific IP address of the host system to provide something like a `callback` URL.
|
||||
|
||||
|
|
|
|||
|
|
@ -173,7 +173,7 @@ Note, always review the README on [Docker Hub](https://hub.docker.com/r/openhab/
|
|||
- `-v /etc/timezone:/etc/timezone:ro` : ties the timezone of the container to the host's time zone, read only so the container cannot change the host's time zone
|
||||
- `-v /opt/openhab/conf:/openhab/conf` : location of the conf folder for openHAB configurations (*Note:* you must create these folders on the host before running the container)
|
||||
- `-v /opt/openhab/userdata:/openhab/userdata` : location for logs, cache, persistence databases, etc.
|
||||
- `-v /opt/openhab/addons:/openhab/addons` : only needed if installing addons unavailable via PaperUI or the Karaf Console
|
||||
- `-v /opt/openhab/addons:/openhab/addons` : only needed if installing addons unavailable via UI or the Karaf Console
|
||||
- `-v /opt/openhab/.java:/openhab/.java` : needed by the Nest 1.x binding (and others?), location of the security token
|
||||
- `--device=/dev/ttyUSB0` : location of my zwave controller, change and/or add more --device tags to pass all your devices needed by openHAB to the container
|
||||
- `--restart=always` : if the container crashes or the system reboots the container is restarted
|
||||
|
|
|
|||
Loading…
Reference in New Issue