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

Fix typos and capitalization issues (#2207) 

Signed-off-by: Wouter Born <github@maindrain.net>
pull/2209/head
Wouter Born 2024-01-13 19:06:34 +01:00 committed by GitHub
parent d33956a21c
commit 45773302a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
addons/actions.md
View File

@ -304,7 +304,7 @@ Action | Returns
`isBankHoliday(<datetime>, <file>)` | `true` if the day defined by the `ZonedDateTime` `<datetime>` is in `<file>`, `false` otherwise
`isInDayset("<set>")` | `true` if today is in the custom dayset `<set>` (see below), for example `isInDayset("school")`, `false` otherwise
`isInDayset("<set>", <offset>)` | `true` if the day `<offset>` days from today is in dayset `<set>`, `false` otherwise
`isInDayset("<set>", <datetime>)` | `true` if the day defined by the passed in `ZonedDateTime` `<datetime>` os in dayset `<set>`, `false` otherwise
`isInDayset("<set>", <datetime>)` | `true` if the day defined by the passed in `ZonedDateTime` `<datetime>` is in dayset `<set>`, `false` otherwise
`isWeekend` | `true` if today is a weekend, `false` otherwise
`isWeekend(<offset>)` | `true` if the day `<offset>` days from today is a weekend
`isWeekend(<datetime>)` | `true` if the day defined by the passed in `ZonedDateTime` `<datetime>` is a weekend, `false` otherwise

4
configuration/blockly/index.md
View File

@ -108,9 +108,9 @@ Also there is a good intro about that topic can be viewed at ![youtube](../imag
Please visit [Getting started with openHAB Blocklies and creating a rule](rules-blockly-before-using.html) before asking questions in the forum.
## Blockly Youtube Tutorials
## Blockly YouTube Tutorials
Three Youtube tutorials have been made available via the [openHAB Youtube channel](https://www.youtube.com/c/OpenhabOrg):
Three YouTube tutorials have been made available via the [openHAB YouTube channel](https://www.youtube.com/c/OpenhabOrg):
- [Episode 1](https://www.youtube.com/watch?v=EdllUlJ7p6k)
- [Introduction](https://www.youtube.com/watch?v=EdllUlJ7p6k)

8
configuration/blockly/rules-blockly-before-using.md
View File

@ -25,7 +25,7 @@ This folder is referred to as $OPENHAB\_CONF in this page, and the location of t
- via mounting the files shares from the server to your client-PC.
In the main UI as an admin you can go to _Help & About_ and will have the different folder locations under _Technical information_.
- 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).
- Use the share _openHAB_-conf when mounting it from Windows or MacOS
- Use the share _openHAB_-conf when mounting it from Windows or macOS
**Link the openHAB share in Windows**
@ -79,9 +79,9 @@ Also view ![youtube](../images/blockly/youtube-logo-small.png) [Creating a Block
![blockly-edit-screen](../images/blockly/blockly-edit-screen.png)
- you can now click the ![toolbox-submenu](../images/blockly/blockly-arrow.png) to access all openHAB Blocks.
- Drag and Drop the blocks to the white area
- Press `Ctrl-s` (Windows) or `Command-s` (MacOS) to save your rule
- Press `Ctrl-r` (Windows) or `Command-r` (MacOS) to directly run your rule with the trigger
- Press `Ctrl-d` (Windows) or `Command-d` (MacOS) to disable / enable your rule.
- Press `Ctrl-s` (Windows) or `Command-s` (macOS) to save your rule
- Press `Ctrl-r` (Windows) or `Command-r` (macOS) to directly run your rule with the trigger
- Press `Ctrl-d` (Windows) or `Command-d` (macOS) to disable / enable your rule.
See the following video on ![youtube](../images/blockly/youtube-logo-small.png) [How to disable Rules](https://youtu.be/hSRfooBKn9A?t=1668)
- **Click on** ![showblock](../images/blockly/blockly-workspace-showblocks.png) **on the lower right of the bottom toolbar to see the generated code** and will transition to ![showcode](../images/blockly/blockly-workspace-showcode.png)(click again to come back to the blocks).

4
configuration/blockly/rules-blockly-voice-and-multimedia.md
View File

@ -15,7 +15,7 @@ In general, this section deals with two topics
1) Playing or streaming audio to an audio sink e.g a speaker
1) Saying a text via using any Text-to-Speech API (e.g. Google's API)
It should be noted that both functionalities do not just work right out of the box because e.g for (1) the audio sinks need to be installed in openHAB and for (2) e.g. the whole Google API needs to be configured in particular with your own personal google account.
It should be noted that both functionalities do not just work right out of the box because e.g for (1) the audio sinks need to be installed in openHAB and for (2) e.g. the whole Google API needs to be configured in particular with your own personal Google account.
Even though (2) is not trivial but after having done that the usage of the functionality with blockly is very easy and worth the effort.
More about that topic can be viewed at ![youtube](../images/blockly/youtube-logo-small.png) [Playing sounds on audio sinks](https://youtu.be/EdllUlJ7p6k?t=2035)
@ -63,7 +63,7 @@ same as above but also allowing to provide the volume at the same time
- all available audio sinks are automatically provided by openHABs blocklies
**Known issue workaround:**
In several cases (like the google minis) it is known that setting the volume together with playing the sound results into only setting the volume either during playing the sound or even after the sound has played.
In several cases (like the Google Minis) it is known that setting the volume together with playing the sound results into only setting the volume either during playing the sound or even after the sound has played.
In case this happens the more robust approach is as follows
- Search for the thing of that particular sink and add an in item for the volume channel

2
configuration/index.md
View File

@ -22,7 +22,7 @@ In order to represent all of these, openHAB defines the following base component
- [Persistence](persistence.html) - Services to store data over time
- [Rules](rules-dsl.html) - Automation logic, the "smart" in your Smart Home!
- [Blockly Rules](blockly/) - Visually define the automation logic of your Smart Home
- [JSR223 Scripting](jsr223.html) - Define rules and other runtime objects using [Javascript](https://openjdk.java.net/projects/nashorn/), [Jython](https://www.jython.org) or [Groovy](https://www.groovy-lang.org/)
- [JSR223 Scripting](jsr223.html) - Define rules and other runtime objects using [JavaScript](https://openjdk.java.net/projects/nashorn/), [Jython](https://www.jython.org) or [Groovy](https://www.groovy-lang.org/)
The individual articles have all the details needed to understand the concepts behind these building blocks for your Smart Home.
For more details on the basic concepts behind openHAB, please visit the [Concepts Overview page](/docs/concepts/index.html).

2
configuration/migration/index.md
View File

@ -140,7 +140,7 @@ Note that openHAB (since version 4) now requires a Java 17 runtime, so please ma
Official update scripts are available that let you update your 2.x installation to version 3.0:
#### Linux/MacOS
#### Linux/macOS
1. Change to your openHAB root directory (e.g. `cd /opt/openhab`)
1. Create a backup by calling `sudo ./runtime/bin/backup`.

4
configuration/restdocs.md
View File

@ -60,9 +60,9 @@ Nevertheless, here is some examples using [curl](https://en.wikipedia.org/wiki/C
The commands above have been copied from the REST API documentation for illustration.
## Rest Api Explorer
## REST API Explorer
You can try and validate rest api calls from within the openHAB UI.
You can try and validate REST API calls from within the openHAB UI.
Just log in with an admin user, navigate to `Developer Tools -> API Explorer` and start exploring.
## Authentication

6
developers/buildsystem.md
View File

@ -5,15 +5,15 @@ title: Build System
# Build System
The buildsystem is based on Maven.
The build system is based on Maven.
A very common tool for Java development.
Maven is a convention centric, declarative system that is extensible via additional plugins.
That means if you stick 100% to Mavens idea of a java project, your buildsystem instruction file is not longer than 10 lines.
That means if you stick 100% to Maven's idea of a Java project, your build system instruction file is not longer than 10 lines.
openHAB has a few extra requirements and we use about 10 additional plugins,
ranging from OSGi specific ones (bnd) to publish and testing plugins.
This section talks about some common buildsystem related topics and also some quirks that you will encounter.
This section talks about some common build system related topics and also some quirks that you will encounter.
## Adding Dependencies

2
developers/guidelines.md
View File

@ -245,7 +245,7 @@ This means in detail:
In case of such exceptions this should be reflected in an updated state of the binding.
- `trace` logging should be used for verbose debug logging.
For example printing output values that can be large, but can help when debugging changed external apis.
For example printing output values that can be large, but can help when debugging changed external APIs.
In general bindings should NOT log to error/warn if e.g. connections are dropped -
this is considered to be an external problem and from a system perspective to be a normal and expected situation.

4
developers/index.md
View File

@ -48,7 +48,7 @@ Development can happen on any of the supported operating systems (Windows, macOS
Please ensure that you have the following prerequisites installed as well:
1. [Git](https://git-scm.com/downloads) For retrieving our source code and push changes back. On Windows: Must be available in %PATH%
1. [Maven 3.x](https://maven.apache.org/download.cgi) Our buildsystem tool. On Windows: Must be available in %PATH%
1. [Maven 3.x](https://maven.apache.org/download.cgi) Our build system tool. On Windows: Must be available in %PATH%
1. Java JDK 17, for example from Oracle [Oracle JDK 17](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html). On Windows: %JAVA% must be set.
You can use any IDE that is suitable for OSGi/Java development.
@ -68,7 +68,7 @@ We have prepared some step-by-step guides for the following IDEs:
</td>
<td style="width:30%">
[![Intellij IDE](./ide/images/intellij.jpg)](ide/intellij.html)
[![IntelliJ IDE](./ide/images/intellij.jpg)](ide/intellij.html)
</td>
</tr>

2
installation/synology.md
View File

@ -172,7 +172,7 @@ Give it a few minutes to start up.
## Shells
If you select the container running and press "Details" you will end up on a windows where you get more information on this running container.
If you select the container running and press "Details" you will see a window with more information on this running container.
One particular menu item you have to check is "Terminal".
In here you see the name of the container left from the black field and if you press that you'll get the Karaf terminal for openHAB.

2
introduction.md
View File

@ -114,7 +114,7 @@ In most cases, the description also contains a fully worked out example that inc
To all newcomers: please read the section [New User Tutorial]({{base}}/tutorial).
That section provides you with step-by-step instructions for your first easy setup.
openHAB runs on most popular platforms such as Linux, Windows and MacOS and on almost any hardware ranging from Raspberry Pis to desktop computers and server PCs.
openHAB runs on most popular platforms such as Linux, Windows and macOS and on almost any hardware ranging from Raspberry Pis to desktop computers and server PCs.
You can find specific installation instructions for these and other platforms in the [Installation Overview]({{base}}/installation/index.html) article.
If you have a strong preference towards a particular platform, then that platform is probably your best choice.