Skip to content

Commit

Permalink
Remove paper ui references. (#1457)
Browse files Browse the repository at this point in the history 
* 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>
  • Loading branch information
@Confectrician
Confectrician authored Jan 16, 2021
1 parent e550bc0 commit e3e0e36
Show file tree
Hide file tree
Showing 16 changed files with 33 additions and 167 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/markdownlint.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:
tags-ignore:
- '**'

pull_request_target:
pull_request:
branches:
- main
types:
Expand Down
113 changes: 4 additions & 109 deletions addons/index.md
View file
Original file line number Diff line number Diff line change
@@ -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.

![installing Add-ons through Paper UI](images/index_installation_paperui.gif)

### 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... -->
2 changes: 1 addition & 1 deletion addons/io.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
38 changes: 4 additions & 34 deletions addons/uis.md
View file
Original file line number Diff line number Diff line change
@@ -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... -->
2 changes: 1 addition & 1 deletion configuration/addons.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

![installing Add-ons through Paper UI](./images/InstallAddonsThroughUi.gif)
![installing Add-ons through UI](./images/InstallAddonsThroughUi.gif)

## Through Configuration Files

Expand Down
11 changes: 6 additions & 5 deletions configuration/apitokens.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

![apitoken login](images/apitoken_login.png)
Expand All @@ -20,7 +21,7 @@ Use your admin username and password and fill in the token name (e.g. the servic

![Create token](images/apitoken_create_token.png)

Now the token is created.
Now the token is created.
Copy the complete token.

![Token](images/apitoken_token.png)
Expand All @@ -31,8 +32,8 @@ As example, below in NodeRed configuration the generated token is used as userna
![Example](images/apitoken_example.png)

## 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.

![Overview](images/apitoken_overview_tokens.png)

2 changes: 1 addition & 1 deletion configuration/habpanel.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions configuration/multimedia.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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:

Expand Down Expand Up @@ -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):

Expand Down
4 changes: 2 additions & 2 deletions configuration/persistence.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion configuration/rules-dsl.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions configuration/things.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Loading

0 comments on commit e3e0e36

Please sign in to comment.