adaptive-lighting/CLAUDE.md
Casey Romkes af57bfb872
fix: entity translations were dead, and both validators disabled themselves (#4)
- Entity translations: HA's Entity._name_internal returns _attr_name before it
  consults translation_key, and sensor.py/number.py set both, so every
  entity.sensor.* and entity.number.* string was unreachable. Dropped
  _attr_name (and the dead display_name parameter); filled ambient_lux,
  lux_reduction and ramp_half_width into strings.json and translations/en.json.
- ambient_lux gets SensorDeviceClass.ILLUMINANCE; the curve outputs keep none.
- The five number entities move to EntityCategory.CONFIG.
- validate.yml and hassfest.yaml lose their schedule: GitHub auto-disabled
  both on 2026-09-08 after 60 days of inactivity, which also stops their push
  and pull_request triggers.
- README: the tanh half-width is live-tunable (5-120 min), not a fixed 30 min;
  the dead All-Contributors badge is gone, and .all-contributorsrc with it
  (the fork does not run the bot and no longer merges from upstream).
- CHANGELOG.md covers 2.3.0-cdit.1 through 2.5.0-cdit.1 (2.2.0 was never
  tagged; its content shipped in 2.3.0) and gives 2.1.0 its real date.
- CLAUDE.md matches the fork as it is: number.py, sensor.py and helpers.py in
  the layout, three switches, no active openspec change,
  add-runtime-range-controls shipped in v2.1.0-cdit.1, and the
  translation_key-only naming rule.

164 tests pass, ruff clean.
2026-09-11 09:44:12 +02:00

6.1 KiB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

What this is

A CDiT fork of basnijholt/adaptive-lighting — a Home Assistant custom component that adjusts light brightness and color temperature in sync with the sun curve. The fork is opinionated about CDiT's single-household setup and explicitly diverges from upstream on the integration's configuration surface.

Fork is not a drop-in replacement. Existing upstream config entries will fail to load (deliberate, see openspec/changes/cdit-config-redesign/design.md decision 4).

Remote topology

origin    git@github.com:CaseyRo/adaptive-lighting.git   (the fork, read-write)
upstream  https://github.com/basnijholt/adaptive-lighting.git   (read-only)

Sync upstream changes:

git fetch upstream
git merge upstream/main         # or rebase, depending on local policy
# resolve conflicts under custom_components/adaptive_lighting/

Commands

Python tooling is uv (not pip or poetry). All commands assume an activated venv from ./scripts/setup-devcontainer.

Task Command
Run the test suite uv run pytest
Run a single test uv run pytest tests/test_config_flow.py::test_options_flow_init
Lint everything (pre-commit) ./scripts/lint
Run HA locally with the custom component loaded ./scripts/develop (boots HA on localhost:8123 from ./config/)

Ruff config lives in .ruff.toml. Pre-commit hooks in .pre-commit-config.yaml. Both enforce on push via ./scripts/lint.

Architecture

This is a standard Home Assistant custom component packaged under custom_components/adaptive_lighting/. HA loads it by directory name when present in a HA config's custom_components/. The HACS integration provides distribution.

Big-picture layout:

custom_components/adaptive_lighting/
├── __init__.py             entry point: async_setup_entry, async_unload_entry,
│                           and the curve math (sun-position + brightness/CT calc)
├── config_flow.py          UI flow for setup and reconfiguration. Iterates
│                           VALIDATION_TUPLES from const.py to build the schema.
├── switch.py               the 3 switch entities per AL config (master,
│                           adapt_color, adapt_brightness). Sleep mode was
│                           removed in cdit-config-redesign.
├── number.py               5 live sliders: the 4 brightness/CT range values
│                           (RANGE_ENTITIES) plus ramp half-width. RestoreNumber,
│                           EntityCategory.CONFIG.
├── sensor.py               5 read-only curve outputs (OUTPUT_SENSORS):
│                           output_brightness, output_color_temp, sun_elevation,
│                           and — only with a lux sensor configured —
│                           ambient_lux, lux_reduction.
├── helpers.py              small shared utilities used across the platforms.
├── const.py                CONF_/DEFAULT_ constants + VALIDATION_TUPLES — the
│                           single source for what fields exist in the schema.
├── color_and_brightness.py pure math: tanh, sun-elevation curve, color-temp
│                           interpolation.
├── adaptation_utils.py     per-light service-call shaping (intercept,
│                           skip_redundant_commands, split commands, etc.)
├── hass_utils.py           HA-specific helpers (entity registry lookups,
│                           timestamps, service-call dispatch).
├── manifest.json           integration metadata; `version` here gates
│                           the strict break in cdit-config-redesign.
└── strings.json            UI labels for the config flow, errors, abort reasons.

Both follow-on changes that used to be listed here are resolved: add-runtime-range-controls shipped (v2.1.0-cdit.1, archived 2026-05-17) and house-mode-modes was deleted in 70983a8 — do not re-propose it without checking why it was dropped.

Entity naming across number.py and sensor.py goes through _attr_translation_key, never _attr_name: Entity._name_internal returns _attr_name before it ever consults the translation key, so setting both silently kills every translation.

Planning workflow — OpenSpec under opsx

All non-trivial changes go through OpenSpec before code lands. The experimental opsx schema (artifact-driven: proposal → design → specs → tasks) is configured. Drive it via .claude/commands/opsx/* slash commands or the openspec-* skills.

openspec/
├── config.yaml
├── specs/                  4 long-lived capability specs (options-flow,
│                           runtime-range-controls, lux-feedback, output-sensors)
└── changes/
    └── archive/            7 completed changes — nothing is currently active

There is no active change. changes/ holds only archive/.

Validate any active change with:

openspec validate <change-name> --strict

When implementing tasks for an active change, prefer /opsx:apply <change-name> over manual edits — it walks tasks.md checkbox by checkbox. /opsx:verify checks the resulting code against the spec's scenarios before archive.

Conventions worth preserving

  • Change names: kebab-case (e.g., cdit-config-redesign, add-runtime-range-controls).
  • Capability slugs: kebab-case, scoped tight (options-flow, runtime-range-controls, house-mode-binding) — not broad umbrellas.
  • Annotations in tasks.md: each task ends with [R…, D…] referencing requirements in the change's spec delta and decisions in design.md. Keep traceability.
  • No silent migrations: CDiT-fork breaking changes bump manifest.json major and reject incompatible config entries with a clear error (see cdit-config-redesign design decision 4).
  • openspec/config.yaml context: field: still unset. Fill in once CDiT tech-stack conventions stabilize — it propagates into every artifact prompt.