Merge pull request #52 from schizza/readme_update

readme_update

README.md

@@ -1,24 +1,33 @@
-# Integrates your SWS 12500 weather station seamlessly into Home Assistant
+# Integrates your Sencor SWS 12500 or 16600, GARNI, BRESSER weather stations seamlessly into Home Assistant
 
 This integration will listen for data from your station and passes them to respective sensors. It also provides the ability to push data to Windy API.
 
 _This custom component replaces [old integration via Node-RED and proxy server](https://github.com/schizza/WeatherStation-SWS12500)._
 
-# Warning - FW 3.0 for SWS 12500!
+## Warning - WSLink APP (applies also for SWS 12500 with firmware >3.0)
 
-As by now, it is strongly recommended **not to update to FW 3.0.**
-This firmware seems to be buggy in sending data to Home Assistant withou SSL settings.
-_**I am working of this issue and it is not resloved by now.**_
+For stations that are using WSLink app to setup station and WSLink API for resending data (SWS 12500 manufactured in 2024 and later). You will need to install [WSLink SSL proxy addon](https://github.com/schizza/wslink-addon) to your Home Assistant if you are not running your Home Assistant instance in SSL mode or you do not have SSL proxy for your Home Assistant.
 
 ## Requirements
 
-- [Sencor SWS 12500 Weather Station](https://www.sencor.cz/profesionalni-meteorologicka-stanice/sws-12500).
+- Weather station that supports sending data to custom server in their API [(list of supported stations.)](#list-of-supported-stations)
 - Configure station to send data directly to Home Assistant.
 - If you want to push data to Windy, you have to create an account at [Windy](https://stations.windy.com).
 
+## List of supported stations
+
+- [Sencor SWS 12500 Weather Station](https://www.sencor.cz/profesionalni-meteorologicka-stanice/sws-12500)
+- [Sencor SWS 16600 WiFi SH](https://www.sencor.cz/meteorologicka-stanice/sws-16600)
+- Bresser stations that support custom server upload. [for example, this is known to work](https://www.bresser.com/p/bresser-wi-fi-clearview-weather-station-with-7-in-1-sensor-7002586)
+- Garni stations with WSLink support or custom server support.
+
 ## Installation
 
-### If your station's firmware is 1.0 or your station is configured as described in this README and you still can not see any data incoming to Home Assistant please [read here](https://github.com/schizza/SWS-12500-custom-component/issues/17) and [here](firmware_bug.md)
+### If your SWS12500 station's firmware is 1.0 or your station is configured as described in this README and you still can not see any data incoming to Home Assistant please [read here](https://github.com/schizza/SWS-12500-custom-component/issues/17) and [here](firmware_bug.md)
+
+### For stations that send through WSLink API
+
+Make sure you have your Home Assistant cofigured in SSL mode or use [WSLink SSL proxy addon](https://github.com/schizza/wslink-addon) to bypass SSL configuration of whole Home Assistant.
 
 ### HACS installation
 
@@ -44,11 +53,15 @@ For manual installation you must have an access to your Home Assistant's `/confi
 
 ## Configure your station in AP mode
 
+> This configuration example is for Sencor SWS12500 with FW < 3.0
+
+> For WSLink read [this notes.](#wslink-notes)
+
 1. Hold the Wi-Fi button on the back of the station for 6 seconds until the AP will flash on the display.
 2. Select your station from available APs on your computer.
 3. Connect to the station's setup page: `http://192.168.1.1` from your browser.
 4. In the third URL section fill in the address to your local Home Assistant installation.
-5. Create new `ID` and `KEY`. You can use [online tool](https://www.allkeysgenerator.com/Random/Security-Encryption-Key-Generator.aspx) to generate random keys. _(you will need them to configure integation to Home Assistatnt)_
+5. Create new `ID` and `KEY`. You can use [online tool](https://randomkeygen.com) to generate random keys. _(you will need them to configure integration to Home Assistant)_
 6. Save your configuration.
    ![station_setup](README/station_hint.png)
 
@@ -61,7 +74,7 @@ API_KEY: PASSWORD in station's config
 
 ![config dialog](README/cfg_dialog.png)
 
-If you chanage `API ID` or `API KEY` in the station, you have to reconfigure integration to accept data from your station.
+If you change `API ID` or `API KEY` in the station, you have to reconfigure integration to accept data from your station.
 
 - In `Settings` -> `Devices & services` find SWS12500 and click `Configure`.
 - In dialog box choose `Basic - Configure credentials`
@@ -85,3 +98,23 @@ As soon as the integration is added into Home Assistant it will listen for incom
   ![enable windy](README/windy_cfg.png)
 
 - You are done.
+
+## WSLink notes
+
+While your station is using WSLink you have to have Home Assistant in SSL mode or behind SSL proxy server.
+You can bypass whole SSL settings by using [WSLink SSL proxy addon](https://github.com/schizza/wslink-addon) which is made exactly for this integration to support WSLink on unsecured installations of Home Assistant.
+
+### Configuration
+
+- Set your station as [mentioned above](#configure-your-station-in-ap-mode) while changing `HA port` to be the port number you set in the addon (443 for example) not port of your Home Assistant instance. And that will do the trick!
+
+```plain
+HomeAssistant is at 192.0.0.2:8123
+WSLink proxy addon listening on port 4443
+
+you will set URL in station to: 192.0.0.2:4443
+```
+
+- Your station will be sending data to this SSL proxy and addon will handle the rest.
+
+_Most of the stations does not care about self-signed certificates on the server side._