An open API service indexing awesome lists of open source software.

https://github.com/wearebasis/ha-basis

Basis Home Assistant Integration
https://github.com/wearebasis/ha-basis

basis basis-smart-home basis-smart-panel home-assistant home-assistant-integration smart-home

Last synced: 3 months ago
JSON representation

Basis Home Assistant Integration

Awesome Lists containing this project

README

          

# Basis Smart Panel

A Home Assistant integration for Basis Smart panels by [Basis NZ Ltd](https://wearebasis.com/).

## Features

- **Real-time Power Monitoring** - Track current power consumption, import/export power, and primary current at the panel level
- **Circuit-level Insights** - Monitor power, current, and voltage for each individual circuit
- **Energy Statistics** - View daily and monthly energy import/export totals
- **Circuit Control** - Remotely control circuit standby states through Home Assistant
- **Connectivity Status** - Binary sensor showing panel connection status
- **Multi-panel Support** - Manage multiple Basis panels from a single integration

## Requirements

- Home Assistant 2025.1.0 or newer
- A Basis Smart Panel with an active cloud connection
- Basis account credentials

## Installation

### HACS (Recommended)

1. Open HACS in Home Assistant
2. Click on "Integrations"
3. Click the three dots in the top right corner and select "Custom repositories"
4. Add this repository URL and select "Integration" as the category
5. Click "Add"
6. Search for "Basis Smart Panel" and install it
7. Restart Home Assistant

### Manual Installation

1. Download the `custom_components/basis_smart_panel` folder from this repository
2. Copy it to your `config/custom_components/` directory
3. Restart Home Assistant

## Configuration

1. Go to **Settings** > **Devices & Services**
2. Click **Add Integration**
3. Search for "Basis Smart Panel"
4. Follow the OAuth2 authentication flow to link your Basis account

## Entities

### Sensors

| Entity | Description | Update Interval |
|--------|-------------|-----------------|
| Current Power | Net power consumption (W) | 5 seconds |
| House Consumption Power | Power being used by the house (W) | 5 seconds |
| Generation Power | Power being generated by solar (W) | 5 seconds |
| Primary Current | Main current draw (A) | 5 seconds |
| Consumption Energy Today | Energy consumed by the house today (kWh) | 5 minutes |
| Generation Energy Today | Energy generated by solar today (kWh) | 5 minutes |
| Consumption Energy This Month | Energy consumed by the house this month (kWh) | 5 minutes |
| Generation Energy This Month | Energy generated by solar this month (kWh) | 5 minutes |

### Circuit Sensors

For each circuit in your panel:

- Power (W)
- Current (A)
- Voltage (V)

### Binary Sensors

- **Connected** - Shows whether the panel is currently connected to the Basis cloud

### Switches

- **Circuit Standby** - Control the standby state of individual circuits (where supported)

## Support

For issues with this integration, please open an issue on GitHub.

## Trademarks

This project may contain trademarks or logos for Basis NZ Ltd. products or services. See [TRADEMARKS.md](TRADEMARKS.md) for details.

## License

This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.