[beta testers wanted!] Jython addon w/ helper libraries (requires OH 2.5.x)

Setup, Configuration and Use Scripts & Rules
,
112

Here are the steps that worked for me.

  1. Make sure you’re running OH 2.5.x (S1778) or newer
  2. The Next-Generation Rule Engine is still in development, so it is recommended to use the latest snapshot or milestone release of openHAB.
  3. Use the Karaf logging commands to enable debug logging for automation: log:set DEBUG org.openhab.core.automation . Leave this on for setup and testing, but you may want to set to WARN when everything is setup. For older openHAB builds before the ESH reintegration (older than snapshot 1566 and 2.5M2), you will need to change this to org.eclipse.smarthome.automation .
  4. Enable debug logging for jsr223: log:set DEBUG jsr223 . This is the default logger used in the examples and the helper libraries.
  5. Review the general openHAB Scripted Automation documentation and the language specific documentation found as links on that page.
  6. Install the Next-Generation Rule Engine add-on.
  7. Shut down openHAB and make a backup
  8. Download the contents of this repository. Using the openhab account, copy the contents of the /Core/ directory into your openHAB’s site configuration directory (Linux, Windows). This will create a directory structure as described in File Locations and will contain all of the Core files for each language, including the startup delay scripts that ensure openHAB has started completely before loading other scripts. If you do not plan to use all of the languages, you may want to remove the directories for them under /automation/jsr223/ and /automation/lib/ .
  9. There is a main configuration file for each scripting language’s helper libraries that must be renamed. For example, in /automation/lib/python/ , rename the file configuration.py.example to configuration.py . These files can be used to secure personal information, so that they are not stored in files that may be shared with the community, or to store variables that are accesed by multiple scripts and/or modules, e.g. LOG_PREFIX.
  10. The ‘’/automation/lib/python/personal/__init.py.example`` file must be renamed to __init__.py . If you modify it, take care not to overwrite the file during upgrades.
  11. Download the bundle that matches your OH version to OPENHAB_CONF/addons/.
  12. Copy the /Script Examples/Python/hello_world.py script to /automation/jsr223/python/personal/ .
  13. Start openHAB and watch the logs for errors and the entries from the Hello World script. This script will make a log entry every 10s and should be deleted after installation has been verified.
  14. Ask questions on the openHAB forum and tag posts with jsr223 . Report issues here, but please don’t hesitate to update the documentation and code. Just like openHAB, this repository is community driven!
  15. Check out the First Steps page for what to do next.
4 Likes