Уведомления в Telegram (Телеграм)

Материал из Sprut.hub Wiki

Для получения уведомлений о событиях Sprut.hub через бота в Telegram можно использовать решение с помощью кода (пока не готово официальная интеграция).

Если у вас нет своего бота, вам необходимо его создать.

Именно этот бот, будет присылать вам сообщения, которые вы будете отправлять из Sprut.hub.

Если вы хотите, чтобы сообщения приходили в ваш канал, который будут читать несколько пользователей, то вам на шаге 4 - необходимо выяснить ID канала, куда будут присылаться сообщения от бота и указать его.

Создание своего бота в Telegram

Для этого необходимо в Telegram в поиске вбить @BotFather (это официальный бот для создания ботов)


После этого, необходимо:

Шаг 1: Нажмите «Запустить» для активации бота BotFather. В ответ вы получите список команд по управлению ботов.

Шаг 2: Выполнить команду /newbot

Шаг 3: Дать имя своему боту — например "Мой дом" и присвоить никнейм бота, по которому вы сможете его найти. Он должен быть уникальным и заканчиваться на слово «bot».

После этого вы получите сообщение, которое будет содержать ссылку на вашего бота, а также токен для авторизации в Sprut.hub или другой системе управления умным домом.

Шаг 4: Далее вам необходимо узнать ваш chatID. Для этого вам нужно подключиться к этому боту, который и сообщит вам ваш chatID. Если же вам нужно, чтобы ваш бот присылал сообщения в какой нибудь общий канал Telegram, то вам нужно выяснить ID этого канала. Для этого, необходимо переслать сообщение из этого канала тому же боту, чтобы он вам сообщил ID чата, из которого вы переслали сообщение.

Шаг 5: Чтобы начать пользоваться ботом, нужно начать с ним чат и нажать кнопку "Запустить"

Ваш бот готов к использованию

Если вы хотите, чтобы бот отправлял сообщения в ваш канал и его сообщения могли читать несколько пользователей, то вы должны добавить бота в этот канал с правами администратора и возможностью отправлять сообщения

Создание глобального сценария

Теперь вам необходимо настроить его работу в Sprut.hub. Для этого необходимо создать глобальный сценарий в виде кода. Идем в "Сценарии" - "Глобальные" и создаем там новый сценарий

После этого - вставляем в блок кода сценария следующий код:

let chatIDs = ["777777777", "888888888", "-123123123123"];
// 777777777 и 888888888 - ID чатов, в которые будут отправляться сообщения
// -123123123123 - ID канала, куда вы можете добавить бота, чтобы сообщения от него приходили группе людей

// let chatIDs = ["777777777"] // первая строка будет выглядеть так, если вам нужно отправлять только в один чат

let token = "666666666:AABBCCddEeffggeeHH-IIJJkKLlMmnno_oP"

function sendToTelegram(text, notify) {
    try {
        if (!Array.isArray(text))
            text = [text];

        chatIDs.forEach(function (chatID) {
            HttpClient.POST("https://api.telegram.org")
                .path("bot" + token)
                .path("sendMessage")
                .queryString("chat_id", chatID)
                .queryString("text", text.join("\n"))
                .queryString("parse_mode", "Markdown")
                .queryString("disable_notification", notify == null ? false : !notify)
                .send()
        })
    } catch (e) {
        log.error(e.message);
    }
}
sendToTelegram(["*Мой город*", "Хаб запущен"])

Скачать шаблон сценария

В коде необходимо заменить "777777777" и другие ID на те ID, которые вы получили от бота на Шаге 4 и заменить токен 666666666:AABBCCddEeffggeeHH-IIJJkKLlMmnno_oP на токен, который вы получили на Шаге 3

После этого сохраняем сценарий

Дополнительные настройки отправки сообщений

В этот же глобальный сценарий, после функции sendToTelegram, вы можете добавить дополнительную строку, которая будет уведомлять вас о запуске хаба вызывая функцию выше:

sendToTelegram(["*Мой город*", "Хаб запущен"])

Вызов функции отправки сообщений из блочных сценариев, производится через добавление в блоке кода блочного сценария (в раздел "Тогда" или "Иначе") следующей команды:

global.sendToTelegram("Сообщение")

Если вам нужен перевод на новую строку, то код будет выглядеть вот так

global.sendToTelegram(["*Нижний Новгород*, хаб запущен", "вторая строка"])

Если вы хотите, чтобы приходили "тихие" уведомления в телеграм, то строка кода будет выглядеть вот так:

global.sendToTelegram(["*Нижний Новгород*, хаб запущен", "вторая строка"], false)

Также можно оформлять текст с помощью разных "плюшек" в виде различного форматирования текста:

global.sendToTelegram("*выделение жирным*")
global.sendToTelegram("__выделение подчеркнутым__")
global.sendToTelegram("_наклонный текст_")
global.sendToTelegram("[Инструкции живут тут](https://spruthub.ru/news)") - это отправка ссылки

Если вам нужно отправить в телеграм значение какого либо устройства, то можно использовать следующий синтаксис:

global.sendToTelegram("Состояние сигнализации: " + Hub.getCharacteristic(2, 13).format())

где 2 - это идентификатор аксессуара, а 13 это идентификатор характеристики Для отправки в одном сообщении состояний нескольких устройств в одну строку

global.sendToTelegram("Показания датчика температуры 1 : " + Hub.getCharacteristicValue(13,15) + " Показания датчика температуры 2 : " + Hub.getCharacteristicValue(16,19))

Для отправки в одном сообщении состояний нескольких устройств в две строки

global.sendToTelegram(["Показания датчика температуры 1 : " + Hub.getCharacteristicValue(13,15), "Показания датчика температуры 2 : " + Hub.getCharacteristicValue(16,19)])

Уведомления в Telegram из блочных сценариев

Глобальные сценарии используются в блочных через вызов функции.

Для этого переходим в раздел Блочных сценариев и создаем новый блочный сценарий или добавляем уже в существующий, отправку уведомлений в телеграм:

Передача данных датчика в Telegram

Если вы хотите что-то посложнее, например отправить данные датчика или что-то подобное, то можно использовать данные характеристики устройства.

Например отправка состояния открытия окна будет выглядеть в виде такой команды:

global.sendToTelegram("Состояние окна: " + Hub.getCharacteristic(1154, 16).format())

где цифра 1154 - это ID аксессуара Окно в хабе, а цифра 16 - это номер характеристики "Целевая позиция" у Окна.

Чтобы не напрягаться с поиском того, как называется сервис или характеристика для использования в коде (даже с авто-подстановкой), а также какие у них идентификаторы, достаточно зайти в настройки устройства и нажать кнопку информации у нужной характеристики

И там будут нужные вам названия сервисов и характеристик для указания в коде, а также идентификаторы всех уровней.

Отправка фото в Телеграм

Если вам необходимо отправлять фото в телеграм, то нужно дополнить глобальный сценарий еще одной функцией

let chatIDs = ["777777777"];
let token = "666666666:AABBCCddEeffggeeHH-IIJJkKLlMmnno_oP"

function sendToTelegram(text, notify) {
    try {
        if (!Array.isArray(text))
            text = [text];

        chatIDs.forEach(function (chatID) {
            HttpClient.POST("https://api.telegram.org")
                .path("bot" + token)
                .path("sendMessage")
                .queryString("chat_id", chatID)
                .queryString("text", text.join("\n"))
                .queryString("parse_mode", "Markdown")
                .queryString("disable_notification", notify == null ? false : !notify)
                .send()
        })
    } catch (e) {
        log.error(e.message);
    }
}

function sendPhotoToTelegram(binary,caption) {
    try {
        if (!caption) {caption = ""}
        chatIDs.forEach(function (chatID) {
            HttpClient.POST('https://api.telegram.org')
                .path("bot" + token)
                .path("sendPhoto")
                .queryString("chat_id", chatID)
                .queryString('caption', caption) 
                .fieldMultipart('photo', binary)
                .send();
        })
    } catch (e) {
        log.error(e.message);
    }
}
sendToTelegram(["*Мой город*", "Хаб запущен"])

Скачать шаблон сценария

В коде необходимо заменить "777777777" на ID которые вы получили от бота на Шаге 4 и заменить токен 666666666:AABBCCddEeffggeeHH-IIJJkKLlMmnno_oP на токен, который вы получили на Шаге 3

А отправка фото, осуществляется следующим блоком кода в блочном сценарии

let snapshot = HttpClient.GET("[АДРЕС_ИЗОБРАЖЕНИЯ]").send().getBinary();
global.sendPhotoToTelegram(snapshot,"Изображение с камеры");

Где в данном примере, [АДРЕС_ИЗОБРАЖЕНИЯ] - это URL для картинки с вашей камеры видеонаблюдения, если она умеет отдавать статичные картинки.

Стандартная ссылка для подобных картинок: http://[ВАШ_ЛОГИН]:[ВАШ_ПАРОЛЬ]@[IP_АДРЕС_КАМЕРЫ]:[ПОРТ]/cgi-bin/snapshot.cgi

но она может быть другой, или ваша камера может не уметь показывать статичные картинки.

Главное для использования этого варианта отправки картинок, чтобы она была доступна из хаба по обычной ссылке на сайт.

Универсальный вариант для чатов, групп и каналов с отправкой в конкретный топик группы

Номер топика в супергруппе можно получить скопировав ссылку на любое сообщение в топике. Она будет выглядеть как:

https://t.me/c/123456789/2/17 - где:

  • 123456789 - идентификатор группы (чтобы добавить в код, нужно в начало идентификатора добавить -100 чтобы получилось -100123456789)
  • 2 - идентификатор топика
  • 17 - идентификатор сообщения

Идентификатор чата с ботом вы получили на шаге 4

Идентификатор канала, в который бот должен отправлять сообщения вы так же получили на шаге 4

В итоге мы получаем три места, куда бот будет отправлять сообщения: чат с ботом, канал и конкретный топик в супергруппе. Где:

  • -100123456789 - это ID супергруппы
  • -100987654321 - это ID канала
  • 50506060 - это ID чата с ботом

Глобальный сценарий будет выглядеть таким образом:

let chatIDs = ["-100123456789","50506060","-100987654321"];
let token = "666666666:AABBCCddEeffggeeHH-IIJJkKLlMmnno_oP"

function sendToTelegram(text,topic,notify) {
    try {
        if (!Array.isArray(text))
            text = [text];

        chatIDs.forEach(function (chatID) {
            if (chatID.indexOf("-")) {topic = ""}
            HttpClient.POST("https://api.telegram.org")
                .path("bot" + token)
                .path("sendMessage")
                .queryString("chat_id", chatID)
                .queryString("message_thread_id", topic)
                .queryString("text", text.join("\n"))
                .queryString("parse_mode", "Markdown")
                .queryString("disable_notification", notify == null ? false : !notify)
                .send()
        })
    } catch (e) {
        log.error(e.message);
    }
}

Отправка сообщений Если нужно отправить сообщение в чат с ботом, канал и топик General супегруппы

global.sendToTelegram("Сообщение в канал, чат и топик General")

Если нужно отправить сообщение в чат с ботом, канал и топик с индексом 2 супергруппы, где цифра 2 после запятой - ID топика в супергруппе

global.sendToTelegram("Сообщение в канал, чат и топик номер 2",2)