mirror of
https://github.com/openhab/openhab-addons.git
synced 2025-01-10 15:11:59 +01:00
[jrubyscripting] Fix broken image in README.md (#15435)
* [jrubyscripting] Fix broken image in README.md * [jrubyscripting] Update the base url in the regenerate instructions Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
This commit is contained in:
parent
52c657ff41
commit
78381e8b6d
@ -1,5 +1,5 @@
|
|||||||
<!-- This file is auto-generated by YARD from https://github.com/openhab/openhab-jruby/blob/main/USAGE.md; please do not edit directly -->
|
<!-- This file is auto-generated by YARD from https://github.com/openhab/openhab-jruby/blob/main/USAGE.md; please do not edit directly -->
|
||||||
<!-- To regenerate, run `bin/yard display -f markdown -o https://openhab.github.io/openhab-jruby/5.4 file:USAGE.md` -->
|
<!-- To regenerate, run `bin/yard display -f markdown -o https://openhab.github.io/openhab-jruby/main file:USAGE.md` -->
|
||||||
|
|
||||||
# JRuby Scripting
|
# JRuby Scripting
|
||||||
|
|
||||||
@ -217,18 +217,18 @@ Advanced users, or users migrating scripts from existing systems may want to use
|
|||||||
|
|
||||||
Using the openHAB UI, first create a new rule and set a trigger condition.
|
Using the openHAB UI, first create a new rule and set a trigger condition.
|
||||||
|
|
||||||
![openHAB Rule Configuration](docs/images/rule-config.png)
|
![openHAB Rule Configuration](doc/rule-config.png)
|
||||||
|
|
||||||
#### Adding Actions
|
#### Adding Actions
|
||||||
|
|
||||||
Select "Add Action" and then select "Run Script" with "Ruby".
|
Select "Add Action" and then select "Run Script" with "Ruby".
|
||||||
This will bring up an empty script editor where you can enter your JavaScript.
|
This will bring up an empty script editor where you can enter your JavaScript.
|
||||||
|
|
||||||
![openHAB Rule Engines](docs/images/rule-engines.png)
|
![openHAB Rule Engines](doc/rule-engines.png)
|
||||||
|
|
||||||
You can now write rules using standard Ruby along with the included openHAB [library](#library-details).
|
You can now write rules using standard Ruby along with the included openHAB [library](#library-details).
|
||||||
|
|
||||||
![openHAB Rule Script](docs/images/rule-script.png)
|
![openHAB Rule Script](doc/rule-script.png)
|
||||||
|
|
||||||
For example, turning a light on:
|
For example, turning a light on:
|
||||||
|
|
||||||
@ -740,23 +740,24 @@ Exec.execute_command_line('/path/to/program')
|
|||||||
|
|
||||||
### Logging
|
### Logging
|
||||||
|
|
||||||
The JRuby Scripting addon has a global `logger` object for logging.
|
The JRuby Scripting addon has a global `logger` object for logging. To log a message on `INFO` log level:
|
||||||
|
|
||||||
```text
|
```ruby
|
||||||
log:set DEBUG org.openhab.automation.jrubyscripting.script
|
logger.info("The current time is #{Time.now}")
|
||||||
```
|
```
|
||||||
|
|
||||||
The default logger name for UI rules is `org.openhab.automation.jrubyscripting.script`.
|
The default logger name for UI rules is `org.openhab.automation.jrubyscripting.script`.
|
||||||
For file-based rules, it's based on the rule's ID, such as `org.openhab.automation.jrubyscripting.rule.myrule.rb:15`
|
For file-based rules, it's based on the rule's ID, such as `org.openhab.automation.jrubyscripting.rule.myrule.rb:15`
|
||||||
This can be changed by assigning a new logger locally.
|
|
||||||
|
|
||||||
Please be aware that messages might not appear in the logs if the logger name does not start with `org.openhab`.
|
To use a custom logger name:
|
||||||
This behaviour is due to [log4j2](https://logging.apache.org/log4j/2.x/) requiring definition for each logger prefix.
|
|
||||||
|
|
||||||
```ruby
|
```ruby
|
||||||
logger = OpenHAB::Log.logger("org.openhab.custom")
|
logger = OpenHAB::Log.logger("org.openhab.custom")
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Please be aware that messages might not appear in the logs if the logger name does not start with `org.openhab`.
|
||||||
|
This behaviour is due to [log4j2](https://logging.apache.org/log4j/2.x/) requiring definition for each logger prefix.
|
||||||
|
|
||||||
The [logger](https://openhab.github.io/openhab-jruby/main/OpenHAB/Logger.html) is similar to a standard [Ruby Logger](https://docs.ruby-lang.org/en/master/Logger.html).
|
The [logger](https://openhab.github.io/openhab-jruby/main/OpenHAB/Logger.html) is similar to a standard [Ruby Logger](https://docs.ruby-lang.org/en/master/Logger.html).
|
||||||
Supported logging functions include:
|
Supported logging functions include:
|
||||||
|
|
||||||
@ -810,7 +811,7 @@ When a script is unloaded, all created timers are automatically cancelled.
|
|||||||
You can access all variables of the current context in the created timers.
|
You can access all variables of the current context in the created timers.
|
||||||
|
|
||||||
Note: Variables can be mutated (changed) after the timer has been created.
|
Note: Variables can be mutated (changed) after the timer has been created.
|
||||||
Be aware that this can lead to unattended side effects, e.g. when you change the variable after timer creation, which can make debugging quite difficult!
|
Be aware that this can lead to unintentional side effects, e.g. when you change the variable after timer creation, which can make debugging quite difficult!
|
||||||
|
|
||||||
```ruby
|
```ruby
|
||||||
my_var = "Hello world!";
|
my_var = "Hello world!";
|
||||||
|
Before Width: | Height: | Size: 154 KiB After Width: | Height: | Size: 154 KiB |
Before Width: | Height: | Size: 134 KiB After Width: | Height: | Size: 134 KiB |
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 102 KiB |
Loading…
Reference in New Issue
Block a user