upd

Author: GyverLibs

docs/1.main.md

@@ -143,9 +143,24 @@ fb::Result sendFile(const fb::File& m, bool wait = true);
 // редактировать файл
 fb::Result editFile(const fb::FileEdit& m, bool wait = true);
 
-// скачать файл
+// получить прямую ссылку на файл
+String getFileLink(Text fileID);
+
+// получить путь к файлу относительно корня api
+String getFilePath(Text fileID);
+
+// обновить прошивку из файла, указать id юзера для отправки уведомления
+void updateFlash(fb::DocumentRead document, Text user_id = "");
+
+// обновить FS из файла, указать id юзера для отправки уведомления
+void updateFS(fb::DocumentRead document, Text user_id = "");
+
+// скачать файл по id
 fb::Fetcher downloadFile(const Text& fileID);
 
+// скачать файл
+fb::Fetcher downloadFile(fb::DocumentRead document);
+
 // ============================== SET ==============================
 
 // отправить статус "набирает сообщение" на 5 секунд

docs/3.start.md

@@ -90,7 +90,15 @@ void loop() {
 }
 ```
 
-> Разбор обновлений описан в следующей главе документации
+Подробнее разбор обновлений описан в следующей главе документации
+
+> Указатель на текущий объект FastBot (тот, который вызвал коллбэк) можно получить из переменной `fb::Core* fb::thisBot`. Кастовать его в нужный класс и использовать:
+
+```cpp
+void update(fb::Update& u) {
+    static_cast<FastBot2*>(fb::thisBot)->sendMessage(...);
+}
+```
 
 ### Минимальный код (для esp)
 ```cpp

docs/4.updates.md

@@ -14,14 +14,6 @@ void update(fb::Update& u) {
 }
 ```
 
-> Указатель на текущий объект FastBot (тот, который вызвал коллбэк) можно получить из переменной `fb::Core* fb::thisBot`. Кастовать его в нужный класс и использовать:
-
-```cpp
-void update(fb::Update& u) {
-    static_cast<FastBot2*>(fb::thisBot)->sendMessage(...);
-}
-```
-
 Отличие FastBot2 состоит в том, что библиотека не разбирает пакет обновления по отдельным переменным: данные извлекаются в момент обращения к ним. Это сильно быстрее и расходует в сотни раз меньше памяти.
 
 ### Тип данных Text
@@ -49,20 +41,20 @@ void update(fb::Update& u) {
 
     // пример с разбором callback query через хэш
     switch (u.query().data().hash()) {
-        case su::SH("abc123"):
+        case SH("abc123"):
             // ....
             break;
-        case su::SH("hfghfgh"):
+        case SH("hfghfgh"):
             // ....
             break;
-        case su::SH("test222"):
+        case SH("test222"):
             // ....
             break;
     }
 }
 ```
 
-> В примере с хэшем строка, указанная в `su::SH`, не существует в программе: вместо этого компилятор подставляет её хэш (число). А в `switch` мы подаём хэш пришедшей строки. Это позволяет максимально быстро, оптимально и очень удобно сравнивать строки в сценариях, когда приходящий текст может иметь известный набор значений. В данном случае - обработка query, очень типовая задача (определение кнопки клавиатуры, на которую нажал юзер).
+> В примере с хэшем строка, указанная в `SH`, не существует в программе: вместо этого компилятор подставляет её хэш (число). А в `switch` мы подаём хэш пришедшей строки. Это позволяет максимально быстро, оптимально и очень удобно сравнивать строки в сценариях, когда приходящий текст может иметь известный набор значений. В данном случае - обработка query, очень типовая задача (определение кнопки клавиатуры, на которую нажал юзер).
 
 ### Личка с админом
 Телеграм бот - публичная штука, любой пользователь может найти вашего бота в поиске и взаимодействовать с ним. Чтобы ограничить круг лиц (админов), которые могут работать с ботом (или иметь дополнительные функции), достаточно вручную фильтровать обновления по id юзера. Несколько способов:

docs/6.menu.md

@@ -89,13 +89,13 @@ void update(fb::Update& u) {
 
         // быстрое "сравнение" строк и поиск нужной даты
         switch (u.query().data().hash()) {
-            case su::SH("data1"):
+            case SH("data1"):
                 // ...
                 break;
-            case su::SH("data2"):
+            case SH("data2"):
                 // ...
                 break;
-            case su::SH("data3"):
+            case SH("data3"):
                 // ...
                 break;
         }

docs/7.files.md

@@ -53,6 +53,19 @@ void update(fb::Update& u) {
 ```
 > После успешного OTA обновления МК дождётся следующего Update обновления от сервера, принудительно пропустит сообщение с файлом прошивки и сам перезагрузится!
 
+### OTA обновление
+Есть второй способ OTA обновления, менее требовательный к памяти. Описанный выше способ вызывает обновление из обработчика, а лучше делать это из loop. При получении файла с обновлением нужно вызвать `updateFlash` или `updateFS` (для файловой системы), передав файл из сообщения и по желанию ID юзера, которому будет отправлено уведомление об окончании обновления. Это может быть тот же юзер, который отправил файл, например:
+
+```cpp
+void updateh(fb::Update& u) {
+    if (u.message().hasDocument() && u.message().document().name().endsWith(".bin")) {
+        bot.updateFlash(u.message().document(), u.message().chat().id());
+    }
+}
+```
+
+Библиотека запомнит файл и запустит обновление из следующего вызова tick, указанный юзер получит сообщение, а после успешного обновления esp автоматически перезагрузится.
+
 ### Отправка файлов
 Файл можно отправить 4-мя способами:
 - Из файла файловой системы (esp8266/esp32)

examples/test/test.ino

@@ -58,7 +58,7 @@ void handleCommand(fb::Update& u) {
     Text chat_id = u.message().chat().id();
 
     switch (u.message().text().hash()) {
-        case su::SH("/start"): {
+        case SH("/start"): {
             // установить команды
             // в конструкторе
             fb::MyCommands commands("help;settings", "Помощь;Настройки");
@@ -94,7 +94,7 @@ void handleCommand(fb::Update& u) {
             bot.sendMessage(msg);
         } break;
 
-        case su::SH("/send_msg"): {
+        case SH("/send_msg"): {
             // вариант 1
             bot.sendMessage(fb::Message("Some text", chat_id));
 
@@ -105,7 +105,7 @@ void handleCommand(fb::Update& u) {
             // bot.sendMessage(msg);
         } break;
 
-        case su::SH("/send_menu"): {
+        case SH("/send_menu"): {
             fb::Message msg("Send menu", chat_id);
 
             // меню, вариант 1
@@ -124,7 +124,7 @@ void handleCommand(fb::Update& u) {
             bot.sendMessage(msg);
         } break;
 
-        case su::SH("/send_inline_menu"): {
+        case SH("/send_inline_menu"): {
             fb::Message msg("Send inline menu", chat_id);
 
             // inline menu, вариант 1
@@ -145,7 +145,7 @@ void handleCommand(fb::Update& u) {
             bot.sendMessage(msg);
         } break;
 
-        case su::SH("/file_txt"): {
+        case SH("/file_txt"): {
             char str[] = "hello text v1";
             fb::File f("file.txt", fb::File::Type::document, (uint8_t*)str, strlen(str));
             f.chatID = chat_id;
@@ -160,7 +160,7 @@ void handleCommand(fb::Update& u) {
             // }
         } break;
 
-        case su::SH("/file_txt_p"): {
+        case SH("/file_txt_p"): {
             fb::File f("file.txt", fb::File::Type::document, (const uint8_t*)lorem_p, sizeof(lorem_p), true);
             f.chatID = chat_id;
             loopStart();
@@ -176,7 +176,7 @@ void handleCommand(fb::Update& u) {
             // }
         } break;
 
-        case su::SH("/file_txt_file_1kb"): {
+        case SH("/file_txt_file_1kb"): {
             File file = LittleFS.open("/lorem_1kb.txt", "r");
             fb::File f("file_1kb.txt", fb::File::Type::document, file);
             f.chatID = chat_id;
@@ -185,7 +185,7 @@ void handleCommand(fb::Update& u) {
             loopPrint();
         } break;
 
-        case su::SH("/file_txt_file_50kb"): {
+        case SH("/file_txt_file_50kb"): {
             File file = LittleFS.open("/lorem_50kb.txt", "r");
             fb::File f("file_50kb.txt", fb::File::Type::document, file);
             f.chatID = chat_id;
@@ -194,15 +194,15 @@ void handleCommand(fb::Update& u) {
             loopPrint();
         } break;
 
-        case su::SH("/file_img_p"): {
+        case SH("/file_img_p"): {
             fb::File f("bot.png", fb::File::Type::photo, image_p, sizeof(image_p), true);
             f.chatID = chat_id;
             loopStart();
             bot.sendFile(f, false);
             loopPrint();
         } break;
 
-        case su::SH("/file_img_url"): {
+        case SH("/file_img_url"): {
             fb::File f("file.txt", fb::File::Type::document, "https://upload.wikimedia.org/wikipedia/ru/6/61/Rickrolling.gif");
             f.chatID = chat_id;
             loopStart();
@@ -264,15 +264,19 @@ void handleDocument(fb::Update& u) {
         bot.sendMessage(fb::Message("OTA begin", u.message().chat().id()), true);
 
         // между downloadFile и updateFlash/updateFS/writeTo не должно быть отправки сообщений!
-        fb::Fetcher fetch = bot.downloadFile(u.message().document().id());
-        if (fetch) {
-            if (fetch.updateFlash()) {
-                Serial.println("OTA done");
-                bot.sendMessage(fb::Message("OTA done", u.message().chat().id()), true);
-            } else {
-                Serial.println("OTA error");
-                bot.sendMessage(fb::Message("OTA error", u.message().chat().id()), true);
-            }
+        // OTA обновление тип 1
+        bot.updateFlash(u.message().document(), u.message().chat().id());
+        
+        // OTA обновление тип 2
+        // fb::Fetcher fetch = bot.downloadFile(u.message().document().id());
+        // if (fetch) {
+        //     if (fetch.updateFlash()) {
+        //         Serial.println("OTA done");
+        //         bot.sendMessage(fb::Message("OTA done", u.message().chat().id()), true);
+        //     } else {
+        //         Serial.println("OTA error");
+        //         bot.sendMessage(fb::Message("OTA error", u.message().chat().id()), true);
+        //     }
         }
     } else {
         // это просто файл, выведем содержимое

library.properties

@@ -1,5 +1,5 @@
 name=FastBot2
-version=1.0.4
+version=1.0.5
 author=AlexGyver <[email protected]>
 maintainer=AlexGyver <[email protected]>
 sentence=Fast and universal Arduino/ESP8266/ESP32 library for Telegram bot 

src/FastBot2Client.h

@@ -66,32 +66,26 @@ class FastBot2Client : public fb::Core {
         return sendPacket(p, wait);
     }
 
+    // обновить прошивку из файла, указать id юзера для отправки уведомления
+    void updateFlash(fb::DocumentRead document, Text user_id = "") {
+        _ota = ota_t::Flash;
+        document.id().toString(_ota_id);
+        user_id.toString(_ota_user);
+    }
+
+    // обновить FS из файла, указать id юзера для отправки уведомления
+    void updateFS(fb::DocumentRead document, Text user_id = "") {
+        _ota = ota_t::FS;
+        document.id().toString(_ota_id);
+        user_id.toString(_ota_user);
+    }
+
     // скачать файл
-    fb::Fetcher downloadFile(const Text& fileID) {
-        FB_ESP_YIELD();
-        StreamReader reader;
-        String path;
-        path.reserve(30);
-        {
-            FB_LOG("getFile");
-            fb::Packet p(tg_cmd::getFile, _token);
-            p[tg_api::file_id] = fileID;
-
-            fb::Result res = sendPacket(p, true);
-            FB_ESP_YIELD();
-            if (res.has(tg_apih::file_id) && res[tg_apih::file_id] == fileID) {
-                res[tg_apih::file_path].toString(path);
-            }
-        }
-
-        if (path.length()) {
-            FB_LOG("download file");
-            fb::Packet p(path, _token);
-            reader = sendPacket(p, true).getReader();
-            FB_ESP_YIELD();
-        }
-        return fb::Fetcher(&_reboot, reader);
+    fb::Fetcher downloadFile(fb::DocumentRead document) {
+        return fb::Core::downloadFile(document.id());
     }
+
+    using fb::Core::downloadFile;
 #endif
 
     // ============================== SET ==============================

src/core/api.h

@@ -4,7 +4,7 @@
 
 #define FB_BOT_API_VERSION "7.4"
 
-#define FB_MAKE_HASH(x) constexpr size_t x = su::SH(#x);
+#define FB_MAKE_HASH(x) constexpr size_t x = SH(#x);
 #define FB_MAKE_EXTERN(x) extern const __FlashStringHelper* x;
 
 namespace tg_api {