├── .gitignore ├── keywords.txt ├── examples ├── EchoBot │ ├── arduino_secrets.h │ └── EchoBot.ino ├── Custom_Keyboard │ ├── arduino_secrets.h │ └── Custom_Keyboard.ino └── EchoBot-ESP8266 │ ├── arduino_secrets.h │ └── EchoBot-ESP8266.ino ├── library.properties ├── src ├── TelegramKeyboard.h ├── TelegramBot.h ├── TelegramKeyboard.cpp └── TelegramBot.cpp ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | TelegramBot KEYWORD1 2 | begin KEYWORD2 3 | sendMessage KEYWORD2 4 | getUpdates KEYWORD2 5 | -------------------------------------------------------------------------------- /examples/EchoBot/arduino_secrets.h: -------------------------------------------------------------------------------- 1 | #define SECRET_SSID "" 2 | #define SECRET_PASS "" 3 | #define SECRET_BOT_TOKEN "" 4 | -------------------------------------------------------------------------------- /examples/Custom_Keyboard/arduino_secrets.h: -------------------------------------------------------------------------------- 1 | #define SECRET_SSID "" 2 | #define SECRET_PASS "" 3 | #define SECRET_BOT_TOKEN "" 4 | -------------------------------------------------------------------------------- /examples/EchoBot-ESP8266/arduino_secrets.h: -------------------------------------------------------------------------------- 1 | #define SECRET_SSID "" 2 | #define SECRET_PASS "" 3 | #define SECRET_BOT_TOKEN "" 4 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=TelegramBot 2 | version=1.2.5 3 | author=Casa Jasmina 4 | maintainer=Casa Jasmina 5 | sentence=Arduino library for TelegramBot 6 | paragraph=Arduino library for TelegramBot 7 | category=Communication 8 | url=https://github.com/CasaJasmina/TelegramBot-Library 9 | architectures= samd, esp8266 10 | -------------------------------------------------------------------------------- /src/TelegramKeyboard.h: -------------------------------------------------------------------------------- 1 | // Copyright Casa Jasmina 2016 2 | // LGPL License 3 | // 4 | // TelegramBot library 5 | // https://github.com/CasaJasmina/TelegramBot-Library 6 | 7 | 8 | #ifndef TelegramKeyboard_h 9 | #define TelegramKeyboard_h 10 | #include 11 | 12 | #define ROWS_LIMIT 10 13 | 14 | struct button { 15 | const char* text; 16 | button* next; 17 | }; 18 | 19 | class TelegramKeyboard 20 | 21 | { 22 | public: 23 | TelegramKeyboard(); 24 | void addRow(const char* row[], int length); 25 | String getButton(int nrow, int button); 26 | int length(); 27 | int rowSize(int nrow); 28 | 29 | private: 30 | int nrows = 0; 31 | 32 | button* rows[ROWS_LIMIT]; 33 | int rows_length[ROWS_LIMIT]; 34 | 35 | }; 36 | #endif 37 | -------------------------------------------------------------------------------- /src/TelegramBot.h: -------------------------------------------------------------------------------- 1 | // Copyright Casa Jasmina 2016 2 | // LGPL License 3 | // 4 | // TelegramBot library 5 | // https://github.com/CasaJasmina/TelegramBot-Library 6 | 7 | #ifndef TelegramBot_h 8 | #define TelegramBot_h 9 | 10 | #include 11 | #include 12 | #include 13 | #include 14 | 15 | #define HOST "api.telegram.org" 16 | #define SSL_PORT 443 17 | 18 | #ifndef JSON_BUFF_SIZE 19 | #ifdef ESP8266 20 | #define JSON_BUFF_SIZE 1000 21 | #else 22 | #define JSON_BUFF_SIZE 10000 23 | #endif 24 | #endif 25 | 26 | struct message{ 27 | String text; 28 | String chat_id; 29 | String sender; 30 | String date; 31 | }; 32 | 33 | class TelegramBot 34 | { 35 | public: 36 | TelegramBot(const char* token, Client &client); 37 | void begin(); 38 | String sendMessage(String chat_id, String text); 39 | String sendMessage(String chat_id, String text, TelegramKeyboard &keyboard_markup, bool one_time_keyboard = true, bool resize_keyboard = true); 40 | String postMessage(String msg); 41 | message getUpdates(); 42 | 43 | private: 44 | String readPayload(); 45 | const char* token; 46 | int last_message_recived; 47 | 48 | Client *client; 49 | }; 50 | 51 | #endif 52 | -------------------------------------------------------------------------------- /src/TelegramKeyboard.cpp: -------------------------------------------------------------------------------- 1 | // Copyright Casa Jasmina 2016 2 | // LGPL License 3 | // 4 | // TelegramBot library 5 | // https://github.com/CasaJasmina/TelegramBot-Library 6 | 7 | #include "TelegramKeyboard.h" 8 | 9 | TelegramKeyboard::TelegramKeyboard(){ 10 | } 11 | 12 | void TelegramKeyboard::addRow(const char* row[], int length){ 13 | button* first = new button(); 14 | first->next = NULL; 15 | 16 | rows_length[nrows] = length; 17 | 18 | for (int i = length-1 ; i >= 0; i--) { 19 | button* temp; 20 | temp = new button; 21 | temp->text = row[i]; 22 | temp->next = first; 23 | first = temp; 24 | } 25 | 26 | rows[nrows] = first; 27 | nrows++; 28 | } 29 | 30 | String TelegramKeyboard::getButton(int nrow, int nbutton){ 31 | if (nrow < 1 || nbutton < 1) { 32 | return "error"; 33 | } 34 | 35 | button* first; 36 | first = rows[nrow-1]; 37 | 38 | for (int i = 0; i < nbutton-1 ; i++){ 39 | first = first->next; 40 | } 41 | 42 | if (first == NULL) { 43 | return "overflow"; 44 | } 45 | 46 | return first->text; 47 | } 48 | 49 | int TelegramKeyboard::length(){ 50 | return nrows; 51 | } 52 | 53 | int TelegramKeyboard::rowSize(int nrow){ 54 | return rows_length[nrow - 1]; 55 | } 56 | -------------------------------------------------------------------------------- /examples/EchoBot-ESP8266/EchoBot-ESP8266.ino: -------------------------------------------------------------------------------- 1 | /* 2 | EchoBot on ESP8266 3 | 4 | This example shows how to program a Telegram Bot 5 | that echoes your messages. 6 | 7 | For a step-by-step tutorial visit: 8 | https://create.arduino.cc/projecthub/Arduino_Genuino/telegram-bot-library-ced4d4 9 | 10 | Updated 13 February 2018 11 | by Tommaso Laterza 12 | 13 | This example code is in the public domain. 14 | 15 | */ 16 | 17 | #include "arduino_secrets.h" 18 | #include 19 | #include 20 | #include 21 | 22 | // Initialize Wifi connection to the router 23 | const char* ssid = SECRET_SSID; 24 | const char* password = SECRET_PASS; 25 | 26 | 27 | // Initialize Telegram BOT 28 | const char BotToken[] = SECRET_BOT_TOKEN; 29 | 30 | WiFiClientSecure net_ssl; 31 | TelegramBot bot (BotToken, net_ssl); 32 | 33 | 34 | void setup() { 35 | 36 | Serial.begin(115200); 37 | while (!Serial); // Wait for the Serial monitor to be opened 38 | 39 | // attempt to connect to Wifi network: 40 | Serial.print("Connecting Wifi: "); 41 | WiFi.begin(ssid, password); 42 | while (WiFi.status() != WL_CONNECTED) { 43 | delay(500); 44 | Serial.print("."); 45 | } 46 | Serial.println(""); 47 | Serial.println("WiFi connected"); 48 | 49 | 50 | bot.begin(); 51 | 52 | } 53 | 54 | void loop() { 55 | 56 | message m = bot.getUpdates(); // Read new messages 57 | if ( m.chat_id != 0 ){ // Checks if there are some updates 58 | Serial.println(m.text); 59 | bot.sendMessage(m.chat_id, m.text); // Reply to the same chat with the same text 60 | } else { 61 | Serial.println("no new message"); 62 | } 63 | 64 | } 65 | -------------------------------------------------------------------------------- /examples/EchoBot/EchoBot.ino: -------------------------------------------------------------------------------- 1 | /* 2 | EchoBot 3 | 4 | This example shows how to program a Telegram Bot 5 | that echoes your messages. 6 | 7 | For a step-by-step tutorial visit: 8 | https://create.arduino.cc/projecthub/Arduino_Genuino/telegram-bot-library-ced4d4 9 | 10 | In oreder to make the bot more reliable in the long run we suggest using a watchdog 11 | The Adafruit_SleepyDog is a handy library that will reset the board if something goes wrong 12 | 13 | Updated 29 May 2016 14 | by Tommaso Laterza 15 | Updated 13 February 2018 16 | by Tommaso Laterza 17 | 18 | This example code is in the public domain. 19 | 20 | */ 21 | 22 | #include "arduino_secrets.h" 23 | #include 24 | #include 25 | #include 26 | 27 | // Initialize Wifi connection to the router 28 | char ssid[] = SECRET_SSID; // your network SSID (name) 29 | char pass[] = SECRET_PASS; // your network key 30 | 31 | // Initialize Telegram BOT 32 | const char BotToken[] = SECRET_BOT_TOKEN; 33 | 34 | WiFiSSLClient client; 35 | TelegramBot bot (BotToken, client); 36 | 37 | 38 | void setup() { 39 | 40 | Serial.begin(115200); 41 | while (!Serial) {} // Wait for the Serial monitor to be opened 42 | delay(3000); 43 | 44 | // attempt to connect to Wifi network: 45 | Serial.print("Connecting Wifi: "); 46 | Serial.println(ssid); 47 | while (WiFi.begin(ssid, pass) != WL_CONNECTED) { 48 | Serial.print("."); 49 | delay(500); 50 | } 51 | Serial.println(""); 52 | Serial.println("WiFi connected"); 53 | 54 | bot.begin(); 55 | } 56 | 57 | void loop() { 58 | 59 | message m = bot.getUpdates(); // Read new messages 60 | if ( m.chat_id != 0 ){ // Checks if there are some updates 61 | Serial.println(m.text); 62 | bot.sendMessage(m.chat_id, m.text); // Reply to the same chat with the same text 63 | } else { 64 | Serial.println("no new message"); 65 | } 66 | 67 | } 68 | -------------------------------------------------------------------------------- /examples/Custom_Keyboard/Custom_Keyboard.ino: -------------------------------------------------------------------------------- 1 | /* 2 | EchoBot 3 | 4 | This example shows how to program a Telegram Bot 5 | that echoes your messages using a custom keyboard. 6 | 7 | For a step-by-step tutorial visit: 8 | https://create.arduino.cc/projecthub/Arduino_Genuino/telegram-bot-library-ced4d4 9 | 10 | In oreder to make the bot more reliable in the long run we suggest using a watchdog 11 | The Adafruit_SleepyDog is a handy library that will reset the board if something goes wrong 12 | 13 | Updated 29 May 2016 14 | by Tommaso Laterza 15 | Updated 13 February 2018 16 | by Tommaso Laterza 17 | 18 | This example code is in the public domain. 19 | 20 | */ 21 | 22 | #include "arduino_secrets.h" 23 | #include 24 | #include 25 | #include 26 | 27 | // Initialize Wifi connection to the router 28 | char ssid[] = SECRET_SSID; // your network SSID (name) 29 | char pass[] = SECRET_PASS; // your network key 30 | 31 | // Initialize Telegram BOT 32 | const char BotToken[] = SECRET_BOT_TOKEN; 33 | 34 | WiFiSSLClient client; 35 | TelegramBot bot (BotToken, client); 36 | TelegramKeyboard keyboard_one; 37 | 38 | void setup() { 39 | 40 | Serial.begin(115200); 41 | while (!Serial) {} // Wait for the Serial monitor to be opened 42 | delay(3000); 43 | 44 | // attempt to connect to Wifi network: 45 | Serial.print("Connecting Wifi: "); 46 | Serial.println(ssid); 47 | while (WiFi.begin(ssid, pass) != WL_CONNECTED) { 48 | Serial.print("."); 49 | delay(500); 50 | } 51 | Serial.println(""); 52 | Serial.println("WiFi connected"); 53 | 54 | // define your row's 55 | const char* row_one[] = {"true", "false"}; 56 | const char* row_two[] = {"one", "two", "three", "hello!"}; 57 | 58 | // assing a row to one or more keyboards 59 | // second argument is the length of the row 60 | keyboard_one.addRow(row_one, 2); 61 | keyboard_one.addRow(row_two, 4); 62 | bot.begin(); 63 | } 64 | 65 | void loop() { 66 | 67 | message m = bot.getUpdates(); // Read new messages 68 | if ( m.chat_id != 0 ) { // Checks if there are some updates 69 | Serial.println(m.text); 70 | bot.sendMessage(m.chat_id, m.text, keyboard_one); // Reply to the same chat with the same text 71 | } else { 72 | Serial.println("no new message"); 73 | } 74 | 75 | delay(2000); 76 | } 77 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # TelegramBot Library 2 | 3 | 4 | A project by [Casa Jasmina](http://casajasmina.arduino.cc/) 5 | 6 | ## Introduction 7 | 8 | This library allows you to host a Telegram Bot on your Arduino, and interact with telegram bot API. 9 | 10 | It works on [Arduino/Genuino MKR1000] (http://www.arduino.cc/en/Main/ArduinoMKR1000), and on [Arduino Zero](https://www.arduino.cc/en/Main/ArduinoBoardZero) with the [WiFi shield 101](https://www.arduino.cc/en/Main/ArduinoWiFiShield101). 11 | 12 | ## Installing 13 | 14 | The library can be installed from the library manager or added manually selecting the menu: 15 | 16 | Sketch / include Library / Add .Zip library 17 | 18 | You also have to install the ArduinoJson library written by [Benoît Blanchon](https://github.com/bblanchon). 19 | Available [here](https://github.com/bblanchon/ArduinoJson). 20 | 21 | 22 | ## Getting started 23 | 24 | View the last released Telegram API documentation at: https://core.telegram.org/bots/api. 25 | 26 | To generate your new Bot, you need an Access Token. Talk to [BotFather](https://telegram.me/botfather) and follow a few simple steps described [here](https://core.telegram.org/bots#botfather). 27 | 28 | For full details, see "[Bots: An introduction for developers](https://core.telegram.org/bots)". 29 | 30 | ## Api Reference 31 | ```c++ 32 | TelegramBot(const char* token, Client &client); 33 | ``` 34 | ```c++ 35 | String sendMessage(String chat_id, String my_text); 36 | ``` 37 | ```c++ 38 | String sendMessage(String chat_id, String my_text, Keyboard keyboard, bool one_time_keyboard = true, bool resize_keyboard = true); 39 | ``` 40 | ```c++ 41 | String postMessage(String msg); 42 | ``` 43 | ```c++ 44 | message getUpdates(); 45 | ``` 46 | 47 | ```c++ 48 | struct message{ 49 | const char* text; 50 | const char* chat_id; 51 | const char* sender; 52 | const char* date; 53 | }; 54 | ``` 55 | ## Groups implementation 56 | 57 | When the bot is included in a group it will be, by default, in privacy mode. Which means that it will receive only messages starting with "/", the so called commands. 58 | In order to disable the privacy mode you have to chat with BotFather and use this commands: 59 | 60 | ``` 61 | /mybots 62 | @yourBot 63 | Bot setting 64 | Group privacy 65 | Turn off 66 | ``` 67 | You can also create your own list of commands using /setcommands while chatting with the BotFather. This list will appear only in the mobile view, pressing the "/" icon. 68 | 69 | ## Reliability 70 | 71 | In the long run we recommend to use a watchdog. If you are using the library [Adafruit sleepy dog](https://github.com/adafruit/Adafruit_SleepyDog) in its 1.1.1 (or later) version, you have also to download the [Adafruit_ASFcore](https://github.com/adafruit/Adafruit_ASFcore) library. 72 | 73 | ## License 74 | 75 | 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. 76 | -------------------------------------------------------------------------------- /src/TelegramBot.cpp: -------------------------------------------------------------------------------- 1 | // Official 2 | // Copyright Casa Jasmina 2016 3 | // LGPL License 4 | // 5 | // TelegramBot library 6 | // https://github.com/CasaJasmina/TelegramBot-Library 7 | 8 | #include "TelegramBot.h" 9 | 10 | TelegramBot::TelegramBot(const char* token, Client &client) { 11 | this->client = &client; 12 | this->token=token; 13 | } 14 | 15 | 16 | void TelegramBot::begin() { 17 | if(!client->connected()){ 18 | client->connect(HOST, SSL_PORT); 19 | } 20 | } 21 | 22 | /************************************************************************************ 23 | * GetUpdates - function to receive messages from telegram as a Json and parse them * 24 | ************************************************************************************/ 25 | message TelegramBot::getUpdates() { 26 | begin(); 27 | 28 | //Send your request to api.telegram.org 29 | String getRequest = "GET /bot"+String(token)+"/getUpdates?limit=1&offset="+String(last_message_recived)+" HTTP/1.1"; 30 | client->println(getRequest); 31 | client->println("User-Agent: curl/7.37.1"); 32 | client->println("Host: api.telegram.org"); 33 | client->println("Accept: */*"); 34 | client->println(); 35 | 36 | String payload = readPayload(); 37 | if (payload != "") { 38 | message m; 39 | StaticJsonBuffer jsonBuffer; 40 | JsonObject & root = jsonBuffer.parseObject(payload); 41 | 42 | 43 | 44 | if(root.success()){ 45 | 46 | int update_id = root["result"][0]["update_id"]; 47 | update_id = update_id+1; 48 | 49 | if(last_message_recived != update_id ){ 50 | String sender = root["result"][0]["message"]["from"]["username"]; 51 | String text = root["result"][0]["message"]["text"]; 52 | String chat_id = root["result"][0]["message"]["chat"]["id"]; 53 | String date = root["result"][0]["message"]["date"]; 54 | 55 | m.sender = sender; 56 | m.text = text; 57 | m.chat_id = chat_id; 58 | m.date = date; 59 | last_message_recived=update_id; 60 | return m; 61 | }else{ 62 | m.chat_id = ""; 63 | return m; 64 | } 65 | } 66 | else{ 67 | Serial.println(""); 68 | Serial.println("Message too long, skipped."); 69 | Serial.println(""); 70 | int update_id_first_digit=0; 71 | int update_id_last_digit=0; 72 | for(int a =0; a<3; a++){ 73 | update_id_first_digit= payload.indexOf(':',update_id_first_digit+1); 74 | } 75 | for(int a =0; a<2; a++){ 76 | update_id_last_digit= payload.indexOf(',',update_id_last_digit+1); 77 | } 78 | last_message_recived = payload.substring(update_id_first_digit+1,update_id_last_digit).toInt() +1; 79 | } 80 | } 81 | } 82 | 83 | // send message function 84 | // send a simple text message to a telegram char 85 | String TelegramBot::sendMessage(String chat_id, String text) { 86 | if(chat_id!="0" && chat_id!=""){ 87 | StaticJsonBuffer jsonBuffer; 88 | JsonObject& buff = jsonBuffer.createObject(); 89 | buff["chat_id"] = chat_id; 90 | buff["text"] = text; 91 | 92 | String msg; 93 | buff.printTo(msg); 94 | return postMessage(msg); 95 | } else { 96 | Serial.println("Chat_id not defined"); 97 | } 98 | } 99 | 100 | // send a message to a telegram chat with a reply markup 101 | String TelegramBot::sendMessage(String chat_id, String text, TelegramKeyboard &keyboard_markup, bool one_time_keyboard, bool resize_keyboard) { 102 | StaticJsonBuffer jsonBuffer; 103 | JsonObject& buff = jsonBuffer.createObject(); 104 | buff["chat_id"] = chat_id; 105 | buff["text"] = text; 106 | 107 | JsonObject& reply_markup = buff.createNestedObject("reply_markup"); 108 | JsonArray& keyboard = reply_markup.createNestedArray("keyboard"); 109 | 110 | for (int a = 1 ; a <= keyboard_markup.length() ; a++){ 111 | JsonArray& row = keyboard.createNestedArray(); 112 | for( int b = 1; b <= keyboard_markup.rowSize(a) ; b++){ 113 | row.add(keyboard_markup.getButton(a,b)); 114 | } 115 | } 116 | 117 | reply_markup.set("one_time_keyboard", one_time_keyboard); 118 | reply_markup.set("resize_keyboard", resize_keyboard); 119 | reply_markup.set("selective", false); 120 | 121 | String msg; 122 | buff.printTo(msg); 123 | // Serial.println(msg); 124 | return postMessage(msg); 125 | } 126 | 127 | // gets the telegram json string 128 | // posts the message to telegram 129 | // returns the payload 130 | String TelegramBot::postMessage(String msg) { 131 | begin(); 132 | 133 | client->println("POST /bot"+String(token)+"/sendMessage"+" HTTP/1.1"); 134 | client->println("Host: api.telegram.org"); 135 | client->println("Content-Type: application/json"); 136 | client->println("Connection: close"); 137 | client->print("Content-Length: "); 138 | client->println(msg.length()); 139 | client->println(); 140 | client->println(msg); 141 | 142 | return readPayload(); 143 | } 144 | 145 | // reads the payload coming from telegram server 146 | // returns the payload string 147 | String TelegramBot::readPayload(){ 148 | char c; 149 | String payload=""; 150 | //Read the answer and save it in String payload 151 | while (client->connected()) { 152 | payload = client->readStringUntil('\n'); 153 | if (payload == "\r") { 154 | break; 155 | } 156 | } 157 | payload = client->readStringUntil('\r'); 158 | // Serial.println(payload); 159 | return payload; 160 | } 161 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | (This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.) 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | {description} 474 | Copyright (C) {year} {fullname} 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | {signature of Ty Coon}, 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | --------------------------------------------------------------------------------