diff --git a/.gitignore b/.gitignore index 68bc17f..dbce267 100644 --- a/.gitignore +++ b/.gitignore @@ -158,3 +158,5 @@ cython_debug/ # and can be added to the global gitignore or merged into this file. For a more nuclear # option (not recommended) you can uncomment the following to ignore the entire idea folder. #.idea/ + +.DS_Store diff --git a/README.md b/README.md new file mode 100644 index 0000000..6e323fe --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ + +# Integrates your SWS 12500 weather station 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).* + +## Requirements + +- [Sencor SWS 12500 Weather Station](https://www.sencor.cz/profesionalni-meteorologicka-stanice/sws-12500). +- 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). + +## Installation + +### Manual installation + +For manual installation you must have an access to your Home Assistant's `/config` folder. + +- Clone this repository or download [latest release here](https://github.com/schizza/SWS-12500-custom-component/releases/latest). + +- Copy the `custom_components/sws12500-custom-component` folder to your `config/custom_components` folder in Home Assistant. +- Restart Home Assistant. +- Now go to `Integrations` and add new integration `SWS 12500` + +## Configure your station in AP mode + +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)* +6. Save your configuration. +![station_setup](README/station_hint.png) + +Once integration is added to Home Assistant, configuration dialog will ask you for `API_ID` and `API_KEY` as you set them in your station: + +```plain +API_ID: ID in station's config +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. + +- In `Settings` -> `Devices & services` find SWS12500 and click `Configure`. +- In dialog box choose `Basic - Configure credentials` + +![reconfigure dialog](README/reconfigure.png) + +As soon as the integration is added into Home Assistant it will listen for incoming data from the station and starts to fill sensors as soon as data will first arrive. + +## Resending data to Windy API + +- First of all you need to create account at [Windy stations](https://stations.windy.com). +- Once you have an account created, copy your Windy API Key. +![windy api key](README/windy_key.png) + +- In `Settings` -> `Devices & services` find SWS12500 and click `Configure`. +- In dialog box choose `Windy configuration`. +![config dialog](README/cfg.png) + +- Fill in `Key` you were provided at `Windy stations`. +- Tick `Enable` checkbox. +![enable windy](README/windy_cfg.png) + +- You are done. diff --git a/README/cfg.png b/README/cfg.png new file mode 100644 index 0000000..eae1db4 Binary files /dev/null and b/README/cfg.png differ diff --git a/README/cfg_dialog.png b/README/cfg_dialog.png new file mode 100644 index 0000000..097a45f Binary files /dev/null and b/README/cfg_dialog.png differ diff --git a/README/reconfigure.png b/README/reconfigure.png new file mode 100644 index 0000000..4fc7c3e Binary files /dev/null and b/README/reconfigure.png differ diff --git a/README/station_hint.png b/README/station_hint.png new file mode 100644 index 0000000..7fc2b04 Binary files /dev/null and b/README/station_hint.png differ diff --git a/README/windy_cfg.png b/README/windy_cfg.png new file mode 100644 index 0000000..5dd88ef Binary files /dev/null and b/README/windy_cfg.png differ diff --git a/README/windy_key.png b/README/windy_key.png new file mode 100644 index 0000000..2d7ec79 Binary files /dev/null and b/README/windy_key.png differ