You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,9 @@ The result is available at [https://openhab.org/docs/](https://www.openhab.org/d
8
8
9
9
## How it works
10
10
11
-
In this repo you can find and improve all *general* documentation contents.
11
+
In this repo you can find and improve all _general_ documentation contents.
12
12
In fact that is all you can see in the `main` branch.
13
-
There are also other *read-only* branches, which hold external content like the *add-ons* and *concepts* documentation.
13
+
There are also other _read-only_ branches, which hold external content like the _add-ons_ and _concepts_ documentation.
14
14
We will read about them later.
15
15
16
16
### So I can't improve an add-on article here?
@@ -44,7 +44,7 @@ You can read a bit more below about our external resources and how we get them.
44
44
45
45
### Automatically Generated Parts
46
46
47
-
Those parts include __all__ add-on documentation files, no matter if they are from the `openhab-core` repo, the `openhab-addons` repo or any special binding repo like *habmin*, *zwave* or the *alexa skill*.
47
+
Those parts include __all__ add-on documentation files, no matter if they are from the `openhab-core` repo, the `openhab-addons` repo or any special binding repo like _habmin_, _zwave_ or the _alexa skill_.
48
48
49
49
We are keeping all those files at their original location, because it simply doesn't make sense to keep them here.
50
50
Imagine you want to do an improvement of the zwave binding and have to update the readme file in a completely different place.
@@ -60,8 +60,8 @@ The process below is subject to changes until the openHAB 3.x website become the
60
60
### How the documentation build works
61
61
62
62
We have set up our [build server](https://ci.openhab.org/view/Documentation%20(3.x)/) to do the magic automatically.
63
-
There are several triggers (mostly time based), which will then *gather the external contents* and move them to our [final](https://github.com/openhab/openhab-docs/tree/final) branch.
64
-
You can find this migrated external content in the *final* branch under:
63
+
There are several triggers (mostly time based), which will then _gather the external contents_ and move them to our [final](https://github.com/openhab/openhab-docs/tree/final) branch.
64
+
You can find this migrated external content in the _final_ branch under:
65
65
66
66
-`_addons_*`
67
67
-`concepts`
@@ -71,14 +71,14 @@ The external content is updated by the following toolchain:
Copy file name to clipboardexpand all lines: addons/actions.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -177,7 +177,7 @@ The Timer object supports the following methods:
177
177
178
178
-`cancel`: prevents the scheduled timer from executing. Most of the time `cancel` is used used in conjunction with setting the timer handler to `null` as a convenient indicator that some previously defined timer is now finished with. However setting the handler to `null` does not interact with the timer itself.
179
179
-`isActive`: returns `true` if the timer will be executed as scheduled, i.e. it has not been cancelled or completed.
180
-
-`isCancelled`: returns `true` if the timer has been cancelled *before* it completed.
180
+
-`isCancelled`: returns `true` if the timer has been cancelled _before_ it completed.
181
181
-`isRunning`: returns `true` if the code is currently executing (i.e. the timer activated the code but it is not done running).
182
182
-`hasTerminated`: returns `true` if the timer has been cancelled or the code has run and completed.
183
183
-`reschedule(AbstractInstant instant)`: reschedules the timer to execute at the new time. If the Timer has terminated this method does nothing.
@@ -227,7 +227,7 @@ Notification actions may be placed in Rules to send alerts to mobile devices reg
227
227
Three different actions are available:
228
228
229
229
-`sendNotification(emailAddress, message)`: Sends a notification to a specific cloud instance user
230
-
-`sendBroadcastNotification(message)`: Sends a notification to *all* devices of *all* users
230
+
-`sendBroadcastNotification(message)`: Sends a notification to _all_ devices of _all_ users
231
231
-`sendLogNotification(message)`: Sends a log notification to the `notifications` list at your openHAB Cloud instance. Notifications are NOT sent to any registered devices
232
232
233
233
For each of the three actions, there's another variant accepting an icon name and a severity:
Copy file name to clipboardexpand all lines: administration/console.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -94,7 +94,7 @@ openhab> help bundle:stop
94
94
95
95
The console also supports auto-completion during input.
96
96
Auto-completion proposes possible commands based on the current input and is triggered by a <TAB> press on your keyboard.
97
-
So for example entering "*bund*" and pressing the <TAB> key will first extend to the only viable candidate "bundle", a subsequent <TAB> press will result in:
97
+
So for example entering "_bund_" and pressing the <TAB> key will first extend to the only viable candidate "bundle", a subsequent <TAB> press will result in:
Copy file name to clipboardexpand all lines: concepts/audio.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -8,31 +8,31 @@ title: Audio & Voice
8
8
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.
9
9
10
10
openHAB has a very modular architecture that enables many different use cases.
11
-
At its core, there is the notion of an *audio stream*.
12
-
Audio streams are provided by *audio sources* and consumed by *audio sinks*.
11
+
At its core, there is the notion of an _audio stream_.
12
+
Audio streams are provided by _audio sources_ and consumed by _audio sinks_.
13
13
14
14
15
15
16
-
-*Audio Streams* are essentially byte streams with a given *audio format*.
16
+
-_Audio Streams_ are essentially byte streams with a given _audio format_.
17
17
They do not need to be limited in size, i.e. it is allowed to have continuous streams, e.g. the input from a microphone or from an Internet radio station.
18
-
-*Audio Formats* define the container (e.g. WAV), encoding, bit rate, sample frequency and depth and the bit order (little or big endian).
19
-
-*Audio Sources* are services that are capable of producing audio streams.
18
+
-_Audio Formats_ define the container (e.g. WAV), encoding, bit rate, sample frequency and depth and the bit order (little or big endian).
19
+
-_Audio Sources_ are services that are capable of producing audio streams.
20
20
They can support different formats and provide a stream in a requested format upon request.
21
21
Typical audio source services are microphones. Typically, a continuous stream is expected from them.
22
-
-*Audio Sinks* are services that accept audio streams of certain formats.
22
+
-_Audio Sinks_ are services that accept audio streams of certain formats.
23
23
Typically, these are expected to play the audio stream, i.e. they are some kind of speaker or media device.
24
-
-*Text-to-Speech* (TTS) services are similar to audio sources with respect to the ability to create audio streams.
24
+
-_Text-to-Speech_ (TTS) services are similar to audio sources with respect to the ability to create audio streams.
25
25
The difference is that they take a string as an input and will synthesize this string to a spoken text using a given voice.
26
26
TTS services can provide information about the voices that they support and the locale that those voices are associated with.
27
27
Each voice supports exactly one locale.
28
-
-*Speech-to-Text* (STT) services are similar to audio sinks, but they do not simply play back the stream, but convert it to a plain string.
28
+
-_Speech-to-Text_ (STT) services are similar to audio sinks, but they do not simply play back the stream, but convert it to a plain string.
29
29
They provide information about supported formats and locales.
30
30
31
-
As plain text from an STT service is often not very useful, there is additionally the concept of a *human language interpreter*:
31
+
As plain text from an STT service is often not very useful, there is additionally the concept of a _human language interpreter_:
32
32
33
33
34
34
35
-
A *Human Language Interpreter* takes a string as an input.
35
+
A _Human Language Interpreter_ takes a string as an input.
36
36
It then derives actions from it (like sending commands to devices) and/or replies with a string, which opens the possibility to realize conversations.
37
37
As such an interpreter is not directly linked to audio streams, but operates on strings only, this can be the basis for any kind of assistant, e.g. for chat bots using the console, XMPP, Twitter or other messaging services.
According to the [naming convention for bundles](/docs/administration/bundles.html#naming-convention-for-bundles) the *id* for the shown example is *network*.
40
+
According to the [naming convention for bundles](/docs/administration/bundles.html#naming-convention-for-bundles) the _id_ for the shown example is _network_.
41
41
42
42
Another way to find the correct `id` is to look at the URL of the add-on documentation page.
43
43
For example the url for the [Network Binding documentation](/addons/bindings/network/) is
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.
51
+
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.
52
52
The path depends on your installation.
53
53
You can find out the correct locations on the corresponding documentation pages, e.g. [Linux](/docs/installation/linux.html#file-locations) or [Windows](/docs/installation/windows.html#file-locations).
54
54
@@ -62,7 +62,7 @@ transformation = jsonpath
62
62
persistence = influxdb
63
63
```
64
64
65
-
To install the network Binding like we want in this example, we just need to add the id *network* to the Binding section.
65
+
To install the network Binding like we want in this example, we just need to add the id _network_ to the Binding section.
Copy file name to clipboardexpand all lines: configuration/blockly/index.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -24,12 +24,12 @@ Therefore openHAB also provides a graphical way of writing rules which allows to
24
24
The basic idea behind the visual paradigm and representation within openHAB is based on the [Google Blockly Support](https://developers.google.com/blockly) which has been integrated and which provides the basic blocks for programming like the ones on the left and the right side of the below images
All of these provide general functionality that is not specific to openHAB itself. If you want to learn more about how to use them, search for the many blockly tutorials that are available.
32
-
However, to leverage the full capabilities more than *50 specific blocks* have been provided that are tailored for easy access of openHAB's capabilities.
32
+
However, to leverage the full capabilities more than _50 specific blocks_ have been provided that are tailored for easy access of openHAB's capabilities.
33
33
34
34
This section provides a detailed description of the specific blocks and provides examples on how to use them. Note that some of the blocks (like voice, streaming or notifications) need some special setup within openHAB - in these case links to the respective documentation is provided.
35
35
Also see this [Intro](https://youtu.be/EdllUlJ7p6k?t=295) Quick Intro Blockly Rules
@@ -45,7 +45,7 @@ There is also a help-button available in each section that links to the document
Please read this information first before asking questions in the forum. *In case you ask for help please always post the respective code that is being generated.*
48
+
Please read this information first before asking questions in the forum. _In case you ask for help please always post the respective code that is being generated._
49
49
50
50
Also there is a good intro about that topic can be viewed at [Various Help Documentation available in openHAB Blocky](https://youtu.be/EdllUlJ7p6k?t=1589)
51
51
@@ -111,7 +111,7 @@ Also view  [Overview of the
111
111
112
112
### Items and Things
113
113
114
-
*Items* and *Things* are the [major entities of openHAB](https://www.openhab.org/docs/concepts/) to control and monitor the home.
114
+
_Items_ and _Things_ are the [major entities of openHAB](https://www.openhab.org/docs/concepts/) to control and monitor the home.
115
115
116
116
[![Items and Things](../images/blockly/blockly-items-and-things-small.png"Items and Things")
117
117
](rules-blockly-items-things.html)
@@ -131,7 +131,7 @@ See [Timers and Delays](rules-blockly-timers-and-delays.html) section.
131
131
### Date Handling
132
132
133
133
Date blocks are used as input parameters for other blocks.
134
-
Some of these blocks are used by ephemeris blocks, whilst others are used in the persistence section. Therefore blocks are *typed* to assure correct connection to other blocks.
134
+
Some of these blocks are used by ephemeris blocks, whilst others are used in the persistence section. Therefore blocks are _typed_ to assure correct connection to other blocks.
135
135
136
136
[![Date Handling](../images/blockly/blockly-date-handling1-small.png"Dates part 1")
137
137
](rules-blockly-date-handling.html)[![Date Handling](../images/blockly/blockly-date-handling2-small.png"Dates Part 2")
@@ -151,7 +151,7 @@ See [Ephemeris](rules-blockly-ephemeris.html) section.
151
151
152
152
### Voice and Multimedia
153
153
154
-
This section deals with *playing or streaming audio* to an audio sink e.g a speaker or *saying a text* via using any Text-to-Speech API (e.g. Google's API)
154
+
This section deals with _playing or streaming audio_ to an audio sink e.g a speaker or _saying a text_ via using any Text-to-Speech API (e.g. Google's API)
155
155
156
156
[![Voice and Multimedia](../images/blockly/blockly-voice-and-multimedia-small.png"Voice and Multimedia")
157
157
](rules-blockly-voice-and-multimedia.html)
@@ -179,7 +179,7 @@ See [Persistence](rules-blockly-persistence.html) section.
179
179
180
180
### Value Storage
181
181
182
-
These blocks enable storing information *for a rule* that is kept after the rule has run, so it can be reused when the rule is run again later in stateful way.
182
+
These blocks enable storing information _for a rule_ that is kept after the rule has run, so it can be reused when the rule is run again later in stateful way.
Copy file name to clipboardexpand all lines: configuration/blockly/rules-blockly-before-using.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -25,17 +25,17 @@ Please read them carefully before asking questions in the forum.
25
25
## **OpenHAB Configuration Files**
26
26
27
27
Some openHAB blocks rely on particular configuration files found in the openHAB configuration folder.
28
-
This folder is referred to as $OPENHAB_CONF in this page, and the location of this folder for your setup can be found via the UI: *Help & About* -> *Technical Information* -> *Configuration folder*.
28
+
This folder is referred to as $OPENHAB_CONF in this page, and the location of this folder for your setup can be found via the UI: _Help & About_ -> _Technical Information_ -> _Configuration folder_.
29
29
30
30
- via mounting the files shares from the server to your client-PC.
31
-
In the main UI as an admin you can go to *Help & About* and will have the different folder locations under *Technical information*.
31
+
In the main UI as an admin you can go to _Help & About_ and will have the different folder locations under _Technical information_.
32
32
- the exact configuration of the shares can be found on your server at [/etc/samba/smb.conf](https://github.com/openhab/openhabian/blob/main/includes/smb.conf).
33
-
- Use the share *openHAB*-conf when mounting it from Windows or MacOS
33
+
- Use the share _openHAB_-conf when mounting it from Windows or MacOS
34
34
35
35
**Link the openHAB share in Windows**
36
36
37
37
- Find you openHAB-Server via the network share functionality
38
-
- User the share *openHAB*-conf to assign it to a network drive
38
+
- User the share _openHAB_-conf to assign it to a network drive
39
39
40
40
**Link the openHAB share in macOS**
41
41
@@ -49,7 +49,7 @@ In the main UI as an admin you can go to *Help & About* and will have the differ
49
49
50
50
**Finding it on Linux**
51
51
52
-
- Access the folder directly on the openHAB server at */etc/openhab*
52
+
- Access the folder directly on the openHAB server at _/etc/openhab_
53
53
54
54
All methods reveal the following folders
55
55
@@ -132,7 +132,7 @@ Pinching on a tablet or a touch bar also allows convenient zooming of the worksp
132
132
133
133
During development the log-block is lot very often which writes information into the log files.
134
134
135
-
- To be able to conveniently view your log files it is recommended to setup *frontail* which can be achieved easily via [openhabian-config](https://www.openhab.org/docs/installation/openhabian.html#optional-components)
135
+
- To be able to conveniently view your log files it is recommended to setup _frontail_ which can be achieved easily via [openhabian-config](https://www.openhab.org/docs/installation/openhabian.html#optional-components)
136
136
- Start `openhabian-config` on your server and choose option 20 and then option 21
137
137
- After installation you can view your logs under [openhabian-config](http://myopenhab-server:9001) (adapt the server name)
138
138
-**see [how to log](https://www.openhab.org/docs/administration/logging.html)**
0 commit comments