Updated documentation

README.md

@@ -35,10 +35,8 @@ custom_components
 ├── {other components}
 ```
 
-Then proceed to configuration.
-
-# Configuration
 
+# Preparation
 1. Get the IP and Serial Number to use in the configuration. 
 
 Find the internal IP of the logger on the DHCP server, and then open a browser and navigate to that address. If you are prompted for a username/password, use "admin" as username and "admin" as password.
@@ -51,10 +49,26 @@ Once logged in, expand the "Device information" and note the Device serial numbe
 
 3. On your DHCP server, reserve the IP for the WiFi data logger so that it will not change. 
 
-4. In your configuration.yaml file, add the solarman platform under "sensor"
 
 
-## Example:
+
+
+# Configuration
+This integration can be configured using config-flow, or by manually configuring using the configuraiton.yaml file. Both methods are described below:
+## Automatic (config flow)
+1. After the installation of this component, click on the "Configuration" tab on the left, then on "Devices & Services"
+2. Select the "Integrations" tab on the top of the screen, then on the "+ ADD INTEGRATION" button on the left-hand corner.
+3. Select the solarman integration
+![Solarman](./flow_select.png)
+
+4.Configure the entity by filling in the details.
+![Solarman](./flow_init_manual.png)
+
+
+## Manual Configuration (configurtion.yaml)
+In your configuration.yaml file, add the solarman platform under "sensor"
+
+### Example:
 
 ~~~ YAML
 
@@ -65,8 +79,7 @@ sensor:
     inverter_port: 8899
     inverter_serial: 1720747149 
     inverter_mb_slaveid: 1
-    scan_interval: 30
-    lookup_file: sofar_lsw3.yaml
+    lookup_file: deye.yaml
 ~~~
 
 ## Parameters 
@@ -74,16 +87,16 @@ sensor:
 | Parameter | Description |
 | ---- | ---- |
 | name | This name will be prefixed to all parameter values (change as you like)|
-| inverter_host| The IP address of the data logger |
+| inverter_host| The IP address of the data logger. (* see: autodiscover) |
 | inverter_port | Always 8899 |
-| inverter_serial| The serial number of the data collector |
+| inverter_serial| The serial number of the data collector (* see: autodiscover) |
 | inverter_mb_slaveid| The Modbus Slave ID of the inverter. Defaults to 1 |
 | scan_interval | Time in seconds between refresh intervals |
 | lookup_file | ** The yaml file to use for parameter-definition |
 
-** This parameter is optional, and if not specified will revert to parameters.yaml. If you customize the parameters, create a lookup file "customize.yaml" and refer to it so that it will not be overwritten during updates. 
+** This parameter is optional, and if not specified will revert to deye_hybrid.yaml. If you customize the parameters, create a lookup file "custom_parameters.yaml" and refer to it so that it will not be overwritten during updates. 
 
-## Lookup Files
+### Lookup Files
 
 | Lookup File | Inverters supported | Notes |
 | --- | --- | --- |
@@ -91,19 +104,41 @@ sensor:
 | deye_string.yaml | DEYE/Sunsynk/SolArk String inverters | eg. SUN-4/5/6/7/8/10/12K-G03 Plus
 | sofar_lsw3.yaml | SOFAR Inverters
 
+# Auto-discovery
+The component has the option to auto-discover the logger IP and serial number. 
 
-## Entities
+To use auto discovery, the IP should be specified as 0.0.0.0 and/or the serial as 0
+
+NOTE:
+This should be used as a temporary or debug measure since the discovery only happens when the component starts and, if the logger is inaccessible at that point, the entities will unavailable until restart. This will not be the case when the IP and serial was specified.
+
+## Manual
+~~~ YAML
+
+sensor:
+  - platform: solarman
+    name: DEYE 
+    inverter_host: 0.0.0.0
+    inverter_port: 8899
+    inverter_serial: 0 
+    inverter_mb_slaveid: 1
+    lookup_file: deye.yaml
+~~~
+## Config-flow
+![Autodicover](./flow_init.png)
+
+# Entities
 Once the component is running, it will add the following entities to Home Assistant
 ![Entities](./entities.png)
 
-## Status Entities
+# Status Entities
 Apart from the inverter-parameters, it will also add status entities to view the status of the solarman component.
 ![Component-status](./component_status.png)
 
-## Energy Dashboard
+# Energy Dashboard
 The entities includes the device classes to enable it to be added to the [Energy Dashboard](https://www.home-assistant.io/blog/2021/08/04/home-energy-management/) introduced with Home Assistant Core 2021.8.
 
 To configure the energy dashboard with the infirmation provided by this component,  see [configuring energy dashboard](energy.md)
 
-## Customization
+# Customization
 This integration was tested agains the DEYE 5kW inverter, and it is possible that the parameter-definitions for other inverters may differ. If you want to try your hand at it, refer to [customizing parameters.yaml](customization.md)

customization.md

@@ -1,9 +1,9 @@
 # Customizing 
 
-The hart of this component is the parameter-definition file *parameters.yaml*. By changing the file, the behaviour is totally changed.
+The hart of this component is the parameter-definition file ex *deye_hybrid.yaml*. By changing the file, the behaviour is totally changed.
 
 NOTE:
-In order to leave your customized file intact during upgrades, copy the most relevan yaml file to a file called "custom_parameters.yaml, and set the "lookup_file" option in configuration.yaml to point to it.
+In order to leave your customized file intact during upgrades, copy the most relevant yaml file to a file called "custom_parameters.yaml, and set the "lookup_file" option in configuration.yaml to point to it.
 
 ~~~ YAML
 sensor: