upd

Author: GyverLibs

README.md

@@ -38,6 +38,7 @@ ESP8266
 <a id="init"></a>
 ## Инициализация
 ```cpp
+FastBot bot;
 FastBot bot(токен);
 FastBot bot(токен, лимит);
 FastBot bot(токен, лимит, порог);
@@ -53,11 +54,20 @@ FastBot bot(токен, лимит, порог, период);
 ```cpp
 // настройки
 void setChatID(String chatID);                  // установка ID чата для парсинга сообщений. Можно указать несколько через запятую
-void attach(void (*handler)(String&, String&)); // подключение обработчика сообщений
-void detach();                                  // отключение обработчика сообщений
 void setLimit(int limit);                       // макс кол-во сообщений на запрос
 void setOvf(int ovf);                           // макс символов
 void setPeriod(int period);                     // период опроса
+void setToken(String token);                    // изменить/задать токен
+
+// парсинг
+void attach(void (*handler)(String&, String&)); // подключение обработчика сообщений
+void attach(void (*FB_msg)(msg&));              // подключение обработчика сообщений
+void detach();                                  // отключение ВСЕХ ОБРАБОТЧИКОВ СООБЩЕНИЙ
+
+// структура входящих сообщений FB_msg
+chat_id     // id чата
+name        // имя пользователя
+text        // текст сообщения
 
 // тикер
 uint8_t tickManual();                           // ручная проверка обновлений
@@ -105,6 +115,46 @@ String chatIDs;                                 // указанная в setChat
 ```
 
 <a id="example"></a>
+## Особенности парсинга сообщений
+Сообщения автоматически читаются в `tick()`, при поступлении нового сообщения вызывается указанная функция-обработчик. Но тут есть варианты:
+- Если задан ID чата/чатов (через `setChatID()`) - происходит автоматическое отсеивание сообщений НЕ из указанных чатов
+- Если ID чата/чатов не задан - сообщение будет обработано, т.е. вызван обработчик
+
+Обработчик подключается при помощи `attach(FB_msg&)` или `attach(String&, String&)` (устаревший)
+- Создаём в скетче свою функцию вида `void функция(FB_msg& сообщение)`
+- Вызываем `attach(функция)`
+- Эта функция будет автоматически вызвана при входящем сообщении, если ID чата совпадают или не настроены
+- Внутри этой функции можно пользоваться переданной переменной `сообщение`, которая имеет тип `FB_msg` (структура) и содержит в себе:
+    - `chat_id` - id чата
+    - `name` - имя пользователя
+    - `text` - текст сообщения
+
+Минимальный пример:
+```cpp
+void setup() {
+  // подключаемся к WiFi
+  // .............
+  
+  // подключаем обработчик сообщений
+  bot.attach(newMsg);
+}
+
+// функция-обработчик
+void newMsg(FB_msg& msg) {
+  // выводим ID чата, имя юзера и текст сообщения
+  Serial.print(msg.chat_id);
+  Serial.print(", ");
+  Serial.print(msg.name);
+  Serial.print(", ");
+  Serial.println(msg.text);
+}
+
+// проверка происходит в лупе
+void loop() {
+  bot.tick();
+}
+```
+
 ## Пример
 ```cpp
 // узнать токен бота можно у BotFather
@@ -132,13 +182,16 @@ void setup() {
     if (millis() > 15000) ESP.restart();
   }
   Serial.println("Connected");
+  
+  // можно сменить токен
+  //bot.setToken(BOT_TOKEN);
 
   // установить ID чата, чтобы принимать сообщения только из него
   // узнать ID можно из ручного запроса в браузере
   bot.setChatID(CHAT_ID); // передай "" (пустую строку) чтобы отключить проверку
 
   // подключаем функцию-обработчик
-  bot.attach(parseHandler);
+  bot.attach(newMsg);
 
   // отправить сообщение (работает, если указан CHAT_ID)
   bot.sendMessage("Hello, World!");
@@ -155,15 +208,17 @@ void setup() {
   bot.inlineMenu("Choose wisely", "Answer 1 \t Answer 2 \t Answer 3 \n Answer 4");
 }
 
-// создать свою функцию вида имя(String& ник, String& сообщение)
-void parseHandler(String& name, String& msg) {
-  // msg - сообщение в чате от name юзера
-  Serial.print(name);
+// создать свою функцию вида имя(FB_msg& сообщение)
+void newMsg(FB_msg& msg) {
+  // выводим ID чата, имя юзера и текст сообщения
+  Serial.print(msg.chat_id);
+  Serial.print(", ");
+  Serial.print(msg.name);
   Serial.print(", ");
-  Serial.println(msg);
+  Serial.println(msg.text);  
 }
 
-// можно вручную дёргать по одному сообщению при помощи tickManual
+// можно вручную дёргать по одному сообщению при помощи tickManual()
 // тогда "лимит" при инициализации поставить 1
 void loop() {
   // тикаем в луп
@@ -179,6 +234,7 @@ void loop() {
 - v1.3 - добавлена возможность задать текст при открытии и закрытии меню
 - v1.3.1 - исправлены ошибки с 1.3
 - v1.4 - добавлена возможность удалять сообщения
+- v1.5 - оптимизация, возможность смены токена, новый парсинг сообщений (id, имя, текст)
 
 <a id="feedback"></a>
 ## Баги и обратная связь

examples/demo/demo.ino

@@ -1,3 +1,5 @@
+// общее демо библиотеки. Обязательно смотри остальные примеры и документацию на гитхаб!
+
 // узнать токен бота можно у BotFather
 // узнать chat id можно по запросу https://api.telegram.org/bot<token>/getUpdates
 // искать "chat":{"id": тут id
@@ -18,17 +20,10 @@ FastBot bot(BOT_TOKEN);
 // период - период автоматического опроса бота в мс (по умолч. 1000)
 
 void setup() {
-  delay(2000);
-  Serial.begin(115200);
-  Serial.println();
-
-  WiFi.begin(WIFI_SSID, WIFI_PASS);
-  while (WiFi.status() != WL_CONNECTED) {
-    delay(500);
-    Serial.print(".");
-    if (millis() > 15000) ESP.restart();
-  }
-  Serial.println("Connected");
+  connectWiFi();
+  
+  // можно сменить токен
+  //bot.setToken(BOT_TOKEN);
 
   // установить ID чата, чтобы принимать сообщения только из него
   // узнать ID можно из ручного запроса в браузере
@@ -80,6 +75,21 @@ void loop() {
   bot.tick();
 }
 
+void connectWiFi() {
+  delay(2000);
+  Serial.begin(115200);
+  Serial.println();
+
+  WiFi.begin(WIFI_SSID, WIFI_PASS);
+  while (WiFi.status() != WL_CONNECTED) {
+    delay(500);
+    Serial.print(".");
+    if (millis() > 15000) ESP.restart();
+  }
+  Serial.println("Connected");
+}
+
+
 /*
 Статусы tick:
 	0 - ожидание

examples/echoBot/echoBot.ino

@@ -0,0 +1,48 @@
+// бот отправляет обратно сообщения из чата (эхо-бот)
+
+#define WIFI_SSID "login"
+#define WIFI_PASS "pass"
+#define BOT_TOKEN "2654326546:asjhAsfAsfkllgUsaOuiz_axfkj_AsfkjhB"
+#define CHAT_ID "574578754"
+
+#include <ESP8266WiFi.h>
+#include "FastBot.h"
+FastBot bot;
+
+void setup() {
+  connectWiFi();
+
+  bot.setToken(BOT_TOKEN);
+  bot.attach(newMsg);
+}
+
+// обработчик сообщений
+void newMsg(FB_msg& msg) {
+  // выводим ID чата, имя юзера и текст сообщения
+  Serial.print(msg.chat_id);
+  Serial.print(", ");
+  Serial.print(msg.name);
+  Serial.print(", ");
+  Serial.println(msg.text);    
+    
+  // отправить сообщение обратно
+  bot.sendMessage(msg.text, msg.chat_id);  
+}
+
+void loop() {
+  bot.tick();
+}
+
+void connectWiFi() {
+  delay(2000);
+  Serial.begin(115200);
+  Serial.println();
+
+  WiFi.begin(WIFI_SSID, WIFI_PASS);
+  while (WiFi.status() != WL_CONNECTED) {
+    delay(500);
+    Serial.print(".");
+    if (millis() > 15000) ESP.restart();
+  }
+  Serial.println("Connected");
+}

examples/menuTest/menuTest.ino

@@ -17,18 +17,8 @@ String menu4 = "Answer 3.1 \t Answer 3.2 \t Answer 3.3 \n Back";
 byte depth = 0;
 
 void setup() {
-  delay(2000);
-  Serial.begin(115200);
-  Serial.println();
-
-  WiFi.begin(WIFI_SSID, WIFI_PASS);
-  while (WiFi.status() != WL_CONNECTED) {
-    delay(500);
-    Serial.print(".");
-    if (millis() > 15000) ESP.restart();
-  }
-  Serial.println("Connected");
-
+  connectWiFi();
+  
   bot.setPeriod(200);
   bot.setChatID(CHAT_ID);   // передай "" (пустую строку) чтобы отключить проверку
   bot.attach(parseHandler); // подключаем функцию-обработчик
@@ -64,3 +54,17 @@ void parseHandler(String& name, String& msg) {
 void loop() {
   bot.tick();
 }
+
+void connectWiFi() {
+  delay(2000);
+  Serial.begin(115200);
+  Serial.println();
+
+  WiFi.begin(WIFI_SSID, WIFI_PASS);
+  while (WiFi.status() != WL_CONNECTED) {
+    delay(500);
+    Serial.print(".");
+    if (millis() > 15000) ESP.restart();
+  }
+  Serial.println("Connected");
+}

keywords.txt

@@ -30,6 +30,7 @@ sendRequest	KEYWORD2
 autoIncrement	KEYWORD2
 incrementID	KEYWORD2
 chatIDs	KEYWORD2
+setToken	KEYWORD2
 
 #######################################
 # Constants (LITERAL1)

library.properties

@@ -1,5 +1,5 @@
 name=FastBot
-version=1.4
+version=1.5
 author=AlexGyver <[email protected]>
 maintainer=AlexGyver <[email protected]>
 sentence=Simple library for Telegram bot (messages and menus)