Add fixes from markdownlint-cli (#1442)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>pull/1443/head
Jerome Luckenbach
GitHub
parent
a128dbae5c
commit
ec6c80dbdf
|
|
@ -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:
|
||||
|
||||
|
||||
|
||||
|
||||
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).
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
- 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
|
||||
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
||||
- **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,
|
||||
usually by a component framework such as Declarative Services (DS).
|
||||
A component may publish itself as an OSGi service or consume OSGi services.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
Use `services.msc` and find the `openHAB` service.
|
||||
|
||||
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)
|
||||
|
||||
|
||||
### File Locations
|
||||
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ The semantic model, when set up correctly, will allow openHAB to turn all lights
|
|||
|
||||
## Introduction to the Ontology and Relationships
|
||||
|
||||
|
||||
|
||||
|
||||
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:
|
||||
|
||||
|
||||
|
||||
<!--(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.
|
||||
|
|
@ -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.
|
||||
|
||||
|
||||
|
||||
|
||||
Let's start with a hierarchy of Locations. Click on Add Location.
|
||||
|
||||
|
||||
|
||||
|
||||
Add your first item, a Group representing the ground floor.
|
||||
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:
|
||||
|
||||
|
||||
|
||||
|
||||
## 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 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**.
|
||||
|
|
@ -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.
|
||||
Check the channels you're interested in and only those.
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
|
@ -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.
|
||||
The Equipment and Points should be added to the model where you wanted.
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
Switch to the Channels tab.
|
||||
|
||||
|
||||
|
||||
|
||||
Click on Add Equipment to Model below the list.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
If this equipment is a part of another equipment, choose that equipment as the parent instead of a location.
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -24,15 +24,15 @@ From Settings, go to Things, then click the blue "+" button.
|
|||
We need to install the Z-Wave binding.
|
||||
Click "Install More Bindings".
|
||||
|
||||
|
||||
|
||||
|
||||
Find the Z-Wave binding, click on it, then click Install.
|
||||
|
||||
|
||||
|
||||
|
||||
Wait for it to disappear from the list, then go back.
|
||||
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
Choose the correct port, alter the name and/or ID of the controller Thing, then click Add in the top-right corner.
|
||||
|
||||
|
|
|
|||
|
|
@ -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`.
|
||||
|
||||
|
||||
|
||||
|
||||
Click on the blue "+" button located at the bottom-right corner.
|
||||
|
||||
Since you have no bindings, this screen will appear:
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
Click on the binding, then on Install.
|
||||
|
||||
|
||||
|
||||
|
||||
It will take from a few seconds to a minute for the binding to install...
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
You will notice that the auto-discovery has already detected something (note the red "1" badge).
|
||||
|
||||
|
||||
|
||||
|
||||
## Accept the Discovered Bridge Thing
|
||||
|
||||
|
|
@ -64,35 +64,35 @@ Click on the binding.
|
|||
The bridge has indeed been detected and appears under Discovered Things.
|
||||
If not, you can try again by clicking the `Scan Again` button.
|
||||
|
||||
 Thing
|
||||
 Thing
|
||||
|
||||
Click on the discovered `Hue Bridge`.
|
||||
|
||||
|
||||
|
||||
|
||||
openHAB will ask you to confirm or change the label/name.
|
||||
Click OK after naming the new Thing.
|
||||
|
||||
You will be taken back to the Things page, where the Hue Bridge should now appear.
|
||||
|
||||
|
||||
|
||||
|
||||
However, we can see that it's marked offline.
|
||||
To find out why we can click on the `Hue Bridge`.
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
## Accept the Light Bulb Things
|
||||
|
||||
Go back to Things.
|
||||
You will notice a new red button on that screen.
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
|
@ -102,13 +102,13 @@ Alternatively, you can also click on the "+" button to get a per-binding view an
|
|||
|
||||
Click Inbox.
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
These actions are:
|
||||
|
||||
|
|
@ -119,7 +119,7 @@ These actions are:
|
|||
Now go back to Things.
|
||||
The newly approved Hue Things should appear on the list.
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
|
|
|||
Loading…
Reference in New Issue