├── src ├── CallbackFunction.h ├── WemoManager.h ├── WemoSwitch.h ├── WemoManager.cpp └── WemoSwitch.cpp ├── .gitignore ├── library.properties ├── .gitattributes ├── examples ├── SingleSwitch │ └── SingleSwitch.ino └── MultiSwitch │ └── MultiSwitch.ino ├── README.md └── LICENSE.md /src/CallbackFunction.h: -------------------------------------------------------------------------------- 1 | #ifndef CALLBACKFUNCTION_H 2 | #define CALLBACKFUNCTION_H 3 | 4 | #include 5 | 6 | typedef std::function CallbackFunction; 7 | 8 | #endif 9 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files 2 | *.slo 3 | *.lo 4 | *.o 5 | *.obj 6 | 7 | # Precompiled Headers 8 | *.gch 9 | *.pch 10 | 11 | # Compiled Dynamic libraries 12 | *.so 13 | *.dylib 14 | *.dll 15 | 16 | # Fortran module files 17 | *.mod 18 | 19 | # Compiled Static libraries 20 | *.lai 21 | *.la 22 | *.a 23 | *.lib 24 | 25 | # Executables 26 | *.exe 27 | *.out 28 | *.app 29 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=Esp32AlexaWemoEmulator 2 | version=1.0 3 | author=Brian Lough (adapted for ESP32 by Igor Antolic) 4 | maintainer=Brian Lough 5 | sentence=Use your esp32 with the Alexa by emulating a Wemo plug 6 | paragraph=Use your esp32 with the Alexa by emulating a Wemo plug 7 | category=Communication 8 | url=https://github.com/witnessmenow/esp8266-alexa-wemo-emulator.git 9 | architectures=* 10 | -------------------------------------------------------------------------------- /src/WemoManager.h: -------------------------------------------------------------------------------- 1 | #ifndef WemoManager_h 2 | #define WemoManager_h 3 | 4 | #include 5 | #include 6 | #include 7 | #include "WemoSwitch.h" 8 | 9 | class WemoManager { 10 | private: 11 | WiFiUDP UDP; 12 | public: 13 | WemoManager(); 14 | ~WemoManager(); 15 | bool begin(); 16 | void serverLoop(); 17 | void addDevice(WemoSwitch& device); 18 | }; 19 | 20 | #endif 21 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | 4 | # Custom for Visual Studio 5 | *.cs diff=csharp 6 | 7 | # Standard to msysgit 8 | *.doc diff=astextplain 9 | *.DOC diff=astextplain 10 | *.docx diff=astextplain 11 | *.DOCX diff=astextplain 12 | *.dot diff=astextplain 13 | *.DOT diff=astextplain 14 | *.pdf diff=astextplain 15 | *.PDF diff=astextplain 16 | *.rtf diff=astextplain 17 | *.RTF diff=astextplain 18 | -------------------------------------------------------------------------------- /src/WemoSwitch.h: -------------------------------------------------------------------------------- 1 | #ifndef WemoSwitch_H 2 | #define WemoSwitch_H 3 | 4 | #include 5 | #include 6 | #include 7 | #include 8 | #include "CallbackFunction.h" 9 | 10 | 11 | class WemoSwitch { 12 | private: 13 | WebServer *server = NULL; 14 | WiFiUDP UDP; 15 | String serial; 16 | String persistent_uuid; 17 | String device_name; 18 | unsigned int localPort; 19 | String deviceStatus; 20 | CallbackFunction onCallback; 21 | CallbackFunction offCallback; 22 | 23 | void startWebServer(); 24 | void handleEventservice(); 25 | void handleUpnpControl(); 26 | void handleRoot(); 27 | void handleSetupXml(); 28 | public: 29 | WemoSwitch(); 30 | WemoSwitch(String alexaInvokeName, unsigned int port, CallbackFunction onCallback, CallbackFunction offCallback); 31 | ~WemoSwitch(); 32 | String getAlexaInvokeName(); 33 | void serverLoop(); 34 | void respondToSearch(IPAddress& senderIP, unsigned int senderPort); 35 | }; 36 | 37 | #endif 38 | -------------------------------------------------------------------------------- /examples/SingleSwitch/SingleSwitch.ino: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | #include "WemoSwitch.h" 4 | #include "WemoManager.h" 5 | #include "CallbackFunction.h" 6 | 7 | // prototypes 8 | boolean connectWifi(); 9 | 10 | //on/off callbacks 11 | void lightOn(); 12 | void lightOff(); 13 | 14 | //------- Replace the following! ------ 15 | char ssid[] = "xxx"; // your network SSID (name) 16 | char password[] = "yyyy"; // your network key 17 | 18 | WemoManager wemoManager; 19 | WemoSwitch *light = NULL; 20 | 21 | const int ledPin = 19; 22 | 23 | void setup() 24 | { 25 | Serial.begin(115200); 26 | 27 | // Set WiFi to station mode and disconnect from an AP if it was Previously 28 | // connected 29 | WiFi.mode(WIFI_STA); 30 | WiFi.disconnect(); 31 | delay(100); 32 | 33 | // Attempt to connect to Wifi network: 34 | Serial.print("Connecting Wifi: "); 35 | Serial.println(ssid); 36 | WiFi.begin(ssid, password); 37 | while (WiFi.status() != WL_CONNECTED) { 38 | Serial.print("."); 39 | delay(500); 40 | } 41 | Serial.println(""); 42 | Serial.println("WiFi connected"); 43 | Serial.println("IP address: "); 44 | IPAddress ip = WiFi.localIP(); 45 | Serial.println(ip); 46 | 47 | wemoManager.begin(); 48 | // Format: Alexa invocation name, local port no, on callback, off callback 49 | light = new WemoSwitch("DESK lights", 80, lightOn, lightOff); 50 | wemoManager.addDevice(*light); 51 | 52 | pinMode(ledPin, OUTPUT); // initialize digital ledPin as an output. 53 | delay(10); 54 | digitalWrite(ledPin, HIGH); // Wemos BUILTIN_LED is active Low, so high is off 55 | } 56 | 57 | void loop() 58 | { 59 | wemoManager.serverLoop(); 60 | } 61 | 62 | void lightOn() { 63 | Serial.print("Switch 1 turn on ..."); 64 | digitalWrite(ledPin, LOW); 65 | } 66 | 67 | void lightOff() { 68 | Serial.print("Switch 1 turn off ..."); 69 | digitalWrite(ledPin, HIGH); 70 | } 71 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Home automation -> Alexa + ESP32 to control lights, switches 2 | 3 | "Alexa, turn living room lights on" 4 | 5 | This one works without cloud service - it is local only since it emulates Wemo switch. 6 | (aka "Arduino Esp32 Alexa Wemo switch emulator", (!)) 7 | 8 | This project is completly based on the [forked repo](https://github.com/witnessmenow/esp8266-alexa-wemo-emulator) done by witnessmenow and [forked repo](https://github.com/kakopappa/arduino-esp8266-alexa-multiple-wemo-switch) kakopappa. ALL CREDITS ACCTUALLY GO TO THEM! 9 | Only thing changed is that it works with ESP32. 10 | I didnt have time to set flag (#define)... (sorry) 11 | 12 | Modified instructions: 13 | 14 | This library enables your esp32 to simulate a Belkin Wemo switch. It can be discovered as a device by your Amazon Echo/Dot on the Smart home section. It supports calling the emulated device a custom name e.g. "Alexa, turn off test lights", where test lights is the custom name 15 | 16 | The library supports emulating up to 14 switches using 1 ESP32 chip. (Can do even more but ... who needs more than that) 17 | 18 | ## Installing 19 | 20 | The downloaded code can be included as a new library into the IDE selecting the menu: 21 | 22 | Sketch / include Library / Add .Zip library 23 | 24 | Restart the Arduino IDE and follow the examples located at 25 | 26 | File -> Examples -> Esp32AlexaWemoEmulator 27 | 28 | Note: you might need 29 | 30 | https://github.com/zhouhan0126/WebServer-esp32 31 | 32 | ## Activating and using with Amazon Echo Dot / Alexa 33 | 34 | After uploading sketch to microcontroler (and waiting a few seconds to let it connect to local WiFI, say: 35 | 36 | "Alexa, discover devices!" 37 | 38 | Alexa should find as many switches you configured, and should know them by names you defined in code. If you name some switch as "Living room light" you can say: 39 | 40 | "Alexa, turn living room lights on" 41 | -------------------------------------------------------------------------------- /examples/MultiSwitch/MultiSwitch.ino: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | #include "WemoSwitch.h" 4 | #include "WemoManager.h" 5 | #include "CallbackFunction.h" 6 | 7 | // prototypes 8 | boolean connectWifi(); 9 | 10 | //on/off callbacks 11 | void lightOn(); 12 | void lightOff(); 13 | void secondOn(); 14 | void secondOff(); 15 | 16 | //------- Replace the following! ------ 17 | char ssid[] = "xxx"; // your network SSID (name) 18 | char password[] = "yyyy"; // your network key 19 | 20 | WemoManager wemoManager; 21 | WemoSwitch *light = NULL; 22 | WemoSwitch *second = NULL; 23 | 24 | const int ledPin = BUILTIN_LED; 25 | 26 | void setup() 27 | { 28 | Serial.begin(115200); 29 | 30 | // Set WiFi to station mode and disconnect from an AP if it was Previously 31 | // connected 32 | WiFi.mode(WIFI_STA); 33 | WiFi.disconnect(); 34 | delay(100); 35 | 36 | // Attempt to connect to Wifi network: 37 | Serial.print("Connecting Wifi: "); 38 | Serial.println(ssid); 39 | WiFi.begin(ssid, password); 40 | while (WiFi.status() != WL_CONNECTED) { 41 | Serial.print("."); 42 | delay(500); 43 | } 44 | Serial.println(""); 45 | Serial.println("WiFi connected"); 46 | Serial.println("IP address: "); 47 | IPAddress ip = WiFi.localIP(); 48 | Serial.println(ip); 49 | 50 | wemoManager.begin(); 51 | // Format: Alexa invocation name, local port no, on callback, off callback 52 | light = new WemoSwitch("test lights", 80, lightOn, lightOff); 53 | second = new WemoSwitch("second lights", 81, secondOn, secondOff); 54 | wemoManager.addDevice(*light); 55 | wemoManager.addDevice(*second); 56 | 57 | pinMode(ledPin, OUTPUT); // initialize digital ledPin as an output. 58 | delay(10); 59 | digitalWrite(ledPin, HIGH); // Wemos BUILTIN_LED is active Low, so high is off 60 | } 61 | 62 | void loop() 63 | { 64 | wemoManager.serverLoop(); 65 | } 66 | 67 | void lightOn() { 68 | Serial.print("Switch 1 turn on ..."); 69 | digitalWrite(ledPin, LOW); 70 | } 71 | 72 | void lightOff() { 73 | Serial.print("Switch 1 turn off ..."); 74 | digitalWrite(ledPin, HIGH); 75 | } 76 | 77 | void secondOn() { 78 | Serial.print("Switch 2 turn on ..."); 79 | digitalWrite(ledPin, LOW); 80 | } 81 | 82 | void secondOff() { 83 | Serial.print("Switch 2 turn off ..."); 84 | digitalWrite(ledPin, HIGH); 85 | } 86 | -------------------------------------------------------------------------------- /src/WemoManager.cpp: -------------------------------------------------------------------------------- 1 | #include "WemoManager.h" 2 | #include "WemoSwitch.h" 3 | #include 4 | 5 | // Multicast declarations 6 | IPAddress ipMulti(239, 255, 255, 250); 7 | const unsigned int portMulti = 1900; 8 | char packetBuffer[512]; 9 | 10 | #define MAX_SWITCHES 14 11 | WemoSwitch switches[MAX_SWITCHES] = {}; 12 | int numOfSwitchs = 0; 13 | 14 | //#define numOfSwitchs (sizeof(switches)/sizeof(Switch)) //array size 15 | 16 | //<> 17 | WemoManager::WemoManager(){ 18 | 19 | } 20 | 21 | //<> 22 | WemoManager::~WemoManager(){/*nothing to destruct*/} 23 | 24 | bool WemoManager::begin(){ 25 | boolean state = false; 26 | 27 | Serial.println("Begin multicast .."); 28 | 29 | //if(UDP.beginMulticast(WiFi.localIP(), ipMulti, portMulti)) { 30 | if(UDP.beginMulticast(ipMulti, portMulti)) { 31 | Serial.print("Udp multicast server started at "); 32 | Serial.print(ipMulti); 33 | Serial.print(":"); 34 | Serial.println(portMulti); 35 | 36 | state = true; 37 | } 38 | else{ 39 | Serial.println("Connection failed"); 40 | } 41 | 42 | return state; 43 | } 44 | 45 | //Switch *ptrArray; 46 | 47 | void WemoManager::addDevice(WemoSwitch& device) { 48 | Serial.print("Adding switch : "); 49 | Serial.print(device.getAlexaInvokeName()); 50 | Serial.print(" index : "); 51 | Serial.println(numOfSwitchs); 52 | 53 | switches[numOfSwitchs] = device; 54 | numOfSwitchs++; 55 | } 56 | 57 | void WemoManager::serverLoop(){ 58 | 59 | int packetSize = UDP.parsePacket(); 60 | if (packetSize > 0) 61 | { 62 | IPAddress senderIP = UDP.remoteIP(); 63 | unsigned int senderPort = UDP.remotePort(); 64 | 65 | // read the packet into the buffer 66 | UDP.read(packetBuffer, packetSize); 67 | 68 | // check if this is a M-SEARCH for WeMo device 69 | String request = String((char *)packetBuffer); 70 | //Serial.println("----------"); 71 | //Serial.println(request); 72 | //Serial.println("-----------"); 73 | if(request.indexOf("M-SEARCH") >= 0) { 74 | if((request.indexOf("urn:Belkin:device:**") > 0) || (request.indexOf("ssdp:all") > 0) || (request.indexOf("upnp:rootdevice") > 0)) { 75 | Serial.println("Got UDP Belkin Request.."); 76 | 77 | // int arrSize = sizeof(switchs) / sizeof(Switch); 78 | 79 | for(int n = 0; n < numOfSwitchs; n++) { 80 | WemoSwitch &sw = switches[n]; 81 | 82 | if (&sw != NULL) { 83 | sw.respondToSearch(senderIP, senderPort); 84 | } 85 | } 86 | } 87 | } 88 | } 89 | 90 | for(int i = 0; i < numOfSwitchs; i++) { 91 | WemoSwitch &swit = switches[i]; 92 | 93 | if (&swit != NULL) { 94 | swit.serverLoop(); 95 | } 96 | } 97 | } 98 | -------------------------------------------------------------------------------- /src/WemoSwitch.cpp: -------------------------------------------------------------------------------- 1 | #include "WemoSwitch.h" 2 | #include "CallbackFunction.h" 3 | 4 | 5 | 6 | //<> 7 | WemoSwitch::WemoSwitch(){ 8 | //Serial.println("default constructor called"); 9 | } 10 | //WemoSwitch::WemoSwitch(String alexaInvokeName,unsigned int port){ 11 | WemoSwitch::WemoSwitch(String alexaInvokeName, unsigned int port, CallbackFunction oncb, CallbackFunction offcb){ 12 | uint32_t uniqueSwitchId = /*ESP.getChipId()*/ 123456+ port ; 13 | char uuid[64]; 14 | sprintf_P(uuid, PSTR("38323636-4558-4dda-9188-cda0e6%02x%02x%02x"), 15 | (uint16_t) ((uniqueSwitchId >> 16) & 0xff), 16 | (uint16_t) ((uniqueSwitchId >> 8) & 0xff), 17 | (uint16_t) uniqueSwitchId & 0xff); 18 | 19 | serial = String(uuid); 20 | persistent_uuid = "Socket-1_0-" + serial+"-"+ String(port); 21 | 22 | device_name = alexaInvokeName; 23 | localPort = port; 24 | onCallback = oncb; 25 | offCallback = offcb; 26 | deviceStatus = "0"; 27 | 28 | startWebServer(); 29 | } 30 | 31 | 32 | 33 | //<> 34 | WemoSwitch::~WemoSwitch(){/*nothing to destruct*/} 35 | 36 | void WemoSwitch::serverLoop(){ 37 | if (server != NULL) { 38 | server->handleClient(); 39 | delay(1); 40 | } 41 | } 42 | 43 | void WemoSwitch::startWebServer(){ 44 | server = new WebServer(localPort); 45 | 46 | server->on("/", [&]() { 47 | handleRoot(); 48 | }); 49 | 50 | 51 | server->on("/setup.xml", [&]() { 52 | handleSetupXml(); 53 | }); 54 | 55 | server->on("/upnp/control/basicevent1", [&]() { 56 | handleUpnpControl(); 57 | }); 58 | 59 | server->on("/eventservice.xml", [&]() { 60 | handleEventservice(); 61 | }); 62 | 63 | //server->onNotFound(handleNotFound); 64 | server->begin(); 65 | 66 | Serial.println("WebServer started on port: "); 67 | Serial.println(localPort); 68 | } 69 | 70 | void WemoSwitch::handleEventservice(){ 71 | Serial.println(" ########## Responding to eventservice.xml ... ########\n"); 72 | 73 | String eventservice_xml = "" 74 | "" 75 | "" 76 | "SetBinaryState" 77 | "" 78 | "" 79 | "" 80 | "BinaryState" 81 | "BinaryState" 82 | "in" 83 | "" 84 | "" 85 | "" 86 | "" 87 | "" 88 | "" 89 | "BinaryState" 90 | "Boolean" 91 | "0" 92 | "" 93 | "" 94 | "level" 95 | "string" 96 | "0" 97 | "" 98 | "" 99 | "\r\n" 100 | "\r\n"; 101 | 102 | server->send(200, "text/plain", eventservice_xml.c_str()); 103 | } 104 | 105 | void WemoSwitch::handleUpnpControl(){ 106 | Serial.println("########## Responding to /upnp/control/basicevent1 ... ##########"); 107 | 108 | //for (int x=0; x <= HTTP.args(); x++) { 109 | // Serial.println(HTTP.arg(x)); 110 | //} 111 | 112 | String request = server->arg(0); 113 | Serial.print("request:"); 114 | Serial.println(request); 115 | 116 | Serial.println("Responding to Control request"); 117 | 118 | String response_xml = ""; 119 | 120 | if( 121 | (request.indexOf("") > 0) 122 | and (request.indexOf("1") > 0) 123 | ) { 124 | Serial.println("Got Turn on request"); 125 | onCallback(); 126 | deviceStatus = "1"; 127 | response_xml = "" 128 | "" 129 | "" 130 | "1" 131 | "" 132 | "" 133 | "\r\n" 134 | "\r\n"; 135 | } 136 | 137 | if( 138 | (request.indexOf("") > 0) 139 | and (request.indexOf("0") > 0) 140 | ) { 141 | Serial.println("Got Turn off request"); 142 | offCallback(); 143 | deviceStatus = "0"; 144 | response_xml = "" 145 | "" 146 | "" 147 | "0" 148 | "" 149 | "" 150 | "\r\n" 151 | "\r\n"; 152 | } 153 | 154 | if(request.indexOf("") > 0) { 155 | Serial.println("Got GetStatus request"); 156 | response_xml = "" 157 | "" 158 | "" 159 | "" + deviceStatus + "" 160 | "" 161 | "" 162 | "\r\n" 163 | "\r\n"; 164 | } 165 | 166 | server->send(200, "text/xml", response_xml.c_str()); 167 | Serial.print("Sending :"); 168 | Serial.println(response_xml); 169 | } 170 | 171 | void WemoSwitch::handleRoot(){ 172 | server->send(200, "text/plain", "You should tell Alexa to discover devices"); 173 | } 174 | 175 | void WemoSwitch::handleSetupXml(){ 176 | Serial.println(" ########## Responding to setup.xml ... ########\n"); 177 | 178 | IPAddress localIP = WiFi.localIP(); 179 | char s[16]; 180 | sprintf(s, "%d.%d.%d.%d", localIP[0], localIP[1], localIP[2], localIP[3]); 181 | 182 | String setup_xml = "" 183 | "" 184 | "" 185 | "1" 186 | "0" 187 | "" 188 | "" 189 | "urn:Belkin:device:controllee:1" 190 | ""+ device_name +"" 191 | "Belkin International Inc." 192 | "Emulated Socket" 193 | "3.1415" 194 | "http://www.belkin.com" 195 | "Belkin Plugin Socket 1.0" 196 | "http://www.belkin.com/plugin/" 197 | "uuid:"+ persistent_uuid +"" 198 | ""+ serial +"" 199 | "0" 200 | "" 201 | "" 202 | "urn:Belkin:service:basicevent:1" 203 | "urn:Belkin:serviceId:basicevent1" 204 | "/upnp/control/basicevent1" 205 | "/upnp/event/basicevent1" 206 | "/eventservice.xml" 207 | "" 208 | "" 209 | "" 210 | "\r\n" 211 | "\r\n"; 212 | 213 | server->send(200, "text/xml", setup_xml.c_str()); 214 | 215 | Serial.print("Sending :"); 216 | Serial.println(setup_xml); 217 | } 218 | 219 | String WemoSwitch::getAlexaInvokeName() { 220 | return device_name; 221 | } 222 | 223 | void WemoSwitch::respondToSearch(IPAddress& senderIP, unsigned int senderPort) { 224 | Serial.println(""); 225 | Serial.print("Sending response to "); 226 | Serial.println(senderIP); 227 | Serial.print("Port : "); 228 | Serial.println(senderPort); 229 | 230 | IPAddress localIP = WiFi.localIP(); 231 | char s[16]; 232 | sprintf(s, "%d.%d.%d.%d", localIP[0], localIP[1], localIP[2], localIP[3]); 233 | 234 | String response = 235 | "HTTP/1.1 200 OK\r\n" 236 | "CACHE-CONTROL: max-age=86400\r\n" 237 | "DATE: Sat, 26 Nov 2016 04:56:29 GMT\r\n" 238 | "EXT:\r\n" 239 | "LOCATION: http://" + String(s) + ":" + String(localPort) + "/setup.xml\r\n" 240 | "OPT: \"http://schemas.upnp.org/upnp/1/0/\"; ns=01\r\n" 241 | "01-NLS: b9200ebb-736d-4b93-bf03-835149d13983\r\n" 242 | "SERVER: Unspecified, UPnP/1.0, Unspecified\r\n" 243 | "ST: urn:Belkin:device:**\r\n" 244 | "USN: uuid:" + persistent_uuid + "::urn:Belkin:device:**\r\n" 245 | "X-User-Agent: redsonic\r\n\r\n"; 246 | 247 | UDP.beginPacket(senderIP, senderPort); 248 | UDP.print(response.c_str()); 249 | UDP.endPacket(); 250 | 251 | Serial.println("Response sent !"); 252 | } 253 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 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 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | --------------------------------------------------------------------------------