Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add MQTT notify platform #64728

Merged
merged 29 commits into from
Mar 8, 2022
Merged

Add MQTT notify platform #64728

merged 29 commits into from
Mar 8, 2022

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Jan 22, 2022

Proposed change

Add new MQTT platform notify.
The platform implements a MQTT notify service that supports setup from configuration.yaml and auto discovery.
The platform does not generate entities but does support a device payload to be sent in auto discovery mode.
The device will be created at discovery and will be automatically be removed if the device is unregistered with an empty discovery payload. If the device is removed from the device registry it will also remove the registered notify services.

A device can support displaying notification message through a LCD or OLED screen. The notify service can be discovered automatically and message can be send from automation scripts.

The current MQTT notify documentation page is also updated.

Some real-time other applications are:
https://github.com/jpmens/mqttwarn
https://support.kaspersky.com/IoTSecureGateway/2.0/en-US/193697.htm
https://github.com/maxbachmann/mqtt-mm2-gateway a gateway to https://github.com/MichMich/MagicMirror

MQTT can be used natively for other integrations to subscribe for notitications.
https://www.academia.edu/44759428/Secure_Push_notification_service_based_on_MQTT_Protocol_for_mobile_platforms

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@probot-home-assistant
Copy link

Hey there @emontnemery, mind taking a look at this pull request as it has been labeled with an integration (mqtt) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

@jbouwh jbouwh marked this pull request as ready for review January 23, 2022 23:34
@jbouwh jbouwh marked this pull request as draft January 24, 2022 12:06
@jbouwh jbouwh marked this pull request as ready for review January 24, 2022 19:43
@jbouwh jbouwh marked this pull request as draft February 4, 2022 08:17
@jbouwh jbouwh marked this pull request as ready for review February 5, 2022 15:02
homeassistant/components/mqtt/notify.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/notify.py Outdated Show resolved Hide resolved
jbouwh and others added 3 commits February 17, 2022 13:38
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @jbouwh 👍

@emontnemery emontnemery merged commit e574a3e into home-assistant:dev Mar 8, 2022
@jbouwh jbouwh deleted the mqtt-notify branch March 9, 2022 16:04
@github-actions github-actions bot locked and limited conversation to collaborators Mar 10, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants