Merge pull request witnessmenow#33 from rusboard/master

send Chat Action code and example

Author: witnessmenow

examples/ESP8266/ChatAction/ChatAction.ino

@@ -0,0 +1,101 @@
+/*******************************************************************
+*  An example of bot that show bot action message.                *
+*                                                                 *
+*                                                                 *
+*                                                                 *
+*  written by Vadim Sinitski                                      *
+ *******************************************************************/
+#include <ESP8266WiFi.h>
+#include <WiFiClientSecure.h>
+#include <UniversalTelegramBot.h>
+
+// Initialize Wifi connection to the router
+char ssid[] = "XXXXXX";     // your network SSID (name)
+char password[] = "YYYYYY"; // your network key
+
+// Initialize Telegram BOT
+#define BOTtoken "XXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"  // your Bot Token (Get from Botfather)
+
+WiFiClientSecure client;
+UniversalTelegramBot bot(BOTtoken, client);
+
+int Bot_mtbs = 1000; //mean time between scan messages
+long Bot_lasttime;   //last time messages' scan has been done
+bool Start = false;
+
+void handleNewMessages(int numNewMessages) {
+  Serial.println("handleNewMessages");
+  Serial.println(String(numNewMessages));
+
+  for (int i=0; i<numNewMessages; i++) {
+    String chat_id = String(bot.messages[i].chat_id);
+    String text = bot.messages[i].text;
+
+    String from_name = bot.messages[i].from_name;
+    if (from_name == "") from_name = "Guest";
+
+    if (text == "/send_test_action") {
+        bot.sendChatAction(chat_id, "typing");
+        delay(4000);
+        bot.sendMessage(chat_id, "Did you see the action message?");
+
+        // You can't use own message, just choose from one of bellow
+
+        //typing for text messages
+        //upload_photo for photos
+        //record_video or upload_video for videos
+        //record_audio or upload_audio for audio files
+        //upload_document for general files
+        //find_location for location data
+
+        //more info here - https://core.telegram.org/bots/api#sendchataction
+    }
+
+    if (text == "/start") {
+      String welcome = "Welcome to Universal Arduino Telegram Bot library, " + from_name + ".\n";
+      welcome += "This is Chat Action Bot example.\n\n";
+      welcome += "/send_test_action : to send test chat action message\n";
+      bot.sendMessage(chat_id, welcome);
+    }
+  }
+}
+
+
+void setup() {
+  Serial.begin(115200);
+
+  // Set WiFi to station mode and disconnect from an AP if it was Previously
+  // connected
+  WiFi.mode(WIFI_STA);
+  WiFi.disconnect();
+  delay(100);
+
+  // attempt to connect to Wifi network:
+  Serial.print("Connecting Wifi: ");
+  Serial.println(ssid);
+  WiFi.begin(ssid, password);
+
+  while (WiFi.status() != WL_CONNECTED) {
+    Serial.print(".");
+    delay(500);
+  }
+
+  Serial.println("");
+  Serial.println("WiFi connected");
+  Serial.print("IP address: ");
+  Serial.println(WiFi.localIP());
+}
+
+void loop() {
+  if (millis() > Bot_lasttime + Bot_mtbs)  {
+    int numNewMessages = bot.getUpdates(bot.last_message_received + 1);
+
+    while(numNewMessages) {
+      Serial.println("got response");
+      handleNewMessages(numNewMessages);
+      numNewMessages = bot.getUpdates(bot.last_message_received + 1);
+    }
+
+    Bot_lasttime = millis();
+  }
+}

examples/ESP8266/ChatAction/README.md

@@ -0,0 +1,13 @@
+#ESP8266 - Chat Action
+
+This is a basic example of how to use chat action using UniversalTelegramBot for ESP8266 based boards.
+
+Application originally written by [Giancarlo Bacchio]([email protected]) for [ESP8266-TelegramBot library](https://github.com/Gianbacchio/ESP8266-TelegramBot)
+
+Adapted by [Brian Lough](https://github.com/witnessmenow)
+
+NOTE: You will need to enter your SSID, password and bot Token for the example to work.
+
+## License
+
+You may copy, distribute and modify the software provided that modifications are described and licensed for free under [LGPL-3](http://www.gnu.org/licenses/lgpl-3.0.html). Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under [LGPL-3](http://www.gnu.org/licenses/lgpl-3.0.html), but applications that use the library don't have to be.

src/UniversalTelegramBot.cpp

@@ -550,3 +550,26 @@ bool UniversalTelegramBot::checkForOkResponse(String response) {
 
   return false;
 }
+
+bool UniversalTelegramBot::sendChatAction(String chat_id, String text)  {
+
+  bool sent = false;
+  if (_debug) Serial.println("SEND Chat Action Message");
+  long sttime = millis();
+
+  if (text != "") {
+    while (millis() < sttime+8000) {    // loop for a while to send the message
+      String command="bot"+_token+"/sendChatAction?chat_id="+chat_id+"&action="+text;
+      String response = sendGetToTelegram(command);
+
+      if (_debug) Serial.println(response);
+      sent = checkForOkResponse(response);
+
+      if (sent) {
+        break;
+      }
+    }
+  }
+
+  return sent;
+}

src/UniversalTelegramBot.h

@@ -65,6 +65,8 @@ class UniversalTelegramBot
     bool sendMessageWithInlineKeyboard(String chat_id, String text,
         String parse_mode, String keyboard);
 
+    bool sendChatAction(String chat_id, String text);
+
     bool sendPostMessage(JsonObject& payload);
     String sendPostPhoto(JsonObject& payload);
     String sendPhotoByBinary(String chat_id, String contentType, int fileSize,