Welcome to the HABApp documentation!

User Documentation

• Installation & Usage
  • Virtual environment
  • Docker
  • Upgrading to a newer version of HABApp
  • Command line arguments
  • Usage with PyCharm
  • Install a development version of HABApp
• About HABApp
  • About
  • HABApp architecture
  • HABApp folder structure
  • Integration with openHAB
  • Integration with MQTT
• Configuration
  • Description
  • Example
  • Configuration Reference
• Getting Started
  • First rule
  • A more generic rule
  • Interacting with items
  • Watch items for events
  • Trigger an event when an item is constant
  • Convenience functions
• Logging
  • Configuration
  • Provided loggers
  • Example
  • Custom log levels
  • Logging to stdout
  • Add custom filters to loggers
• Rule
  • Interacting with items
  • Interacting with events
  • Scheduler
  • Other tools and scripts
  • How to properly use rules from other rule files
  • All available functions
• Parameters
  • Parameters
  • Validation
  • Create rules from Parameters
  • Parameter classes
• HABApp
  • Datatypes
  • Items
  • Events
• openHAB
  • Additional configuration
  • openHAB item types
  • Interaction with a openHAB
  • openHAB event types
  • Transformations
  • Textual thing configuration
  • Example openHAB rules
• MQTT
  • Interaction with the MQTT broker
  • Rule Interface
  • Mqtt item types
  • Mqtt event types
  • Example MQTT rule
• Advanced Usage
  • HABApp Topics
  • File properties
  • Running Python code on startup
  • Invoking openHAB actions
  • Mocking openHAB items and events for tests
• asyncio
  • async http
• util - helpers and utilities
  • Functions
  • Rate limiter
  • Statistics
  • Fade
  • EventListenerGroup
  • MultiModeItem
• Additional rule examples
  • Using the scheduler
  • Mirror openHAB events to a MQTT Broker
  • Trigger an event when an item is constant
  • Turn something off after movement
  • Process Errors in Rules
• Tips & Tricks
  • yml files
  • openHAB
• Troubleshooting
  • Warnings
  • Errors
• Class reference
  • Watches
  • InstantView

Indices and tables

• Index

• Module Index