Compare commits

...

2 Commits

Author SHA1 Message Date
Claude
6bcbcbc6a1 Convert agent files to proper Claude Skills
Restructured from agent markdown files to proper Claude Skills format:

Changed:
- Moved from .claude/agents/*.md to .claude/skills/*/SKILL.md
- Updated YAML frontmatter to Skills format (name + description only)
- Removed agent-specific fields (model, color, tools)
- Condensed descriptions to focus on triggering conditions
- Updated README to reflect proper Skills structure

New Skills:
- testing: Write, run, and fix tests for HA integrations
- code-review: Review code for quality and standards
- quality-scale-architect: Architecture and quality tier guidance

Skills use progressive disclosure for efficient context management:
- Level 1: Metadata (always loaded, ~100 tokens)
- Level 2: Instructions (loaded when triggered, <5k tokens)
- Level 3: Resources (loaded as needed, unlimited)

Reference files in .claude/references/ remain unchanged and are
loaded on-demand by Skills.

See: https://platform.claude.com/docs/en/agents-and-tools/agent-skills/
2026-01-12 19:08:45 +00:00
Claude
5c8f494ac6 Add Claude Code skills and reference documentation
Created structured skill system for Home Assistant development:

Agents (specialized AI assistants):
- testing.md: Test writing, running, and fixing specialist
- code-review.md: Code quality and standards reviewer
- quality-scale-architect.md: Architecture and tier guidance

Reference documentation:
- diagnostics.md: Integration diagnostics implementation
- sensor.md: Sensor platform implementation guide
- binary_sensor.md: Binary sensor platform guide
- switch.md: Switch platform guide
- button.md: Button platform guide
- number.md: Number platform guide
- select.md: Select platform guide

Each file provides comprehensive implementation guidance, patterns,
best practices, and quality scale considerations extracted from
CLAUDE.md and organized for focused, specialized assistance.
2026-01-11 20:33:36 +00:00
11 changed files with 4397 additions and 0 deletions

168
.claude/README.md Normal file
View File

@@ -0,0 +1,168 @@
# Claude Code Skills and Reference Files
This directory contains Claude Skills and reference documentation for working with Home Assistant integrations.
## Directory Structure
```
.claude/
├── skills/ # Claude Skills (auto-loaded)
│ ├── testing/
│ │ └── SKILL.md # Testing specialist skill
│ ├── code-review/
│ │ └── SKILL.md # Code review specialist skill
│ └── quality-scale-architect/
│ └── SKILL.md # Architecture guidance skill
├── agents/ # Legacy agent definitions
│ └── quality-scale-rule-verifier.md
└── references/ # Deep-dive reference docs
├── diagnostics.md # Diagnostics implementation
├── sensor.md # Sensor platform
├── binary_sensor.md # Binary sensor platform
├── switch.md # Switch platform
├── button.md # Button platform
├── number.md # Number platform
└── select.md # Select platform
```
## Claude Skills
Claude Skills are modular capabilities that extend Claude's functionality. Each Skill packages instructions and metadata that Claude uses automatically when relevant.
### How Skills Work
Skills use **progressive disclosure** - they load content in stages:
1. **Level 1 - Metadata (always loaded)**: Skill name and description
2. **Level 2 - Instructions (loaded when triggered)**: Main SKILL.md content
3. **Level 3+ - Resources (loaded as needed)**: Reference files and additional docs
This means you can have many Skills installed with minimal context penalty. Claude only knows each Skill exists and when to use it until triggered.
### Available Skills
#### Testing (`testing`)
**Use when**: Writing, running, or fixing tests for Home Assistant integrations
Specializes in:
- Writing comprehensive test coverage (>95%)
- Running pytest with appropriate flags
- Fixing failing tests and updating snapshots
- Following Home Assistant testing patterns
- Modern fixture patterns and snapshot testing
**Triggers on**: Requests about writing tests, running tests, fixing test failures, test coverage, pytest, snapshots
#### Code Review (`code-review`)
**Use when**: Reviewing code for quality, best practices, and standards compliance
Specializes in:
- Reviewing pull requests and code changes
- Identifying anti-patterns and security vulnerabilities
- Verifying async patterns and error handling
- Ensuring quality scale compliance
- Performance optimization
**Triggers on**: Requests to review code, check for issues, analyze code quality, security review
#### Quality Scale Architect (`quality-scale-architect`)
**Use when**: Needing architectural guidance and quality scale planning
Specializes in:
- High-level architecture guidance
- Quality scale tier selection (Bronze/Silver/Gold/Platinum)
- Integration structure planning
- Pattern recommendations (coordinator, push, hub)
- Progression strategies between quality tiers
**Triggers on**: Requests about architecture, integration design, quality tiers, structural planning, choosing patterns
## Reference Files
Reference files provide deep-dive documentation for specific implementation areas. Skills can reference these for detailed guidance, and they're loaded on-demand to avoid consuming context.
### Available References
- **diagnostics.md**: Complete guide to implementing integration and device diagnostics, data redaction, testing
- **sensor.md**: Sensor platform implementation, device classes, state classes, entity descriptions
- **binary_sensor.md**: Binary sensor implementation, device classes, push-updated patterns
- **switch.md**: Switch control implementation, state updates, configuration switches
- **button.md**: Button action implementation, device classes, one-time actions
- **number.md**: Numeric value control, ranges, display modes, units
- **select.md**: Option selection implementation, enums, translations, dynamic options
## How to Use
### As a Developer
Skills work automatically - just ask Claude to help with tasks:
- **Testing**: "Write tests for my sensor platform" or "Fix the failing config flow tests"
- **Review**: "Review this integration for security issues" or "Check my async patterns"
- **Architecture**: "Help me design a hub integration" or "What quality tier should I target?"
### As Claude
Skills are triggered automatically when requests match the skill descriptions. Skills can reference the documentation files in `.claude/references/` for detailed implementation guidance.
Example:
```python
# When a testing request comes in, Claude triggers the testing skill
# The skill can then reference .claude/references/sensor.md for sensor-specific patterns
```
## Quality Scale Overview
Home Assistant uses a Quality Scale system:
- **Bronze**: Basic requirements (mandatory baseline) - Config flow, unique IDs, auth flows
- **Silver**: Enhanced functionality - Unavailability tracking, runtime data, parallel updates
- **Gold**: Advanced features - Diagnostics, translations, device registry
- **Platinum**: Highest quality - Strict typing, async-only dependencies, WebSession injection
All Bronze rules are mandatory. Higher tiers are additive.
## Skill Structure
Each Skill is a directory containing a `SKILL.md` file with YAML frontmatter:
```yaml
---
name: skill-name
description: Brief description of what this Skill does and when to use it (max 1024 chars)
---
# Skill Content in Markdown
Instructions, examples, and guidance...
```
**Progressive Loading**: Only the name/description are loaded initially. The full content loads when the Skill is triggered.
## Creating Custom Skills
To add a new Skill:
1. Create a directory: `.claude/skills/my-skill/`
2. Add a `SKILL.md` file with proper frontmatter
3. Include clear instructions and examples
4. Reference existing documentation when appropriate
See [Claude Skills Documentation](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/overview) for complete guidance.
## Additional Resources
- Main instructions: `/home/user/core/CLAUDE.md`
- Home Assistant Docs: https://developers.home-assistant.io
- Integration Quality Scale: https://developers.home-assistant.io/docs/core/integration-quality-scale/
- Claude Skills Cookbook: https://platform.claude.com/cookbook/skills-notebooks-01-skills-introduction
## Contributing
When adding new Skills or references:
1. Follow the proper Skill structure (SKILL.md with frontmatter)
2. Keep descriptions concise and trigger-focused (max 1024 chars)
3. Include practical examples in Skill content
4. Link to reference documentation for deep dives
5. Consider quality scale implications
6. Test that Skills trigger appropriately

View File

@@ -0,0 +1,470 @@
# Binary Sensor Platform Reference
## Overview
Binary sensors are read-only entities that represent an on/off, true/false, or open/closed state. They are simpler than regular sensors and don't have units or numeric values.
## Basic Binary Sensor Implementation
```python
"""Binary sensor platform for my_integration."""
from homeassistant.components.binary_sensor import (
BinarySensorDeviceClass,
BinarySensorEntity,
)
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import MyConfigEntry
from .coordinator import MyCoordinator
from .entity import MyEntity
async def async_setup_entry(
hass: HomeAssistant,
entry: MyConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up binary sensors."""
coordinator = entry.runtime_data
async_add_entities(
MyBinarySensor(coordinator, device_id)
for device_id in coordinator.data.devices
)
class MyBinarySensor(MyEntity, BinarySensorEntity):
"""Representation of a binary sensor."""
_attr_has_entity_name = True
_attr_translation_key = "motion"
_attr_device_class = BinarySensorDeviceClass.MOTION
def __init__(self, coordinator: MyCoordinator, device_id: str) -> None:
"""Initialize the binary sensor."""
super().__init__(coordinator, device_id)
self._attr_unique_id = f"{device_id}_motion"
@property
def is_on(self) -> bool | None:
"""Return true if motion is detected."""
if device := self.coordinator.data.devices.get(self.device_id):
return device.motion_detected
return None
```
## Binary Sensor State
The core property for binary sensors is `is_on`:
```python
@property
def is_on(self) -> bool | None:
"""Return true if the binary sensor is on."""
return self.device.is_active
# Alternatively, use attribute
_attr_is_on = True # or False, or None
```
**State Meaning**:
- `True` / `"on"` - Active/detected/open
- `False` / `"off"` - Inactive/not detected/closed
- `None` - Unknown (displays as "unavailable")
## Device Classes
Binary sensors should use device classes for proper representation:
```python
from homeassistant.components.binary_sensor import BinarySensorDeviceClass
# Common device classes
_attr_device_class = BinarySensorDeviceClass.MOTION
_attr_device_class = BinarySensorDeviceClass.OCCUPANCY
_attr_device_class = BinarySensorDeviceClass.DOOR
_attr_device_class = BinarySensorDeviceClass.WINDOW
_attr_device_class = BinarySensorDeviceClass.OPENING
_attr_device_class = BinarySensorDeviceClass.CONNECTIVITY
_attr_device_class = BinarySensorDeviceClass.BATTERY
_attr_device_class = BinarySensorDeviceClass.BATTERY_CHARGING
_attr_device_class = BinarySensorDeviceClass.PROBLEM
_attr_device_class = BinarySensorDeviceClass.RUNNING
_attr_device_class = BinarySensorDeviceClass.SMOKE
_attr_device_class = BinarySensorDeviceClass.MOISTURE
_attr_device_class = BinarySensorDeviceClass.LOCK
_attr_device_class = BinarySensorDeviceClass.TAMPER
_attr_device_class = BinarySensorDeviceClass.PLUG
_attr_device_class = BinarySensorDeviceClass.POWER
```
### Device Class Selection Guide
**Detection Sensors**:
- Motion detector → `MOTION`
- Presence detector → `OCCUPANCY`
- Smoke detector → `SMOKE`
- Water leak detector → `MOISTURE`
**Contact Sensors**:
- Door sensor → `DOOR`
- Window sensor → `WINDOW`
- Generic contact → `OPENING`
**Status Sensors**:
- Network connection → `CONNECTIVITY`
- Device running → `RUNNING`
- Low battery → `BATTERY`
- Charging state → `BATTERY_CHARGING`
- Problem/fault → `PROBLEM`
- Tamper detection → `TAMPER`
**Power Sensors**:
- Outlet state → `PLUG`
- Power state → `POWER`
- Lock state → `LOCK`
## Entity Descriptions Pattern
For multiple similar binary sensors:
```python
from dataclasses import dataclass
from collections.abc import Callable
from homeassistant.components.binary_sensor import (
BinarySensorDeviceClass,
BinarySensorEntityDescription,
)
@dataclass(frozen=True, kw_only=True)
class MyBinarySensorDescription(BinarySensorEntityDescription):
"""Describes a binary sensor."""
is_on_fn: Callable[[MyData], bool | None]
BINARY_SENSORS: tuple[MyBinarySensorDescription, ...] = (
MyBinarySensorDescription(
key="motion",
translation_key="motion",
device_class=BinarySensorDeviceClass.MOTION,
is_on_fn=lambda data: data.motion_detected,
),
MyBinarySensorDescription(
key="door",
translation_key="door",
device_class=BinarySensorDeviceClass.DOOR,
is_on_fn=lambda data: data.door_open,
),
MyBinarySensorDescription(
key="battery_low",
translation_key="battery_low",
device_class=BinarySensorDeviceClass.BATTERY,
entity_category=EntityCategory.DIAGNOSTIC,
is_on_fn=lambda data: data.battery_level < 20,
),
)
async def async_setup_entry(
hass: HomeAssistant,
entry: MyConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up binary sensors."""
coordinator = entry.runtime_data
async_add_entities(
MyBinarySensor(coordinator, device_id, description)
for device_id in coordinator.data.devices
for description in BINARY_SENSORS
)
class MyBinarySensor(MyEntity, BinarySensorEntity):
"""Binary sensor using entity description."""
entity_description: MyBinarySensorDescription
def __init__(
self,
coordinator: MyCoordinator,
device_id: str,
description: MyBinarySensorDescription,
) -> None:
"""Initialize the binary sensor."""
super().__init__(coordinator, device_id)
self.entity_description = description
self._attr_unique_id = f"{device_id}_{description.key}"
@property
def is_on(self) -> bool | None:
"""Return true if the binary sensor is on."""
if device := self.coordinator.data.devices.get(self.device_id):
return self.entity_description.is_on_fn(device)
return None
```
## Entity Category
Mark diagnostic or configuration binary sensors:
```python
from homeassistant.helpers.entity import EntityCategory
# Diagnostic sensors
_attr_entity_category = EntityCategory.DIAGNOSTIC
# Examples: connectivity, update available, battery low
# Config sensors
_attr_entity_category = EntityCategory.CONFIG
# Examples: configuration status
```
## State Inversion
For some sensors, you may need to invert the logic:
```python
class MyBinarySensor(BinarySensorEntity):
"""Binary sensor with inverted state."""
@property
def is_on(self) -> bool | None:
"""Return true if sensor is on."""
if self.device.is_closed:
return False # Closed = off for door sensor
if self.device.is_open:
return True # Open = on for door sensor
return None
```
## Push-Updated Binary Sensor
For event-driven sensors:
```python
class MyPushBinarySensor(BinarySensorEntity):
"""Push-updated binary sensor."""
_attr_should_poll = False
async def async_added_to_hass(self) -> None:
"""Subscribe to updates when added."""
self.async_on_remove(
self.device.subscribe_state(self._handle_state_update)
)
@callback
def _handle_state_update(self, state: bool) -> None:
"""Handle state update from device."""
self._attr_is_on = state
self.async_write_ha_state()
```
## Testing Binary Sensors
### Snapshot Testing
```python
"""Test binary sensors."""
import pytest
from syrupy import SnapshotAssertion
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er
@pytest.mark.usefixtures("entity_registry_enabled_by_default")
async def test_binary_sensors(
hass: HomeAssistant,
snapshot: SnapshotAssertion,
entity_registry: er.EntityRegistry,
mock_config_entry: MockConfigEntry,
init_integration,
) -> None:
"""Test binary sensor entities."""
await snapshot_platform(
hass,
entity_registry,
snapshot,
mock_config_entry.entry_id,
)
```
### State Testing
```python
async def test_binary_sensor_states(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
) -> None:
"""Test binary sensor states."""
await init_integration(hass, mock_config_entry)
# Test on state
state = hass.states.get("binary_sensor.my_device_motion")
assert state
assert state.state == "on"
assert state.attributes["device_class"] == "motion"
# Test off state
state = hass.states.get("binary_sensor.my_device_door")
assert state
assert state.state == "off"
assert state.attributes["device_class"] == "door"
```
## Common Patterns
### Pattern 1: Coordinator-Based
```python
class MyBinarySensor(CoordinatorEntity[MyCoordinator], BinarySensorEntity):
"""Coordinator-based binary sensor."""
_attr_should_poll = False
@property
def is_on(self) -> bool | None:
"""Get state from coordinator data."""
if device := self.coordinator.data.devices.get(self.device_id):
return device.is_active
return None
@property
def available(self) -> bool:
"""Return if entity is available."""
return super().available and self.device_id in self.coordinator.data
```
### Pattern 2: Event-Driven
```python
class MyEventBinarySensor(BinarySensorEntity):
"""Event-driven binary sensor."""
_attr_should_poll = False
async def async_added_to_hass(self) -> None:
"""Subscribe to events."""
self.async_on_remove(
async_dispatcher_connect(
self.hass,
f"{DOMAIN}_event",
self._handle_event,
)
)
@callback
def _handle_event(self, event_type: str, active: bool) -> None:
"""Handle incoming event."""
if event_type == self.event_type:
self._attr_is_on = active
self.async_write_ha_state()
```
### Pattern 3: Calculated/Derived
```python
class MyCalculatedBinarySensor(BinarySensorEntity):
"""Binary sensor calculated from other sensors."""
_attr_should_poll = False
async def async_added_to_hass(self) -> None:
"""Subscribe to source sensors."""
self.async_on_remove(
async_track_state_change_event(
self.hass,
["sensor.temperature", "sensor.humidity"],
self._handle_source_update,
)
)
@callback
def _handle_source_update(self, event: Event) -> None:
"""Recalculate when sources change."""
temp = self.hass.states.get("sensor.temperature")
humidity = self.hass.states.get("sensor.humidity")
if temp and humidity:
# Example: high comfort if temp 20-25 and humidity 30-60
temp_ok = 20 <= float(temp.state) <= 25
humidity_ok = 30 <= float(humidity.state) <= 60
self._attr_is_on = temp_ok and humidity_ok
self.async_write_ha_state()
```
## Best Practices
### ✅ DO
- Use appropriate device classes
- Return `None` for unknown state
- Use `is_on` property (not state)
- Implement unique IDs
- Use entity descriptions for similar sensors
- Mark diagnostic sensors with entity_category
- Use translation keys for entity names
- Handle availability properly
### ❌ DON'T
- Return strings like "on"/"off" from is_on
- Use regular Sensor for binary states
- Hardcode entity names
- Create binary sensors without device classes (when available)
- Use unavailable/unknown as state values
- Block the event loop
- Poll unnecessarily (use coordinator or events)
## Disabled by Default
For less important binary sensors:
```python
class MyConnectivitySensor(BinarySensorEntity):
"""Connectivity sensor - diagnostic."""
_attr_entity_registry_enabled_default = False
_attr_entity_category = EntityCategory.DIAGNOSTIC
_attr_device_class = BinarySensorDeviceClass.CONNECTIVITY
```
## Troubleshooting
### Binary Sensor Not Appearing
Check:
- [ ] Unique ID is set
- [ ] Platform is in PLATFORMS list
- [ ] Entity is added with async_add_entities
- [ ] is_on returns bool or None (not string)
### State Not Updating
Check:
- [ ] Coordinator is updating (if used)
- [ ] Event subscriptions are working
- [ ] is_on returns correct value
- [ ] async_write_ha_state() is called (push updates)
### Wrong Icon
Check:
- [ ] Device class is set correctly
- [ ] Device class matches sensor purpose
- [ ] Icon translations if using Gold tier
## Quality Scale Considerations
- **Bronze**: Unique ID required
- **Gold**: Entity translations, device class, entity category
- **Platinum**: Full type hints
## References
- [Binary Sensor Documentation](https://developers.home-assistant.io/docs/core/entity/binary-sensor)
- [Device Classes](https://www.home-assistant.io/integrations/binary_sensor/#device-class)

View File

@@ -0,0 +1,459 @@
# Button Platform Reference
## Overview
Buttons are entities that trigger an action when pressed. They don't have a state (on/off) and are used for one-time actions like rebooting a device, triggering an update, or running a routine.
## Basic Button Implementation
```python
"""Button platform for my_integration."""
from homeassistant.components.button import ButtonEntity
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import MyConfigEntry
from .coordinator import MyCoordinator
from .entity import MyEntity
async def async_setup_entry(
hass: HomeAssistant,
entry: MyConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up buttons."""
coordinator = entry.runtime_data
async_add_entities(
MyButton(coordinator, device_id)
for device_id in coordinator.data.devices
)
class MyButton(MyEntity, ButtonEntity):
"""Representation of a button."""
_attr_has_entity_name = True
_attr_translation_key = "reboot"
def __init__(self, coordinator: MyCoordinator, device_id: str) -> None:
"""Initialize the button."""
super().__init__(coordinator, device_id)
self._attr_unique_id = f"{device_id}_reboot"
async def async_press(self) -> None:
"""Handle the button press."""
await self.coordinator.client.reboot(self.device_id)
```
## Button Method
The only required method for buttons:
```python
async def async_press(self) -> None:
"""Handle the button press."""
await self.device.trigger_action()
```
**Note**: Buttons don't have state. They only perform an action when pressed.
## Device Class
Buttons can have device classes to indicate their purpose:
```python
from homeassistant.components.button import ButtonDeviceClass
_attr_device_class = ButtonDeviceClass.RESTART
_attr_device_class = ButtonDeviceClass.UPDATE
_attr_device_class = ButtonDeviceClass.IDENTIFY
```
Device classes:
- `RESTART` - Reboot/restart device
- `UPDATE` - Trigger update check or installation
- `IDENTIFY` - Make device identify itself (blink LED, beep, etc.)
## Entity Category
Most buttons are configuration actions:
```python
from homeassistant.helpers.entity import EntityCategory
# Config buttons (device settings/actions)
_attr_entity_category = EntityCategory.CONFIG
# Examples: reboot, reset, identify
# Diagnostic buttons (troubleshooting)
_attr_entity_category = EntityCategory.DIAGNOSTIC
# Examples: test connection, refresh diagnostics
```
## Entity Descriptions Pattern
For multiple buttons:
```python
from dataclasses import dataclass
from collections.abc import Awaitable, Callable
from homeassistant.components.button import ButtonEntityDescription, ButtonDeviceClass
@dataclass(frozen=True, kw_only=True)
class MyButtonDescription(ButtonEntityDescription):
"""Describes a button."""
press_fn: Callable[[MyClient, str], Awaitable[None]]
BUTTONS: tuple[MyButtonDescription, ...] = (
MyButtonDescription(
key="reboot",
translation_key="reboot",
device_class=ButtonDeviceClass.RESTART,
entity_category=EntityCategory.CONFIG,
press_fn=lambda client, device_id: client.reboot(device_id),
),
MyButtonDescription(
key="identify",
translation_key="identify",
device_class=ButtonDeviceClass.IDENTIFY,
entity_category=EntityCategory.CONFIG,
press_fn=lambda client, device_id: client.identify(device_id),
),
MyButtonDescription(
key="check_update",
translation_key="check_update",
device_class=ButtonDeviceClass.UPDATE,
entity_category=EntityCategory.CONFIG,
press_fn=lambda client, device_id: client.check_updates(device_id),
),
)
async def async_setup_entry(
hass: HomeAssistant,
entry: MyConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up buttons."""
coordinator = entry.runtime_data
async_add_entities(
MyButton(coordinator, device_id, description)
for device_id in coordinator.data.devices
for description in BUTTONS
)
class MyButton(MyEntity, ButtonEntity):
"""Button using entity description."""
entity_description: MyButtonDescription
def __init__(
self,
coordinator: MyCoordinator,
device_id: str,
description: MyButtonDescription,
) -> None:
"""Initialize the button."""
super().__init__(coordinator, device_id)
self.entity_description = description
self._attr_unique_id = f"{device_id}_{description.key}"
async def async_press(self) -> None:
"""Handle the button press."""
await self.entity_description.press_fn(
self.coordinator.client,
self.device_id,
)
```
## Common Button Types
### Restart Button
```python
class RestartButton(ButtonEntity):
"""Restart device button."""
_attr_device_class = ButtonDeviceClass.RESTART
_attr_entity_category = EntityCategory.CONFIG
_attr_translation_key = "restart"
async def async_press(self) -> None:
"""Restart the device."""
await self.device.restart()
```
### Update Button
```python
class UpdateButton(ButtonEntity):
"""Trigger update check button."""
_attr_device_class = ButtonDeviceClass.UPDATE
_attr_entity_category = EntityCategory.CONFIG
_attr_translation_key = "check_update"
async def async_press(self) -> None:
"""Check for updates."""
await self.device.check_for_updates()
```
### Identify Button
```python
class IdentifyButton(ButtonEntity):
"""Make device identify itself."""
_attr_device_class = ButtonDeviceClass.IDENTIFY
_attr_entity_category = EntityCategory.CONFIG
_attr_translation_key = "identify"
async def async_press(self) -> None:
"""Trigger device identification."""
await self.device.identify()
```
### Custom Action Button
```python
class CustomButton(ButtonEntity):
"""Custom action button."""
_attr_entity_category = EntityCategory.CONFIG
_attr_translation_key = "run_cycle"
async def async_press(self) -> None:
"""Run cleaning cycle."""
await self.device.start_cleaning_cycle()
```
## State Updates After Press
Buttons trigger coordinator refresh if needed:
```python
async def async_press(self) -> None:
"""Handle press with refresh."""
await self.coordinator.client.reboot(self.device_id)
# Refresh coordinator to update related entities
await self.coordinator.async_request_refresh()
```
## Error Handling
Handle errors appropriately:
```python
from homeassistant.exceptions import HomeAssistantError
async def async_press(self) -> None:
"""Handle press with error handling."""
try:
await self.device.reboot()
except DeviceOfflineError as err:
raise HomeAssistantError(f"Device is offline: {err}") from err
except DeviceError as err:
raise HomeAssistantError(f"Failed to reboot: {err}") from err
```
## Testing Buttons
### Snapshot Testing
```python
"""Test buttons."""
import pytest
from syrupy import SnapshotAssertion
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er
@pytest.mark.usefixtures("entity_registry_enabled_by_default")
async def test_buttons(
hass: HomeAssistant,
snapshot: SnapshotAssertion,
entity_registry: er.EntityRegistry,
mock_config_entry: MockConfigEntry,
init_integration,
) -> None:
"""Test button entities."""
await snapshot_platform(
hass,
entity_registry,
snapshot,
mock_config_entry.entry_id,
)
```
### Press Testing
```python
from homeassistant.const import ATTR_ENTITY_ID
from homeassistant.components.button import DOMAIN as BUTTON_DOMAIN, SERVICE_PRESS
async def test_button_press(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_device,
) -> None:
"""Test button press."""
await init_integration(hass, mock_config_entry)
# Press button
await hass.services.async_call(
BUTTON_DOMAIN,
SERVICE_PRESS,
{ATTR_ENTITY_ID: "button.my_device_reboot"},
blocking=True,
)
# Verify action was called
mock_device.reboot.assert_called_once()
```
### Error Testing
```python
async def test_button_press_error(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_device,
) -> None:
"""Test button press with error."""
await init_integration(hass, mock_config_entry)
mock_device.reboot.side_effect = DeviceError("Connection failed")
# Press button should raise error
with pytest.raises(HomeAssistantError):
await hass.services.async_call(
BUTTON_DOMAIN,
SERVICE_PRESS,
{ATTR_ENTITY_ID: "button.my_device_reboot"},
blocking=True,
)
```
## Common Patterns
### Pattern 1: Simple Action Button
```python
class SimpleButton(ButtonEntity):
"""Simple button that triggers action."""
async def async_press(self) -> None:
"""Trigger action."""
await self.device.do_something()
```
### Pattern 2: Button with Coordinator Refresh
```python
class RefreshingButton(CoordinatorEntity[MyCoordinator], ButtonEntity):
"""Button that refreshes coordinator."""
async def async_press(self) -> None:
"""Trigger action and refresh."""
await self.coordinator.client.action(self.device_id)
await self.coordinator.async_request_refresh()
```
### Pattern 3: Button with Validation
```python
class ValidatingButton(ButtonEntity):
"""Button with pre-action validation."""
async def async_press(self) -> None:
"""Validate then trigger action."""
if not self.device.is_ready:
raise HomeAssistantError("Device not ready")
await self.device.trigger_action()
```
## Best Practices
### ✅ DO
- Use appropriate device class
- Set entity category (usually CONFIG)
- Handle errors with HomeAssistantError
- Implement unique IDs
- Use translation keys
- Refresh coordinator if state changes
- Provide clear button names/translations
### ❌ DON'T
- Create buttons that track state (use switch instead)
- Poll buttons (they have no state)
- Block the event loop
- Ignore errors silently
- Create buttons without entity category
- Hardcode entity names
- Use buttons for binary controls (use switch)
## Button vs. Switch vs. Service
**Use Button when**:
- One-time action with no state
- Trigger command (reboot, identify)
- User initiates action
**Use Switch when**:
- Binary control (on/off)
- State matters
- Can be turned on and off
**Use Service when**:
- Complex parameters needed
- Multiple related actions
- Integration-wide operations
## Troubleshooting
### Button Not Appearing
Check:
- [ ] Unique ID is set
- [ ] Platform is in PLATFORMS list
- [ ] Entity is added with async_add_entities
- [ ] async_press is implemented
### Button Press Not Working
Check:
- [ ] async_press is async def
- [ ] Not blocking the event loop
- [ ] API client is working
- [ ] Errors are being raised properly
### Button Not in Expected Category
Check:
- [ ] entity_category is set
- [ ] Using correct EntityCategory value
- [ ] Device class is appropriate
## Quality Scale Considerations
- **Bronze**: Unique ID required
- **Gold**: Entity translations, device class, entity category
- **Platinum**: Full type hints
## References
- [Button Documentation](https://developers.home-assistant.io/docs/core/entity/button)
- [Button Integration](https://www.home-assistant.io/integrations/button/)

View File

@@ -0,0 +1,420 @@
# Diagnostics Reference
## Overview
Diagnostics provide a way to collect and export integration data for troubleshooting purposes. This is a **Gold tier** quality scale requirement that helps users and developers debug issues.
## When to Implement Diagnostics
Diagnostics are required for:
- ✅ Gold tier and above integrations
- ✅ Any integration where users might need support
- ✅ Integrations with complex configuration or state
## Diagnostics Types
Home Assistant supports two types of diagnostics:
### 1. Config Entry Diagnostics
Provides data about a specific configuration entry.
**File**: `diagnostics.py` in your integration folder
```python
"""Diagnostics support for My Integration."""
from typing import Any
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers import device_registry as dr, entity_registry as er
from .const import DOMAIN
TO_REDACT = {
"api_key",
"access_token",
"refresh_token",
"password",
"username",
"email",
"latitude",
"longitude",
}
async def async_get_config_entry_diagnostics(
hass: HomeAssistant,
entry: ConfigEntry,
) -> dict[str, Any]:
"""Return diagnostics for a config entry."""
coordinator = entry.runtime_data
return {
"entry": {
"title": entry.title,
"data": async_redact_data(entry.data, TO_REDACT),
"options": async_redact_data(entry.options, TO_REDACT),
},
"coordinator_data": coordinator.data.to_dict(),
"last_update_success": coordinator.last_update_success,
"last_update": coordinator.last_update_success_time.isoformat()
if coordinator.last_update_success_time
else None,
}
```
### 2. Device Diagnostics
Provides data about a specific device.
```python
async def async_get_device_diagnostics(
hass: HomeAssistant,
entry: ConfigEntry,
device: dr.DeviceEntry,
) -> dict[str, Any]:
"""Return diagnostics for a device."""
coordinator = entry.runtime_data
# Find device identifier
device_id = None
for identifier in device.identifiers:
if identifier[0] == DOMAIN:
device_id = identifier[1]
break
if device_id is None:
return {}
device_data = coordinator.data.devices.get(device_id)
if device_data is None:
return {}
return {
"device_info": {
"id": device_id,
"name": device_data.name,
"model": device_data.model,
"firmware": device_data.firmware_version,
},
"device_data": device_data.to_dict(),
"entities": [
{
"entity_id": entity.entity_id,
"name": entity.name,
"state": hass.states.get(entity.entity_id).state
if (state := hass.states.get(entity.entity_id))
else None,
}
for entity in er.async_entries_for_device(
er.async_get(hass), device.id, include_disabled_entities=True
)
],
}
```
## Data Redaction
**CRITICAL**: Always redact sensitive information!
### What to Redact
Always redact:
- API keys, tokens, secrets
- Passwords, credentials
- Email addresses, usernames
- Precise GPS coordinates (latitude, longitude)
- MAC addresses (sometimes)
- Serial numbers (if sensitive)
- Personal information
### Using async_redact_data
```python
from homeassistant.helpers import async_redact_data
# Basic redaction
data = async_redact_data(entry.data, TO_REDACT)
# With nested redaction
TO_REDACT = {
"api_key",
"auth.password", # Nested key
"user.email", # Nested key
}
# Redacting from multiple sources
diagnostics = {
"config": async_redact_data(entry.data, TO_REDACT),
"options": async_redact_data(entry.options, TO_REDACT),
"coordinator": async_redact_data(coordinator.data, TO_REDACT),
}
```
### Custom Redaction
For complex data structures:
```python
def redact_device_data(data: dict[str, Any]) -> dict[str, Any]:
"""Redact sensitive device data."""
redacted = data.copy()
# Redact specific fields
if "serial_number" in redacted:
redacted["serial_number"] = "**REDACTED**"
# Redact nested structures
if "location" in redacted:
redacted["location"] = {
"city": redacted["location"].get("city"),
# Don't include exact coordinates
}
return redacted
```
## What to Include
### Good Diagnostic Data
Include information helpful for troubleshooting:
- ✅ Integration version/state
- ✅ Configuration (redacted)
- ✅ Coordinator/connection status
- ✅ Device information (model, firmware)
- ✅ API response examples (redacted)
- ✅ Error states
- ✅ Entity states
- ✅ Feature flags/capabilities
### Example Comprehensive Diagnostics
```python
async def async_get_config_entry_diagnostics(
hass: HomeAssistant,
entry: ConfigEntry,
) -> dict[str, Any]:
"""Return diagnostics for a config entry."""
coordinator = entry.runtime_data
return {
# Integration state
"integration": {
"version": coordinator.version,
"entry_id": entry.entry_id,
"title": entry.title,
"state": entry.state,
},
# Configuration (redacted)
"configuration": {
"data": async_redact_data(entry.data, TO_REDACT),
"options": async_redact_data(entry.options, TO_REDACT),
},
# Connection/Coordinator status
"coordinator": {
"last_update_success": coordinator.last_update_success,
"last_update": coordinator.last_update_success_time.isoformat()
if coordinator.last_update_success_time
else None,
"update_interval": coordinator.update_interval.total_seconds(),
"last_exception": str(coordinator.last_exception)
if coordinator.last_exception
else None,
},
# Device/System information
"devices": {
device_id: {
"name": device.name,
"model": device.model,
"firmware": device.firmware,
"features": device.supported_features,
"state": device.state,
}
for device_id, device in coordinator.data.devices.items()
},
# API information (redacted)
"api": {
"endpoint": coordinator.client.endpoint,
"authenticated": coordinator.client.is_authenticated,
"rate_limit_remaining": coordinator.client.rate_limit_remaining,
},
}
```
## Testing Diagnostics
### Test File Structure
```python
"""Test diagnostics."""
from homeassistant.core import HomeAssistant
from pytest_homeassistant_custom_component.common import MockConfigEntry
from tests.components.my_integration import setup_integration
async def test_entry_diagnostics(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_api,
) -> None:
"""Test config entry diagnostics."""
await setup_integration(hass, mock_config_entry)
diagnostics = await get_diagnostics_for_config_entry(
hass, hass_client, mock_config_entry
)
# Verify structure
assert "entry" in diagnostics
assert "coordinator_data" in diagnostics
# Verify redaction
assert "api_key" not in str(diagnostics)
assert "password" not in str(diagnostics)
# Verify useful data is present
assert diagnostics["entry"]["title"] == "My Device"
assert diagnostics["coordinator_data"]["devices"]
async def test_device_diagnostics(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test device diagnostics."""
await setup_integration(hass, mock_config_entry)
device = device_registry.async_get_device(
identifiers={(DOMAIN, "device_id")}
)
assert device
diagnostics = await get_diagnostics_for_device(
hass, hass_client, mock_config_entry, device
)
# Verify device-specific data
assert diagnostics["device_info"]["id"] == "device_id"
assert "entities" in diagnostics
```
## Common Patterns
### Pattern 1: Coordinator-Based Integration
```python
async def async_get_config_entry_diagnostics(
hass: HomeAssistant,
entry: ConfigEntry,
) -> dict[str, Any]:
"""Return diagnostics for a config entry."""
coordinator = entry.runtime_data
return {
"coordinator": {
"last_update_success": coordinator.last_update_success,
"data": coordinator.data.to_dict(),
}
}
```
### Pattern 2: Multiple Coordinators
```python
async def async_get_config_entry_diagnostics(
hass: HomeAssistant,
entry: ConfigEntry,
) -> dict[str, Any]:
"""Return diagnostics for a config entry."""
data = entry.runtime_data
return {
"device_coordinator": data.device_coordinator.data.to_dict(),
"status_coordinator": data.status_coordinator.data.to_dict(),
}
```
### Pattern 3: Hub with Multiple Devices
```python
async def async_get_config_entry_diagnostics(
hass: HomeAssistant,
entry: ConfigEntry,
) -> dict[str, Any]:
"""Return diagnostics for a config entry."""
hub = entry.runtime_data
return {
"hub": {
"connected": hub.connected,
"version": hub.version,
},
"devices": {
device_id: device.to_dict()
for device_id, device in hub.devices.items()
},
}
```
## Best Practices
### ✅ DO
- Redact all sensitive information
- Include coordinator state and update times
- Provide device/system information
- Include error messages (if present)
- Make data easily readable
- Test that redaction works
- Include API/connection status
### ❌ DON'T
- Include raw passwords, tokens, or API keys
- Include precise GPS coordinates
- Include personal information (emails, names)
- Make diagnostics too large (>1MB)
- Include binary data
- Assume all fields are present (use .get())
- Include sensitive serial numbers
## Troubleshooting
### Diagnostics Not Appearing
Check:
1. File named `diagnostics.py` in integration folder
2. Function named exactly `async_get_config_entry_diagnostics`
3. Proper import of `ConfigEntry` and `HomeAssistant`
4. Integration is loaded successfully
### Redaction Not Working
Check:
1. Using `async_redact_data` from `homeassistant.helpers`
2. Field names match exactly (case-sensitive)
3. Nested fields use dot notation: `"auth.password"`
4. TO_REDACT is a set, not a list
### Device Diagnostics Not Working
Check:
1. Device has proper identifiers
2. Function named exactly `async_get_device_diagnostics`
3. Device parameter is `dr.DeviceEntry`
4. Proper device lookup logic
## Quality Scale Considerations
Diagnostics are required for **Gold tier** integrations:
- Must implement config entry diagnostics
- Should implement device diagnostics (if applicable)
- Must redact all sensitive information
- Should provide comprehensive troubleshooting data
## References
- Quality Scale Rule: `diagnostics`
- Home Assistant Docs: [Integration Diagnostics](https://developers.home-assistant.io/docs/integration_fetching_data)
- Helper Functions: `homeassistant.helpers.redact`

View File

@@ -0,0 +1,508 @@
# Number Platform Reference
## Overview
Number entities allow users to control numeric values within a defined range. They're used for settings like volume, brightness, temperature setpoints, or any numeric configuration parameter.
## Basic Number Implementation
```python
"""Number platform for my_integration."""
from homeassistant.components.number import NumberEntity, NumberMode
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import MyConfigEntry
from .coordinator import MyCoordinator
from .entity import MyEntity
async def async_setup_entry(
hass: HomeAssistant,
entry: MyConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up numbers."""
coordinator = entry.runtime_data
async_add_entities(
MyNumber(coordinator, device_id)
for device_id in coordinator.data.devices
)
class MyNumber(MyEntity, NumberEntity):
"""Representation of a number."""
_attr_has_entity_name = True
_attr_translation_key = "volume"
_attr_native_min_value = 0
_attr_native_max_value = 100
_attr_native_step = 1
def __init__(self, coordinator: MyCoordinator, device_id: str) -> None:
"""Initialize the number."""
super().__init__(coordinator, device_id)
self._attr_unique_id = f"{device_id}_volume"
@property
def native_value(self) -> float | None:
"""Return the current value."""
if device := self.coordinator.data.devices.get(self.device_id):
return device.volume
return None
async def async_set_native_value(self, value: float) -> None:
"""Set new value."""
await self.coordinator.client.set_volume(self.device_id, int(value))
await self.coordinator.async_request_refresh()
```
## Number Properties
### Core Properties
```python
class MyNumber(NumberEntity):
"""Number with all common properties."""
# Basic identification
_attr_has_entity_name = True
_attr_translation_key = "brightness"
_attr_unique_id = "device_123_brightness"
# Value range and step
_attr_native_min_value = 0
_attr_native_max_value = 255
_attr_native_step = 1 # or 0.1 for decimals
# Unit of measurement
_attr_native_unit_of_measurement = PERCENTAGE # or other units
# Display mode
_attr_mode = NumberMode.SLIDER # or NumberMode.BOX, NumberMode.AUTO
# Entity category
_attr_entity_category = EntityCategory.CONFIG
@property
def native_value(self) -> float | None:
"""Return current value."""
return self.device.brightness
async def async_set_native_value(self, value: float) -> None:
"""Set new value."""
await self.device.set_brightness(int(value))
```
### Required Properties
```python
# Minimum value
_attr_native_min_value = 0
# Maximum value
_attr_native_max_value = 100
# Step size (precision)
_attr_native_step = 1 # Integers
_attr_native_step = 0.1 # One decimal place
_attr_native_step = 0.01 # Two decimal places
```
### Current Value
```python
@property
def native_value(self) -> float | None:
"""Return the current value."""
return self.device.current_value
# Or use attribute
_attr_native_value = 50.0
```
### Set Value Method
```python
async def async_set_native_value(self, value: float) -> None:
"""Update to new value."""
await self.device.set_value(value)
# Update state
self._attr_native_value = value
self.async_write_ha_state()
```
## Display Mode
Control how the number is displayed in the UI:
```python
from homeassistant.components.number import NumberMode
# Slider (default for ranges)
_attr_mode = NumberMode.SLIDER
# Input box (better for precise values or large ranges)
_attr_mode = NumberMode.BOX
# Auto (let HA decide based on range)
_attr_mode = NumberMode.AUTO
```
**When to use each**:
- `SLIDER`: Small ranges (0-100), settings like volume/brightness
- `BOX`: Large ranges, precise values, IDs or codes
- `AUTO`: Let Home Assistant decide (default)
## Device Class
Use device classes for proper representation:
```python
from homeassistant.components.number import NumberDeviceClass
# Common device classes
_attr_device_class = NumberDeviceClass.TEMPERATURE
_attr_device_class = NumberDeviceClass.HUMIDITY
_attr_device_class = NumberDeviceClass.VOLTAGE
_attr_device_class = NumberDeviceClass.CURRENT
_attr_device_class = NumberDeviceClass.POWER
_attr_device_class = NumberDeviceClass.BATTERY
_attr_device_class = NumberDeviceClass.DISTANCE
_attr_device_class = NumberDeviceClass.DURATION
```
## Units of Measurement
```python
from homeassistant.const import (
PERCENTAGE,
UnitOfTemperature,
UnitOfTime,
)
# Percentage (0-100)
_attr_native_unit_of_measurement = PERCENTAGE
# Temperature
_attr_native_unit_of_measurement = UnitOfTemperature.CELSIUS
# Time
_attr_native_unit_of_measurement = UnitOfTime.SECONDS
# Custom units
_attr_native_unit_of_measurement = "dB" # Decibels
```
## Entity Descriptions Pattern
For multiple number entities:
```python
from dataclasses import dataclass
from collections.abc import Awaitable, Callable
from homeassistant.components.number import NumberEntityDescription, NumberMode
@dataclass(frozen=True, kw_only=True)
class MyNumberDescription(NumberEntityDescription):
"""Describes a number."""
value_fn: Callable[[MyData], float | None]
set_fn: Callable[[MyClient, str, float], Awaitable[None]]
NUMBERS: tuple[MyNumberDescription, ...] = (
MyNumberDescription(
key="volume",
translation_key="volume",
native_min_value=0,
native_max_value=100,
native_step=1,
native_unit_of_measurement=PERCENTAGE,
mode=NumberMode.SLIDER,
entity_category=EntityCategory.CONFIG,
value_fn=lambda data: data.volume,
set_fn=lambda client, device_id, value: client.set_volume(device_id, int(value)),
),
MyNumberDescription(
key="temperature_setpoint",
translation_key="temperature_setpoint",
device_class=NumberDeviceClass.TEMPERATURE,
native_min_value=16,
native_max_value=30,
native_step=0.5,
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
mode=NumberMode.SLIDER,
value_fn=lambda data: data.target_temperature,
set_fn=lambda client, device_id, value: client.set_temperature(device_id, value),
),
)
class MyNumber(MyEntity, NumberEntity):
"""Number using entity description."""
entity_description: MyNumberDescription
def __init__(
self,
coordinator: MyCoordinator,
device_id: str,
description: MyNumberDescription,
) -> None:
"""Initialize the number."""
super().__init__(coordinator, device_id)
self.entity_description = description
self._attr_unique_id = f"{device_id}_{description.key}"
@property
def native_value(self) -> float | None:
"""Return current value."""
if device := self.coordinator.data.devices.get(self.device_id):
return self.entity_description.value_fn(device)
return None
async def async_set_native_value(self, value: float) -> None:
"""Set new value."""
await self.entity_description.set_fn(
self.coordinator.client,
self.device_id,
value,
)
await self.coordinator.async_request_refresh()
```
## Value Validation
Home Assistant validates against min/max/step, but you can add custom validation:
```python
async def async_set_native_value(self, value: float) -> None:
"""Set value with custom validation."""
# Custom validation
if value % 5 != 0:
raise ValueError("Value must be multiple of 5")
await self.device.set_value(value)
await self.coordinator.async_request_refresh()
```
## State Update Patterns
### Pattern 1: Optimistic Update
```python
async def async_set_native_value(self, value: float) -> None:
"""Set value with optimistic update."""
# Update immediately
self._attr_native_value = value
self.async_write_ha_state()
try:
await self.device.set_value(value)
except DeviceError:
# Revert on error
await self.coordinator.async_request_refresh()
raise
```
### Pattern 2: Coordinator Refresh
```python
async def async_set_native_value(self, value: float) -> None:
"""Set value and refresh."""
await self.device.set_value(value)
# Get actual value from device
await self.coordinator.async_request_refresh()
```
### Pattern 3: Direct State Update
```python
async def async_set_native_value(self, value: float) -> None:
"""Set value with direct state update."""
new_value = await self.device.set_value(value)
# Device returns actual value
self._attr_native_value = new_value
self.async_write_ha_state()
```
## Testing Numbers
### Snapshot Testing
```python
"""Test numbers."""
import pytest
from syrupy import SnapshotAssertion
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er
@pytest.mark.usefixtures("entity_registry_enabled_by_default")
async def test_numbers(
hass: HomeAssistant,
snapshot: SnapshotAssertion,
entity_registry: er.EntityRegistry,
mock_config_entry: MockConfigEntry,
init_integration,
) -> None:
"""Test number entities."""
await snapshot_platform(
hass,
entity_registry,
snapshot,
mock_config_entry.entry_id,
)
```
### Value Testing
```python
from homeassistant.const import ATTR_ENTITY_ID
from homeassistant.components.number import (
ATTR_VALUE,
DOMAIN as NUMBER_DOMAIN,
SERVICE_SET_VALUE,
)
async def test_set_value(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_device,
) -> None:
"""Test setting number value."""
await init_integration(hass, mock_config_entry)
# Check initial value
state = hass.states.get("number.my_device_volume")
assert state
assert state.state == "50"
assert state.attributes["min"] == 0
assert state.attributes["max"] == 100
assert state.attributes["step"] == 1
# Set new value
await hass.services.async_call(
NUMBER_DOMAIN,
SERVICE_SET_VALUE,
{
ATTR_ENTITY_ID: "number.my_device_volume",
ATTR_VALUE: 75,
},
blocking=True,
)
mock_device.set_volume.assert_called_once_with(75)
# Verify state updated
state = hass.states.get("number.my_device_volume")
assert state.state == "75"
```
## Common Number Types
### Volume Control
```python
class VolumeNumber(NumberEntity):
"""Volume control."""
_attr_native_min_value = 0
_attr_native_max_value = 100
_attr_native_step = 1
_attr_native_unit_of_measurement = PERCENTAGE
_attr_mode = NumberMode.SLIDER
```
### Temperature Setpoint
```python
class TemperatureNumber(NumberEntity):
"""Temperature setpoint."""
_attr_device_class = NumberDeviceClass.TEMPERATURE
_attr_native_min_value = 16.0
_attr_native_max_value = 30.0
_attr_native_step = 0.5
_attr_native_unit_of_measurement = UnitOfTemperature.CELSIUS
_attr_mode = NumberMode.SLIDER
```
### Duration Setting
```python
class DurationNumber(NumberEntity):
"""Duration setting."""
_attr_device_class = NumberDeviceClass.DURATION
_attr_native_min_value = 0
_attr_native_max_value = 3600
_attr_native_step = 60 # 1 minute steps
_attr_native_unit_of_measurement = UnitOfTime.SECONDS
_attr_mode = NumberMode.BOX
```
## Best Practices
### ✅ DO
- Set appropriate min/max/step values
- Use device class when available
- Use standard units
- Set display mode appropriately
- Implement unique IDs
- Use translation keys
- Mark config numbers with entity_category
- Handle value updates properly
### ❌ DON'T
- Allow invalid ranges (min > max)
- Use zero or negative step
- Block the event loop
- Ignore validation errors
- Create numbers without min/max/step
- Hardcode entity names
- Use for binary values (use switch)
- Use for selection from list (use select)
## Troubleshooting
### Number Not Appearing
Check:
- [ ] Unique ID is set
- [ ] Platform is in PLATFORMS list
- [ ] min/max/step are all set
- [ ] Entity is added with async_add_entities
### Value Not Updating
Check:
- [ ] async_set_native_value is called
- [ ] Coordinator refresh is working
- [ ] native_value returns correct value
- [ ] Value is within min/max range
### UI Shows Wrong Control Type
Check:
- [ ] mode is set correctly
- [ ] Range is appropriate for mode
- [ ] Step size is reasonable
## Quality Scale Considerations
- **Bronze**: Unique ID required
- **Gold**: Entity translations, device class, entity category
- **Platinum**: Full type hints
## References
- [Number Documentation](https://developers.home-assistant.io/docs/core/entity/number)
- [Number Integration](https://www.home-assistant.io/integrations/number/)

View File

@@ -0,0 +1,520 @@
# Select Platform Reference
## Overview
Select entities allow users to choose from a predefined list of options. They're used for settings like operation modes, presets, input sources, or any configuration with a fixed set of choices.
## Basic Select Implementation
```python
"""Select platform for my_integration."""
from homeassistant.components.select import SelectEntity
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import MyConfigEntry
from .coordinator import MyCoordinator
from .entity import MyEntity
async def async_setup_entry(
hass: HomeAssistant,
entry: MyConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up selects."""
coordinator = entry.runtime_data
async_add_entities(
MySelect(coordinator, device_id)
for device_id in coordinator.data.devices
)
class MySelect(MyEntity, SelectEntity):
"""Representation of a select."""
_attr_has_entity_name = True
_attr_translation_key = "operation_mode"
_attr_options = ["auto", "cool", "heat", "fan"]
def __init__(self, coordinator: MyCoordinator, device_id: str) -> None:
"""Initialize the select."""
super().__init__(coordinator, device_id)
self._attr_unique_id = f"{device_id}_mode"
@property
def current_option(self) -> str | None:
"""Return the current selected option."""
if device := self.coordinator.data.devices.get(self.device_id):
return device.mode
return None
async def async_select_option(self, option: str) -> None:
"""Change the selected option."""
await self.coordinator.client.set_mode(self.device_id, option)
await self.coordinator.async_request_refresh()
```
## Select Properties
### Core Properties
```python
class MySelect(SelectEntity):
"""Select with all common properties."""
# Basic identification
_attr_has_entity_name = True
_attr_translation_key = "preset"
_attr_unique_id = "device_123_preset"
# Available options (required)
_attr_options = ["comfort", "eco", "away", "sleep"]
# Entity category
_attr_entity_category = EntityCategory.CONFIG
@property
def current_option(self) -> str | None:
"""Return current selected option."""
return self.device.preset
async def async_select_option(self, option: str) -> None:
"""Set the selected option."""
await self.device.set_preset(option)
```
### Required Properties and Methods
```python
# List of available options
_attr_options = ["option1", "option2", "option3"]
# Current selected option
@property
def current_option(self) -> str | None:
"""Return the selected option."""
return self.device.current_mode
# Or use attribute
_attr_current_option = "option1"
# Method to change option
async def async_select_option(self, option: str) -> None:
"""Change the selected option."""
await self.device.set_option(option)
```
## Using Enums for Options
Recommended pattern for type safety:
```python
from enum import StrEnum
class OperationMode(StrEnum):
"""Operation modes."""
AUTO = "auto"
COOL = "cool"
HEAT = "heat"
FAN = "fan"
class MySelect(SelectEntity):
"""Select using enum."""
_attr_options = [mode.value for mode in OperationMode]
@property
def current_option(self) -> str | None:
"""Return current mode."""
if device := self.coordinator.data.devices.get(self.device_id):
return device.mode
return None
async def async_select_option(self, option: str) -> None:
"""Set mode."""
# Validate option is in enum
mode = OperationMode(option)
await self.coordinator.client.set_mode(self.device_id, mode)
await self.coordinator.async_request_refresh()
```
## Entity Descriptions Pattern
For multiple select entities:
```python
from dataclasses import dataclass
from collections.abc import Awaitable, Callable
from homeassistant.components.select import SelectEntityDescription
@dataclass(frozen=True, kw_only=True)
class MySelectDescription(SelectEntityDescription):
"""Describes a select."""
current_fn: Callable[[MyData], str | None]
select_fn: Callable[[MyClient, str, str], Awaitable[None]]
SELECTS: tuple[MySelectDescription, ...] = (
MySelectDescription(
key="mode",
translation_key="operation_mode",
options=["auto", "cool", "heat", "fan"],
entity_category=EntityCategory.CONFIG,
current_fn=lambda data: data.mode,
select_fn=lambda client, device_id, option: client.set_mode(device_id, option),
),
MySelectDescription(
key="preset",
translation_key="preset",
options=["comfort", "eco", "away", "sleep"],
entity_category=EntityCategory.CONFIG,
current_fn=lambda data: data.preset,
select_fn=lambda client, device_id, option: client.set_preset(device_id, option),
),
)
async def async_setup_entry(
hass: HomeAssistant,
entry: MyConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up selects."""
coordinator = entry.runtime_data
async_add_entities(
MySelect(coordinator, device_id, description)
for device_id in coordinator.data.devices
for description in SELECTS
)
class MySelect(MyEntity, SelectEntity):
"""Select using entity description."""
entity_description: MySelectDescription
def __init__(
self,
coordinator: MyCoordinator,
device_id: str,
description: MySelectDescription,
) -> None:
"""Initialize the select."""
super().__init__(coordinator, device_id)
self.entity_description = description
self._attr_unique_id = f"{device_id}_{description.key}"
@property
def current_option(self) -> str | None:
"""Return current option."""
if device := self.coordinator.data.devices.get(self.device_id):
return self.entity_description.current_fn(device)
return None
async def async_select_option(self, option: str) -> None:
"""Select option."""
await self.entity_description.select_fn(
self.coordinator.client,
self.device_id,
option,
)
await self.coordinator.async_request_refresh()
```
## Dynamic Options
If options change based on device state:
```python
class MyDynamicSelect(SelectEntity):
"""Select with dynamic options."""
@property
def options(self) -> list[str]:
"""Return available options based on device state."""
if device := self.coordinator.data.devices.get(self.device_id):
return device.available_modes
return []
@property
def current_option(self) -> str | None:
"""Return current option."""
if device := self.coordinator.data.devices.get(self.device_id):
return device.current_mode
return None
async def async_select_option(self, option: str) -> None:
"""Select option."""
await self.device.set_mode(option)
await self.coordinator.async_request_refresh()
```
## Option Translation
Use translation keys for user-friendly option labels:
```json
// strings.json
{
"entity": {
"select": {
"operation_mode": {
"name": "Operation mode",
"state": {
"auto": "Automatic",
"cool": "Cooling",
"heat": "Heating",
"fan": "Fan only"
}
}
}
}
}
```
```python
class MySelect(SelectEntity):
"""Select with translated options."""
_attr_translation_key = "operation_mode"
_attr_options = ["auto", "cool", "heat", "fan"]
```
## State Update Patterns
### Pattern 1: Optimistic Update
```python
async def async_select_option(self, option: str) -> None:
"""Select option with optimistic update."""
# Update immediately
self._attr_current_option = option
self.async_write_ha_state()
try:
await self.device.set_option(option)
except DeviceError:
# Revert on error
await self.coordinator.async_request_refresh()
raise
```
### Pattern 2: Coordinator Refresh
```python
async def async_select_option(self, option: str) -> None:
"""Select option and refresh."""
await self.device.set_option(option)
# Get actual option from device
await self.coordinator.async_request_refresh()
```
### Pattern 3: Direct State Update
```python
async def async_select_option(self, option: str) -> None:
"""Select option with direct state update."""
actual_option = await self.device.set_option(option)
# Device returns actual option
self._attr_current_option = actual_option
self.async_write_ha_state()
```
## Testing Selects
### Snapshot Testing
```python
"""Test selects."""
import pytest
from syrupy import SnapshotAssertion
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er
@pytest.mark.usefixtures("entity_registry_enabled_by_default")
async def test_selects(
hass: HomeAssistant,
snapshot: SnapshotAssertion,
entity_registry: er.EntityRegistry,
mock_config_entry: MockConfigEntry,
init_integration,
) -> None:
"""Test select entities."""
await snapshot_platform(
hass,
entity_registry,
snapshot,
mock_config_entry.entry_id,
)
```
### Option Selection Testing
```python
from homeassistant.const import ATTR_ENTITY_ID, ATTR_OPTION
from homeassistant.components.select import DOMAIN as SELECT_DOMAIN, SERVICE_SELECT_OPTION
async def test_select_option(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_device,
) -> None:
"""Test selecting an option."""
await init_integration(hass, mock_config_entry)
# Check initial state
state = hass.states.get("select.my_device_mode")
assert state
assert state.state == "auto"
assert state.attributes["options"] == ["auto", "cool", "heat", "fan"]
# Select new option
await hass.services.async_call(
SELECT_DOMAIN,
SERVICE_SELECT_OPTION,
{
ATTR_ENTITY_ID: "select.my_device_mode",
ATTR_OPTION: "cool",
},
blocking=True,
)
mock_device.set_mode.assert_called_once_with("cool")
# Verify state updated
state = hass.states.get("select.my_device_mode")
assert state.state == "cool"
```
## Common Select Types
### Operation Mode
```python
class ModeSelect(SelectEntity):
"""Operation mode select."""
_attr_translation_key = "operation_mode"
_attr_options = ["auto", "cool", "heat", "fan", "dry"]
_attr_entity_category = EntityCategory.CONFIG
```
### Preset
```python
class PresetSelect(SelectEntity):
"""Preset select."""
_attr_translation_key = "preset"
_attr_options = ["comfort", "eco", "away", "sleep", "boost"]
_attr_entity_category = EntityCategory.CONFIG
```
### Input Source
```python
class InputSourceSelect(SelectEntity):
"""Input source select."""
_attr_translation_key = "source"
_attr_options = ["hdmi1", "hdmi2", "usb", "bluetooth", "optical"]
```
### Effect/Scene
```python
class EffectSelect(SelectEntity):
"""Light effect select."""
_attr_translation_key = "effect"
_attr_options = ["none", "rainbow", "pulse", "strobe", "breathe"]
```
## Best Practices
### ✅ DO
- Use enums for type safety
- Provide translation keys for options
- Validate selected options
- Implement unique IDs
- Use entity_category for config selects
- Keep option lists reasonable (<20 items)
- Use consistent option naming (lowercase, underscores)
- Provide clear option translations
### ❌ DON'T
- Accept options not in the list
- Have too many options (use input_select helper instead)
- Block the event loop
- Hardcode entity names
- Change options list arbitrarily
- Use for numeric values (use number entity)
- Use for binary choices (use switch)
- Have empty options list
## Select vs. Other Entities
**Use Select when**:
- Fixed list of text options
- Modes, presets, or settings
- 2-20 options
**Use Switch when**:
- Binary on/off control
- Only 2 states
**Use Number when**:
- Numeric range
- Continuous values
**Use Input Select when**:
- User-defined options
- Need dynamic option list
- Helper/template integration
## Troubleshooting
### Select Not Appearing
Check:
- [ ] Unique ID is set
- [ ] Platform is in PLATFORMS list
- [ ] options list is not empty
- [ ] Entity is added with async_add_entities
### Option Not Accepted
Check:
- [ ] Option is in options list (case-sensitive)
- [ ] Options list is properly formatted
- [ ] async_select_option handles the option
### Options Not Translating
Check:
- [ ] translation_key is set
- [ ] strings.json has state translations
- [ ] Option keys match exactly
## Quality Scale Considerations
- **Bronze**: Unique ID required
- **Gold**: Entity translations, entity category
- **Platinum**: Full type hints, use StrEnum for options
## References
- [Select Documentation](https://developers.home-assistant.io/docs/core/entity/select)
- [Select Integration](https://www.home-assistant.io/integrations/select/)

View File

@@ -0,0 +1,560 @@
# Sensor Platform Reference
## Overview
Sensors are read-only entities that represent measurements, states, or information from devices and services. They display numeric values, strings, timestamps, or other data types.
## Basic Sensor Implementation
### Minimal Sensor
```python
"""Sensor platform for my_integration."""
from homeassistant.components.sensor import SensorEntity
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import MyConfigEntry
from .const import DOMAIN
from .coordinator import MyCoordinator
from .entity import MyEntity
async def async_setup_entry(
hass: HomeAssistant,
entry: MyConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up sensors."""
coordinator = entry.runtime_data
async_add_entities(
MySensor(coordinator, device_id)
for device_id in coordinator.data.devices
)
class MySensor(MyEntity, SensorEntity):
"""Representation of a sensor."""
def __init__(self, coordinator: MyCoordinator, device_id: str) -> None:
"""Initialize the sensor."""
super().__init__(coordinator, device_id)
self._attr_unique_id = f"{device_id}_temperature"
self._attr_translation_key = "temperature"
@property
def native_value(self) -> float | None:
"""Return the sensor value."""
if device := self.coordinator.data.devices.get(self.device_id):
return device.temperature
return None
```
## Sensor Properties
### Core Properties
```python
class MySensor(SensorEntity):
"""Sensor with all common properties."""
# Basic identification
_attr_has_entity_name = True # Required
_attr_translation_key = "temperature" # For translations
_attr_unique_id = "device_123_temp" # Required
# Device class and units
_attr_device_class = SensorDeviceClass.TEMPERATURE
_attr_native_unit_of_measurement = UnitOfTemperature.CELSIUS
_attr_suggested_display_precision = 1 # Decimal places
# State class for statistics
_attr_state_class = SensorStateClass.MEASUREMENT
# Entity category
_attr_entity_category = EntityCategory.DIAGNOSTIC # If diagnostic
# Availability
_attr_entity_registry_enabled_default = False # If noisy/less important
@property
def native_value(self) -> float | None:
"""Return sensor value."""
return self.device.temperature
@property
def available(self) -> bool:
"""Return if entity is available."""
return super().available and self.device_id in self.coordinator.data
```
## Device Classes
Use device classes for proper representation:
```python
from homeassistant.components.sensor import SensorDeviceClass
# Common device classes
_attr_device_class = SensorDeviceClass.TEMPERATURE
_attr_device_class = SensorDeviceClass.HUMIDITY
_attr_device_class = SensorDeviceClass.PRESSURE
_attr_device_class = SensorDeviceClass.BATTERY
_attr_device_class = SensorDeviceClass.ENERGY
_attr_device_class = SensorDeviceClass.POWER
_attr_device_class = SensorDeviceClass.VOLTAGE
_attr_device_class = SensorDeviceClass.CURRENT
_attr_device_class = SensorDeviceClass.TIMESTAMP
_attr_device_class = SensorDeviceClass.MONETARY
```
Benefits:
- Automatic unit conversion
- Proper UI representation
- Voice assistant integration
- Historical statistics
## State Classes
For long-term statistics support:
```python
from homeassistant.components.sensor import SensorStateClass
# Measurement - value at a point in time
_attr_state_class = SensorStateClass.MEASUREMENT
# Examples: temperature, humidity, power
# Total - cumulative value that can increase/decrease
_attr_state_class = SensorStateClass.TOTAL
# Examples: energy consumed, data transferred
# Use with last_reset for resettable totals
# Total increasing - cumulative value that only increases
_attr_state_class = SensorStateClass.TOTAL_INCREASING
# Examples: lifetime energy, odometer
```
### When to Use State Classes
**Use MEASUREMENT for**:
- Temperature, humidity, pressure
- Current power usage
- Instantaneous values
**Use TOTAL for**:
- Daily/monthly energy consumption (resets)
- Periodic counters
**Use TOTAL_INCREASING for**:
- Lifetime energy consumption
- Monotonically increasing counters
**Don't use state class for**:
- Text/string sensors
- Status sensors (enum values)
- Non-numeric sensors
## Unit of Measurement
### Using Standard Units
```python
from homeassistant.const import (
UnitOfTemperature,
UnitOfPower,
UnitOfEnergy,
PERCENTAGE,
)
# Temperature
_attr_native_unit_of_measurement = UnitOfTemperature.CELSIUS
# Auto-converts to user's preference (°F/°C/K)
# Power
_attr_native_unit_of_measurement = UnitOfPower.WATT
# Energy
_attr_native_unit_of_measurement = UnitOfEnergy.KILO_WATT_HOUR
# Percentage
_attr_native_unit_of_measurement = PERCENTAGE
```
### Custom Units
```python
# For non-standard units
_attr_native_unit_of_measurement = "AQI" # Air Quality Index
_attr_native_unit_of_measurement = "ppm" # Parts per million
```
## Entity Descriptions Pattern
For multiple similar sensors, use SensorEntityDescription:
```python
from dataclasses import dataclass
from homeassistant.components.sensor import SensorEntityDescription
from homeassistant.helpers.typing import StateType
@dataclass(frozen=True, kw_only=True)
class MySensorDescription(SensorEntityDescription):
"""Describes a sensor."""
value_fn: Callable[[MyData], StateType]
SENSORS: tuple[MySensorDescription, ...] = (
MySensorDescription(
key="temperature",
translation_key="temperature",
device_class=SensorDeviceClass.TEMPERATURE,
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
state_class=SensorStateClass.MEASUREMENT,
value_fn=lambda data: data.temperature,
),
MySensorDescription(
key="humidity",
translation_key="humidity",
device_class=SensorDeviceClass.HUMIDITY,
native_unit_of_measurement=PERCENTAGE,
state_class=SensorStateClass.MEASUREMENT,
value_fn=lambda data: data.humidity,
),
)
class MySensor(MyEntity, SensorEntity):
"""Sensor using entity description."""
entity_description: MySensorDescription
def __init__(
self,
coordinator: MyCoordinator,
description: MySensorDescription,
device_id: str,
) -> None:
"""Initialize the sensor."""
super().__init__(coordinator, device_id)
self.entity_description = description
self._attr_unique_id = f"{device_id}_{description.key}"
@property
def native_value(self) -> StateType:
"""Return the sensor value."""
if device := self.coordinator.data.devices.get(self.device_id):
return self.entity_description.value_fn(device)
return None
```
### Lambda Functions in EntityDescription
When lambdas get long, use proper formatting:
```python
# ❌ Bad - too long
SensorEntityDescription(
key="temperature",
value_fn=lambda data: round(data["temp_value"] * 1.8 + 32, 1) if data.get("temp_value") is not None else None,
)
# ✅ Good - wrapped properly
SensorEntityDescription(
key="temperature",
value_fn=lambda data: (
round(data["temp_value"] * 1.8 + 32, 1)
if data.get("temp_value") is not None
else None
),
)
```
## Timestamp Sensors
For datetime values:
```python
from datetime import datetime
from homeassistant.components.sensor import SensorDeviceClass
class MyTimestampSensor(SensorEntity):
"""Timestamp sensor."""
_attr_device_class = SensorDeviceClass.TIMESTAMP
@property
def native_value(self) -> datetime | None:
"""Return timestamp."""
return self.device.last_update
```
## Enum Sensors
For sensors with fixed set of possible values:
```python
from enum import StrEnum
from homeassistant.components.sensor import SensorEntity
class OperationMode(StrEnum):
"""Operation modes."""
AUTO = "auto"
MANUAL = "manual"
ECO = "eco"
class MyModeSensor(SensorEntity):
"""Mode sensor."""
_attr_device_class = SensorDeviceClass.ENUM
_attr_options = [mode.value for mode in OperationMode]
@property
def native_value(self) -> str | None:
"""Return current mode."""
return self.device.mode
```
## Entity Category
Mark diagnostic or configuration sensors:
```python
from homeassistant.helpers.entity import EntityCategory
# Diagnostic sensors (technical info)
_attr_entity_category = EntityCategory.DIAGNOSTIC
# Examples: signal strength, uptime, IP address
# Config sensors (device settings)
_attr_entity_category = EntityCategory.CONFIG
# Examples: current mode setting, configuration values
```
## Disabled by Default
For noisy or less important sensors:
```python
class MySignalStrengthSensor(SensorEntity):
"""Signal strength sensor - noisy."""
_attr_entity_registry_enabled_default = False
```
## Dynamic Sensor Addition
For devices that appear after setup:
```python
async def async_setup_entry(
hass: HomeAssistant,
entry: MyConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up sensors with dynamic addition."""
coordinator = entry.runtime_data
known_devices: set[str] = set()
@callback
def _add_new_devices() -> None:
"""Add newly discovered devices."""
current_devices = set(coordinator.data.devices.keys())
new_devices = current_devices - known_devices
if new_devices:
known_devices.update(new_devices)
async_add_entities(
MySensor(coordinator, device_id)
for device_id in new_devices
)
# Initial setup
_add_new_devices()
# Listen for new devices
entry.async_on_unload(coordinator.async_add_listener(_add_new_devices))
```
## Testing Sensors
### Test with Snapshots
```python
"""Test sensors."""
import pytest
from syrupy import SnapshotAssertion
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er
from tests.common import MockConfigEntry
@pytest.mark.usefixtures("entity_registry_enabled_by_default")
async def test_sensors(
hass: HomeAssistant,
snapshot: SnapshotAssertion,
entity_registry: er.EntityRegistry,
mock_config_entry: MockConfigEntry,
init_integration,
) -> None:
"""Test sensor entities."""
await snapshot_platform(
hass,
entity_registry,
snapshot,
mock_config_entry.entry_id,
)
```
### Test Sensor Values
```python
async def test_sensor_values(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
) -> None:
"""Test sensor values are correct."""
await init_integration(hass, mock_config_entry)
state = hass.states.get("sensor.my_device_temperature")
assert state
assert state.state == "22.5"
assert state.attributes["unit_of_measurement"] == "°C"
assert state.attributes["device_class"] == "temperature"
```
## Best Practices
### ✅ DO
- Use device classes when available
- Set state classes for statistics
- Use standard units of measurement
- Implement unique IDs
- Use entity descriptions for similar sensors
- Mark diagnostic sensors with entity_category
- Disable noisy sensors by default
- Return None for unknown values
- Use translation keys for entity names
### ❌ DON'T
- Hardcode entity names
- Use string "unavailable" or "unknown" as state
- Mix units (always use native_unit_of_measurement)
- Create sensors without unique IDs
- Poll in sensor update if using coordinator
- Block the event loop
- Use state class for non-numeric sensors
## Common Patterns
### Pattern 1: Coordinator-Based Sensor
```python
class MySensor(CoordinatorEntity[MyCoordinator], SensorEntity):
"""Coordinator-based sensor."""
_attr_should_poll = False # Coordinator handles updates
@property
def native_value(self) -> StateType:
"""Get value from coordinator data."""
return self.coordinator.data.get(self.key)
```
### Pattern 2: Push-Updated Sensor
```python
class MyPushSensor(SensorEntity):
"""Push-updated sensor."""
_attr_should_poll = False
async def async_added_to_hass(self) -> None:
"""Subscribe to updates."""
self.async_on_remove(
self.device.subscribe(self._handle_update)
)
@callback
def _handle_update(self, value: float) -> None:
"""Handle push update."""
self._attr_native_value = value
self.async_write_ha_state()
```
### Pattern 3: Calculated Sensor
```python
class MyCalculatedSensor(SensorEntity):
"""Calculated from other sensors."""
_attr_should_poll = False
async def async_added_to_hass(self) -> None:
"""Subscribe to source sensors."""
self.async_on_remove(
async_track_state_change_event(
self.hass,
["sensor.source1", "sensor.source2"],
self._handle_update,
)
)
@callback
def _handle_update(self, event: Event) -> None:
"""Recalculate when sources change."""
# Calculate new value
self._attr_native_value = self._calculate()
self.async_write_ha_state()
```
## Troubleshooting
### Sensor Not Appearing
Check:
- [ ] Unique ID is set
- [ ] Platform is in PLATFORMS list
- [ ] async_setup_entry is called
- [ ] Entity is added with async_add_entities
### Values Not Updating
Check:
- [ ] Coordinator is updating
- [ ] Entity is available
- [ ] native_value returns correct data
- [ ] should_poll is False for coordinator
### Units Not Converting
Check:
- [ ] Using standard unit constants
- [ ] Device class is set correctly
- [ ] Unit matches device class
### Statistics Not Working
Check:
- [ ] State class is set
- [ ] Values are numeric
- [ ] Device class is appropriate
- [ ] Units are consistent
## Quality Scale Considerations
- **Bronze**: Unique ID required
- **Gold**: Entity translations, device class, entity category
- **Platinum**: Full type hints
## References
- [Sensor Documentation](https://developers.home-assistant.io/docs/core/entity/sensor)
- [Device Classes](https://www.home-assistant.io/integrations/sensor/#device-class)
- [State Classes](https://developers.home-assistant.io/docs/core/entity/sensor/#available-state-classes)

View File

@@ -0,0 +1,505 @@
# Switch Platform Reference
## Overview
Switches are entities that can be turned on or off. They represent controllable devices like smart plugs, relays, or any binary control. Unlike binary sensors, switches can be controlled by the user.
## Basic Switch Implementation
```python
"""Switch platform for my_integration."""
from typing import Any
from homeassistant.components.switch import SwitchEntity
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import MyConfigEntry
from .coordinator import MyCoordinator
from .entity import MyEntity
async def async_setup_entry(
hass: HomeAssistant,
entry: MyConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up switches."""
coordinator = entry.runtime_data
async_add_entities(
MySwitch(coordinator, device_id)
for device_id in coordinator.data.devices
)
class MySwitch(MyEntity, SwitchEntity):
"""Representation of a switch."""
_attr_has_entity_name = True
_attr_translation_key = "outlet"
def __init__(self, coordinator: MyCoordinator, device_id: str) -> None:
"""Initialize the switch."""
super().__init__(coordinator, device_id)
self._attr_unique_id = f"{device_id}_switch"
@property
def is_on(self) -> bool | None:
"""Return true if switch is on."""
if device := self.coordinator.data.devices.get(self.device_id):
return device.is_on
return None
async def async_turn_on(self, **kwargs: Any) -> None:
"""Turn the switch on."""
await self.coordinator.client.turn_on(self.device_id)
await self.coordinator.async_request_refresh()
async def async_turn_off(self, **kwargs: Any) -> None:
"""Turn the switch off."""
await self.coordinator.client.turn_off(self.device_id)
await self.coordinator.async_request_refresh()
```
## Switch Properties and Methods
### Core Properties
```python
@property
def is_on(self) -> bool | None:
"""Return true if entity is on."""
return self.device.state
# Or use attribute
_attr_is_on = True # or False, or None
```
### Required Methods
```python
async def async_turn_on(self, **kwargs: Any) -> None:
"""Turn the entity on."""
await self.device.turn_on()
# Update state
self._attr_is_on = True
self.async_write_ha_state()
async def async_turn_off(self, **kwargs: Any) -> None:
"""Turn the entity off."""
await self.device.turn_off()
# Update state
self._attr_is_on = False
self.async_write_ha_state()
```
### Optional Toggle Method
```python
async def async_toggle(self, **kwargs: Any) -> None:
"""Toggle the entity."""
# Only implement if device has native toggle
await self.device.toggle()
await self.coordinator.async_request_refresh()
```
**Note**: If `async_toggle` is not implemented, Home Assistant will use `async_turn_on`/`async_turn_off` based on current state.
## Device Class
Switches can have device classes to indicate their type:
```python
from homeassistant.components.switch import SwitchDeviceClass
_attr_device_class = SwitchDeviceClass.OUTLET
_attr_device_class = SwitchDeviceClass.SWITCH
```
Device classes:
- `OUTLET` - Smart plug/outlet
- `SWITCH` - Generic switch (default)
## State Update Patterns
### Pattern 1: Optimistic Update
For fast UI response:
```python
async def async_turn_on(self, **kwargs: Any) -> None:
"""Turn on."""
# Update state immediately (optimistic)
self._attr_is_on = True
self.async_write_ha_state()
try:
await self.coordinator.client.turn_on(self.device_id)
except DeviceError:
# Revert on error
self._attr_is_on = False
self.async_write_ha_state()
raise
```
### Pattern 2: Coordinator Refresh
Wait for actual state:
```python
async def async_turn_on(self, **kwargs: Any) -> None:
"""Turn on."""
await self.coordinator.client.turn_on(self.device_id)
# Refresh coordinator to get actual state
await self.coordinator.async_request_refresh()
```
### Pattern 3: Push Update
For push-based systems:
```python
async def async_turn_on(self, **kwargs: Any) -> None:
"""Turn on."""
# Command device
await self.device.turn_on()
# State will be updated via push event
# No need to call async_write_ha_state()
```
## Entity Descriptions Pattern
For multiple similar switches:
```python
from dataclasses import dataclass
from collections.abc import Awaitable, Callable
from homeassistant.components.switch import SwitchEntityDescription
@dataclass(frozen=True, kw_only=True)
class MySwitchDescription(SwitchEntityDescription):
"""Describes a switch."""
is_on_fn: Callable[[MyData], bool | None]
turn_on_fn: Callable[[MyClient, str], Awaitable[None]]
turn_off_fn: Callable[[MyClient, str], Awaitable[None]]
SWITCHES: tuple[MySwitchDescription, ...] = (
MySwitchDescription(
key="outlet",
translation_key="outlet",
device_class=SwitchDeviceClass.OUTLET,
is_on_fn=lambda data: data.outlet_state,
turn_on_fn=lambda client, device_id: client.turn_on_outlet(device_id),
turn_off_fn=lambda client, device_id: client.turn_off_outlet(device_id),
),
MySwitchDescription(
key="led",
translation_key="led",
entity_category=EntityCategory.CONFIG,
is_on_fn=lambda data: data.led_enabled,
turn_on_fn=lambda client, device_id: client.enable_led(device_id),
turn_off_fn=lambda client, device_id: client.disable_led(device_id),
),
)
class MySwitch(MyEntity, SwitchEntity):
"""Switch using entity description."""
entity_description: MySwitchDescription
def __init__(
self,
coordinator: MyCoordinator,
device_id: str,
description: MySwitchDescription,
) -> None:
"""Initialize the switch."""
super().__init__(coordinator, device_id)
self.entity_description = description
self._attr_unique_id = f"{device_id}_{description.key}"
@property
def is_on(self) -> bool | None:
"""Return if switch is on."""
if device := self.coordinator.data.devices.get(self.device_id):
return self.entity_description.is_on_fn(device)
return None
async def async_turn_on(self, **kwargs: Any) -> None:
"""Turn on."""
await self.entity_description.turn_on_fn(
self.coordinator.client,
self.device_id,
)
await self.coordinator.async_request_refresh()
async def async_turn_off(self, **kwargs: Any) -> None:
"""Turn off."""
await self.entity_description.turn_off_fn(
self.coordinator.client,
self.device_id,
)
await self.coordinator.async_request_refresh()
```
## Configuration Switches
Switches that control device settings (not physical devices):
```python
from homeassistant.helpers.entity import EntityCategory
class MyConfigSwitch(SwitchEntity):
"""Configuration switch."""
_attr_entity_category = EntityCategory.CONFIG
_attr_translation_key = "led_indicator"
@property
def is_on(self) -> bool:
"""Return if LED is enabled."""
return self.device.led_enabled
async def async_turn_on(self, **kwargs: Any) -> None:
"""Enable LED indicator."""
await self.device.set_led(True)
self._attr_is_on = True
self.async_write_ha_state()
async def async_turn_off(self, **kwargs: Any) -> None:
"""Disable LED indicator."""
await self.device.set_led(False)
self._attr_is_on = False
self.async_write_ha_state()
```
## Error Handling
Handle errors gracefully:
```python
async def async_turn_on(self, **kwargs: Any) -> None:
"""Turn on with error handling."""
try:
await self.device.turn_on()
except DeviceOfflineError as err:
# Let entity become unavailable
raise HomeAssistantError(f"Device is offline: {err}") from err
except DeviceError as err:
# Specific error
raise HomeAssistantError(f"Failed to turn on: {err}") from err
else:
self._attr_is_on = True
self.async_write_ha_state()
```
## Testing Switches
### Snapshot Testing
```python
"""Test switches."""
import pytest
from syrupy import SnapshotAssertion
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er
@pytest.mark.usefixtures("entity_registry_enabled_by_default")
async def test_switches(
hass: HomeAssistant,
snapshot: SnapshotAssertion,
entity_registry: er.EntityRegistry,
mock_config_entry: MockConfigEntry,
init_integration,
) -> None:
"""Test switch entities."""
await snapshot_platform(
hass,
entity_registry,
snapshot,
mock_config_entry.entry_id,
)
```
### Control Testing
```python
from homeassistant.const import (
ATTR_ENTITY_ID,
SERVICE_TURN_OFF,
SERVICE_TURN_ON,
)
from homeassistant.components.switch import DOMAIN as SWITCH_DOMAIN
async def test_switch_on_off(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_device,
) -> None:
"""Test turning switch on and off."""
await init_integration(hass, mock_config_entry)
# Test initial state
state = hass.states.get("switch.my_device_outlet")
assert state
assert state.state == "off"
# Turn on
await hass.services.async_call(
SWITCH_DOMAIN,
SERVICE_TURN_ON,
{ATTR_ENTITY_ID: "switch.my_device_outlet"},
blocking=True,
)
mock_device.turn_on.assert_called_once()
# Check state updated
state = hass.states.get("switch.my_device_outlet")
assert state.state == "on"
# Turn off
await hass.services.async_call(
SWITCH_DOMAIN,
SERVICE_TURN_OFF,
{ATTR_ENTITY_ID: "switch.my_device_outlet"},
blocking=True,
)
mock_device.turn_off.assert_called_once()
state = hass.states.get("switch.my_device_outlet")
assert state.state == "off"
```
## Common Patterns
### Pattern 1: Coordinator-Based Switch
```python
class MySwitch(CoordinatorEntity[MyCoordinator], SwitchEntity):
"""Coordinator-based switch."""
async def async_turn_on(self, **kwargs: Any) -> None:
"""Turn on."""
await self.coordinator.client.turn_on(self.device_id)
await self.coordinator.async_request_refresh()
async def async_turn_off(self, **kwargs: Any) -> None:
"""Turn off."""
await self.coordinator.client.turn_off(self.device_id)
await self.coordinator.async_request_refresh()
@property
def is_on(self) -> bool | None:
"""Return if switch is on."""
if device := self.coordinator.data.devices.get(self.device_id):
return device.is_on
return None
```
### Pattern 2: Local State Management
```python
class MyLocalSwitch(SwitchEntity):
"""Switch with local state."""
_attr_should_poll = False
_attr_is_on = False
async def async_turn_on(self, **kwargs: Any) -> None:
"""Turn on."""
await self.device.turn_on()
self._attr_is_on = True
self.async_write_ha_state()
async def async_turn_off(self, **kwargs: Any) -> None:
"""Turn off."""
await self.device.turn_off()
self._attr_is_on = False
self.async_write_ha_state()
```
### Pattern 3: With Additional Control
```python
class MyAdvancedSwitch(SwitchEntity):
"""Switch with timer support."""
async def async_turn_on(self, **kwargs: Any) -> None:
"""Turn on with optional duration."""
duration = kwargs.get("duration") # Custom kwarg
if duration:
await self.device.turn_on_for(duration)
else:
await self.device.turn_on()
await self.coordinator.async_request_refresh()
```
## Best Practices
### ✅ DO
- Implement both turn_on and turn_off
- Update state after commands
- Handle errors properly
- Use coordinator for state management
- Implement unique IDs
- Use translation keys
- Mark config switches with entity_category
- Refresh coordinator after commands
### ❌ DON'T
- Block the event loop
- Ignore errors silently
- Create switches without unique IDs
- Mix control and sensing (use separate entities)
- Poll unnecessarily
- Hardcode entity names
- Forget to update state after commands
## Troubleshooting
### Switch Not Responding
Check:
- [ ] turn_on/turn_off methods are async
- [ ] Not blocking the event loop
- [ ] API client is working
- [ ] Errors are being raised properly
### State Not Updating
Check:
- [ ] async_write_ha_state() is called
- [ ] Coordinator refresh is working
- [ ] is_on returns correct value
- [ ] Push updates are subscribed
### Switch Appearing as Unavailable
Check:
- [ ] Device connection is working
- [ ] Coordinator update is successful
- [ ] available property returns True
- [ ] Entity is in coordinator.data
## Quality Scale Considerations
- **Bronze**: Unique ID required
- **Gold**: Entity translations, device class (if applicable)
- **Platinum**: Full type hints
## References
- [Switch Documentation](https://developers.home-assistant.io/docs/core/entity/switch)
- [Switch Integration](https://www.home-assistant.io/integrations/switch/)

View File

@@ -0,0 +1,285 @@
---
name: code-review
description: Review Home Assistant integration code for quality, best practices, and standards compliance. Use when reviewing pull requests, identifying anti-patterns, checking security vulnerabilities (OWASP), verifying async patterns, ensuring quality scale compliance, or providing comprehensive code feedback.
---
# Code Review Skill for Home Assistant Integrations
You are an expert Home Assistant code reviewer with deep knowledge of Python, async programming, Home Assistant architecture, and integration best practices.
## Review Guidelines
### What to Review
**DO review and comment on:**
- Architecture and design patterns
- Async programming correctness
- Error handling and edge cases
- Security vulnerabilities (XSS, SQL injection, command injection, etc.)
- Performance issues (blocking operations, inefficient loops)
- Code organization and clarity
- Compliance with Home Assistant patterns
- Quality scale requirements
- Missing functionality or incomplete implementations
**DO NOT comment on:**
- Missing imports (static analysis catches this)
- Code formatting (Ruff handles this)
- Minor style issues that linters catch
### Git Practices During Review
⚠️ **CRITICAL**: After review has started:
- **DO NOT amend commits**
- **DO NOT squash commits**
- **DO NOT rebase commits**
- Reviewers need to see what changed since their last review
## Key Review Areas
### 1. Async Programming Patterns
#### ✅ Good Async Patterns
```python
# Proper async I/O
data = await client.get_data()
# Using asyncio.sleep instead of time.sleep
await asyncio.sleep(5)
# Executor for blocking operations
result = await hass.async_add_executor_job(blocking_function, args)
# Gathering async operations
results = await asyncio.gather(
client.get_temp(),
client.get_humidity(),
)
# @callback for event loop safe functions
@callback
def async_update_callback(self, event):
self.async_write_ha_state()
```
#### ❌ Bad Async Patterns
```python
# Blocking operations in event loop
data = requests.get(url) # ❌ Blocks event loop
time.sleep(5) # ❌ Blocks event loop
# Awaiting in loops (use gather instead)
for device in devices:
data = await device.get_data() # ❌ Sequential, slow
# Reusing BleakClient instances
await self.client.connect() # ❌ Don't reuse BleakClient
```
### 2. Error Handling
#### ✅ Good Error Handling
```python
# Minimal try blocks, process outside
try:
data = await device.get_data()
except DeviceError as err:
_LOGGER.error("Failed to get data: %s", err)
return
# Process data outside try block
processed = data.get("value", 0) * 100
self._attr_native_value = processed
# Proper exception types
try:
await client.connect()
except asyncio.TimeoutError as ex:
raise ConfigEntryNotReady(f"Timeout connecting to {host}") from ex
except AuthError as ex:
raise ConfigEntryAuthFailed("Invalid credentials") from ex
```
#### ❌ Bad Error Handling
```python
# Too much code in try block
try:
data = await device.get_data()
processed = data.get("value", 0) * 100 # ❌ Should be outside
self._attr_native_value = processed
except DeviceError:
_LOGGER.error("Failed")
# Bare exceptions in regular code
try:
data = await device.get_data()
except Exception: # ❌ Too broad (unless in config flow/background task)
_LOGGER.error("Failed")
# Wrong exception type
if end_date < start_date:
raise ValueError("Invalid dates") # ❌ Should be ServiceValidationError
```
### 3. Security Vulnerabilities
Check for OWASP Top 10 vulnerabilities:
```python
# ❌ Command Injection
os.system(f"ping {user_input}") # DANGEROUS
# ✅ Safe alternative
await hass.async_add_executor_job(
subprocess.run,
["ping", user_input],
check=True
)
# ❌ Exposing secrets in diagnostics
return {"api_key": entry.data[CONF_API_KEY]} # DANGEROUS
# ✅ Safe alternative
return async_redact_data(entry.data, {CONF_API_KEY, CONF_PASSWORD})
```
### 4. Configuration Flow Patterns
#### ✅ Good Config Flow
```python
class MyConfigFlow(ConfigFlow, domain=DOMAIN):
VERSION = 1
MINOR_VERSION = 1
async def async_step_user(self, user_input=None):
errors = {}
if user_input is not None:
try:
await self._test_connection(user_input)
except ConnectionError:
errors["base"] = "cannot_connect"
except AuthError:
errors["base"] = "invalid_auth"
except Exception: # ✅ Allowed in config flow
errors["base"] = "unknown"
else:
await self.async_set_unique_id(device_id)
self._abort_if_unique_id_configured()
return self.async_create_entry(
title=device_name,
data=user_input,
)
return self.async_show_form(
step_id="user",
data_schema=vol.Schema({
vol.Required(CONF_HOST): str,
vol.Required(CONF_API_KEY): str,
}),
errors=errors,
)
```
### 5. Entity Patterns
#### ✅ Good Entity Patterns
```python
class MySensor(CoordinatorEntity[MyCoordinator], SensorEntity):
_attr_has_entity_name = True
_attr_translation_key = "temperature"
def __init__(self, coordinator: MyCoordinator, device_id: str) -> None:
super().__init__(coordinator)
self._attr_unique_id = f"{device_id}_temperature"
self._attr_device_info = DeviceInfo(
identifiers={(DOMAIN, device_id)},
name=coordinator.data[device_id].name,
)
@property
def native_value(self) -> float | None:
if device_data := self.coordinator.data.get(self.device_id):
return device_data.temperature
return None
@property
def available(self) -> bool:
return super().available and self.device_id in self.coordinator.data
```
### 6. Quality Scale Compliance
Review manifest.json and quality_scale.yaml:
```json
{
"domain": "my_integration",
"name": "My Integration",
"codeowners": ["@me"],
"config_flow": true,
"integration_type": "device",
"iot_class": "cloud_polling",
"quality_scale": "silver"
}
```
Check:
- [ ] All required Bronze rules implemented or exempted
- [ ] Rules match declared quality scale tier
- [ ] Valid exemption reasons provided
- [ ] manifest.json has all required fields
## Performance Patterns
### ✅ Good Performance
```python
# Parallel API calls
temp, humidity = await asyncio.gather(
api.get_temperature(),
api.get_humidity(),
)
# Efficient coordinator usage
PARALLEL_UPDATES = 0 # Unlimited for coordinator-based
```
### ❌ Bad Performance
```python
# Sequential API calls
temp = await api.get_temperature()
humidity = await api.get_humidity() # ❌ Should use gather
# User-configurable scan intervals
vol.Optional("scan_interval"): cv.positive_int # ❌ Not allowed
```
## Review Process
When reviewing code:
1. **Architecture Review**: Does it follow HA patterns?
2. **Code Quality**: Are async patterns correct? Is error handling comprehensive?
3. **Standards Compliance**: Quality scale requirements met?
4. **Performance & Efficiency**: No blocking operations? Efficient API usage?
5. **User Experience**: Clear error messages? Proper translations?
## Providing Feedback
Structure feedback as:
1. **Summary**: Overall assessment
2. **Critical Issues**: Must fix before merge
3. **Suggestions**: Nice-to-have improvements
4. **Positive Notes**: What's done well
Be specific with file:line references and provide code examples.
## Reference Files
For detailed patterns and best practices, see:
- `.claude/references/diagnostics.md` - Diagnostics implementation
- `.claude/references/sensor.md` - Sensor platform
- `.claude/references/binary_sensor.md` - Binary sensor platform
- `.claude/references/switch.md` - Switch platform
- `.claude/references/button.md` - Button platform
- `.claude/references/number.md` - Number platform
- `.claude/references/select.md` - Select platform

View File

@@ -0,0 +1,297 @@
---
name: quality-scale-architect
description: Provide architectural guidance and quality scale oversight for Home Assistant integrations. Use when designing integration structure, selecting quality tiers (Bronze/Silver/Gold/Platinum), recommending architectural patterns (coordinator/push/hub), planning quality progression, or advising on integration organization.
---
# Quality Scale Architect for Home Assistant Integrations
You are an expert Home Assistant integration architect specializing in quality scale systems, best practices, and architectural patterns.
## Quality Scale System
### Quality Scale Tiers
**Bronze** - Basic Requirements (Mandatory for all integrations with quality scale)
- ✅ Config flow (UI configuration)
- ✅ Entity unique IDs
- ✅ Action setup (or exempt)
- ✅ Appropriate setup retries
- ✅ Reauthentication flow
- ✅ Reconfigure flow
- ✅ Test coverage
**Silver** - Enhanced Functionality
- All Bronze requirements +
- ✅ Entity unavailable tracking
- ✅ Parallel updates configuration
- ✅ Runtime data storage
- ✅ Unique config entry titles
**Gold** - Advanced Features
- All Silver requirements +
- ✅ Device registry usage
- ✅ Integration diagnostics
- ✅ Device diagnostics
- ✅ Entity category
- ✅ Device class
- ✅ Disabled by default (for noisy entities)
- ✅ Entity translations
- ✅ Exception translations
- ✅ Icon translations
**Platinum** - Highest Quality Standards
- All Gold requirements +
- ✅ Strict typing (full type hints)
- ✅ Async dependencies (no sync-blocking libs)
- ✅ WebSession injection
- ✅ config_entry parameter in coordinator
## Architectural Patterns
### Pattern 1: Coordinator-Based Architecture
**Use when**: Polling multiple entities from the same API
```python
class MyCoordinator(DataUpdateCoordinator[MyData]):
def __init__(
self,
hass: HomeAssistant,
client: MyClient,
config_entry: ConfigEntry,
) -> None:
super().__init__(
hass,
logger=LOGGER,
name=DOMAIN,
update_interval=timedelta(minutes=5),
config_entry=config_entry, # ✅ Pass for Platinum
)
self.client = client
async def _async_update_data(self) -> MyData:
try:
return await self.client.fetch_data()
except ApiError as err:
raise UpdateFailed(f"Error: {err}") from err
```
### Pattern 2: Push-Based Architecture
**Use when**: Device pushes updates (webhooks, MQTT, WebSocket)
```python
class MyEntity(SensorEntity):
async def async_added_to_hass(self) -> None:
self.async_on_remove(
self.hub.subscribe_updates(self._handle_update)
)
@callback
def _handle_update(self, data: dict) -> None:
self._attr_native_value = data["value"]
self.async_write_ha_state()
```
### Pattern 3: Hub with Discovery
**Use when**: Hub device with multiple discoverable endpoints
```python
@callback
def _check_new_devices() -> None:
"""Check for new devices."""
current = set(coordinator.data.devices.keys())
new = current - known_devices
if new:
known_devices.update(new)
async_dispatcher_send(hass, f"{DOMAIN}_new_device", new)
entry.async_on_unload(coordinator.async_add_listener(_check_new_devices))
```
## Architectural Decision Guide
### Choosing Integration Type
**Device Integration** (`"integration_type": "device"`)
- Physical or virtual devices
- Example: Smart plugs, thermostats, cameras
**Hub Integration** (`"integration_type": "hub"`)
- Central hub controlling multiple devices
- Example: Philips Hue bridge, Z-Wave controller
**Service Integration** (`"integration_type": "service"`)
- Cloud services, APIs
- Example: Weather services, notification platforms
**Helper Integration** (`"integration_type": "helper"`)
- Utility integrations
- Example: Template, group, automation helpers
### Choosing IoT Class
```json
{
"iot_class": "cloud_polling", // API polling
"iot_class": "cloud_push", // Cloud webhooks/MQTT
"iot_class": "local_polling", // Local device polling
"iot_class": "local_push", // Local device push
"iot_class": "calculated" // No external data
}
```
## Quality Scale Progression Strategy
### Starting Bronze (Minimum Viable Integration)
**Essential Components**:
```
homeassistant/components/my_integration/
├── __init__.py # async_setup_entry, async_unload_entry
├── manifest.json # Required fields, quality_scale: "bronze"
├── const.py # DOMAIN constant
├── config_flow.py # UI configuration with reauth/reconfigure
├── sensor.py # Platform with unique IDs
├── strings.json # Translations
└── quality_scale.yaml # Rule tracking
tests/components/my_integration/
├── conftest.py # Test fixtures
├── test_config_flow.py # 100% coverage
└── test_sensor.py # Entity tests
```
**Bronze Checklist**:
- [ ] Config flow with UI setup
- [ ] Reauthentication flow
- [ ] Reconfigure flow
- [ ] All entities have unique IDs
- [ ] Proper setup error handling
- [ ] >95% test coverage
- [ ] 100% config flow coverage
### Progressing to Silver
**Add**:
- Entity unavailability tracking
- Runtime data storage (not hass.data)
- Parallel updates configuration
- Unique entry titles
```python
# Store in runtime_data (Silver requirement)
entry.runtime_data = coordinator
# Entity availability (Silver requirement)
@property
def available(self) -> bool:
return super().available and self.device_id in self.coordinator.data
# Parallel updates (Silver requirement)
PARALLEL_UPDATES = 0 # For coordinator-based
```
### Progressing to Gold
**Add**:
- Device registry entries
- Integration & device diagnostics
- Entity categories, device classes
- Entity translations
- Exception translations
- Icon translations
```python
# Device info (Gold requirement)
_attr_device_info = DeviceInfo(
identifiers={(DOMAIN, device.id)},
name=device.name,
manufacturer="Manufacturer",
model="Model",
)
# Diagnostics (Gold requirement)
async def async_get_config_entry_diagnostics(
hass: HomeAssistant,
entry: MyConfigEntry,
) -> dict[str, Any]:
return {
"data": async_redact_data(entry.data, TO_REDACT),
"runtime": entry.runtime_data.to_dict(),
}
```
### Progressing to Platinum
**Add**:
- Comprehensive type hints (py.typed)
- Async-only dependencies
- WebSession injection support
```python
# Type hints (Platinum requirement)
type MyIntegrationConfigEntry = ConfigEntry[MyClient]
# WebSession injection (Platinum requirement)
client = MyClient(
host=entry.data[CONF_HOST],
session=async_get_clientsession(hass),
)
# Pass config_entry to coordinator (Platinum requirement)
coordinator = MyCoordinator(hass, client, entry)
```
## Common Architectural Questions
### Q: Should I use a coordinator?
**Use coordinator when**:
- Polling API for multiple entities
- Want efficient data sharing
- Need coordinated updates
**Don't use coordinator when**:
- Push-based updates (use callbacks)
- Single entity integration
- Each entity has independent data source
### Q: Where should I store runtime data?
```python
# ✅ GOOD - Use runtime_data (Silver+)
entry.runtime_data = coordinator
# ❌ BAD - Don't use hass.data
hass.data.setdefault(DOMAIN, {})[entry.entry_id] = coordinator
```
### Q: When should I create devices vs. just entities?
**Create devices when**:
- Representing physical/virtual devices
- Multiple entities belong to same device
- Want grouped device management
**Just entities when**:
- Service integration (no physical device)
- Single entity integration
- Calculated/helper entities
## Reference Files
For detailed implementation guidance, see:
- `.claude/references/diagnostics.md` - Diagnostics implementation
- `.claude/references/sensor.md` - Sensor platform
- `.claude/references/binary_sensor.md` - Binary sensor platform
- `.claude/references/switch.md` - Switch platform
- `.claude/references/button.md` - Button platform
- `.claude/references/number.md` - Number platform
- `.claude/references/select.md` - Select platform
## Your Task
When providing architectural guidance:
1. **Understand Requirements**: What is the integration type? What data needs exposure? Polling or push? What quality tier?
2. **Recommend Architecture**: Suggest appropriate patterns, identify required components, explain decisions
3. **Quality Scale Guidance**: Recommend starting tier, identify applicable rules, suggest progression path
4. **Implementation Plan**: Outline file structure, identify key components, suggest implementation order
5. **Best Practices**: Performance considerations, maintainability tips, common pitfalls to avoid

View File

@@ -0,0 +1,205 @@
---
name: testing
description: Write, run, and fix tests for Home Assistant integrations. Use when writing comprehensive test coverage (>95%), running pytest, fixing failing tests, updating snapshots, or following HA testing patterns. Specializes in modern fixture patterns, config flow testing (100% coverage), entity snapshot testing, and mocking external APIs.
---
# Testing Skill for Home Assistant Integrations
You are an expert Home Assistant integration test engineer specializing in writing comprehensive, maintainable tests that follow Home Assistant conventions and best practices.
## Testing Standards
### Coverage Requirements
- **Minimum Coverage**: 95% for all modules
- **Config Flow**: 100% coverage required for all paths
- **Location**: Tests go in `tests/components/{domain}/`
### Test File Organization
```
tests/components/my_integration/
├── __init__.py
├── conftest.py # Fixtures and test setup
├── test_config_flow.py # Config flow tests (100% coverage)
├── test_sensor.py # Sensor platform tests
├── test_init.py # Integration setup tests
└── snapshots/ # Generated snapshot files
```
## Modern Fixture Setup Pattern
Always use this pattern for integration tests:
```python
from homeassistant.core import HomeAssistant
from homeassistant.const import Platform
from pytest_homeassistant_custom_component.common import MockConfigEntry
@pytest.fixture
def mock_config_entry() -> MockConfigEntry:
"""Return the default mocked config entry."""
return MockConfigEntry(
title="My Integration",
domain=DOMAIN,
data={CONF_HOST: "127.0.0.1", CONF_API_KEY: "test_key"},
unique_id="device_unique_id",
)
@pytest.fixture
def mock_device_api() -> Generator[MagicMock]:
"""Return a mocked device API."""
with patch("homeassistant.components.my_integration.MyDeviceAPI", autospec=True) as api_mock:
api = api_mock.return_value
api.get_data.return_value = MyDeviceData.from_json(
load_fixture("device_data.json", DOMAIN)
)
yield api
@pytest.fixture
def platforms() -> list[Platform]:
"""Fixture to specify platforms to test."""
return [Platform.SENSOR]
@pytest.fixture
async def init_integration(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_device_api: MagicMock,
platforms: list[Platform],
) -> MockConfigEntry:
"""Set up the integration for testing."""
mock_config_entry.add_to_hass(hass)
with patch("homeassistant.components.my_integration.PLATFORMS", platforms):
await hass.config_entries.async_setup(mock_config_entry.entry_id)
await hass.async_block_till_done()
return mock_config_entry
```
## Entity Testing with Snapshots
Use snapshot testing for entity verification:
```python
from syrupy import SnapshotAssertion
from homeassistant.helpers import entity_registry as er, device_registry as dr
@pytest.mark.usefixtures("entity_registry_enabled_by_default", "init_integration")
async def test_entities(
hass: HomeAssistant,
snapshot: SnapshotAssertion,
entity_registry: er.EntityRegistry,
device_registry: dr.DeviceRegistry,
mock_config_entry: MockConfigEntry,
) -> None:
"""Test the sensor entities."""
await snapshot_platform(hass, entity_registry, snapshot, mock_config_entry.entry_id)
# Verify entities are assigned to device
device_entry = device_registry.async_get_device(
identifiers={(DOMAIN, "device_unique_id")}
)
assert device_entry
entity_entries = er.async_entries_for_config_entry(
entity_registry, mock_config_entry.entry_id
)
for entity_entry in entity_entries:
assert entity_entry.device_id == device_entry.id
```
## Config Flow Testing (100% Coverage Required)
Test ALL paths in config flow:
```python
async def test_user_flow_success(hass, mock_api):
"""Test successful user flow."""
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": config_entries.SOURCE_USER}
)
assert result["type"] == FlowResultType.FORM
assert result["step_id"] == "user"
result = await hass.config_entries.flow.async_configure(
result["flow_id"], user_input=TEST_USER_INPUT
)
assert result["type"] == FlowResultType.CREATE_ENTRY
assert result["title"] == "My Device"
assert result["data"] == TEST_USER_INPUT
async def test_flow_connection_error(hass, mock_api_error):
"""Test connection error handling."""
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": config_entries.SOURCE_USER}
)
result = await hass.config_entries.flow.async_configure(
result["flow_id"], user_input=TEST_USER_INPUT
)
assert result["type"] == FlowResultType.FORM
assert result["errors"] == {"base": "cannot_connect"}
async def test_flow_duplicate_entry(hass, mock_config_entry, mock_api):
"""Test duplicate entry prevention."""
mock_config_entry.add_to_hass(hass)
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": config_entries.SOURCE_USER}
)
result = await hass.config_entries.flow.async_configure(
result["flow_id"], user_input=TEST_USER_INPUT
)
assert result["type"] == FlowResultType.ABORT
assert result["reason"] == "already_configured"
```
## Running Tests
### Integration-Specific Tests (Recommended)
```bash
pytest ./tests/components/<integration_domain> \
--cov=homeassistant.components.<integration_domain> \
--cov-report term-missing \
--durations-min=1 \
--durations=0 \
--numprocesses=auto
```
### Quick Test of Changed Files
```bash
pytest --timeout=10 --picked
```
### Update Test Snapshots
```bash
pytest ./tests/components/<integration_domain> --snapshot-update
```
**⚠️ IMPORTANT**: After using `--snapshot-update`:
1. Run tests again WITHOUT the flag to verify snapshots
2. Review the snapshot changes carefully
3. Don't commit snapshot updates without verification
## Critical Testing Rules
### NEVER Do These Things
- ❌ Don't access `hass.data` directly in tests
- ❌ Don't test entities in isolation without integration setup
- ❌ Don't forget to mock external dependencies
### ALWAYS Do These Things
- ✅ Use proper integration setup through fixtures
- ✅ Mock all external APIs
- ✅ Test through the integration's public interface
- ✅ Use snapshot testing for entities
- ✅ Achieve 100% config flow coverage
- ✅ Achieve >95% overall coverage
## Reference Files
For detailed implementation guidance, see:
- `.claude/references/sensor.md` - Sensor platform patterns
- `.claude/references/binary_sensor.md` - Binary sensor patterns
- `.claude/references/switch.md` - Switch platform patterns
- `.claude/references/button.md` - Button platform patterns
- `.claude/references/number.md` - Number platform patterns
- `.claude/references/select.md` - Select platform patterns