Skip to content

About

Компонент для отправки сообщений от имени бота в чат(ы) Яндекс Мессенджера из Home Assistant.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

6 Commits

Folders and files

Repository files navigation

Яндекс Мессенджер для Home Assistant

hacs_badge

Данный компонент предназначен для создания уведомлений с применением бот-платформы Яндекс Мессенджера из Home Assistant.

Возможности

  • Отправка текстовых сообщений в чат Яндекс Мессенджера от имени бота
  • Отправка изображений с локальных путей или по URL
  • Отправка файлов любого типа
  • Отправка галерей (нескольких изображений)
  • Поддержка заголовков для сообщений
  • Настройка API URL (по умолчанию используется официальный бот-API Яндекс Мессенджера)
  • Конфигурация через UI Home Assistant
  • Отправка сообщений в несколько чатов одновременно
  • Настройка чата по умолчанию для автоматической отправки без указания получателя

Установка

Через HACS (Home Assistant Community Store)

  1. Откройте HACS в Home Assistant
  2. Перейдите во вкладку Интеграции
  3. Нажмите на три точки в правом верхнем углу и выберите Добавить пользовательское репозиторий
  4. Введите URL репозитория: https://github.com/hell-0/yandex-messenger-ha
  5. Выберите тип Интеграция
  6. Нажмите Добавить
  7. Найдите Yandex Messenger и нажмите Установить
  8. Перезапустите Home Assistant

Вручную

  1. Скачайте или клонируйте репозиторий
  2. Скопируйте папку custom_components/yandex_messenger в папку custom_components вашей установки Home Assistant
  3. Перезапустите Home Assistant

Путь к папке должен быть:

homeassistant
└── custom_components/
    └── yandex_messenger/
        ├── __init__.py
        ├── config_flow.py
        ├── const.py
        ├── manifest.json
        ├── notify.py
        ├── services.yaml
        ├── strings.json
        ├── yandex_messenger.py
        └── brand/
            └── icon.png

Настройка

Требования

Получение API токена

  1. Перейдите в Яндекс 360
  2. Откройте настройки своего бота
  3. Скопируйте API токен (OAuth token)

Добавление интеграции

  1. В Home Assistant перейдите в Настройки → Устройства и службы
  2. Нажмите + Добавить интеграцию
  3. Найдите и выберите Yandex Messenger
  4. Заполните форму настройки:
    • Имя: Произвольное имя интеграции (по умолчанию: "Yandex Messenger")
    • API Token: Ваш токен доступа к API
    • Default Chat ID (опционально): ID чата по умолчанию для отправки сообщений
    • API URL (опционально): URL API endpoint (по умолчанию: https://botapi.messenger.yandex.net/bot/v1/messages/)
  5. Нажмите Отправить

Настройка чата по умолчанию

После добавления интеграции вы можете настроить чат по умолчанию:

  1. Перейдите в Настройки → Устройства и службы
  2. Найдите интеграцию Yandex Messenger
  3. Нажмите на три точки и выберите Настроить
  4. Введите ID чата, в который будут отправляться сообщения по умолчанию

Использование

Службы

После установки интеграции становятся доступны следующие службы:

yandex_messenger.send_message

Отправка текстового сообщения в чат.

Параметр Обязательный Описание
message Да Текст сообщения
target Нет ID чата или username получателя (если не указан, используется чат по умолчанию)
title Нет Заголовок сообщения

Пример:

action: yandex_messenger.send_message
data:
  message: "Привет из Home Assistant!"
  target: "0/0/<id вашего чата>"
  title: "Уведомление"

Отправка в несколько чатов:

action: yandex_messenger.send_message
data:
  message: "Уведомление для нескольких чатов"
  target:
    - "0/0/chat_id_1"
    - "0/0/chat_id_2"
    - "0/0/chat_id_3"

Отправка в чат по умолчанию:

action: yandex_messenger.send_message
data:
  message: "Сообщение в чат по умолчанию"

yandex_messenger.send_image

Отправка изображения в чат.

Параметр Обязательный Описание
image_url Да URL изображения или путь к локальному файлу
target Нет ID чата получателя (если не указан, используется чат по умолчанию)

Пример:

service: yandex_messenger.send_image
data:
  image_url: "/tmp/image.jpg"
  target: "0/0/<id вашего чата>"

Отправка в чат по умолчанию:

service: yandex_messenger.send_image
data:
  image_url: "/tmp/image.jpg"

yandex_messenger.send_file

Отправка файла в чат.

Параметр Обязательный Описание
file_url Да URL файла или путь к локальному файлу
target Нет ID чата получателя (если не указан, используется чат по умолчанию)

Пример:

action: yandex_messenger.send_file
data:
  file_url: "/tmp/document.pdf"
  target: "0/0/<id вашего чата>"

Отправка в чат по умолчанию:

action: yandex_messenger.send_file
data:
  file_url: "/tmp/document.pdf"

yandex_messenger.send_gallery

Отправка галереи (альбома) из нескольких изображений.

Параметр Обязательный Описание
items Да Список изображений (URL или пути к файлам)
target Нет ID чата получателя (если не указан, используется чат по умолчанию)

Пример:

action: yandex_messenger.send_gallery
data:
  items:
    - "/tmp/image1.jpg"
    - "/tmp/image2.jpg"
    - "/tmp/image3.jpg"
  target: "0/0/<id вашего чата>"

Отправка в чат по умолчанию:

action: yandex_messenger.send_gallery
data:
  items:
    - "/tmp/image1.jpg"
    - "/tmp/image2.jpg"

Примечания

  • Для отправки сообщений в чат необходимо знать его ID. Вы можете получить ID чата через API Яндекс Мессенджера или через адресную строку браузера при открытии чата.
  • Если вы используете локальные файлы, убедитесь, что Home Assistant имеет доступ к этим файлам.
  • Для получения ID чата откройте чат в браузере и скопируйте ID из адресной строки (последняя часть URL).

Известные проблемы

  • Токен должен иметь права на отправку сообщений в целевой чат (бот, от имени которого отправляются сообщения, обязательно должен быть участником чата)
  • Некоторые типы файлов могут быть ограничены API Яндекс Мессенджера
  • Максимальный размер файла зависит от ограничений API Яндекс Мессенджера

Использование через Notify платформу

Кроме служб, компонент также регистрирует платформу notify, которая позволяет использовать стандартные службы Home Assistant для отправки уведомлений.

Примеры использования Notify платформы:

Отправка сообщения:

service: notify.yandex_messenger
data:
  message: "Система готова к работе"
  target: "0/0/123456789"

Отправка сообщения с заголовком:

service: notify.yandex_messenger
data:
  message: "Дверь гаража открыта"
  title: "Событие безопасности"
  target: "0/0/123456789"

Отправка изображения (через службу send_image):

service: yandex_messenger.send_image
data:
  image_url: "https://example.com/camera.jpg"
  target: "0/0/123456789"

Отправка в чат по умолчанию:

service: yandex_messenger.send_image
data:
  image_url: "https://example.com/camera.jpg"

Примечание: Notify платформа поддерживает только текстовые сообщения. Для отправки изображений, файлов и галерей используйте соответствующие службы.

Примечание по API: Согласно документации Yandex Messenger API, методы отправки изображений, файлов и галерей не поддерживают подписи (caption) и пользовательские названия файлов.

Лицензия

Этот проект распространяется под лицензией MIT.

Благодарности

About

Компонент для отправки сообщений от имени бота в чат(ы) Яндекс Мессенджера из Home Assistant.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages