/* ESP32 Simple Service Discovery Copyright (c) 2015 Hristo Gochkov Original (Arduino) version by Filippo Sallemi, July 23, 2014. Can be found at: https://github.com/nomadnt/uSSDP License (MIT license): 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 #include "ESP32SSDP.h" #include "WiFiUdp.h" #include //#define DEBUG_SSDP Serial #define SSDP_INTERVAL 1200 #define SSDP_PORT 1900 #define SSDP_METHOD_SIZE 10 #define SSDP_URI_SIZE 2 #define SSDP_BUFFER_SIZE 64 #define SSDP_MULTICAST_TTL 2 static const IPAddress SSDP_MULTICAST_ADDR(239, 255, 255, 250); static const char _ssdp_response_template[] PROGMEM = "HTTP/1.1 200 OK\r\n" "EXT:\r\n"; static const char _ssdp_notify_template[] PROGMEM = "NOTIFY * HTTP/1.1\r\n" "HOST: 239.255.255.250:1900\r\n" "NTS: ssdp:alive\r\n"; static const char _ssdp_packet_template[] PROGMEM = "%s" // _ssdp_response_template / _ssdp_notify_template "CACHE-CONTROL: max-age=%u\r\n" // SSDP_INTERVAL "SERVER: Arduino/1.0 UPNP/1.1 %s/%s\r\n" // _modelName, _modelNumber "USN: uuid:%s\r\n" // _uuid "%s: %s\r\n" // "NT" or "ST", _deviceType "LOCATION: http://%u.%u.%u.%u:%u/%s\r\n" // WiFi.localIP(), _port, _schemaURL "\r\n"; static const char _ssdp_schema_template[] PROGMEM = "HTTP/1.1 200 OK\r\n" "Content-Type: text/xml\r\n" "Connection: close\r\n" "Access-Control-Allow-Origin: *\r\n" "\r\n" "" "" "" "1" "0" "" "http://%u.%u.%u.%u:%u/" // WiFi.localIP(), _port "" "%s" "%s" "%s" "%s" "%s" "%s" "%s" "%s" "%s" "uuid:%s" "" // "" // "" // "image/png" // "48" // "48" // "24" // "icon48.png" // "" // "" // "image/png" // "120" // "120" // "24" // "icon120.png" // "" // "" "\r\n" "\r\n"; struct SSDPTimer { ETSTimer timer; }; SSDPClass::SSDPClass() : _server(0), _timer(0), _port(80), _ttl(SSDP_MULTICAST_TTL), _respondToPort(0), _pending(false), _delay(0), _process_time(0), _notify_time(0) { _uuid[0] = '\0'; _modelNumber[0] = '\0'; sprintf(_deviceType, "urn:schemas-upnp-org:device:Basic:1"); _friendlyName[0] = '\0'; _presentationURL[0] = '\0'; _serialNumber[0] = '\0'; _modelName[0] = '\0'; _modelURL[0] = '\0'; _manufacturer[0] = '\0'; _manufacturerURL[0] = '\0'; sprintf(_schemaURL, "ssdp/schema.xml"); } SSDPClass::~SSDPClass(){ end(); } void SSDPClass::end(){ if(!_server) { return; } #ifdef DEBUG_SSDP DEBUG_SSDP.printf_P(PSTR("SSDP end ... ")); #endif // undo all initializations done in begin(), in reverse order _stopTimer(); _server->stop(); delete (_server); _server = 0; } bool SSDPClass::begin(){ _pending = false; end(); uint32_t chipId = ((uint16_t) (ESP.getEfuseMac() >> 32)); sprintf(_uuid, "38323636-4558-4dda-9188-cda0e6%02x%02x%02x", (uint16_t) ((chipId >> 16) & 0xff), (uint16_t) ((chipId >> 8) & 0xff), (uint16_t) chipId & 0xff ); assert(nullptr == _server); _server = new WiFiUDP; #ifdef DEBUG_SSDP DEBUG_SSDP.printf("SSDP UUID: %s\n", (char *)_uuid); #endif _server = new WiFiUDP; if (!(_server->beginMulticast(IPAddress(SSDP_MULTICAST_ADDR), SSDP_PORT))) { #ifdef DEBUG_SSDP DEBUG_SSDP.println("Error begin"); #endif return false; } _startTimer(); return true; } void SSDPClass::_send(ssdp_method_t method){ char buffer[1460]; IPAddress ip = WiFi.localIP(); char valueBuffer[strlen_P(_ssdp_notify_template)+1]; strcpy_P(valueBuffer, (method == NONE)?_ssdp_response_template:_ssdp_notify_template); int len = snprintf_P(buffer, sizeof(buffer), _ssdp_packet_template, valueBuffer, SSDP_INTERVAL, _modelName, _modelNumber, _uuid, (method == NONE)?"ST":"NT", _deviceType, ip[0], ip[1], ip[2], ip[3], _port, _schemaURL ); if(len < 0) return; IPAddress remoteAddr; uint16_t remotePort; if(method == NONE) { remoteAddr = _respondToAddr; remotePort = _respondToPort; #ifdef DEBUG_SSDP DEBUG_SSDP.print("Sending Response to "); #endif } else { remoteAddr = IPAddress(SSDP_MULTICAST_ADDR); remotePort = SSDP_PORT; #ifdef DEBUG_SSDP DEBUG_SSDP.println("Sending Notify to "); #endif } #ifdef DEBUG_SSDP DEBUG_SSDP.print(remoteAddr); DEBUG_SSDP.print(":"); DEBUG_SSDP.println(remotePort); #endif _server->beginPacket(remoteAddr, remotePort); _server->println(buffer); _server->endPacket(); } void SSDPClass::schema(WiFiClient client){ IPAddress ip = WiFi.localIP(); char buffer[strlen_P(_ssdp_schema_template)+1]; strcpy_P(buffer, _ssdp_schema_template); client.printf(buffer, ip[0], ip[1], ip[2], ip[3], _port, _deviceType, _friendlyName, _presentationURL, _serialNumber, _modelName, _modelNumber, _modelURL, _manufacturer, _manufacturerURL, _uuid ); } void SSDPClass::_update(){ int nbBytes =0; char * packetBuffer = nullptr; if(!_pending && _server) { ssdp_method_t method = NONE; nbBytes= _server->parsePacket(); typedef enum {METHOD, URI, PROTO, KEY, VALUE, ABORT} states; states state = METHOD; typedef enum {START, MAN, ST, MX} headers; headers header = START; uint8_t cursor = 0; uint8_t cr = 0; char buffer[SSDP_BUFFER_SIZE] = {0}; packetBuffer = new char[nbBytes +1]; int message_size=_server->read(packetBuffer,nbBytes); int process_pos = 0; packetBuffer[message_size]='\0'; _respondToAddr = _server->remoteIP(); _respondToPort = _server->remotePort(); #ifdef DEBUG_SSDP if (message_size) { DEBUG_SSDP.println("****************************************************"); DEBUG_SSDP.println(_server->remoteIP()); DEBUG_SSDP.println(packetBuffer); DEBUG_SSDP.println("****************************************************"); } #endif while(process_pos < message_size){ char c = packetBuffer[process_pos]; process_pos++; (c == '\r' || c == '\n') ? cr++ : cr = 0; #ifdef DEBUG_SSDP if ((c == '\r' || c == '\n') && (cr < 2)) DEBUG_SSDP.println(buffer); #endif switch(state){ case METHOD: if(c == ' '){ if(strcmp(buffer, "M-SEARCH") == 0) method = SEARCH; if(method == NONE) state = ABORT; else state = URI; cursor = 0; } else if(cursor < SSDP_METHOD_SIZE - 1){ buffer[cursor++] = c; buffer[cursor] = '\0'; } break; case URI: if(c == ' '){ if(strcmp(buffer, "*")) state = ABORT; else state = PROTO; cursor = 0; } else if(cursor < SSDP_URI_SIZE - 1){ buffer[cursor++] = c; buffer[cursor] = '\0'; } break; case PROTO: if(cr == 2){ state = KEY; cursor = 0; } break; case KEY: if(cr == 4){ _pending = true; _process_time = millis(); } else if(c == ' '){ cursor = 0; state = VALUE; } else if(c != '\r' && c != '\n' && c != ':' && cursor < SSDP_BUFFER_SIZE - 1){ buffer[cursor++] = c; buffer[cursor] = '\0'; } break; case VALUE: if(cr == 2){ switch(header){ case START: break; case MAN: #ifdef DEBUG_SSDP DEBUG_SSDP.printf("MAN: %s\n", (char *)buffer); #endif break; case ST: if(strcmp(buffer, "ssdp:all")){ state = ABORT; #ifdef DEBUG_SSDP DEBUG_SSDP.printf("REJECT: %s\n", (char *)buffer); #endif } // if the search type matches our type, we should respond instead of ABORT if(strcasecmp(buffer, _deviceType) == 0){ _pending = true; _process_time = 0; #ifdef DEBUG_SSDP DEBUG_SSDP.println("the search type matches our type"); #endif state = KEY; } break; case MX: _delay = random(0, atoi(buffer)) * 1000L; break; } if(state != ABORT){ state = KEY; header = START; cursor = 0; } } else if(c != '\r' && c != '\n'){ if(header == START){ if(strncmp(buffer, "MA", 2) == 0) header = MAN; else if(strcmp(buffer, "ST") == 0) header = ST; else if(strcmp(buffer, "MX") == 0) header = MX; } if(cursor < SSDP_BUFFER_SIZE - 1){ buffer[cursor++] = c; buffer[cursor] = '\0'; } } break; case ABORT: _pending = false; _delay = 0; break; } } } if(packetBuffer) delete packetBuffer; if(_pending && (millis() - _process_time) > _delay){ _pending = false; _delay = 0; #ifdef DEBUG_SSDP DEBUG_SSDP.println("Send None"); #endif _send(NONE); } else if(_notify_time == 0 || (millis() - _notify_time) > (SSDP_INTERVAL * 1000L)){ _notify_time = millis(); #ifdef DEBUG_SSDP DEBUG_SSDP.println("Send Notify"); #endif _send(NOTIFY); } else { #ifdef DEBUG_SSDP DEBUG_SSDP.println("Do not sent"); #endif } if (_pending) { _server->flush(); } } void SSDPClass::setSchemaURL(const char *url){ strlcpy(_schemaURL, url, sizeof(_schemaURL)); } void SSDPClass::setHTTPPort(uint16_t port){ _port = port; } void SSDPClass::setDeviceType(const char *deviceType){ strlcpy(_deviceType, deviceType, sizeof(_deviceType)); } void SSDPClass::setName(const char *name){ strlcpy(_friendlyName, name, sizeof(_friendlyName)); } void SSDPClass::setURL(const char *url){ strlcpy(_presentationURL, url, sizeof(_presentationURL)); } void SSDPClass::setSerialNumber(const char *serialNumber){ strlcpy(_serialNumber, serialNumber, sizeof(_serialNumber)); } void SSDPClass::setSerialNumber(const uint32_t serialNumber){ snprintf(_serialNumber, sizeof(uint32_t)*2+1, "%08X", serialNumber); } void SSDPClass::setModelName(const char *name){ strlcpy(_modelName, name, sizeof(_modelName)); } void SSDPClass::setModelNumber(const char *num){ strlcpy(_modelNumber, num, sizeof(_modelNumber)); } void SSDPClass::setModelURL(const char *url){ strlcpy(_modelURL, url, sizeof(_modelURL)); } void SSDPClass::setManufacturer(const char *name){ strlcpy(_manufacturer, name, sizeof(_manufacturer)); } void SSDPClass::setManufacturerURL(const char *url){ strlcpy(_manufacturerURL, url, sizeof(_manufacturerURL)); } void SSDPClass::setTTL(const uint8_t ttl){ _ttl = ttl; } void SSDPClass::_onTimerStatic(SSDPClass* self) { #ifdef DEBUG_SSDP DEBUG_SSDP.println("Update"); #endif self->_update(); } void SSDPClass::_startTimer() { _stopTimer(); _timer= new SSDPTimer(); ETSTimer* tm = &(_timer->timer); const int interval = 1000; ets_timer_disarm(tm); ets_timer_setfn(tm, reinterpret_cast(&SSDPClass::_onTimerStatic), reinterpret_cast(this)); ets_timer_arm(tm, interval, 1 /* repeat */); } void SSDPClass::_stopTimer() { if(!_timer){ return; } ETSTimer* tm = &(_timer->timer); ets_timer_disarm(tm); delete _timer; _timer = nullptr; } #if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_SSDP) SSDPClass SSDP; #endif