Skip to content

srcfl/zap-home-assistant

Repository files navigation

Sourceful Zap - Home Assistant Integration

hacs Project Status: WIP

Home Assistant integration for the Sourceful Zap - a local coordination gateway for distributed energy resources.

Status: In development. Targeting Home Assistant Core inclusion with Bronze tier quality scale.

About the Zap

The Zap is a ~$20 ESP32-based gateway enabling local energy coordination with <200ms response times - critical for grid services that cloud APIs (2-5s latency) cannot support.

Supported protocols: P1 · Modbus TCP/RTU · MQTT · OCPP · REST API

Learn more: sourceful.energy

Installation

HACS (Coming Soon)

Once published, install via HACS.

Manual

# Clone to custom_components
cd ~/.homeassistant/custom_components
git clone https://github.com/srcfl/zap-home-assistant.git sourceful_zap

Legacy P1 Integration

For the working P1-only integration, use the legacy-v0.1 branch.

Development

This integration follows Home Assistant development guidelines.

Requirements

Requirement Reference
Config Flow Config Entries
Coordinator DataUpdateCoordinator
Translations Internationalization
Tests Testing
Quality Scale Bronze tier minimum

Structure

custom_components/sourceful_zap/
├── __init__.py          # Integration setup
├── manifest.json        # Integration metadata
├── config_flow.py       # UI configuration
├── coordinator.py       # Data fetching
├── sensor.py            # Sensor entities
├── const.py             # Constants
├── strings.json         # Translations
└── translations/        # Localized strings

See File Structure and Manifest docs.

Local Development

# Set up dev environment
python -m venv venv
source venv/bin/activate
pip install homeassistant

# Run tests
pytest tests/

Contributing

Join the discussion on Discord.

License

MIT - see LICENSE


Sourceful Labs AB · Kalmar, Sweden 🇸🇪

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5

Languages