Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/t1gr0u/rain-gauge-card
A Lovelace card that shows the rain gauge for Home Assistant
https://github.com/t1gr0u/rain-gauge-card
hacs home-assistant lovelace uv-index
Last synced: 3 months ago
JSON representation
A Lovelace card that shows the rain gauge for Home Assistant
- Host: GitHub
- URL: https://github.com/t1gr0u/rain-gauge-card
- Owner: t1gr0u
- License: mit
- Created: 2023-03-04T16:42:29.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-01-05T20:45:37.000Z (10 months ago)
- Last Synced: 2024-07-10T13:11:53.329Z (4 months ago)
- Topics: hacs, home-assistant, lovelace, uv-index
- Language: TypeScript
- Homepage:
- Size: 171 KB
- Stars: 38
- Watchers: 2
- Forks: 17
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Rain Gauge Card
A Lovelace card that shows the rain gauge for [Home Assistant](https://home-assistant.io/).
[![GitHub Release][releases-shield]][releases-link] [![GitHub Release Date][release-date-shield]][releases-link] [![GitHub Releases][latest-download-shield]][traffic-link] [![GitHub Releases][total-download-shield]][traffic-link]
[![HACS Badge][hacs-shield]][hacs-link] [![HomeAssistant][home-assistant-shield]][home-assistant-link] [![License][license-shield]][license-link]
![Project Maintenance][maintenance-shield] [![GitHub Activity][activity-shield]][activity-link] [![Open bugs][bugs-shield]][bugs-link] [![Open enhancements][enhancements-shield]][enhancement-link]
[![Community Forum][forum-shield]][forum-link]
## Installation
### [HACS](https://hacs.xyz/) (Home Assistant Community Store)
1. Go to HACS page on your Home Assistant instance
1. Select `Frontend`
1. Press add icon and search for `rain-gauge`
1. Select Rain Gauge Card repo and install
1. Force refresh the Home Assistant page (Ctrl + F5)
1. Add rain-gauge-card to your page
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=t1gr0u&repository=rain-gauge-card&category=plugin)
### Manual
1. Download the 'rain-gauge-card.js' from the latest [release](https://github.com/t1gr0u/rain-gauge-card/releases) (with right click, save link as)
1. Place the downloaded file on your Home Assistant machine in the `config/www` folder (when there is no `www` folder in the folder where your `configuration.yaml` file is, create it and place the file there)
1. In Home Assistant go to `Configuration->Lovelace Dashboards->Resources` (When there is no `resources` tag on the `Lovelace Dashboard` page, enable advanced mode in your account settings, and retry this step)
1. Add a new resource
1. Url = `/local/rain-gauge-card.js`
1. Resource type = `module`
1. Force refresh the Home Assistant page (Ctrl + F5)
1. Add rain-gauge-card to your page
## Using the card
- Add the card with the visual editor
- Or add the card manually with the following (minimal) configuration:
```yaml
type: custom:rain-gauge-card
entity: sensor.rain_daily
```
## Lovelace Examples
### Default
```yaml
type: custom:rain-gauge-card
entity: sensor.rain_daily
```
## Options
| Name | Type | Requirement | Description | Default |
| ----------------- | ------- | ------------ | ------------------------------------------------------------------------ | ------------------- |
| type | string | **Required** | `custom:rain-gauge-card` | |
| name | string | **Optional** | Card name | `Rain Gauge` |
| border_colour | string | **Optional** | Change the border colour | `#000000` |
| fill_drop_colour | string | **Optional** | Change the drop colour | `#04ACFF` |
| show_error | boolean | **Optional** | Show what an error looks like for the card | `false` |
| show_warning | boolean | **Optional** | Show what a warning looks like for the card | `false` |
| entity | string | **Required** | Home Assistant entity ID. | `none` |
| max_level | number | **Optional** | Override the max level in the drop (will take inches too) | `40mm` |
| language | string | **Optional** | The 2 character that determines the language | `en` |
| is_imperial | boolean | **Optional** | Switch to inches (`in`) instead of `mm` | `false` |
| hourly_rate_entity| string | **Optional** | Home Assistant entity ID to hourly rate | `none` |
| tap_action | object | **Optional** | Action to take on tap | `action: more-info` |
| hold_action | object | **Optional** | Action to take on hold | `none` |
| double_tap_action | object | **Optional** | Action to take on double tap | `none` |
## Action Options
| Name | Type | Requirement | Description | Default |
| --------------- | ------ | ------------ | -------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| action | string | **Required** | Action to perform (more-info, toggle, call-service, navigate url, none) | `more-info` |
| navigation_path | string | **Optional** | Path to navigate to (e.g. /lovelace/0/) when action defined as navigate | `none` |
| url | string | **Optional** | URL to open on click when action is url. The URL will open in a new tab | `none` |
| service | string | **Optional** | Service to call (e.g. media_player.media_play_pause) when action defined as call-service | `none` |
| service_data | object | **Optional** | Service data to include (e.g. entity_id: media_player.bedroom) when action defined as call-service | `none` |
| haptic | string | **Optional** | Haptic feedback _success, warning, failure, light, medium, heavy, selection_ | `none` |
| repeat | number | **Optional** | How often to repeat the `hold_action` in milliseconds. | `none` |
### Language
The following languages are supported:
| Language | Yaml value | Supported | Translated by |
| --------- | ---------- | --------- | ----------------------------------------------------------------------------------- |
| Czech | `cs` | v1.3.1 | [@MiisaTrAnCe](https://github.com/MiisaTrAnCe) |
| Danish | `da` | v1.3.1 | [@Tntdruid](https://github.com/Tntdruid) |
| Dutch | `nl` | v1.3.1 | [@jobvk](https://github.com/jobvk) |
| English | `en` | v1.0.0 | [@t1gr0u](https://github.com/t1gr0u) |
| French | `fr` | v1.0.0 | [@t1gr0u](https://github.com/t1gr0u) |
| Italian | `it` | v1.4.0 | [@StefanoGiugliano](https://github.com/StefanoGiugliano) |
| German | `de` | v1.3.1 | [@AndLindemann](https://github.com/AndLindemann) |
| Hungarian | `ha` | v1.3.1 | [@erelke](https://github.com/erelke) |
| Portuguese| `pt` | v1.1.0 | [@ViPeR5000](https://github.com/viper5000) |
| Slovakia | `sk` | v1.4.0 | [@milandzuris](https://github.com/milandzuris) |
| Slovenian | `sl` | v1.1.0 | [@mnheia](https://github.com/mnheia) |
| Swedish | `sv` | v1.4.0 | [@tangix](https://github.com/tangix) |
#### How to add a language
If you wish to add a language please follow these steps:
* Go into the `src/localize/languages/` folder
* Duplicate the `en.json` and name it as the language that you would like to add by following the [2 characters ISO language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
* Then modify the `localize.ts` file, located in `src/localize/` to include your language file.
* Update the `Readme.md`, found in `src/` to include your language and your Github username in the language table.
## Thanks to
- [@iantrich](https://www.github.com/iantrich) for the [boiler-plate card](https://github.com/custom-cards/boilerplate-card), which got me started
## Support
Clone and create a PR to help make the card even better.
[releases-shield]: https://img.shields.io/github/release/t1gr0u/rain-gauge-card.svg?style=flat-square
[releases-link]: https://github.com/t1gr0u/rain-gauge-card/releases/latest
[release-date-shield]: https://img.shields.io/github/release-date/t1gr0u/rain-gauge-card?style=flat-square
[latest-download-shield]: https://img.shields.io/github/downloads/t1gr0u/rain-gauge-card/latest/total?style=flat-square&label=downloads%20latest%20release
[total-download-shield]: https://img.shields.io/github/downloads/t1gr0u/rain-gauge-card/total?style=flat-square&label=total%20views
[traffic-link]: https://github.com/t1gr0u/rain-gauge-card/graphs/traffic
[hacs-shield]: https://img.shields.io/badge/HACS-Default-orange.svg?style=flat-square
[hacs-link]: https://github.com/custom-components/hacs
[home-assistant-shield]: https://img.shields.io/badge/Home%20Assistant-visual%20editor/yaml-green?style=flat-square
[home-assistant-link]: https://www.home-assistant.io/
[license-shield]: https://img.shields.io/github/license/custom-cards/boilerplate-card.svg?style=flat-square
[license-link]: LICENSE.md
[activity-shield]: https://img.shields.io/github/commit-activity/y/t1gr0u/rain-gauge-card.svg?style=flat-square
[activity-link]: https://github.com/t1gr0u/rain-gauge-card/commits/master
[bugs-shield]: https://img.shields.io/github/issues/t1gr0u/rain-gauge-card/bug?color=red&style=flat-square&label=bugs
[bugs-link]: https://github.com/t1gr0u/rain-gauge-card/labels/bug
[enhancements-shield]: https://img.shields.io/github/issues/t1gr0u/rain-gauge-card/enhancement?color=blue&style=flat-square&label=enhancements
[enhancement-link]: https://github.com/t1gr0u/rain-gauge-card/labels/enhancement
[maintenance-shield]: https://img.shields.io/maintenance/yes/2023.svg?style=flat-square