jpawlowski/hass.tibber_prices
1
0
Fork 0
mirror of https://github.com/jpawlowski/hass.tibber_prices.git synced 2026-03-30 13:23:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
hass.tibber_prices/docs/development/architecture.md
Julian Pawlowski df79afc87e docs: restructure documentation and add AI development disclosure 
Created professional documentation structure:

**User Documentation (docs/user/):**
- README.md: Documentation hub with quick start guide
- Placeholder files for future content migration:
  * installation.md, configuration.md, sensors.md
  * services.md, automation-examples.md, troubleshooting.md

**Developer Documentation (docs/development/):**
- README.md: Comprehensive contributor guide with AI section
- setup.md: DevContainer and environment setup
- architecture.md: Code structure overview
- testing.md: Testing guidelines
- coding-guidelines.md: Style guide and critical patterns
- release-management.md: Complete release workflow documentation

**AI Development Disclosure:**
- README.md: "🤖 Development Note" section before license
  * Honest disclosure about extensive AI assistance
  * Quality assurance measures mentioned
  * Invitation for bug reports with positive tone
- docs/development/README.md: Detailed AI section
  * What AI handles (patterns, generation, refactoring)
  * Benefits (rapid development, consistency)
  * Limitations (edge cases, complex patterns)
  * Quality assurance process
- CONTRIBUTING.md: Brief AI note with practical tip

**Updated:**
- README.md: Simplified to landing page with documentation links
- CONTRIBUTING.md: Modernized with new docs structure
- copilot-instructions.md: Added documentation organization section

Impact: Clear separation of user vs. developer documentation following
open-source best practices. Transparent about AI-assisted development
approach without being defensive. Scalable structure for future growth.
2025-11-09 14:25:27 +00:00

893 B
Raw Blame History

Architecture

Note: This guide is under construction. For now, please refer to .github/copilot-instructions.md for detailed architecture information.

Core Components

Data Flow

  1. TibberPricesApiClient - GraphQL API client
  2. TibberPricesDataUpdateCoordinator - Update orchestration & caching
  3. Price enrichment functions - Statistical calculations
  4. Entity platforms - Sensors and binary sensors
  5. Custom services - API endpoints

Key Patterns

  • Dual translation system: /translations/ (HA schema) + /custom_translations/ (extended)
  • Price enrichment: 24h trailing/leading averages, ratings, differences
  • Quarter-hour precision: Entity updates on 00/15/30/45 boundaries
  • Intelligent caching: User data (24h), price data (calendar day validation)

See .github/copilot-instructions.md "Architecture Overview" section for complete details.