You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+55-16Lines changed: 55 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,22 +11,51 @@
11
11
12
12
# FastBot
13
13
Многофункциональная быстрая библиотека для телеграм бота на esp8266/esp32
14
-
- Работает на стандартных библиотеках
15
-
- Опциональный "белый список" ID чатов
16
-
- Проверка обновлений вручную или по таймеру
17
-
- Отправка/удаление/редактирование/ответ на сообщения
18
-
- Чтение и отправка в чатах, группах, каналах
19
-
- Изменение названия и описания чата
20
-
- Закрепление/открепление сообщений
21
-
- Отправка стикеров
22
-
- Сообщения с форматированием markdown/html
23
-
- Вывод обычного меню
24
-
- Вывод инлайн меню с поддержкой кнопок-ссылок
25
-
- Поддержка Unicode (другие языки + эмодзи) для входящих сообщений
26
-
- Встроенный urlencode для исходящих сообщений
27
-
- Встроенные часы реального времени с синхронизацией от сервера Telegram
28
-
- Возможность OTA обновления прошивки .bin файлом из чата Telegram (firmware и SPIFFS)
29
-
- Отправка файлов из памяти в чат (+ редактирование)
14
+
1. FastBot
15
+
1. Совместимость
16
+
1. Создание и настройка бота
17
+
2. Ограничения
18
+
1. Лимиты Telegram
19
+
2. Прочее
20
+
3. Вывод графики
21
+
4. Документация и проекты
22
+
5. Сравнение с Universal-Arduino-Telegram-Bot
23
+
6. Содержание
24
+
7. Установка
25
+
1. Обновление
26
+
8. Инициализация
27
+
9. Документация
28
+
10. Использование
29
+
11. Отправка сообщений
30
+
12. Парсинг сообщений
31
+
1. Белый список
32
+
13. Тикер
33
+
14. Минимальный пример
34
+
15. Обращение к сообщениям
35
+
16. Отправка стикеров
36
+
17. Меню
37
+
18. Обычное меню
38
+
19. Инлайн меню
39
+
20. Инлайн меню с коллбэком
40
+
21. Ответ на коллбэк
41
+
22. Модуль времени
42
+
23. Время получения сообщения
43
+
24. Часы реального времени
44
+
25. Обновление прошивки из чата
45
+
1. Примеры сценариев обновления прошивки
46
+
2. Примеры сценариев обновления SPIFFS
47
+
3. Сжатие бинарника
48
+
26. Оформление текста
49
+
27. Отправка файлов (v2.20+)
50
+
1. Файл из буфера
51
+
2. Файл из памяти
52
+
28. Скачивание файлов (v2.20+)
53
+
29. Местоположение
54
+
30. Трюки
55
+
1. Перезагрузка
56
+
2. Пропуск "пропущенных" сообщений на основе времени
57
+
31. Версии
58
+
32. Баги и обратная связь
30
59
31
60
### Совместимость
32
61
ESP8266 (SDK v2.6+), ESP32
@@ -127,13 +156,15 @@ ESP8266 (SDK v2.6+), ESP32
127
156
- Вручную: **удалить папку со старой версией**, а затем положить на её место новую. "Замену" делать нельзя: иногда в новых версиях удаляются файлы, которые останутся при замене и могут привести к ошибкам!
// ответить на callback текстом (text) и режимом (alert): FB_NOTIF - уведомление в чате, FB_ALERT - окно с кнопкой ОК
181
212
uint8_t answer(String text, bool alert);
182
213
214
+
// не отвечать автоматически на query этого апдейта
215
+
void noAnswer();
216
+
183
217
//отправить уведомление о том, что бот печатает сообщение
184
218
uint8_t sendTyping(const String& id);
185
219
@@ -383,8 +417,10 @@ String FB_64str(int64_t id); // перевод из int64_t в String
383
417
```
384
418
385
419
<aid="usage"></a>
420
+
386
421
## Использование
387
422
<aid="send"></a>
423
+
388
424
## Отправка сообщений
389
425
Для отправки в чат (сообщения, стикеры, меню и так далее) обязательно должен быть указан ID чата, в который будет осуществляться отправка. Можно указать
390
426
несколько ID через запятую, в пределах одной строки. Есть два способа указать ID:
@@ -404,6 +440,7 @@ bot.sendMessage("Hello!", "112233"); // уйдёт в "112233"
404
440
> Примечание: Телеграм разделяет текст на несколько сообщений, если длина текста превышает ~4000 символов! Эти сообщения будут иметь разный messageID в чате.
405
441
406
442
<aid="inbox"></a>
443
+
407
444
## Парсинг сообщений
408
445
Сообщения автоматически запрашиваются и читаются в `tick()`, при поступлении нового сообщения вызывается указанная функция-обработчик:
409
446
- Создаём в скетче свою функцию вида `void функция(FB_msg& сообщение)`
@@ -426,6 +463,8 @@ bot.sendMessage("Hello!", "112233"); // уйдёт в "112233"
426
463
-`String fileUrl` - адрес файла для загрузки
427
464
-`bool OTA` - запрос на OTA обновление (получен .bin файл)
428
465
-`uint32_t unix` - время сообщения
466
+
-`uint32_t update_id` - id апдейта
467
+
-`String query_id` - id query
429
468
430
469
А также `String toString()` - вся информация из сообщения одной строкой, удобно для отладки (с версии 2.11)
0 commit comments