Giter Club home page Giter Club logo

haconfig-as-pycode's Introduction

HAConfig-as-PyCode

HAConfig-as-PyCode is an event-driven, programmatic Home Assistant configuration project leveraging Python for enhanced reusability, encapsulation, and modular expandability. This project provides an alternative automation approach, focusing on developers compared to Home Assistant's default YAML-based configuration.

Desktop

Implementation

HAConfig-as-PyCode is built on an event-driven architecture, integrating Python via PyScript and Home Assistant's built-in automation capabilities. It combines declarative data structures for desired state configuration with imperative logic to process these data structures in an event-driven manner, leveraging an MQTT broker.

Main Home Automation

  • auto_control.py: Manages control behavior for entities based on state triggers, utilizing the ENTITIES_CONTROL data structure with multi-condition handling.
  • auto_entities.py: Automates entity state management, including default states and timeout handling, using the ENTITIES_AUTO data structure with fallback mechanisms.
  • auto_motion.py: Implements motion sensor-based automations, mapping motion sensors to actions through the ENTITIES_MOTION data structure with adaptive lighting.
  • auto_notify.py: Manages external communication via notifications, leveraging the DATA_DEVICES structure from data.py for mobile push notifications and automation shortcuts.
  • auto_presence.py: Handles presence detection and actions based on weighted indicators and exclusions in the ENTITIES_PRESENCE data structure.

Home Automation Capabilities

  • ha_helper.py: Provides comprehensive helper functions for interacting with Home Assistant resources like system logging and generic utility operations.
  • ha_system.py: Manages system-related setup, configuration tasks, and environmental settings, handling runtime initialization and integration routines.
  • ha_utils.py: Includes utility functions for mobile notifications and event shortcuts, using the DATA_DEVICES structure for managing notification targets.
  • ha_off.py: Implements functionality to turn off various entities.

Services

  • air_control.py: Controls air-based functionality.
  • scrape_housing.py: Scrapes housing offers from various Berlin housing providers, processes data, and sends notifications using the DATA_SCRAPE_HOUSING_PROVIDERS structure. Integrates with auto_notify.py for push notifications and mobile shortcuts via ha_utils.py.
  • subprocesses.py: Manages and executes scheduled subprocesses and commands from data.py:
    • File Backup: Scheduled backups of Home Assistant configuration files.
    • Git Sync: Automatic synchronization of the configuration to the Git repository.
    • Compile: Compiles project files, listing the structure and contents at specified times using time_trigger.

Modules

  • constants.py: Centralizes configuration settings, entity definitions, expressions, mappings, and settings by importing them from sub-modules:
    • config.py: General configuration settings and structure.
    • data.py: Specific input data for automations.
    • entities.py: Default state for entities and conditions for behavior.
    • expressions.py: Expressions for various automation scenarios.
    • mappings.py: Naming and mappings.
    • settings.py: Specific configuration values for independent service logic.
  • generic.py: Generic classes like various enumerations and custom exceptions for error handling.
  • utils.py: Central functions for project-wide logging, log rotation, expression generation, and diagnostics.

Native Python

  • filesystem.py: Handles file system operations requiring privileges beyond the PyScript runtime.
  • logfile.py: Structured file logging operations with a partly singleton pattern for consistent log handling.

Project-wide Logging

Project-wide logging is implemented using observability decorators from utils.py, leveraging logfile.py for structured logging operations. It uses a singleton pattern to ensure uniform log handling across the entire project, providing centralized logging functionalities and facilitating debugging and monitoring function calls.

Log

Customization

Mobile

  • User Interface: The project includes various custom templates for the Home Assistant Lovelace UI. These are implemented through the templates/ directory and external data integration.

    • badges.yaml: Defines badge cards for displaying system status, backup information, air quality, and providing quick access to common actions like turning everything off.
    • bar.yaml: Implements customizable button bars for room-specific lighting and device control.
    • calendar.yaml: Includes a customized calendar view for displaying upcoming events from various calendars.
    • card-art.yaml: Provides a comprehensive overview card with weather information, badges, and a calendar view.
    • card.yaml: Defines room-specific overview cards with dynamic images, thermostat controls, and button bars.
    • clima.yaml: Implements a custom thermostat card with temperature graphs and trend indicators.
    • weather.yaml: Includes a weather forecast card and a custom weather display.
  • Backup and Synchronization: Automated backup and synchronization of the Home Assistant configuration and data.

  • External Data: The project integrates external data from various sources through sensors defined in the config/.sensors/ directory:

    • Housing Offers: Scrapes and delivers housing offers and real estate listings from various companies in Berlin. The data is delivered via notifications to trigger mobile services.
  • Customized Shell: The project includes a customized shell environment with an optimized configuration for the Zsh shell, located in files/.zshrc.

Project Structure

pyscript/
  apps/
    air_control.py
    scrape_housing.py
  auto_control.py
  auto_entities.py
  auto_motion.py
  auto_notify.py
  auto_presence.py
  modules/
    constants/
      config.py
      data.py
      entities.py
      expressions.py
      mappings.py
      settings.py
    generic.py
    utils.py
  python/
    filesystem.py
    logfile.py
  requirements.txt
  scripts/
    ha_helper.py
    ha_off.py
    ha_system.py
    ha_utils.py
    subprocesses.py
    tests.py
config/
  assistant.yaml
  calendar.yaml
  frontend.yaml
  http.yaml
  log.yaml
  pyscript.yaml
  sensors.yaml
  timer.yaml
  utils.yaml
files/
  .zshrc

haconfig-as-pycode's People

Contributors

stevius10 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.