mirror of
https://github.com/openhab/openhab-addons.git
synced 2025-01-10 23:22:02 +01:00
ce3067339d
Updates Groovy from 3.0.9 to 3.0.13. For all bugfixes and improvements, see: * https://groovy-lang.org/changelogs/changelog-3.0.10.html * https://groovy-lang.org/changelogs/changelog-3.0.11.html * https://groovy-lang.org/changelogs/changelog-3.0.12.html * https://groovy-lang.org/changelogs/changelog-3.0.13.html Signed-off-by: Wouter Born <github@maindrain.net>
44 lines
1.9 KiB
Markdown
44 lines
1.9 KiB
Markdown
# Groovy Scripting
|
|
|
|
This add-on provides support for [Groovy](https://groovy-lang.org/) 3.0.13 that can be used as a scripting language within automation rules and which eliminates the need to manually install Groovy.
|
|
|
|
## Creating Groovy Scripts
|
|
|
|
When this add-on is installed, you can select Groovy as a scripting language when creating a script action within the rule editor of the UI.
|
|
|
|
Alternatively, you can create scripts in the `automation/jsr223` configuration directory.
|
|
If you create an empty file called `test.groovy`, you will see a log line with information similar to:
|
|
|
|
```text
|
|
... [INFO ] [.a.m.s.r.i.l.ScriptFileWatcher:150 ] - Loading script 'test.groovy'
|
|
```
|
|
|
|
To enable debug logging, use the [console logging]({{base}}/administration/logging.html) commands to enable debug logging for the automation functionality:
|
|
|
|
```text
|
|
log:set DEBUG org.openhab.core.automation
|
|
```
|
|
|
|
For more information on the available APIs in scripts see the [JSR223 Scripting]({{base}}/configuration/jsr223.html) documentation.
|
|
|
|
## Script Examples
|
|
|
|
Groovy scripts provide access to almost all the functionality in an openHAB runtime environment.
|
|
As a simple example, the following script logs "Hello, World!".
|
|
Note that `System.out.println` will usually not work since the output has no terminal to display the text.
|
|
The openHAB server uses the [SLF4J](https://www.slf4j.org/) library for logging.
|
|
|
|
```groovy
|
|
import org.slf4j.LoggerFactory
|
|
|
|
LoggerFactory.getLogger("org.openhab.core.automation.examples").info("Hello world!")
|
|
```
|
|
|
|
Depending on the openHAB logging configuration, you may need to prefix logger names with `org.openhab.core.automation` for them to show up in the log file (or you modify the logging configuration).
|
|
|
|
The script uses the [LoggerFactory](https://www.slf4j.org/apidocs/org/slf4j/Logger.html) to obtain a named logger and then logs a message like:
|
|
|
|
```text
|
|
... [INFO ] [.openhab.core.automation.examples:-2 ] - Hello world!
|
|
```
|