From 27891b49de03f98e21c321317c10514be473168e Mon Sep 17 00:00:00 2001 From: bluefoxlee Date: Mon, 10 May 2021 17:59:43 +0800 Subject: [PATCH] Update README.md --- README.md | 37 ++++++++++++++++++++++++------------- 1 file changed, 24 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 7ba19f9..7b6593a 100755 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -Buy Me A Coffee -Home assistant support for [Opendata CWB](https://opendata.cwb.gov.tw/index). [The readme in Traditional Chinese](https://github.com/tsunglung/OpenCWB/blob/master/README_zh-tw.md). + +Home assistant support for [Opendata CWB](https://opendata.cwb.gov.tw/index) (Taiwan Centtal Bureau). +[中文版說明](https://github.com/tsunglung/OpenCWB/blob/master/README_zh-tw.md). This integration is based on [OpenWeatherMap](https://openweathermap.org) ([@csparpa](https://pypi.org/user/csparpa), [pyowm](https://github.com/csparpa/pyowm)) to develop. @@ -11,29 +12,39 @@ You can install component with [HACS](https://hacs.xyz/) custom repo: HACS > Int Or manually copy `opencwb` folder to `custom_components` folder in your config folder. -Then restart HA. +And `do not forget` to restart Home Assistant. -# Setup +# Pre-reqirement -**Apply a API key in Opendata CWB** -1. Open the [Opendata CWB](https://opendata.cwb.gov.tw/devManual/insrtuction) Web Site -2. Register your account +**Apply a API key from Opendata CWB** +1. Browse to [Opendata CWB](https://opendata.cwb.gov.tw/userLogin) account page. +2. Login or [register an account](https://pweb.cwb.gov.tw/CWBMEMBER3/register/authorization). 3. Get your personal API Key. # Config -**Please use the config flow of Home Assistant** +**Please follow the config flow of Home Assistant** 1. With GUI. Configuration > Integration > Add Integration > OpneCWB - 1. If the integration didn't show up in the list please REFRESH the page - 2. If the integration is still not in the list, you need to clear the browser cache. -2. Enter API key. -3. Enter the location name of Taiwan. Please reference to the name in the [doc](https://opendata.cwb.gov.tw/opendatadoc/CWB_Opendata_API_V1.2.pdf) appendix A. - 1. Some location name need to include the city name. + a. If the integration didn't show up in the list please REFRESH the page. + b. If the integration is still not in the list, you need to clear the browser cache. +2. Enter API key from previous step. +3. Enter the location name of Taiwan (in Chinese. XD). Please reference to the offical [documents](https://opendata.cwb.gov.tw/opendatadoc/CWB_Opendata_API_V1.2.pdf) appendix A. + a. Some location name need to include the city name. + +# Option + +1. You could setup for the scan interval. One call per hour or per day. Buy Me A Coffee +If you think the add-on is useful for you, please consider to buy me a coffee for support my work. + +Buy Me A Coffee + +And for people live in Taiwan, you could use services below since Paypal might not wirk due to the goverment policy. + | LINE Pay | LINE Bank | JKao Pay | | :------------: | :------------: | :------------: | | Line Pay | Line Bank | JKo Pay |