This repository has been archived by the owner on Aug 7, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
708b45b
commit af3aec3
Showing
2 changed files
with
15 additions
and
109 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,79 +1,13 @@ | ||
| [](https://github.com/custom-components/hacs) | ||
|
|
||
| The `bom forecast` sensor platform uses the [Australian Bureau of Meteorology (BOM)](http://www.bom.gov.au) as a source for forecast meteorological data. This is an updated version of a fork from bremor/bom_forecast | ||
| This Custom Integration is now deprecated and will eventually be removed from HACS and may or may not continue to work (unless BOM changes something) | ||
| The reason for this is that Home Assistant as of version 0.117.0 have removed the BOM Sensor and Radar. | ||
|
|
||
| - Each sensor will be given the `device_id` of "bom [optionalname] friendly name units" Example: sensor.bom_gosford_chance_of_rain_0 | ||
| - A name is optional but if multiple BOM weather stations are used a name will be required. | ||
| - The sensor checks for new data every minute, starting 30 minutes after the timestamp of the most recent data as the data is updated every half-hour. | ||
| Brendan who originally wrote this component has now made a NEW BOM component that replaces both the BOM Sensor AND this FTP component. His new component uses a BOM API. | ||
|
|
||
| Thanks to @exxamalte for the code assistance to enable the new conditions. (uv_alert & fire_danger) | ||
| Please download the new [BOM Component by Brendan here] (https://github.com/bremor/bureau_of_meteorology) | ||
| and the [Radar Card by Simon here] (https://github.com/theOzzieRat/bom-radar-card) | ||
|
|
||
| ## Manual Installation | ||
| To add the BOM weather observation to your installation, create this folder structure in your /config directory: | ||
| - “custom_components/bom_forecast”. | ||
| You can add both to HACS by adding a custom repository. (Integration for BOM and Lovelace for Radar) | ||
|
|
||
| Then, drop the following files into that folder: | ||
| - \_\_init__.py | ||
| - manifest.json | ||
| - sensor.py | ||
|
|
||
| ## HACS Support | ||
| This integration is now part of the default HACS store. You should not need to add it manually. Add this Integration to HACS repo is https://github.com/DavidFW1960/bom_forecast | ||
|
|
||
| ## Configuration | ||
| Either install the package [weather.yaml](https://github.com/DavidFW1960/bom_forecast/blob/master/weather.yaml) (see below under alternate installation) | ||
|
|
||
| Or manually, add the following to your `configuration.yaml` file: | ||
|
|
||
| ```yaml | ||
| # Example configuration.yaml entry | ||
| sensor: | ||
| - platform: bom_forecast | ||
| product_id: !secret my_bom_product_id | ||
| name: !secret my_bom_name #In my examples I use Gosford | ||
| forecast_days: 6 | ||
| rest_of_today: true | ||
| friendly: false | ||
| friendly_state_format: '{max}, {summary}' | ||
| monitored_conditions: | ||
| - 'max' | ||
| - 'min' | ||
| - 'chance_of_rain' | ||
| - 'possible_rainfall' | ||
| - 'summary' | ||
| - 'detailed_summary' | ||
| - 'icon' | ||
| - 'uv_alert' | ||
| - 'fire_danger' | ||
| ``` | ||
| This example uses the secrets.yaml file for the product_id and name. Up to you if you want to do this or not. | ||
| If you use the package below you will still need to edit in the correct details. | ||
| To get the Product ID for any BOM city: | ||
| - Go to [this](http://www.bom.gov.au/nsw/observations/map.shtml) website and search for "City Forecast", or "Town Forecast". | ||
| - The Product ID for your city will be in the left most column, or at the bottom of the page, and will look like "IDV10450" | ||
|  | ||
| NOTE: The product id will be DIFFERENT to the one you use for the Core BOM Sensor Configuration. The numbers will not be the same. | ||
| Configuration variables: | ||
| - **product_id** (*Optional*): The Product ID string as identified from the BOM website. If not given, defaults to the closest city. | ||
| - **name** (*Optional*): The name you would like to give to the weather forecast. | ||
| - **forecast_days** (*Optional*): The number of days of forecast you would like, maximum is 6. If not given, defaults to 6. | ||
| - **rest_of_today** (*Optional*): Would you like to create a sensor for the forecast for the rest of today. Defaults to true. | ||
| - **friendly** (*Optional*): Friendly mode will only create one sensor per day of forecast, and will have all the forecast information as sensor attributes. Defaults to false. | ||
| - **friendly_state_format** (*Optional*): Friendly state format allows you to format the state of your forecast sensors when in friendly mode. For example, '{min} to {max}, {summary}' will display the state as '10 to 25, Cloudy'. Defaults to '{summary}'. | ||
| - **monitored_conditions** (*Required*): A list of the conditions to monitor. | ||
| ## Alternate Install | ||
| Download my [weather.yaml](https://github.com/DavidFW1960/bom_forecast/blob/master/weather.yaml) package (NOTE: The Template sensors as of 0.115.x have deprecated the entity_id. If you are using HA prior to 0.115.x there is an older weather pre0.115.s.yaml file you can use) and install in your /config/packages folder. Make sure your configuration.yaml includes packages folder. You will also need to download [bom_icons.zip](https://github.com/DavidFW1960/bom_forecast/blob/master/bom_icons.zip) in order to be able to create the lovelace cards looking like this: | ||
|  | ||
| The package also 'fixes' the problem whereby the maximum and minimum temperatures are no longer reported by BOM as it will use todays max and the minimum for the day when these values are not returned. It also includes the current text which is used in my [custom_card for BOM](https://github.com/DavidFW1960/bom-weather-card). NOTE: This example and template sensors need the HA Core BOM component to be configured otherwise there won't be any way to get the temperature history. | ||
| BOM also changes the icon displayed for some of their icons at night so there is in the package an automation to take care of that at 6pm. | ||
| The Lovelace card, [lovelace.yaml](https://github.com/DavidFW1960/bom_forecast/blob/master/lovelace.yaml) should be cut/pasted into your lovelace where you want to see the card. | ||
| Note that my custom animated card works with the new component but will require some changes to the configuration. I will detail this in the repo for the card. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,15 @@ | ||
| [](https://github.com/custom-components/hacs) | ||
|
|
||
| The bom forecast sensor platform uses the Australian Bureau of Meteorology (BOM) as a source for forecast meteorological data. This is an updated version of a fork from bremor/bom_forecast | ||
| ## IMPORTANT NOTE | ||
|
|
||
| This Custom Integration is now deprecated and will eventually be removed from HACS and may or may not continue to work (unless BOM changes something) | ||
| The reason for this is that Home Assistant as of version 0.117.0 have removed the BOM Sensor and Radar. | ||
|
|
||
| Each sensor will be given the device_id of "bom [optionalname] friendly name units" Example: sensor.bom_gosford_chance_of_rain_0 | ||
| A name is optional but if multiple BOM weather stations are used a name will be required. | ||
| The sensor checks for new data every minute, starting 30 minutes after the timestamp of the most recent data as the data is updated every half-hour. | ||
| Brendan who originally wrote this component has now made a NEW BOM component that replaces both the BOM Sensor AND this FTP component. His new component uses a BOM API. | ||
|
|
||
| Thanks to @exxamalte for the code assistance to enable the new conditions. | ||
| See the new uv_alert and fire_danger monitored conditions. Checkout readme in the repository for full details. | ||
| Please download the new [BOM Component by Brendan here] (https://github.com/bremor/bureau_of_meteorology) | ||
| and the [Radar Card by Simon here] (https://github.com/theOzzieRat/bom-radar-card) | ||
|
|
||
| With this component you can create a lovelace card like this: | ||
| You can add both to HACS by adding a custom repository. (Integration for BOM and Lovelace for Radar) | ||
|
|
||
|
|
||
|  | ||
|
|
||
|
|
||
|
|
||
| Or you can combine with the BOM Weather Custom Card. | ||
|
|
||
|
|
||
| Full configuration for this component will look like this: | ||
|
|
||
| ```yaml | ||
| - platform: bom_forecast | ||
| product_id: !secret my_bom_product_id | ||
| name: !secret my_bom_name | ||
| forecast_days: 6 | ||
| rest_of_today: true | ||
| friendly: false | ||
| friendly_state_format: '{max}, {summary}' | ||
| monitored_conditions: | ||
| - 'max' | ||
| - 'min' | ||
| - 'chance_of_rain' | ||
| - 'possible_rainfall' | ||
| - 'summary' | ||
| - 'detailed_summary' | ||
| - 'icon' | ||
| - 'uv_alert' | ||
| - 'fire_danger' | ||
| ``` | ||
| Note that my custom animated card works with the new component but will require some changes to the configuration. I will detail this in the repo for the card. |