https://github.com/ironsheep/lovelace-lightning-detector-card
A Lightning Detection Display Card for Home Assistant Lovelace
https://github.com/ironsheep/lovelace-lightning-detector-card
as3935 hassio home-assistant home-assistant-custom homeassistant lovelace-card lovelace-custom-card
Last synced: 11 days ago
JSON representation
A Lightning Detection Display Card for Home Assistant Lovelace
- Host: GitHub
- URL: https://github.com/ironsheep/lovelace-lightning-detector-card
- Owner: ironsheep
- License: mit
- Created: 2020-06-19T04:42:02.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T15:47:05.000Z (over 2 years ago)
- Last Synced: 2025-05-07T03:47:50.529Z (11 days ago)
- Topics: as3935, hassio, home-assistant, home-assistant-custom, homeassistant, lovelace-card, lovelace-custom-card
- Language: TypeScript
- Homepage:
- Size: 885 KB
- Stars: 25
- Watchers: 3
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Lovelace Lightning Detector Card
![Project Maintenance][maintenance-shield]
[![hacs_badge][hacs-shield]](https://github.com/custom-components/hacs)
[![License][license-shield]](LICENSE)
[![GitHub Release][releases-shield]][releases]
I picked up an inexpensive lightning detector sensor based on the AS3925 integrated circuit on a small circuit board from [Sparkfun](https://www.sparkfun.com) (_where i spend too much money ;-)_) and attached it to one of my Raspberry Pi's that I had sitting around. I then installed my software ([see my detector project](https://github.com/ironsheep/lightning-detector-MQTT2HA-Daemon)) to talk to the AS3935 on the RPi and forward what it detected to my MQTT broker which was then forwarded on to my Home Assistant installation. This Lovelace Card provides a means to display this lighting detector data in an easily interpreted form.
### Where to get the AS3935 sensor board
Please visit my sensor project for detail on how/where to get the sensor and for the software needed to send the data to Home Assistant. [See my [lightning-detector-MQTT2HA-Daemon](https://github.com/ironsheep/lightning-detector-MQTT2HA-Daemon) project.]
## About this card
This is a Lovelace card showing you lightning in your local area **as detected by your own inexpensive sensor**. The card has range-rings that when colored indicate that lightning was detected at that range. There are additional details describing when the detections first started (Storm began) how frequent and how stong the detections are (relative power).
With this card you can see a storm approach and how strong it is and when it leaves. You'll also see storm details such as when it started and when it ended.
Here are a couple videos showing the card in action:
- [Storm passing nearby](https://youtu.be/JqDANkaNPYQ) - youtube
- [Storm passing overhead](https://youtu.be/8p5WBOeDCfc) - youtube
----
If you like my work and/or this has helped you in some way then feel free to help me out for a couple of :coffee:'s or :pizza: slices!
[](https://www.buymeacoffee.com/ironsheep)
----
## Installation
Use [HACS](https://github.com/custom-components/hacs) (recommended)
or download _lightning-detector-card.js_ from our [Latest Release](https://github.com/ironsheep/lovelace-lightning-detector-card/releases/latest) and place it in your www directory.
In your ui-lovelace.yaml (or resources.yaml, whichever you use for resources) add this:
```yaml
- url: /hacsfiles/lovelace-lightning-detector-card/lightning-detector-card.js
type: module
```
If you don't use HACS please change the url accordingly.
## Card Configuration
| Name | Type | Default | Description |
| ----- | ------ | ------------- | ------------ |
| type | string | none | 'custom:lightning-detector-card'|
| entity | string | none | use `sensor.current_ringset` or `sensor.past_ringset` (where "sensor" may be different in your installation) |
| name | string | none | Override name for card |
| show_name | bool | false | use true/false to show/hide name |
### Example Lovelace Card Configuration
*This following example is from my current test installation.*
```yaml
- type: 'custom:lightning-detector-card'
entity: sensor.current_ringset
name: "Lightning Detector"
show_name: false
- type: 'custom:lightning-detector-card'
entity: sensor.past_ringset
name: "Lightning Detector (Prior)"
show_name: false
```
### Sensor settings affecting this display
The Lightning MQTT Daemon sends some settings to this card. These settings are:
| Name | Type | Default | Description |
| ----------------------- | ------ | ------- | -------------------------------------------------------------------- |
| period_in_minutes | number | 5 | display detections during this period. |
| number_of_rings | number | 5 | number of rings [3-7] |
| distance_as | string | km | distance units [km, mi] |
| end_storm_after_minutes | number | 30 | mark storm ended after no further detections during this end period. |
To change any of these you'll want to modify the _config.ini_ for your sensor and restart it. This card will then automatically pick up the new values.
## Credits
- [iantrich](https://github.com/iantrich) for the card template and cards you've created which made my implementation effort much easier.
- [RomRider](https://github.com/RomRider) for color handling examples as well as other techniques I "borrowed".
## License
Copyright © 2020 Iron Sheep Productions, LLC. All rights reserved.
Licensed under the MIT License.
Follow these links for more information:
### [Copyright](copyright) | [License](LICENSE)
[maintenance-shield]: https://img.shields.io/badge/maintainer-S%20M%20Moraco%20%40ironsheepbiz-blue.svg?style=for-the-badge
[hacs-shield]: https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge
[license-shield]: https://camo.githubusercontent.com/bc04f96d911ea5f6e3b00e44fc0731ea74c8e1e9/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f69616e74726963682f746578742d646976696465722d726f772e7376673f7374796c653d666f722d7468652d6261646765
[releases-shield]: https://img.shields.io/github/release/ironsheep/lovelace-lightning-detector-card.svg?style=for-the-badge
[releases]: https://github.com/ironsheep/lovelace-lightning-detector-card/releases