From 78381e8b6d0955d720fa2a682bf04c56ba71c4d8 Mon Sep 17 00:00:00 2001 From: jimtng <2554958+jimtng@users.noreply.github.com> Date: Sun, 20 Aug 2023 06:41:54 +1000 Subject: [PATCH] [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 --- .../README.md | 23 +++++++++--------- .../{docs/images => doc}/rule-config.png | Bin .../{docs/images => doc}/rule-engines.png | Bin .../{docs/images => doc}/rule-script.png | Bin 4 files changed, 12 insertions(+), 11 deletions(-) rename bundles/org.openhab.automation.jrubyscripting/{docs/images => doc}/rule-config.png (100%) rename bundles/org.openhab.automation.jrubyscripting/{docs/images => doc}/rule-engines.png (100%) rename bundles/org.openhab.automation.jrubyscripting/{docs/images => doc}/rule-script.png (100%) diff --git a/bundles/org.openhab.automation.jrubyscripting/README.md b/bundles/org.openhab.automation.jrubyscripting/README.md index 157cb1ae126..39686cb12bd 100644 --- a/bundles/org.openhab.automation.jrubyscripting/README.md +++ b/bundles/org.openhab.automation.jrubyscripting/README.md @@ -1,5 +1,5 @@ - + # 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. -![openHAB Rule Configuration](docs/images/rule-config.png) +![openHAB Rule Configuration](doc/rule-config.png) #### Adding Actions Select "Add Action" and then select "Run Script" with "Ruby". 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). -![openHAB Rule Script](docs/images/rule-script.png) +![openHAB Rule Script](doc/rule-script.png) For example, turning a light on: @@ -740,23 +740,24 @@ Exec.execute_command_line('/path/to/program') ### 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 -log:set DEBUG org.openhab.automation.jrubyscripting.script +```ruby +logger.info("The current time is #{Time.now}") ``` 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` -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`. -This behaviour is due to [log4j2](https://logging.apache.org/log4j/2.x/) requiring definition for each logger prefix. +To use a custom logger name: ```ruby 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). 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. 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 my_var = "Hello world!"; diff --git a/bundles/org.openhab.automation.jrubyscripting/docs/images/rule-config.png b/bundles/org.openhab.automation.jrubyscripting/doc/rule-config.png similarity index 100% rename from bundles/org.openhab.automation.jrubyscripting/docs/images/rule-config.png rename to bundles/org.openhab.automation.jrubyscripting/doc/rule-config.png diff --git a/bundles/org.openhab.automation.jrubyscripting/docs/images/rule-engines.png b/bundles/org.openhab.automation.jrubyscripting/doc/rule-engines.png similarity index 100% rename from bundles/org.openhab.automation.jrubyscripting/docs/images/rule-engines.png rename to bundles/org.openhab.automation.jrubyscripting/doc/rule-engines.png diff --git a/bundles/org.openhab.automation.jrubyscripting/docs/images/rule-script.png b/bundles/org.openhab.automation.jrubyscripting/doc/rule-script.png similarity index 100% rename from bundles/org.openhab.automation.jrubyscripting/docs/images/rule-script.png rename to bundles/org.openhab.automation.jrubyscripting/doc/rule-script.png