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

Add fixes from markdownlint-cli (#1442) 

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
pull/1443/head
Jerome Luckenbach 2021-01-11 19:33:40 +01:00 committed by GitHub
parent a128dbae5c
commit ec6c80dbdf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 37 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
concepts/index.md
View File

@ -44,7 +44,7 @@ Channels may be linked to multiple Items and Items may be linked to multiple Cha
To illustrate these concepts, consider the example below of a two-channel actuator that controls two lights: To illustrate these concepts, consider the example below of a two-channel actuator that controls two lights:
![](images/thing-devices-1.png) ![thing-devices-1](images/thing-devices-1.png)
The actuator is a Thing that might be installed in an electrical cabinet. The actuator is a Thing that might be installed in an electrical cabinet.
It has a physical address and it must be configured in order to be used (remember the physical view introduced at the beginning of this article). It has a physical address and it must be configured in order to be used (remember the physical view introduced at the beginning of this article).

2
developers/ide/intellij.md
View File

@ -22,7 +22,7 @@ This article refers to the directory where you installed the distribution as `<D
1. open IntelliJ and create a new Project from existing sources (File | New | Project from existing sources) and pick `<ADDON_DIR>`/pom.xml 1. open IntelliJ and create a new Project from existing sources (File | New | Project from existing sources) and pick `<ADDON_DIR>`/pom.xml
- IntelliJ will start importing, indexing and building, it will take while, wait until finished (see status bar) IntelliJ will start importing, indexing and building, it will take while, wait until finished (see status bar)
1. Use Maven to clean & install the addons project 1. Use Maven to clean & install the addons project

2
developers/osgi/osgids.md
View File

@ -24,7 +24,7 @@ In order to simplify the usage of services the [OSGi Alliance](https://www.osgi.
In order to understand this model, we will have to first explain a few terms, used below: In order to understand this model, we will have to first explain a few terms, used below:
- **Declarative Services Container** (we will use the shorthand **DS**) - a module that is managing the [lifecycle](#vii-component-lifecycle) of a *service component- dynamically. - **Declarative Services Container** (we will use the shorthand **DS**) - a module that is managing the [lifecycle](#vii-component-lifecycle) of a *service component- dynamically.
It activates and deactivates different components, basing its decisions on the information contained in the *component description*; It activates and deactivates different components, basing its decisions on the information contained in the _component description_;
- **Service Component** (or also **component**) - an object whose lifecycle is managed, - **Service Component** (or also **component**) - an object whose lifecycle is managed,
usually by a component framework such as Declarative Services (DS). usually by a component framework such as Declarative Services (DS).
A component may publish itself as an OSGi service or consume OSGi services. A component may publish itself as an OSGi service or consume OSGi services.

4
installation/windows.md
View File

@ -169,9 +169,9 @@ By installing the openHAB process as a service in Windows, you can:
Validate proper operations by browsing to `http://localhost:8080` and verifying that the Windows Service is running and set to Automatic Startup type. Validate proper operations by browsing to `http://localhost:8080` and verifying that the Windows Service is running and set to Automatic Startup type.
Use `services.msc` and find the `openHAB` service. Use `services.msc` and find the `openHAB` service.
![Windows Service](images/Windows_Service.jpg) Or by logging in with an SSH client to the console (see info below)
- Logging in with an SSH client to the console (see info below) ![Windows Service](images/Windows_Service.jpg)
### File Locations ### File Locations

24
tutorials/getting_started/model.md
View File

@ -33,7 +33,7 @@ The semantic model, when set up correctly, will allow openHAB to turn all lights
## Introduction to the Ontology and Relationships ## Introduction to the Ontology and Relationships
![](images/ontology_relationships.jpeg) ![ontology relationships](images/ontology_relationships.jpeg)
The above drawing shows the relationship between the four main concepts in the model. The above drawing shows the relationship between the four main concepts in the model.
@ -44,7 +44,7 @@ The above drawing shows the relationship between the four main concepts in the m
Example of an advanced model: Example of an advanced model:
![](images/example_model.png) ![example model](images/example_model.png)
<!--(made with https://www.diagrameditor.com - file here: [Semantic Model.txt|attachment](upload://qEPmmmDomSr4F5dRBHMXajOzO0c.txt) (3.3 KB) change extension to .drawio) --> <!--(made with https://www.diagrameditor.com - file here: [Semantic Model.txt|attachment](upload://qEPmmmDomSr4F5dRBHMXajOzO0c.txt) (3.3 KB) change extension to .drawio) -->
We have an Indoor location which has a House. We have an Indoor location which has a House.
@ -77,11 +77,11 @@ Using the example above, the Z-Wave plug might be modeled as a subequipment of t
From the Settings screen, click on Model. From the Settings screen, click on Model.
![](images/start_model.png) ![start model](images/start_model.png)
Let's start with a hierarchy of Locations. Click on Add Location. Let's start with a hierarchy of Locations. Click on Add Location.
![](images/create_location.png) ![create location](images/create_location.png)
Add your first item, a Group representing the ground floor. Add your first item, a Group representing the ground floor.
Give it a name, but choose carefully as you cannot change it afterward. Give it a name, but choose carefully as you cannot change it afterward.
@ -102,7 +102,7 @@ Add the ground floor and its rooms (master bedroom, bathroom, etc...) to your mo
You should end up with something resembling this: You should end up with something resembling this:
![](images/locations_model.png) ![model locations](images/locations_model.png)
## Modeling Equipment ## Modeling Equipment
@ -114,7 +114,7 @@ If the Equipment you're adding is one of the Things that you have already added,
Select where in the model you want to add the Equipment, for instance the kitchen, and click on Create Equipment from Thing. Select where in the model you want to add the Equipment, for instance the kitchen, and click on Create Equipment from Thing.
![](images/create_equipment_model.png) ![model create equipment](images/create_equipment_model.png)
Select the Thing you want to create the Equipment from, and alter the details of the Equipment item that will be created. Select the Thing you want to create the Equipment from, and alter the details of the Equipment item that will be created.
If you don't find an appropriate Equipment class, choose **Equipment**. If you don't find an appropriate Equipment class, choose **Equipment**.
@ -123,7 +123,7 @@ Below are all the Channels defined by the Thing.
Sometimes Things will have hundreds of channels, so here you have the opportunity of choosing which ones will be linked to new Points items. Sometimes Things will have hundreds of channels, so here you have the opportunity of choosing which ones will be linked to new Points items.
Check the channels you're interested in and only those. Check the channels you're interested in and only those.
![](images/create_equipment_model_channels.png) ![model create equipment channels](images/create_equipment_model_channels.png)
For the plant sensor Thing added earlier, we have an opportunity to change the default basic Number types and make them quantifiable. For the plant sensor Thing added earlier, we have an opportunity to change the default basic Number types and make them quantifiable.
Quantity types (Number with a dimension) provide conversion facilities between Units of Measurement, and the default persistence is more granular. Quantity types (Number with a dimension) provide conversion facilities between Units of Measurement, and the default persistence is more granular.
@ -134,7 +134,7 @@ Also set the semantic class to Measurement and choose an appropriate related pro
When you're finished, click Add in the title bar. When you're finished, click Add in the title bar.
The Equipment and Points should be added to the model where you wanted. The Equipment and Points should be added to the model where you wanted.
![](images/create_equipment_model_added.png) ![model created equipment added](images/create_equipment_model_added.png)
The "Plant Sensor" Equipment has now been created under the Kitchen location, and all the selected Points represent the selected Channels of the Thing. The "Plant Sensor" Equipment has now been created under the Kitchen location, and all the selected Points represent the selected Channels of the Thing.
@ -143,25 +143,25 @@ The "Plant Sensor" Equipment has now been created under the Kitchen location, an
From the Settings, click on Things and then click on the Thing you wish to add to the model. From the Settings, click on Things and then click on the Thing you wish to add to the model.
Switch to the Channels tab. Switch to the Channels tab.
![](images/create_equipment_things_channels.png) ![create equipment things channels](images/create_equipment_things_channels.png)
Click on Add Equipment to Model below the list. Click on Add Equipment to Model below the list.
You'll encounter a similar screen to the one above. You'll encounter a similar screen to the one above.
The difference is, rather than selecting the Thing, you have to select where in the model you want to add the Equipment. The difference is, rather than selecting the Thing, you have to select where in the model you want to add the Equipment.
![](images/create_equipment_things_location.png) ![create equipment things location](images/create_equipment_things_location.png)
Select Pick From Model in the Parent Group section, and the tree view of the Locations and Equipments will appear. Select Pick From Model in the Parent Group section, and the tree view of the Locations and Equipments will appear.
Select the parent group, for instance Living Room, then choose Pick in the top-right corner of the dialog box. Select the parent group, for instance Living Room, then choose Pick in the top-right corner of the dialog box.
If this equipment is a part of another equipment, choose that equipment as the parent instead of a location. If this equipment is a part of another equipment, choose that equipment as the parent instead of a location.
![](images/create_equipment_things_parent.png) ![create equipment things parent](images/create_equipment_things_parent.png)
Then do the same as above, configure the Equipment item and the Points, then click Add. Then do the same as above, configure the Equipment item and the Points, then click Add.
Go back to the Model by choosing Model in the sidebar and verify that the Equipment added to the model from the thing page is effectively there as well as, its Points. Go back to the Model by choosing Model in the sidebar and verify that the Equipment added to the model from the thing page is effectively there as well as, its Points.
![](images/create_equipment_things_added.png) ![create equipment things added](images/create_equipment_things_added.png)
Note how the Channel Links section lists the link to the Thing/Channel, and you also have a control widget to control the item. Note how the Channel Links section lists the link to the Thing/Channel, and you also have a control widget to control the item.
Since it's linked to the Color channel of the Hue bulb, the light will reflect the state of the item. Since it's linked to the Color channel of the Hue bulb, the light will reflect the state of the item.

10
tutorials/getting_started/things_intermediate.md
View File

@ -24,15 +24,15 @@ From Settings, go to Things, then click the blue "+" button.
We need to install the Z-Wave binding. We need to install the Z-Wave binding.
Click "Install More Bindings". Click "Install More Bindings".
![](images/install_zwave.png) ![install zwave](images/install_zwave.png)
Find the Z-Wave binding, click on it, then click Install. Find the Z-Wave binding, click on it, then click Install.
![](images/installing_zwave.png) ![installing zwave](images/installing_zwave.png)
Wait for it to disappear from the list, then go back. Wait for it to disappear from the list, then go back.
![](images/installed_zwave.png) ![installed zwave](images/installed_zwave.png)
## Create the Bridge Thing ## Create the Bridge Thing
@ -40,12 +40,12 @@ Click on the new option: Z-Wave Binding.
Click on Z-Wave Serial Controller to add the controller. Click on Z-Wave Serial Controller to add the controller.
![](images/zwave_add_controller.png) ![add zwave controller](images/zwave_add_controller.png)
We need to specify one required parameter, the serial port. We need to specify one required parameter, the serial port.
In certain cases, depending on your system, you will be provided with a list of options for this setting. In certain cases, depending on your system, you will be provided with a list of options for this setting.
![](images/zwave_port_config.png) ![zwave port config](images/zwave_port_config.png)
Choose the correct port, alter the name and/or ID of the controller Thing, then click Add in the top-right corner. Choose the correct port, alter the name and/or ID of the controller Thing, then click Add in the top-right corner.

30
tutorials/getting_started/things_simple.md
View File

@ -31,13 +31,13 @@ In this case, the Hue binding supports auto-discovery of both the bridge and the
After logging in as an administrator, click on `Settings` from the sidebar, then click on `Things`. After logging in as an administrator, click on `Settings` from the sidebar, then click on `Things`.
![](images/empty_things_menu.png) ![empty things menu](images/empty_things_menu.png)
Click on the blue "+" button located at the bottom-right corner. Click on the blue "+" button located at the bottom-right corner.
Since you have no bindings, this screen will appear: Since you have no bindings, this screen will appear:
![](images/choose_binding.png) ![choose binding](images/choose_binding.png)
Click on `Install Bindings`. Click on `Install Bindings`.
@ -45,17 +45,17 @@ Look for the Hue binding.
Note the search bar at the top can help find bindings quickly by filtering the long list. Note the search bar at the top can help find bindings quickly by filtering the long list.
Click on the binding, then on Install. Click on the binding, then on Install.
![](images/install_hue.png) ![install hue](images/install_hue.png)
It will take from a few seconds to a minute for the binding to install... It will take from a few seconds to a minute for the binding to install...
![](images/installing_hue.png) ![installing hue](images/installing_hue.png)
Wait for it to disappear from the list, then click < Back (or use the browser controls). Wait for it to disappear from the list, then click < Back (or use the browser controls).
The Hue binding will now appear on the previous screen. The Hue binding will now appear on the previous screen.
You will notice that the auto-discovery has already detected something (note the red "1" badge). You will notice that the auto-discovery has already detected something (note the red "1" badge).
![](images/installed_hue.png) ![installed hue](images/installed_hue.png)
## Accept the Discovered Bridge Thing ## Accept the Discovered Bridge Thing
@ -64,35 +64,35 @@ Click on the binding.
The bridge has indeed been detected and appears under Discovered Things. The bridge has indeed been detected and appears under Discovered Things.
If not, you can try again by clicking the `Scan Again` button. If not, you can try again by clicking the `Scan Again` button.
![](images/hue_things_discover_bridge.png) Thing ![hue things discover bridge](images/hue_things_discover_bridge.png) Thing
Click on the discovered `Hue Bridge`. Click on the discovered `Hue Bridge`.
![](images/add_hue_bridge.png) ![add hue bridge](images/add_hue_bridge.png)
openHAB will ask you to confirm or change the label/name. openHAB will ask you to confirm or change the label/name.
Click OK after naming the new Thing. Click OK after naming the new Thing.
You will be taken back to the Things page, where the Hue Bridge should now appear. You will be taken back to the Things page, where the Hue Bridge should now appear.
![](images/hue_bridge_offline.png) ![hue bridge offline](images/hue_bridge_offline.png)
However, we can see that it's marked offline. However, we can see that it's marked offline.
To find out why we can click on the `Hue Bridge`. To find out why we can click on the `Hue Bridge`.
![](images/hue_bridge_config_error.png) ![hue bridge config error](images/hue_bridge_config_error.png)
The error description below the status gives some more information: You have to press the physical button on the device to let openHAB authenticate to it. The error description below the status gives some more information: You have to press the physical button on the device to let openHAB authenticate to it.
Once you've done this, the Thing will become online. Once you've done this, the Thing will become online.
![](images/hue_bridge_online.png) ![hue bridge online](images/hue_bridge_online.png)
## Accept the Light Bulb Things ## Accept the Light Bulb Things
Go back to Things. Go back to Things.
You will notice a new red button on that screen. You will notice a new red button on that screen.
![](images/hue_inbox.png) ![hue inbox](images/hue_inbox.png)
This means that there are newly discovered devices that you can add. This means that there are newly discovered devices that you can add.
Since the Hue bridge is now working, the binding has detected all the Hue devices (bulbs, switches and so on) attached to it. Since the Hue bridge is now working, the binding has detected all the Hue devices (bulbs, switches and so on) attached to it.
@ -102,13 +102,13 @@ Alternatively, you can also click on the "+" button to get a per-binding view an
Click Inbox. Click Inbox.
![](images/discovered_hue_things.png) ![dicsovered hue things](images/discovered_hue_things.png)
You can either click on an individual thing to see actions related to it, or you can click on Select in the top-right corner to add check boxes beside items, which will allow you to perform actions on several inbox entries at once. You can either click on an individual thing to see actions related to it, or you can click on Select in the top-right corner to add check boxes beside items, which will allow you to perform actions on several inbox entries at once.
![](images/hue_individual_add.png) ![hue individual add](images/hue_individual_add.png)
![](images/hue_bulk_add.png) ![hue bulk add](images/hue_bulk_add.png)
These actions are: These actions are:
@ -119,7 +119,7 @@ These actions are:
Now go back to Things. Now go back to Things.
The newly approved Hue Things should appear on the list. The newly approved Hue Things should appear on the list.
![](images/hue_things_added.png) ![hue things added](images/hue_things_added.png)
You now have the Bridge Thing and the two light bulbs added to openHAB. You now have the Bridge Thing and the two light bulbs added to openHAB.
Thankfully most of the bindings you will work with in openHAB will work in this simple way. Thankfully most of the bindings you will work with in openHAB will work in this simple way.