Twitter Follower Status Notifier

         ////////////////////////////////////////////////////  
        //         Twiiter Follower Notifier              //
       //                                                //
      //          -------------------------             //
     //                ESP-WROOM-32                    //           
    //               by Kutluhan Aktar                // 
   //                                                //
  ////////////////////////////////////////////////////

// In this project, I wanted to create a tool with ESP32 Development Board to track the number of followers which my Twitter account gets or loses across a time period.
// To achieve that goal, I programmed a web application which detects the number of followers of a registered Twitter account and the stastus of it by getting
// information from Twitter and saving to a SQL database through a web hook without the Twitter authentification  process.
// You can access the source code of the aforementioned web application via the link below if you want to create your web application on your server.
// The web application, named Twitter Notifier Station, produces a data oacket containing the number of current followers of a registered Twitter account,
// the screen name of the account, and the previous and recent status of followers - INC, DEC, STABLE.
//
// INC - There is an increase in the number of followers.
// DEC - There is a decrease in the number of followers.
// STABLE - There is no change in the number of followers.
// Note: The percentage sign(%) is the delimiter to seperate information from the transferrred data packet.
//
// %[Followers]%[Screen_name]%[Previous_Status]%[Current_Status]%
// %174%ThAmplituhedron%INC%STABLE%
//
// Inspect the Twitter Notifier Station web application:
// https://www.theamplituhedron.com/dashboard/Twitter-Notifier-Station/
//
// As a reminder, my website has SSL protection and therefore you need to identify your connection using HTTPS protocols and entering TheAmplituhedron SSL Certificate
// if you are gonna use Twitter Notifier Station provided by TheAmplituhedron in your projects.
// You can learn about it more from the link below.
// https://www.theamplituhedron.com/projects/Twitter-Follower-Notifier/
//
// Connections
// ESP-WROOM-32 :           
//                                LCD Screen I2C
// GND --------------------------- GND
// 5V(VCC) ----------------------- VIN
// G21 --------------------------- SDA
// G22 --------------------------- SCL
//
//                                INC_LED
// 4   --------------------------- 
//                                DEC_LED
// 17  --------------------------- 
//                                BUZZER
// 27  --------------------------- 
//                                Stop_Button
// 18  ---------------------------

// include WiFi.h and WiFiClientSecure.h libraries to make an HTTP Get Request using ESP32 with the root certificate.
#include <WiFi.h>
#include <WiFiClientSecure.h>

// include LiquidCrystal_I2C to run I2C module.
#include <LiquidCrystal_I2C.h>

// initialize the library by associating I2C address for ESP32
LiquidCrystal_I2C lcd(0x27, 20, 4);

// Define your WiFi settings.
const char *ssid = "[WIFI_NAME]";
const char *password = "[WIFI_PASSWORD]";
// Define SSL Certificate to connect to the server.
// If you are using any other host than TheAmplituhedron, you have to change this root certificate and the host name.
const char *host = "www.theamplituhedron.com"; 
const char* certificate = \
"-----BEGIN CERTIFICATE-----\n" \
"MIIDxTCCAq2gAwIBAgIBADANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMCVVMx\n" \
"EDAOBgNVBAgTB0FyaXpvbmExEzARBgNVBAcTClNjb3R0c2RhbGUxGjAYBgNVBAoT\n" \
"EUdvRGFkZHkuY29tLCBJbmMuMTEwLwYDVQQDEyhHbyBEYWRkeSBSb290IENlcnRp\n" \
"ZmljYXRlIEF1dGhvcml0eSAtIEcyMB4XDTA5MDkwMTAwMDAwMFoXDTM3MTIzMTIz\n" \
"NTk1OVowgYMxCzAJBgNVBAYTAlVTMRAwDgYDVQQIEwdBcml6b25hMRMwEQYDVQQH\n" \
"EwpTY290dHNkYWxlMRowGAYDVQQKExFHb0RhZGR5LmNvbSwgSW5jLjExMC8GA1UE\n" \
"AxMoR28gRGFkZHkgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkgLSBHMjCCASIw\n" \
"DQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL9xYgjx+lk09xvJGKP3gElY6SKD\n" \
"E6bFIEMBO4Tx5oVJnyfq9oQbTqC023CYxzIBsQU+B07u9PpPL1kwIuerGVZr4oAH\n" \
"/PMWdYA5UXvl+TW2dE6pjYIT5LY/qQOD+qK+ihVqf94Lw7YZFAXK6sOoBJQ7Rnwy\n" \
"DfMAZiLIjWltNowRGLfTshxgtDj6AozO091GB94KPutdfMh8+7ArU6SSYmlRJQVh\n" \
"GkSBjCypQ5Yj36w6gZoOKcUcqeldHraenjAKOc7xiID7S13MMuyFYkMlNAJWJwGR\n" \
"tDtwKj9useiciAF9n9T521NtYJ2/LOdYq7hfRvzOxBsDPAnrSTFcaUaz4EcCAwEA\n" \
"AaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAQYwHQYDVR0OBBYE\n" \
"FDqahQcQZyi27/a9BUFuIMGU2g/eMA0GCSqGSIb3DQEBCwUAA4IBAQCZ21151fmX\n" \
"WWcDYfF+OwYxdS2hII5PZYe096acvNjpL9DbWu7PdIxztDhC2gV7+AJ1uP2lsdeu\n" \
"9tfeE8tTEH6KRtGX+rcuKxGrkLAngPnon1rpN5+r5N9ss4UXnT3ZJE95kTXWXwTr\n" \
"gIOrmgIttRD02JDHBHNA7XIloKmf7J6raBKZV8aPEjoJpL1E/QYVN8Gb5DKj7Tjo\n" \
"2GTzLH4U/ALqn83/B2gX2yKQOC16jdFU8WnjXzPKej17CuPKf1855eJ1usV2GDPO\n" \
"LPAvTK33sefOT6jEm0pUBsV/fdUID+Ic/n4XuKxe9tQWskMJDE32p2u0mYRlynqI\n" \
"4uJEvlz36hz1\n" \
"-----END CERTIFICATE-----\n";

// Define your notifier path settings.
// Do not forget to enter your hedron to connect your notifier path on TheAmplituhedron properly.
String SERVER = "https://www.theamplituhedron.com/dashboard/Twitter-Notifier-Station/";
String HEDRON = "[YOUR_HEDRON]";
String NOTIFIER_PATH = SERVER + HEDRON + ".php";

// Define data holders.
String readString, screen_name, previous_status, status;
int followers;

// Define INC_LED, DEC_LED, Stop_Button, and BUZZER pins.
int INC_LED = 4;
int DEC_LED = 17;
int Stop_Button = 18;
int BUZZER = 27;

// Define the exit boolean to turn off notifier.
boolean EXIT = false;

void setup(){
  pinMode(INC_LED, OUTPUT);
  pinMode(DEC_LED, OUTPUT);
  pinMode(Stop_Button, INPUT);
  
  // BUZZER
  ledcSetup(0,8000,12);
  ledcAttachPin(BUZZER,0);
  
  Serial.begin(115200);
  
  // Connect ESP32 to your WiFi.
  WiFi.begin(ssid, password);
  
  Serial.print("Try to connect to WiFi. Please wait! ");
  // Wait until successful connection established.
  while (WiFi.status() != WL_CONNECTED) {
    delay(500);
    Serial.print("*");
  }

  // If connection is successful, write WiFi SSID to serial monitor along with assigned IPAddress.
  Serial.print("\n\n-------------------------------------\n\nConnection is successful!\n\nConnected WiFi SSID :");
  Serial.print(ssid);
  Serial.print("\n\nConnected IP_Adress: \n\n");
  //Serial.println(WiFi.localIP());

  // initialize LCD Screen.
  lcd.init();

  // turn on LCD backlight                      
  lcd.backlight();
 
}

void loop(){
  // define client.
  WiFiClientSecure client;
  // set the root certificate - CA_Cert.
  client.setCACert(certificate);
  // If the host is not responding,return.
  if(!client.connect(host, 443)){
    Serial.println("Connection Failed!");
    return;
  }  
  // Send a GET request to the notifier path ro receive variables.
  client.print(String("GET ") + NOTIFIER_PATH + " HTTP/1.1\r\n" + "Host: " + host + "\r\n" + "Connection: close\r\n\r\n");
  // Detect whether client is responding properly or not.
  unsigned long timeout = millis();
  while (client.available() == 0) {
    if (millis() - timeout > 5000) {
       Serial.println(">>> Client Timeout !");
       client.stop();
       return;
    }
  }
  
  // Save variables coming from the notifier path.
  while(client.available()){
      // By using the plus character, get the response from the notifier path.
      readString = client.readStringUntil('+'); 

      Serial.print("Succesfully Gathered: \n");
      Serial.print(readString);
  }  
  
  // Split variables from the transferred data packet using the percentage sign(%) as the delimiter.
  int delimiter_1, delimiter_2, delimiter_3, delimiter_4, delimiter_5;
  delimiter_1 = readString.indexOf("%");
  delimiter_2 = readString.indexOf("%", delimiter_1 + 1);
  delimiter_3 = readString.indexOf("%", delimiter_2 + 1);
  delimiter_4 = readString.indexOf("%", delimiter_3 + 1);
  delimiter_5 = readString.indexOf("%", delimiter_4 + 1);
  // Get variables.
  followers = readString.substring(delimiter_1 + 1, delimiter_2).toInt();
  screen_name = readString.substring(delimiter_2 + 1, delimiter_3);
  previous_status = readString.substring(delimiter_3 + 1, delimiter_4);
  status = readString.substring(delimiter_4 + 1, delimiter_5);

  client.stop();

  if(status == "STABLE"){
      lcd.setCursor(0,0);
      lcd.print("Name:" + screen_name);
      lcd.setCursor(0, 1);
      lcd.print("Followers:");
      lcd.setCursor(13, 1);
      lcd.print(followers);
      lcd.setCursor(0, 2);
      lcd.print("Pre_Sta:" + previous_status);
      lcd.setCursor(0, 3);
      lcd.print("Sta:" + status);

      digitalWrite(INC_LED, LOW);
      digitalWrite(DEC_LED, LOW);
      EXIT = false;
      ledcWrite(0,0);
      
  }else if(status == "INC"){
    lcd.clear(); 
    while(EXIT == false){
      lcd.setCursor(2,0);
      lcd.print("Congratulations!");
      lcd.setCursor(0,2);
      lcd.print("You have new");
      lcd.setCursor(0,3);
      lcd.print("followers :)");

      ledcWriteTone(0, 500);
      digitalWrite(INC_LED, HIGH);
      digitalWrite(DEC_LED, LOW);

      if(digitalRead(Stop_Button) > 0){
         EXIT = true;    
         lcd.clear();
      }
    }
  }else if(status == "DEC"){
    lcd.clear(); 
    while(EXIT == false){
      lcd.setCursor(6,0);
      lcd.print("Sorry !");
      lcd.setCursor(0,2);
      lcd.print("You lost");
      lcd.setCursor(0,3);
      lcd.print("followers :(");

      ledcWriteTone(0, 500);
      digitalWrite(INC_LED, LOW);
      digitalWrite(DEC_LED, HIGH);

      if(digitalRead(Stop_Button) > 0){
         EXIT = true;   
         lcd.clear();
      }
    }
  }

  delay(1000);
}