Skip to content

Commit

Permalink
refactor: readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
davidrapan committed Jul 15, 2024
1 parent e1bda5c commit 03f57b6
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# Solarman integration

Integration for Solarman Stick Logger
Integration for Solarman Stick Logger

> [!NOTE]
> Use πŸ’¬ Discussions for πŸ™ Q&A and πŸ’‘ Development Planning, etc. and leave 🚩 Issues for 🐞 bug reporting, 🎁 feature requests and such...
> [!NOTE]
> It's still 🚧 work in progress but currently very 🐎 stable πŸ˜‰
>
> *I mean at least for my device as I'm not able to* πŸ§ͺ *test it for any other so any* 🧍 *volunteers?* 😊
> [!IMPORTANT]
> This integration builds on and is heavily inspired by [@StephanJoubert](https://github.com/StephanJoubert/home_assistant_solarman) (but W/ decent amount of changes):
Expand All @@ -22,25 +30,17 @@ Integration for Solarman Stick Logger
> [!WARNING]
> Is note worthy that some names of the SG04LP3 sensors did change for different reasons (some were due to aestetics, etc.)
> So look through the file and change them as you see fit manually before I'll make it available from the HA configuration.
> So look through the file and change them as you see fit manually before I'll make it available from the HA configuration.
>
> One more thing.. It's not possible to use this integration side by side (with the same device) with the implementation from Stephan! It will override it.
> [!NOTE]
> It's still work in progress but I'm now over 3 weeks of uptime so it's really stable ;)
> One more thing.. It's not possible to use this integration side by side (with the same device) with the implementation from Stephan! It will override it.
>
> *I mean at least for my device as I'm not able to test it for any other so any volunteers?*
>
> ...
> [!WARNING]
> TODO: Rest of the info :-D
> TODO: Rest of the info... πŸ˜ƒ
## Miscellaneous
## πŸš€ Miscellaneous

Some might wonder why Energy Dashboard shows different(higher) Load Consumption than sensor like for example "Today(Daily) Load Consumption. And it's because the Energy Dashboard does it's own calculations by summing up Imported(Bought) and Produced energy which also includes consumption of the inverter itself + some AC/DC losses along the way."
Some might wonder why Energy Dashboard shows different(higher) Load Consumption than sensor like for example "Today(Daily) Load Consumption. And it's because the Energy Dashboard does it's own calculations by summing up Imported(Bought) and Produced energy which also includes consumption of the inverter itself + some AC/DC losses along the way."

_So for those curious enough here is some insight..._
_So for those curious enough here is some insight..._

#### Inverter power losses calculation [W]:
```
Expand All @@ -57,9 +57,9 @@ Total losses = Total Energy Imported(Bought) + Total Production + Total Battery
Today(Daily) losses = Today(Daily) Energy Imported(Bought) + Today(Daily) Production + Today(Daily) Battery Discharge - Today(Daily) Energy Exported(Sold) - Today(Daily) Battery Charge - Today(Daily) Load Consumption
```

_To get value which is in Energy Dashboard as "Home Consumption" remove subtraction of Load Consumption from the above._
_To get value which is in Energy Dashboard as "Home Consumption" remove subtraction of Load Consumption from the above._

## Diagnostics
## 🏭 Diagnostics

I was using during the development also this sensor bundle:
```
Expand Down Expand Up @@ -87,17 +87,17 @@ template:
icon: "mdi:calendar-clock"
```
Which provides informantion about how long it is since last update (with resolution of seconds).
Maybe it will be useful for some, but since the stability of the polling improved a lot it's not really needed.
Maybe it will be useful for some, but since the stability of the polling improved a lot it's not really needed.

## Installation
## πŸ”¨ Installation

[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=davidrapan&repository=ha-solarman&category=integration)
[![πŸ”Œ Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=davidrapan&repository=ha-solarman&category=integration)

### HACS (Manually)
### πŸͺ› HACS (Manually)
- Follow the link [here](https://hacs.xyz/docs/faq/custom_repositories/)
- Add custom repository: https://github.com/davidrapan/ha-solarman
- Select type of the category: integration
- Find newly added Solarman, open it and then click on the DOWNLOAD button

### Manually
### πŸ”§ Manually
- Copy the contents of 'custom_components/solarman' directory into the Home Assistant with exactly the same hirearchy withing the '/config' directory

0 comments on commit 03f57b6

Please sign in to comment.