Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Feature development of the v1 API has been stopped. No new features will be adde

- Support has been added to the P1 Meter to control the Plug-In Battery group mode. See [Plug-In Battery API](/docs/v2/batteries) for more information.

#### 2.2.0 - 01-12-2025 (in beta)
#### 2.2.0 - 01-12-2025

- You can now set charge and discharge permissions for the Plug-In Battery group via the `permissions` field in the [Plug-In Battery API](/docs/v2/batteries). See the documentation for more information.
- A new field has been added to `api/batteries`: `battery_count`, which indicates the number of connected Plug-In Batteries.
Expand Down
16 changes: 8 additions & 8 deletions docs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,14 @@ To understand the basics of the API, you can read the [getting-started](/docs/ge

The following table shows which devices are supported by the API and which API version they support.

| Device | Device type | API v1 | API v2 |
| --------------------------------------- | ----------------------------------------------------------------------- | -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| P1 Meter | `HWE-P1` | <Badge colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-green' icon="mdi:check" detail='2.1.0'>Supported</Badge><Badge colorName='hw-purple' icon="mdi:test-tube" detail='2.2.0'>In beta, available from firmware 6.03xx</Badge> |
| Energy Socket | `HWE-SKT` | <Badge colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-grey' icon="mdi:wrench">In development</Badge> |
| Watermeter (Only when powered over USB) | `HWE-WTR` | <Badge colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-grey' icon="mdi:wrench">In development</Badge> |
| kWh Meter (1 phase and 3-phase) | `HWE-KWH1`,<br /> `HWE-KWH3`,<br />`SDM230-wifi` and<br />`SDM630-wifi` | <Badge colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-green' icon="mdi:check" detail='2.1.0'>Supported</Badge> <Badge colorName='hw-purple' icon="mdi:test-tube" detail='2.2.0'>In beta, available from firmware 5.01xx</Badge> |
| Energy Display | `HWE-DSP` | <Badge colorName='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge colorName='hw-grey' icon="mdi:wrench">In development</Badge> |
| Plug-In Battery | `HWE-BAT` | <Badge colorName='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge colorName='hw-green' icon="mdi:check" detail='2.0.1'>Supported</Badge> |
| Device | Device type | API v1 | API v2 |
| --------------------------------------- | ----------------------------------------------------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| P1 Meter | `HWE-P1` | <Badge colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-green' icon="mdi:check" detail='2.2.0'>Supported</Badge> |
| Energy Socket | `HWE-SKT` | <Badge colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-grey' icon="mdi:wrench">In development</Badge> |
| Watermeter (Only when powered over USB) | `HWE-WTR` | <Badge colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-grey' icon="mdi:wrench">In development</Badge> |
| kWh Meter (1 phase and 3-phase) | `HWE-KWH1`,<br /> `HWE-KWH3`,<br />`SDM230-wifi` and<br />`SDM630-wifi` | <Badge colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-green' icon="mdi:check" detail='2.2.0'>Supported</Badge> |
| Energy Display | `HWE-DSP` | <Badge colorName='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge colorName='hw-grey' icon="mdi:wrench">In development</Badge> |
| Plug-In Battery | `HWE-BAT` | <Badge colorName='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge colorName='hw-green' icon="mdi:check" detail='2.0.1'>Supported</Badge> |

## Beta Program.

Expand Down
18 changes: 9 additions & 9 deletions docs/v2/batteries.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ The `/api/batteries` endpoint can be used to retrieve information about the cont

## Parameters

| Data | Availability | Type | Access | Description |
| --------------------------- | -------------------------------------------------------------------------------- | ------------- | ------------ | -------------------------------------------------------------------------------------------------- |
| [mode](#mode) | <Badge colorName='hw-green' icon="mdi:check" detail='2.1.0'>Available</Badge> | String | Read/Write | Control mode of the Plug-In Battery. Can be either `zero`, `to_full`, or `standby`. |
| [permissions](#permissions) | <Badge colorName='hw-purple' icon="mdi:test-tube" detail='2.2.0'>In beta</Badge> | Array[String] | Read/Write\* | Permissions to allow charging, discharging, both, or neither. _Note: Read-only in `to_full` mode._ |
| battery_count | <Badge colorName='hw-purple' icon="mdi:test-tube" detail='2.2.0'>In beta</Badge> | Number | Read-only | Number of connected Plug-In Batteries. |
| power_w | <Badge colorName='hw-green' icon="mdi:check" detail='2.1.0'>Available</Badge> | Number | Read-only | Current combined power consumption/production of the controlled Plug-In Batteries. |
| target_power_w | <Badge colorName='hw-green' icon="mdi:check" detail='2.1.0'>Available</Badge> | Number | Read-only | Target power consumption/production of the controlled Plug-In Batteries. |
| max_consumption_w | <Badge colorName='hw-green' icon="mdi:check" detail='2.1.0'>Available</Badge> | Number | Read-only | Maximum allowed consumption power of the controlled Plug-In Batteries. |
| max_production_w | <Badge colorName='hw-green' icon="mdi:check" detail='2.1.0'>Available</Badge> | Number | Read-only | Maximum allowed production power of the controlled Plug-In Batteries. |
| Data | Availability | Type | Access | Description |
| --------------------------- | ----------------------------------------------------------------------------- | ------------- | ------------ | -------------------------------------------------------------------------------------------------- |
| [mode](#mode) | <Badge colorName='hw-green' icon="mdi:check" detail='2.1.0'>Available</Badge> | String | Read/Write | Control mode of the Plug-In Battery. Can be either `zero`, `to_full`, or `standby`. |
| [permissions](#permissions) | <Badge colorName='hw-green' icon="mdi:check" detail='2.2.0'>Available</Badge> | Array[String] | Read/Write\* | Permissions to allow charging, discharging, both, or neither. _Note: Read-only in `to_full` mode._ |
| battery_count | <Badge colorName='hw-green' icon="mdi:check" detail='2.2.0'>Available</Badge> | Number | Read-only | Number of connected Plug-In Batteries. |
| power_w | <Badge colorName='hw-green' icon="mdi:check" detail='2.1.0'>Available</Badge> | Number | Read-only | Current combined power consumption/production of the controlled Plug-In Batteries. |
| target_power_w | <Badge colorName='hw-green' icon="mdi:check" detail='2.1.0'>Available</Badge> | Number | Read-only | Target power consumption/production of the controlled Plug-In Batteries. |
| max_consumption_w | <Badge colorName='hw-green' icon="mdi:check" detail='2.1.0'>Available</Badge> | Number | Read-only | Maximum allowed consumption power of the controlled Plug-In Batteries. |
| max_production_w | <Badge colorName='hw-green' icon="mdi:check" detail='2.1.0'>Available</Badge> | Number | Read-only | Maximum allowed production power of the controlled Plug-In Batteries. |

## Mode

Expand Down