refactor: readme.md

readme.md

@@ -1,46 +1,37 @@
-# Solarman integration
+# ⚡ Solarman Stick Logger integration
 
-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):
 > - Using asynchronous part of [@jmccrohan](https://github.com/jmccrohan/pysolarmanv5) + small adjustments to the inner workings of the library itself
 > - Fetching is implemented through DataUpdateCoordinator + incorporates many more up to date features of HA
 > - Improved stability (no more disconnects and missing values)
->
 > - Discovery and not just for configuration but also as part of initialization (i.e. adapts to changed IP)
->
 > - Registers which are requested are decided dynamically (when missing from the inverter definition file)
 > - Different registers can be requested in different intervals according to their 'update_interval' set in inverter definition file
->
-> - Added attribute type of a sensor which can be attached to any other sensor
-> - Added template sensors defined by simple formulas and parameters which are then evaluated during runtime
-> - Added configuration for Battery Nominal Voltage and Battery Life Cycle Rating for calculating SOH of the battery
-> - *All this new features can be seen utilized in the 'deye_sg04lp3.yaml'*
->
+> - New Inverter profiles features **See 'deye_sg04lp3.yaml' for examples*:
+>   - Added attribute type of a sensor which can be attached to any other sensor
+>   - Added template sensors defined by simple formulas and parameters which are then evaluated during runtime
+>   - Added configuration for Battery Nominal Voltage and Battery Life Cycle Rating for calculating SOH of the battery  
 > - And many more fixes and improvements (while trying to fully preserve backward compatibility)
 
 > [!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.
->
-> 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 ;)  
->
-> *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
+> 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.  
+> 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]:
 ```
@@ -57,9 +48,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:
 ```
@@ -87,17 +78,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