HA-NotifyHelper

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

HA-NotifyHelper

★ 14 Open GitHub ↗

Home Assistant custom integration for notification./Home Assistant 通知助手整合

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Contributors][contributors-shield]][contributors-url]
 [![Forks][forks-shield]][forks-url]
 [![Stargazers][stars-shield]][stars-url]
 [![Issues][issues-shield]][issues-url]
 [![License][license-shield]][license-url]

[contributors-shield]: https://img.shields.io/github/contributors/kukuxx/HA-NotifyHelper.svg?style=for-the-badge
 [contributors-url]: https://github.com/kukuxx/HA-NotifyHelper/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/kukuxx/HA-NotifyHelper.svg?style=for-the-badge
 [forks-url]: https://github.com/kukuxx/HA-NotifyHelper/network/members

[stars-shield]: https://img.shields.io/github/stars/kukuxx/HA-NotifyHelper.svg?style=for-the-badge
 [stars-url]: https://github.com/kukuxx/HA-NotifyHelper/stargazers

[issues-shield]: https://img.shields.io/github/issues/kukuxx/HA-NotifyHelper.svg?style=for-the-badge
 [issues-url]: https://github.com/kukuxx/HA-NotifyHelper/issues

[license-shield]: https://img.shields.io/github/license/kukuxx/HA-NotifyHelper.svg?style=for-the-badge
 [license-url]: https://github.com/kukuxx/HA-NotifyHelper/blob/main/LICENSE

![image](https://raw.githubusercontent.com/kukuxx/HA-NotifyHelper/master/doc/icon.png)

# HA-Notifyhelper

- [English](/README.md) | [繁體中文](/doc/README-zh-TW.md)

> This is a Home assistant custom integration, It allows you to send notifications to all mobile devices of a person at once and display notifications on a custom Lovelace card, and supports the configuration of multi-person exclusive notification card.

> Thanks to Mark Wu for some ideas and tests.

> [!Tip]
> If you keep getting notifications for old pictures or videos, please see 
<a href='https://community.home-assistant.io/t/home-assistant-sends-cached-images-in-ios-notification/520766'>here.</a>

> [!Tip]
> If you encounter a bug during use, 
> please enable debug mode in the integration and try the original operation, 
> then open issues and post the log.

## Changelog

> [CHANGELOG](/CHANGELOG.md)

## Instructions for use

- It is recommended to use HACS to install. If you want to install manually,
 please put the notifyhelper folder in custom_components folder, 
 and restart Home assistant.

[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=kukuxx&repository=HA-NotifyHelper&category=Integration)

- After the restart is completed, search for notifyhelper in the integration and set it up: 
![image](https://raw.githubusercontent.com/kukuxx/HA-NotifyHelper/master/doc/settings.png)

> [!Tip]
> Only 500 notifications can be saved. 
> If more than 500 notifications are stored,
> they will be deleted starting from the oldest one.

- The method of calling the service is similar to the built-in notify.mobile_app service.
 The following is an automation example:
```
 alias: test1
 description: ""
 triggers:
 - trigger: event
 event_type: ""
 conditions: []
 actions:
 - sequence:
 - action: notify.notify_person
 data:
 title: Test Notification
 message: This is a test message.
 targets:
 - person.you
 - person.other
 color:
 data:
 image: /local/icon.png
 mode: single
```
> [!Important]
> The iOS badge is automatically configured and requires no manual setup. The URL can be specified during integration setup, but any URL defined in automation will override the default.

> [!Tip]
> targets: must be a list. 
> color: Optional, specify the message color please fill in Hex rgb,
> the default is None. 
> data: Optional, Refer to <a href='https://companion.home-assistant.io/docs/notifications/notifications-basic'>HA doc.</a>

- The data parameters accepted by Android and ios are different, if you want to set them separately, you can add ios and android to the data.
 The following is an automation example:
```
 alias: test1
 description: ""
 triggers:
 - trigger: event
 event_type: ""
 conditions: []
 actions:
 - sequence:
 - action: notify.notify_person
 data:
 title: Test Notification
 message: This is a test message.
 targets:
 - person.you
 - person.other
 color: 
 data:
 ios:
 image: /local/icon.png
 push:
 sound:
 name: US-EN-Morgan-Freeman-Roommate-Is-Arriving.wav
 volume: 0.3
 critical: 1
 android:
 image: /local/icon.png
 mode: single
```

> [!Tip]
> If the set parameters are all universal,
you can use the first example without adding ios and android. 
> You can send different photos or videos for ios and android but the notification will only save one of them, please be aware of this.

- Notifications card configuration:
```
    type: custom:notifications-card
    person_name:  // yourname, e.g.:John
    font_size: optional       // text size, default 16px
    line_height: optional    // line spacing ratio, default 1.0

```

- Button card configuration:
```
 show_name: true
 show_icon: true
 type: button
 tap_action:
 action: perform-action
 perform_action: notifyhelper.read
 target: {}
 data:
 targets:
 - person.you
```
> [!Tip]
> targets: must be a list.

> [!NOTE]
> You don’t necessarily need to create a button card to mark notifications as read. 
> You can also use automation to call the service. 
> The same applies to clear notifications. 
> Please configure it according to your personal needs.

## Achievements Display

![gif](https://raw.githubusercontent.com/kukuxx/HA-NotifyHelper/master/doc/display.gif)

HA-NotifyHelper

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README