Welcome to Smart Home Connect’s docs!

Smart Home Connect (SHC) is a Home Automation framework for Python 3, based on Python’s AsyncIO modules for asynchronous event processing. Its purpose is to connect “smart home” devices via different communication protocols, provide means for creating automation rules/scripts and a web interface for controlling the devices via browser.

• The latest stable version on PyPI: https://pypi.org/project/smarthomeconnect/

• SHC’s source code at GitHub: https://github.com/mhthies/smarthomeconnect

Contents:

• Smart Home Connect Base Concepts
  • Connectable Objects
  • The connect Method
  • The origin of a New Value
  • Typing of Connectable Objects
  • Logic Handlers
  • shc.base Module Reference
• Variables and Expressions
  • Variables
  • Expressions
• Datatypes and Type Conversions
  • Inherited semantic types in SHC
  • Default converters
  • JSON conversion
  • shc.datatypes Module Reference
  • shc.conversion Module Reference
• Timers
  • Schedule Timers
  • Delay Timers
  • Helper Classes
  • Ramp Generators
• Start, Stop and Status Monitoring
  • Monitoring of Interface Status
  • Monitoring Helper classes
• HTTP Server and Web User Interface
  • Configuring the User Interface
  • Configuring the HTTP REST + Websocket API
  • Monitoring via HTTP
  • Creating Custom Widgets
  • web Module Reference
• Data Logging
  • Included interfaces with data logging support
  • shc.data_logging Module Reference
  • shc.interfaces.in_memory_data_logging Module Reference
• Interfaces
  • DMX output interfaces
  • KNX Interface
  • MIDI Interface
  • Miscellaneous Interfaces
  • MQTT Interface
  • MySQL Database Interface
  • Pulseaudio Interface
  • SHC Client Interface
  • Tasmota Interface
  • Telegram Bot Interface
  • Creating Custom Interfaces
• Miscellaneous Helper Classes
  • BreakableSubscription
  • ConvertSubscription
  • FadeStepAdapter
  • Hysteresis
  • PeriodicReader
  • SimpleInputConnector
  • SimpleOutputConnector
  • TwoWayPipe
  • UpdateExchange

Indices and Tables

• Index

• Module Index

• Search Page