{"id":20935356,"url":"https://github.com/lab02-research/hass.agent-notifier","last_synced_at":"2025-05-13T20:32:43.519Z","repository":{"id":40300288,"uuid":"431440766","full_name":"LAB02-Research/HASS.Agent-Notifier","owner":"LAB02-Research","description":"HASS.Agent Notifier integration. Adds notifications to HASS.Agent - a Windows based client for Home Assistant.","archived":false,"fork":false,"pushed_at":"2022-11-17T13:29:03.000Z","size":45,"stargazers_count":67,"open_issues_count":1,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2023-03-05T17:49:43.025Z","etag":null,"topics":["hacs","home-assistant","integration","notifications"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LAB02-Research.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"LAB02-Admin","ko_fi":"lab02research"}},"created_at":"2021-11-24T10:29:48.000Z","updated_at":"2023-01-12T09:25:36.000Z","dependencies_parsed_at":"2023-01-22T11:16:22.143Z","dependency_job_id":null,"html_url":"https://github.com/LAB02-Research/HASS.Agent-Notifier","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LAB02-Research%2FHASS.Agent-Notifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LAB02-Research%2FHASS.Agent-Notifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LAB02-Research%2FHASS.Agent-Notifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LAB02-Research%2FHASS.Agent-Notifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LAB02-Research","download_url":"https://codeload.github.com/LAB02-Research/HASS.Agent-Notifier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225258922,"owners_count":17445838,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacs","home-assistant","integration","notifications"],"created_at":"2024-11-18T22:14:32.625Z","updated_at":"2024-11-18T22:14:33.179Z","avatar_url":"https://github.com/LAB02-Research.png","language":"Python","funding_links":["https://github.com/sponsors/LAB02-Admin","https://ko-fi.com/lab02research","https://www.buymeacoffee.com/lab02research"],"categories":[],"sub_categories":[],"readme":"[![Validate](https://github.com/LAB02-Research/HASS.Agent-Notifier/workflows/Validate/badge.svg)](https://github.com/LAB02-Research/HASS.Agent-Notifier/actions?query=workflow:\"Validate\")\r\n[![GitHub release](https://img.shields.io/github/release/LAB02-Research/HASS.Agent-Notifier?include_prereleases=\u0026sort=semver\u0026color=blue)](https://github.com/LAB02-Research/HASS.Agent-Notifier/releases/)\r\n[![License](https://img.shields.io/badge/License-MIT-blue)](#license)\r\n[![buymeacoffee](https://img.shields.io/badge/BuyMeACoffee-Donate-blue.svg)](https://www.buymeacoffee.com/lab02research)\r\n[![Discord](https://img.shields.io/badge/dynamic/json?color=blue\u0026label=Discord\u0026logo=discord\u0026logoColor=white\u0026query=presence_count\u0026suffix=%20Online\u0026url=https://discordapp.com/api/guilds/932957721622360074/widget.json)](https://discord.gg/nMvqzwrVBU)\r\n\r\n[![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg)](https://github.com/hacs/integration)\r\n\r\n\r\n# HASS.Agent Notifier\r\n\r\n⚠️❗**YOU DON'T NEED THIS INTEGRATION IF YOU'RE USING THE NEW [HASS.AGENT](https://github.com/LAB02-Research/HASS.Agent-Integration) INTEGRATION!** ❗⚠️ \r\n\r\n----\r\n\r\nNote: this integrations has been replaced by the [new integration](https://github.com/LAB02-Research/HASS.Agent-Integration). It will keep working, but for new functionality, consider switching to the new one.\r\n\r\n----\r\n\r\nThis \u003ca href=\"https://www.home-assistant.io\" target=\"_blank\"\u003eHome Assistant\u003c/a\u003e integration allows you to send notifications to \u003ca href=\"https://github.com/LAB02-Research/HASS.Agent\" target=\"_blank\"\u003eHASS.Agent\u003c/a\u003e, a Windows-based Home Assistant client.\r\n\r\nNeed help? Check [the documentation](https://hassagent.readthedocs.io/), visit the \u003ca href=\"https://community.home-assistant.io/t/hass-agent-a-new-windows-based-client-to-receive-notifications-perform-quick-actions-and-much-more/369094\" target=\"_blank\"\u003ededicated HA forum thread\u003c/a\u003e or \u003ca href=\"https://discord.gg/nMvqzwrVBU\" target=\"_blank\"\u003ejoin on Discord\u003c/a\u003e.\r\n\r\nNote: it won't be of much use if you don't have HASS.Agent installed \u0026 configured on at least one PC (or Windows based device).\r\n\r\n----\r\n\r\n### Contents\r\n\r\n * [Functionality](#functionality)\r\n * [Installation](#installation)\r\n * [Configuration](#configuration)\r\n * [Installation and Configuration Summary](#installation-and-configuration-summary)\r\n * [Usage](#usage)\r\n * [Help](#help)\r\n * [Debugging](#debugging)\r\n * [License](#license)\r\n\r\n----\r\n\r\n### Functionality\r\n\r\nSend normal (text-based) and image notifications, and configure them to be *actionable* to directly interact with Home Assistant.\r\n\r\n----\r\n\r\n### Installation\r\n\r\nThe easiest way to install is to use \u003ca href=\"https://hacs.xyz\" target=\"_blank\"\u003eHACS\u003c/a\u003e. Simply search for **HASS.Agent Notifier**, install and restart Home Assistant.\r\n\r\nIf you want to manually install, copy the `hass_agent_notifier` folder into the `config\\custom_components` folder of your Home Assistant instance, and restart.\r\n\r\n----\r\n\r\n### Configuration\r\n\r\nThis integration exposes itself as a \u003ca href=\"https://www.home-assistant.io/integrations/notify/\" target=\"_blank\"\u003enotifications integration\u003c/a\u003e, and can be configured by adding this snippet in your `configuration.yaml` file:\r\n\r\n```yaml\r\nnotify: \r\n  name: \"hass agent test device\"\r\n  platform: hass_agent_notifier\r\n  resource: http://{device_ip}:5115/notify\r\n```\r\n\r\nReplace `{device_ip}` with the IP of the device that has an HASS.Agent instance running. To find your IP, run `ipconfig` in a command prompt on your PC. Look for the value after `IPv4 Address`. Optionally replace `5115` if you've configured a different port, normally you shouldn't have to.\r\n\r\nRestart Home Assistant to load your configuration.\r\n\r\nThe port needs to be open on the target device. HASS.Agent will offer to do this for you during the onboarding process. \r\nTo do so manually, you can run this command in an elevated prompt:\r\n\r\n`netsh advfirewall firewall add rule name=\"HASS.Agent Notifier\" dir=in action=allow protocol=TCP localport=5115`\r\n\r\n----\r\n\r\n### Installation and Configuration Summary\r\n\r\nQuick summary to get things working:\r\n\r\n- Install **HASS.Agent-Notifier** integration, either through HACS or manually\r\n- Reboot Home Assistant\r\n- Create a `notify` entity, make sure you enter the right IP for your PC\r\n- Reboot Home Assistant\r\n- Start adding the new entity to your automations \u0026 scripts :)\r\n\r\n----\r\n\r\n### Usage\r\n\r\n#### General\r\n\r\nCurrently, there are four variables you can set:\r\n\r\n * `message`: the message you want to show\r\n * `title`: the title of your popup [optional]\r\n * `image`: http(s) url containing the location of an image [optional]\r\n * `duration`: duration (in seconds) for which the popup will be shown [optional]\r\n\r\n#### Text notification\r\n\r\n```yaml\r\n  action:\r\n    - service: notify.hass_agent_test_device\r\n      data:\r\n        message: \"This is a test message.\"\r\n```\r\n\r\n#### Text notification with title and duration\r\n\r\n```yaml\r\n  action:\r\n    - service: notify.hass_agent_test_device\r\n      data:\r\n        message: \"This is a test message with title and 3 sec duration.\"\r\n        title: \"HASS.Agent Test\"\r\n        data:\r\n          duration: 3\r\n```\r\n\r\n#### Image notification\r\n\r\n```yaml\r\n  action:\r\n    - service: notify.hass_agent_test_device\r\n      data:\r\n        message: \"This is a test message with an image.\"\r\n        data:\r\n          image: \"http://10.0.0.6:1234/jpeg/image.jpg\"\r\n```\r\n\r\n#### Camera Proxy\r\n\r\nAs pointed out by [@brianhanifin]( https://github.com/brianhanifin ) in \u003ca href=\"https://github.com/LAB02-Research/HASS.Agent/issues/5\" target=\"_blank\"\u003ethis issue\u003c/a\u003e, you can also use Home Assistant's camera proxy. This way you don't have to share the credentials etc. of your camera. Home Assistant will provide a token that's valid for 5 minutes, so it's safe to use.\r\n\r\nExample script:\r\n\r\n```yaml\r\nnotification_test:\r\n  alias: Notification Test\r\n  variables:\r\n    image: |\r\n      {%- set image = \"http://hass.local:8123\" + state_attr(\"camera.garden\",\"entity_picture\") %}\r\n      {{ image }}\r\n  sequence:\r\n  - service: notify.hass_agent_test\r\n    data:\r\n      title: Test\r\n      message: \"This is a test message with an image.\"\r\n      data:\r\n        image: \"{{ image }}\"\r\n  mode: single\r\n  icon: mdi:bell\r\n```\r\n\r\nOptionally change `hass.local` to the mDNS/IP of your Home Assistant instance, and change `garden` to the name of your camera - or use another variable as provided in the linked issue.\r\n\r\n#### Script GUI examples\r\n\r\nThis is the sequence part of a test script to send a text-only message, created through the Home Assistant GUI:\r\n\r\n![Script Test Notification](https://raw.githubusercontent.com/LAB02-Research/HASS.Agent/main/images/notifier_script_example.png)\r\n\r\nThis is the same script, but with an image added to the notification:\r\n\r\n![Script Test Image Notification](https://raw.githubusercontent.com/LAB02-Research/HASS.Agent/main/images/notifier_script_image_example.png)\r\n\r\nYou can use the new \u003ca href=\"https://www.home-assistant.io/lovelace/button/\" target=\"_blank\"\u003eButton Card\u003c/a\u003e to trigger your test scripts.\r\n\r\n----\r\n\r\n### Help\r\n\r\nThere's a section dedicated to notification support in [the documentation](https://hassagent.readthedocs.io/). It'll help you troubleshoot common problems, and provide some examples.\r\n\r\n----\r\n\r\n### Debugging\r\n\r\n**Note: make sure you check [the documentation](https://hassagent.readthedocs.io/) for common troubleshooting help.**\r\n\r\nIf something's not working as it should, while everything's configured and HASS.Agent isn't showing any errors in its logs, browse to the following URL from another PC on the same network as HASS.Agent: `http://{hass_agent_ip}:5115`. Make sure to change `{hass_agent_ip}` to the IP of the PC where HASS.Agent's installed.\r\n\r\nIf HASS.Agent is configured and the firewall rule's active, you'll see: `HASS.Agent Active`. \r\n\r\nIf not, something is blocking access to HASS.Agent. Add the following snippet to your configuration.yaml to enable debug logging for the integration:\r\n\r\n\r\n```yaml\r\nlogger:\r\n  default: warning\r\n  logs:\r\n    custom_components.hass_agent_notifier: debug\r\n```\r\n\r\nReboot Home Assistant. Whenever you send a message, this should show up in your logs:\r\n\r\n![Debug Output](https://raw.githubusercontent.com/LAB02-Research/HASS.Agent/main/images/notifier_debug_logging.png)\r\n\r\nIf not, please open a ticket and post your log output.\r\n\r\n----\r\n\r\n### License\r\n\r\nHASS.Agent Notifier and HASS.Agent are released under the \u003ca href=\"https://opensource.org/licenses/MIT\" target=\"_blank\"\u003eMIT license\u003c/a\u003e.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flab02-research%2Fhass.agent-notifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flab02-research%2Fhass.agent-notifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flab02-research%2Fhass.agent-notifier/lists"}