Helper Libraries for openHAB Scripted Automation

UNDER CONSTRUCTION

The openHAB Scripters (formerly OH Jython Scripters) organization and this repository have both recently had name changes, and there has been a directory restructuring to support more languages. Javascript libraries are now included, but they require testing and are likely to have frequent updates as the functionality of the Jython libraries are added to them. Please report any issues that you find!

If you have local repositories, you’ll need to update them to point to the new location.

The main purpose of the helper libraries is to provide a layer of abstraction to simplify the interaction of scripts with the openHAB Automation API. These libraries can be used with openHAB (2.4M3, S1319, or newer) and the Next-Generation Rule Engine. The one exception is that custom module handlers, including the StartupTrigger, DirectoryTrigger, and OsgiEventTrigger in the JythonHLs, require S1566 or newer.

Getting Started

• Installation
  • Core
  • Community
  • Personal
• File Locations
• First Steps
• Setting up VSCode
  • ENV File
  • Exclude Helper Libraries
  • pylint Directives

Guides

• Rules
  • Decorators
  • Extensions
  • Raw API
• Triggers
  • Cron
  • Items and Groups
  • Thing Event
  • Channel Event
  • System Started
  • System Shuts Down
• Logging
  • Rule Decorator
  • core.log
  • LogAction
  • SLF4J
• Actions
  • Use Core & Cloud Actions
  • Persistence extensions
  • Use an Addon/Bundle Action
• Metadata
• Event Object Attributes
• Examples
  • Hello World
  • Design Patterns
  • Action Example
  • Channel Event Example
  • Directory Watcher Example
  • Extension Provider Usage Example
  • Rule Registry Example
  • Testing Example
  • Timer Example
• But How Do I…?
  • Items
  • Groups
  • Miscellaneous

Python

• Reference
  • Suggested reading
  • Scripts vs. Modules
  • Modifying and Reloading Packages or Modules
  • Custom Packages and Modules
  • Package and Module Locations
• Core
  • Packages and Modules
  • Component Scripts
  • Scripts
• Community
  • Alexa Speak and Respond
  • Area Triggers and Actions
  • AutoRemote
  • ClickaTell
  • Delete and Rediscover Z-Wave Things
  • Esper
  • Mode (Time of Day)
  • OpenWeatherMap
  • Sonos
  • WeatherStationUploader
  • ideAlarm
• Examples
  • Component Scripts

JavaScript

• Reference

Contributing

• Coding Guidelines
• Writing Documentation
  • Python docstrings
  • Adding Documentation for Modules
  • Building the Docs
  • Formatting

Indices and tables

• Index

• Module Index

• Search Page