Add documentation for solarman integration#41034
Conversation
home-assistant
Bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
solarmanpv
left a comment
solarmanpv
left a comment
There was a problem hiding this comment.
Solarman.markdown change
c0ffeeca7
added
the
new-integration
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
| - Power (W) | ||
| - Voltage (V) | ||
| - Current (A) | ||
| - Positive Active Energy (kWh) |
There was a problem hiding this comment.
We use sentence-style capitalization, usually also for UI strings. Is there any particular reason these sensor names use heading-style capitalization?
|
Got it. I've updated the sensor name to use sentence-style capitalization in this documentation and will apply the same change to the core repository in the next commit. |
|
|
||
| The SP-2W-EU provides the following sensors: | ||
|
|
||
| - Power |
There was a problem hiding this comment.
For each of the sensors, please also provide the corresponding unit. And an explanation for the less obvious ones? For example: Power factor (ratio of active to apparent power)
|
I'm drafting this PR, as changes are needed. Please undraft it once the changes have been implemented and the PR is ready for review again. |
c0ffeeca7
left a comment
c0ffeeca7
left a comment
There was a problem hiding this comment.
Thank you, @solarmanpv 👍
| --- | ||
| title: Solarman | ||
| description: Instructions on how to integrate your Solarman device with Home Assistant. | ||
| ha_release: 2025.8 |
There was a problem hiding this comment.
| ha_release: 2025.8 | |
| ha_release: 2026.4 |
| Port: | ||
| description: "The TCP port of the device, 8080 by default." | ||
| Scan Interval: | ||
| description: "The polling interval in seconds." |
There was a problem hiding this comment.
Port and scan interval aren't a parameter anymore
|
|
||
| ## Data updates | ||
|
|
||
| The **Solarman integration** integration {% term polling polls %} data from the device every 30 seconds by default. You can define it by changing Scan Interval during integration setup. |
home-assistant
Bot
removed
parent-merged
There was a problem hiding this comment.
Pull request overview
Adds a new integration documentation page under source/_integrations for the Solarman integration, describing setup via config flow and listing supported devices and available sensors.
Changes:
- Added
source/_integrations/solarman.markdownwith front matter metadata and end-user documentation. - Documented prerequisites/config flow setup and listed supported devices and sensor entities.
- Added sections for data update interval, limitations, troubleshooting, and removal.
| 1. Ensure the device is powered on and functioning normally. | ||
| 2. Confirm both the device and Home Assistant are connected to the same local network. | ||
| 3. Ensure the device's IP address is correct and hasn't changed. | ||
| 4. Check the device's settings in app to ensure that the API is enabled. |
There was a problem hiding this comment.
Troubleshooting step: “Check the device's settings in app …” is missing an article and may trip text linting. Consider changing to “in the app” (and optionally specify which app setting enables the API).
| 4. Check the device's settings in app to ensure that the API is enabled. | |
| 4. Check the device's settings in the manufacturer's app to ensure that local API access is enabled. |
| The Solarman {% term integration %} enables direct local communication between Home Assistant and your [Solarman](https://www.solarmanpv.com/) devices. This solution provides real-time monitoring of energy production and consumption while enabling device control, all through secure local communication. | ||
|
|
||
| ## Use cases | ||
|
|
There was a problem hiding this comment.
The PR description says this adds documentation for the Indevolt integration, but this file documents the Solarman integration. Please update the PR description (or rename/adjust the added documentation) so they match, otherwise it’s hard to review and track the change history.
| The Solarman {% term integration %} enables direct local communication between Home Assistant and your [Solarman](https://www.solarmanpv.com/) devices. This solution provides real-time monitoring of energy production and consumption while enabling device control, all through secure local communication. | ||
|
|
||
| ## Use cases | ||
|
|
||
| - Monitor energy usage in real time. | ||
| - Control devices remotely. | ||
| - Automate schedules for your appliances. | ||
|
|
||
| ## Supported devices | ||
|
|
||
| Currently, the integration supports the following devices: | ||
|
|
||
| - SP-2W-EU: Smart Plug for energy monitoring (power consumption, voltage, current) and remote outlet control. | ||
| - P1-2W: P1 Meter Reader for monitoring operating status and consumption data of P1 meter. | ||
| - MR1-D5-W/MR1-D5-WR: Smart Meter for bidirectional energy metering in residential and small commercial and industrial scenarios. |
There was a problem hiding this comment.
The introduction and use cases suggest the integration supports device control and scheduling, but the rest of the page (and ha_platforms) only documents sensors. Please align the text with what the integration actually exposes in Home Assistant (for example, document the control entities/platforms if they exist, or remove the control/scheduling claims if it’s sensor-only).
| The Solarman {% term integration %} enables direct local communication between Home Assistant and your [Solarman](https://www.solarmanpv.com/) devices. This solution provides real-time monitoring of energy production and consumption while enabling device control, all through secure local communication. | |
| ## Use cases | |
| - Monitor energy usage in real time. | |
| - Control devices remotely. | |
| - Automate schedules for your appliances. | |
| ## Supported devices | |
| Currently, the integration supports the following devices: | |
| - SP-2W-EU: Smart Plug for energy monitoring (power consumption, voltage, current) and remote outlet control. | |
| - P1-2W: P1 Meter Reader for monitoring operating status and consumption data of P1 meter. | |
| - MR1-D5-W/MR1-D5-WR: Smart Meter for bidirectional energy metering in residential and small commercial and industrial scenarios. | |
| The Solarman {% term integration %} enables direct local communication between Home Assistant and your [Solarman](https://www.solarmanpv.com/) devices. This solution provides real-time monitoring of energy production and consumption through secure local communication. | |
| ## Use cases | |
| - Monitor energy usage in real time. | |
| - Create automations in Home Assistant based on your current power production or consumption. | |
| - Track and analyze your household energy usage over time. | |
| ## Supported devices | |
| Currently, the integration supports the following devices: | |
| - SP-2W-EU: Smart plug for local energy monitoring, such as power consumption, voltage, and current. | |
| - P1-2W: P1 Meter Reader for monitoring operating status and consumption data of a P1 meter. | |
| - MR1-D5-W/MR1-D5-WR: Smart meter for bidirectional energy metering in residential, small commercial, and industrial scenarios. |
| ha_quality_scale: bronze | ||
| --- | ||
|
|
||
| The Solarman {% term integration %} enables direct local communication between Home Assistant and your [Solarman](https://www.solarmanpv.com/) devices. This solution provides real-time monitoring of energy production and consumption while enabling device control, all through secure local communication. |
There was a problem hiding this comment.
This sentence claims “secure local communication”. Unless the device API is actually authenticated/encrypted, this can be misleading. Consider removing “secure” or clarifying what makes the communication secure (for example, “local communication over your LAN”).
| The Solarman {% term integration %} enables direct local communication between Home Assistant and your [Solarman](https://www.solarmanpv.com/) devices. This solution provides real-time monitoring of energy production and consumption while enabling device control, all through secure local communication. | |
| The Solarman {% term integration %} enables direct local communication between Home Assistant and your [Solarman](https://www.solarmanpv.com/) devices. This solution provides real-time monitoring of energy production and consumption while enabling device control, all over your local network without relying on the cloud. |
| The Solarman {% term integration %} enables direct local communication between Home Assistant and your [Solarman](https://www.solarmanpv.com/) devices. This solution provides real-time monitoring of energy production and consumption while enabling device control, all through secure local communication. | ||
|
|
||
| ## Use cases | ||
|
|
||
| - Monitor energy usage in real time. | ||
| - Control devices remotely. | ||
| - Automate schedules for your appliances. | ||
|
|
||
| ## Supported devices | ||
|
|
||
| Currently, the integration supports the following devices: | ||
|
|
||
| - SP-2W-EU: Smart Plug for energy monitoring (power consumption, voltage, current) and remote outlet control. | ||
| - P1-2W: P1 Meter Reader for monitoring operating status and consumption data of P1 meter. | ||
| - MR1-D5-W/MR1-D5-WR: Smart Meter for bidirectional energy metering in residential and small commercial and industrial scenarios. |
There was a problem hiding this comment.
The SP-2W-EU description says it supports “remote outlet control”, but the front matter lists only the sensor platform and the “Supported functionality” section lists only sensors. If outlet control is supported, add the correct platform(s) (for example, switch) and document the controllable entities; otherwise, adjust this device description to avoid implying control support.
| The Solarman {% term integration %} enables direct local communication between Home Assistant and your [Solarman](https://www.solarmanpv.com/) devices. This solution provides real-time monitoring of energy production and consumption while enabling device control, all through secure local communication. | |
| ## Use cases | |
| - Monitor energy usage in real time. | |
| - Control devices remotely. | |
| - Automate schedules for your appliances. | |
| ## Supported devices | |
| Currently, the integration supports the following devices: | |
| - SP-2W-EU: Smart Plug for energy monitoring (power consumption, voltage, current) and remote outlet control. | |
| - P1-2W: P1 Meter Reader for monitoring operating status and consumption data of P1 meter. | |
| - MR1-D5-W/MR1-D5-WR: Smart Meter for bidirectional energy metering in residential and small commercial and industrial scenarios. | |
| The Solarman {% term integration %} enables direct local communication between Home Assistant and your [Solarman](https://www.solarmanpv.com/) devices. This solution provides real-time monitoring of energy production and consumption through secure local communication. | |
| ## Use cases | |
| - Monitor energy usage in real time. | |
| - Analyze trends in your household energy consumption. | |
| - Build automations in Home Assistant that react to your Solarman energy data. | |
| ## Supported devices | |
| Currently, the integration supports the following devices: | |
| - SP-2W-EU: Smart plug for energy monitoring (power consumption, voltage, current). | |
| - P1-2W: P1 meter reader for monitoring operating status and consumption data of a P1 meter. | |
| - MR1-D5-W/MR1-D5-WR: Smart meter for bidirectional energy metering in residential and small commercial and industrial scenarios. |
| - SP-2W-EU: Smart Plug for energy monitoring (power consumption, voltage, current) and remote outlet control. | ||
| - P1-2W: P1 Meter Reader for monitoring operating status and consumption data of P1 meter. | ||
| - MR1-D5-W/MR1-D5-WR: Smart Meter for bidirectional energy metering in residential and small commercial and industrial scenarios. |
There was a problem hiding this comment.
Grammar/readability: “monitoring operating status and consumption data of P1 meter” reads awkwardly. Consider rephrasing to something like “monitoring the operating status and consumption data from the P1 meter”.
| - SP-2W-EU: Smart Plug for energy monitoring (power consumption, voltage, current) and remote outlet control. | |
| - P1-2W: P1 Meter Reader for monitoring operating status and consumption data of P1 meter. | |
| - MR1-D5-W/MR1-D5-WR: Smart Meter for bidirectional energy metering in residential and small commercial and industrial scenarios. | |
| - SP-2W-EU: Smart plug for energy monitoring (power consumption, voltage, current) and remote outlet control. | |
| - P1-2W: P1 meter reader for monitoring the operating status and consumption data from your P1 meter. | |
| - MR1-D5-W/MR1-D5-WR: Smart meter for bidirectional energy metering in residential and small commercial and industrial scenarios. |
Proposed change
Add documentation for the new indevolt integration.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.