BOM Radar Card

A Home Assistant rain radar card using the new tiled images from the Australian BOM

Support

Hey dude! Help me out for a couple of 🍻 or a ☕!

Description

The new Austalian BOM radar products (mobile app and https://weather.bom.gov.au/) now use map tiles to distribute the radar images. This allow for one continous map that can be zoomed and panned seamlessly. This card allows this to be displayed within Home Assistant. The one drawback of the new system is that currently the BOM only publishes new tiles every 10 minutes (compared to 6 minutes with the old radar products) and there is a bigger lag in them being published. This results in the most recent radar image being between 10 to 20 minutes old at any point in time. The upside is that the radar tiles are available for a much longer time frame. This means you can create radar loops of up to at least 24 hours.

Options

Name	Type	Requirement	Description	Default
type	string	Required		must be `'custom:bom-radar-card'`
center_latitude	number	Optional	The initial center latitude of the map	`-27.85`
center_longitude	number	Optional	The initial center longitude of the map	`133.75`
zoom_level	number	Optional	The initial zoom level, can be from 4 to 10	`4`
frame_delay	number	Optional	The number of milliseconds to show each frame	`500`
frame_count	number	Optional	The number of frames to use in the loop	`10`
show_marker	boolean	Optional	Show the home icon at the marker position	`false`
marker_latitude	number	Optional	The latitude for the home icon if enabled	the same as center_latitude
marker_longitude	number	Optional	The longitude for the home icon if enabled	the same as center_longitude
show_range	boolean	Optional	Show range rings around marker position	`false`
show_scale	boolean	Optional	Show a scale in the bottom left corner	`false`
show_zoom	boolean	Optional	Show the zoom controls in the top left corner	`false`
show_recenter	boolean	Optional	Show the re-center control in the bottom right toolbar	`false`
show_playback	boolean	Optional	Show the playback controls in the bottom right toolbar	`false`
extra_labels	boolean	Optional	Show more town labels (labels become smaller)	`false`
map_style	string	Optional	Specifies the style for the map	`'light'` see section below for valid values
static_map	boolean	Optional	Set to true to disable all panning and zooming	`false`
show_radar_coverage	boolean	Optional	Show an overlay of the radar coverage	`false`
show_radar_location	boolean	Optional	Show an cirlce at radar sites	`false`
radar_location_radius	number	Optional	Set the radius of the location circles	2
radar_location_line_colour	string	Optional	Set the colour of the outer line of the location circles	`'#00FF00'` green
radar_location_fill_colour	string	Optional	Set the colour of the fill of the location circles	`'#FF0000'` red
square_map	boolean	Optional	Will keep the map square (not in panel mode)	`false`

Map style

Specifies the style of map to use. Valid values are 'light', 'dark', 'voyager' and 'satellite'. These are based off the Carto and ESRI map styles that are available.

Samples

This is the configuration used to generate the radar loop on this page.

type: 'custom:bom-radar-card'
frame_count: 10
center_latitude: -25.567607
center_longitude: 152.930597
marker_latitude: -26.175328
marker_longitude: 152.653189
show_marker: true
show_range: true
show_zoom: true
show_recenter: true
show_playback: true
zoom_level: 8

This will display a radar for the whole of Australia showing the previous 24 hours of radar images with a 100mSec delay between frames.

type: 'custom:bom-radar-card'
frame_count: 144
frame_delay: 100
marker_latitude: -33.857058
marker_longitude: 151.215179
show_marker: true
show_range: false

Install

If you use HACS, the resources will automatically be configured with the needed file. The repository needs to be added as a custom repository within HACS. Go to HACS-Frontend, click on the three dots at the top right and select Custom Repositories. For the URL enter https://github.com/makin-things/bom-radar-card and for Category choose Lovelace. Click Add. Now the card will show up HACS for installation.

If you don't use HACS (seriously you should as it makes life so much easier), you can download the required files from latest releases. Drop all of the files in www/community/bom-radar-card folder in your config directory. It should look like this:

    └── ...
    └── configuration.yaml
    └── www
        └── community
            └── bom-radar-card
                └── bom-radar-card.js
                └── home-circle-dark.svg
                └── home-circle-light.svg
                └── leaflet.css
                └── leaflet.js
                └── leaflet.toolbar.min.css
                └── leaflet.toolbar.min.js
                └── pause.png
                └── play.png
                └── radar-colour-bar.png
                └── recenter.png
                └── recenter.png
                └── skip-next.png

Next add the following entry in lovelace configuration:

resources:
  - url: /local/community/bom-radar-card/bom-radar-card.js
    type: module

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Makin-Things / bom-radar-card

Programming Languages

Labels