diff --git a/foo.ino b/foo.ino index aed53b7..0070299 100644 --- a/foo.ino +++ b/foo.ino @@ -1,16 +1,16 @@ -#include - -Discord_Webhook discord; -String DISCORD_WEBHOOK = "https://discord.com/api/webhooks/id/token"; // insert your webhook here - -void setup() { - Serial.begin(115200); - discord.begin(DISCORD_WEBHOOK); // init - discord.addWiFi("WiFiName","WiFiPassword"); // update this line to best fit you - discord.connectWiFi(); - discord.send("Hello World"); -} - -void loop() { - +#include + +Discord_Webhook discord; +String DISCORD_WEBHOOK = "https://discord.com/api/webhooks/id/token"; // insert your webhook here + +void setup() { + Serial.begin(115200); + discord.begin(DISCORD_WEBHOOK); // init + discord.addWiFi("WiFiName","WiFiPassword"); // update this line to best fit you + discord.connectWiFi(); + discord.send("Hello World"); +} + +void loop() { + } \ No newline at end of file diff --git a/libraries/examples/bme280_weather/bme280_weather.ino b/libraries/examples/bme280_weather/bme280_weather.ino new file mode 100644 index 0000000..77010f2 --- /dev/null +++ b/libraries/examples/bme280_weather/bme280_weather.ino @@ -0,0 +1,38 @@ +/* + Send BME280 sensor value to Discord using WebHook + You need Adafruit_BME280 library +*/ + + +#include +#include +#include + +Discord_Webhook discord; +// How to get the Webhook URL +// https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks +String DISCORD_WEBHOOK = "https://discord.com/api/webhooks/id/token"; + +Adafruit_BME280 bme; + +void setup() { + Serial.begin(115200); + if(bme.begin(0x76)){ // Sensor address can be 0x76 or 0x77 + Serial.println("BME280 init success"); + } else { + Serial.println("BME280 init failed"); + } + + discord.begin(DISCORD_WEBHOOK); // Initialize the Discord_Webhook object + discord.addWiFi("WiFiName","WiFiPassword"); // Add WiFi credentials (you can add multiples WiFi SSID) + discord.connectWiFi(); // Connect to WiFi +} + +void loop() { + // Send BME280 sensor value to Discord using WebHook every minute + discord.send("Temperature: " + String(bme.readTemperature()) + + "°C - Humidity: " + String(bme.readHumidity()) + + "% - Pressure: " + String(bme.readPressure() / 100.0F) + + " hPa"); + delay(60000); +} \ No newline at end of file diff --git a/libraries/examples/disableDebug/disableDebug.ino b/libraries/examples/disableDebug/disableDebug.ino new file mode 100644 index 0000000..2c04ea8 --- /dev/null +++ b/libraries/examples/disableDebug/disableDebug.ino @@ -0,0 +1,31 @@ +/* + Send Hello World to Discord using WebHook + This example disable serial debug messages + discord.send returns true if the message was sent successfully +*/ + + +#include + +Discord_Webhook discord; +// How to get the Webhook URL +// https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks +String DISCORD_WEBHOOK = "https://discord.com/api/webhooks/id/token"; + +void setup() { + Serial.begin(115200); + discord.begin(DISCORD_WEBHOOK); // Initialize the Discord_Webhook object + discord.disableDebug(); // Disable debug (no serial message will be send) + discord.addWiFi("WiFiName","WiFiPassword"); // Add WiFi credentials (you can add multiples WiFi SSID) + discord.connectWiFi(); // Connect to WiFi + bool message_sent = discord.send("Hello World"); // Send message + if(message_sent) { + Serial.println("Message sent"); + } else { + Serial.println("I AM ERROR"); + } +} + +void loop() { + +} \ No newline at end of file diff --git a/libraries/examples/helloworld/helloworld.ino b/libraries/examples/helloworld/helloworld.ino new file mode 100644 index 0000000..1de55c6 --- /dev/null +++ b/libraries/examples/helloworld/helloworld.ino @@ -0,0 +1,22 @@ +/* + Send Hello World to Discord using WebHook +*/ + +#include + +Discord_Webhook discord; // Create a Discord_Webhook object +// How to get the Webhook URL +// https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks +String DISCORD_WEBHOOK = "https://discord.com/api/webhooks/id/token"; + +void setup() { + Serial.begin(115200); + discord.begin(DISCORD_WEBHOOK); // Initialize the Discord_Webhook object + discord.addWiFi("WiFiName","WiFiPassword"); // Add WiFi credentials (you can add multiples WiFi SSID) + discord.connectWiFi(); // Connect to WiFi + discord.send("Hello World"); // Send Hello World to Discord +} + +void loop() { + +} \ No newline at end of file diff --git a/libraries/examples/variable/variable.ino b/libraries/examples/variable/variable.ino new file mode 100644 index 0000000..13db812 --- /dev/null +++ b/libraries/examples/variable/variable.ino @@ -0,0 +1,24 @@ +/* + Send a message with variables to Discord using WebHook +*/ + +#include + +Discord_Webhook discord; +// How to get the Webhook URL +// https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks +String DISCORD_WEBHOOK = "https://discord.com/api/webhooks/id/token"; + +void setup() { + int variable_int = 69; // Int variable (can be float, long etc...) + String variable_string = "SUS"; // String variable + + Serial.begin(115200); + discord.begin(DISCORD_WEBHOOK); // Initialize the Discord_Webhook object + discord.addWiFi("WiFiName","WiFiPassword"); // Add WiFi credentials (you can add multiples WiFi SSID) + discord.connectWiFi(); // Connect to WiFi + discord.send("When the variable " + String(variable_int) + " is " + variable_string); // Send message +} + +void loop() { +} \ No newline at end of file diff --git a/libraries/keywords.txt b/libraries/keywords.txt new file mode 100644 index 0000000..f5a222f --- /dev/null +++ b/libraries/keywords.txt @@ -0,0 +1,18 @@ +######################################################### +# Syntax Coloring Map for Usini Discord WebHook Library +######################################################### + +######################################################### +# Datatypes (KEYWORD1) +######################################################### +Discord_Webhook KEYWORD1 + +######################################################### +# Methods and Functions (KEYWORD2) +######################################################### +begin KEYWORD2 +addWiFi KEYWORD2 +connectWiFi KEYWORD2 +disableDebug KEYWORD2 +setTTS KEYWORD2 +send KEYWORD2 diff --git a/libraries/library.properties b/libraries/library.properties new file mode 100644 index 0000000..90e08a9 --- /dev/null +++ b/libraries/library.properties @@ -0,0 +1,9 @@ +name=Discord_WebHook +version=1.0.1 +author=Usini +maintainer=Rémi Sarrailh +sentence=Send message on discord using webhook +paragraph=Arduino Library to make a simple discord bot (sending message only) using webhook, compatible with esp8266, esp32 +category=Communication +url=https://github.com/usini/usini_discord_webHook +architectures=* diff --git a/libraries/src/Discord_WebHook.cpp b/libraries/src/Discord_WebHook.cpp new file mode 100644 index 0000000..cf859ef --- /dev/null +++ b/libraries/src/Discord_WebHook.cpp @@ -0,0 +1,139 @@ +/* + Discord_WebHook.cpp + Library for sending messages to Discord via WebHook + + Copyright (c) 2022 µsini + Author : Rémi Sarrailh + Version : 1.0.0 + + The MIT License (MIT) + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to + deal in the Software without restriction, including without limitation the + rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + IN THE SOFTWARE. +*/ + +#include "Discord_WebHook.h" + +// Get webhook url into webhook_url +void Discord_Webhook::begin(String webhook_url) { + Discord_Webhook::webhook_url = webhook_url; +} + +// Add WiFi credentials using WiFiMulti +void Discord_Webhook::addWiFi(const char *ssid, const char *password) { + if (Discord_Webhook::debug) { + Serial.print("[WIFI] Added ssid:"); + Serial.println(ssid); + } + Discord_Webhook::wifi.addAP(ssid, password); +} + +// Wait for WiFi connection to established +void Discord_Webhook::connectWiFi() { + WiFi.mode(WIFI_STA); + if (Discord_Webhook::debug) { + Serial.println("[WiFi] Connecting WiFi"); + } + // wait for WiFi connection + while ((Discord_Webhook::wifi.run() != WL_CONNECTED)) { + if (Discord_Webhook::debug) { + Serial.print("."); + } + delay(100); + } + if (Discord_Webhook::debug) { + Serial.println("[WiFi] Connected"); + } +} + +// Set TTS variable +void Discord_Webhook::setTTS() { Discord_Webhook::tts = true; } + +// Set debug variable to false +void Discord_Webhook::disableDebug() { Discord_Webhook::debug = false; } + +// Send message to Discord, we disable SSL certificate verification for ease of +// use (Warning: this is insecure) +bool Discord_Webhook::send(String content) { + String discord_tts = "false"; + if (Discord_Webhook::tts) { + discord_tts = "true"; + } + + WiFiClientSecure *client = new WiFiClientSecure; // Create a WiFiClientSecure + bool ok = false; + if (client) { + client->setInsecure(); // Disable SSL certificate verification + + HTTPClient https; // Create HTTPClient + if (Discord_Webhook::debug) { + Serial.println("[HTTP] Connecting to Discord..."); + Serial.println("[HTTP] Message: " + content); + Serial.println("[HTTP] TTS: " + discord_tts); + } + + // Begin HTTPS requests + if (https.begin(*client, Discord_Webhook::webhook_url)) { + https.addHeader("Content-Type", "application/json"); // Set request as JSON + + // Send POST request + int httpCode = https.POST("{\"content\":\"" + content + + "\",\"tts\":" + discord_tts + "}"); + if (httpCode > 0) { // if HTTP code is return + if (httpCode == HTTP_CODE_OK || + httpCode == HTTP_CODE_MOVED_PERMANENTLY || + httpCode == HTTP_CODE_NO_CONTENT) { + // Discord webhook has changed and our request is not correct, so it + // will not send response, so we end without getting a response + // https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks + if (Discord_Webhook::debug) { + Serial.println("[HTTP] OK"); + } + ok = true; + } else { + if (Discord_Webhook::debug) { + // This should mainly return an error if token or id is invalid + String payload = https.getString(); + Serial.print("[HTTP] ERROR: "); + Serial.println(payload); + ok = false; + } + } + https.end(); + } else { + if (Discord_Webhook::debug) { + // This will return an error if the server is unreachable + Serial.printf("[HTTP] ERROR: %s\n", + https.errorToString(httpCode).c_str()); + ok = false; + } + } + } else { + if (Discord_Webhook::debug) { + // This will return an error if request failed + Serial.printf("[HTTP] Unable to connect\n"); + ok = false; + } + } + } else { + if (Discord_Webhook::debug) { + // This shouldn't happen but anyway it's better to check + Serial.println("[HTTP] Unable to create client"); + ok = false; + } + } + delete client; + return ok; +} diff --git a/libraries/src/Discord_WebHook.h b/libraries/src/Discord_WebHook.h new file mode 100644 index 0000000..5a2fbd6 --- /dev/null +++ b/libraries/src/Discord_WebHook.h @@ -0,0 +1,74 @@ +/* + Discord_WebHook.h + Library for sending messages to Discord via WebHook + + Copyright (c) 2022 µsini + Author : Rémi Sarrailh + Version : 1.0.0 + + The MIT License (MIT) + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + THE SOFTWARE. +*/ + +#ifndef Discord_WebHook_h +#define Discord_WebHook_h + +#include + +// Define if it is an ESP32 (code should works on new board ESP32-S2/ESP32-C3) +#if defined(ESP32) +#include +#include +#include + +#elif defined(ESP8266) +#include +#include +#include +#include +//#include "WiFiClientSecureAxTLS.h" +#include +#else +// We still open it as ESP32 for compatibility with later version (not tested) +#warning "Library worked on ESP8266/ESP32 only" +#include +#include +#include +#endif + +class Discord_Webhook { +public: + void begin(String webhook_url); + void addWiFi(const char* ssid, const char* password); + void connectWiFi(); + void disableDebug(); + void setTTS(); + bool send(String content); + +private: + #ifdef ESP32 + WiFiMulti wifi; + #endif + #ifdef ESP8266 + ESP8266WiFiMulti wifi; + #endif + String webhook_url; + bool tts = false; + bool debug = true; +}; + +#endif \ No newline at end of file