mirror of
https://github.com/esp8266/Arduino.git
synced 2025-04-21 10:26:06 +03:00
53b3aaee60
I recently starting playing around with a few esp8266-01s and tried to use the SSDP libraries to work with Smarthings discovery: https://docs.smartthings.com/en/latest/cloud-and-lan-connected-device-types-developers-guide/building-lan-connected-device-types/building-the-service-manager.html on the docs there are example grovy files that do simple service discovery, i was not able to get SSDP to work correctly, though i was able to find some other projects that did (python fauxmo works for alexa, but with modifications i was able to make it work for custom devices in ST). after digging to figure out why the python code was working and the ESP SSDP lib was not i noticed there is a string comparison in the grovy file and it was failing to match the udn with the original usn device id. The ST groovy code could be changed to remedy this problem but i wonder if it should be fixed here, because so many other examples of SSDP discovery take care in ensuring the usn and udn match exactly. ___________ Summary, I think the USN and UDN values should match exactly. This will fix issues, allowing for much easier integration with smart hubs that need the device ids to match. Allowing me to use these libraries and not need to roll a custom SSDP handler.
474 lines
12 KiB
C++
474 lines
12 KiB
C++
/*
|
|
ESP8266 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.
|
|
|
|
*/
|
|
#ifndef LWIP_OPEN_SRC
|
|
#define LWIP_OPEN_SRC
|
|
#endif
|
|
#include <functional>
|
|
#include "ESP8266SSDP.h"
|
|
#include "WiFiUdp.h"
|
|
#include "debug.h"
|
|
|
|
extern "C" {
|
|
#include "osapi.h"
|
|
#include "ets_sys.h"
|
|
#include "user_interface.h"
|
|
}
|
|
|
|
#include "lwip/opt.h"
|
|
#include "lwip/udp.h"
|
|
#include "lwip/inet.h"
|
|
#include "lwip/igmp.h"
|
|
#include "lwip/mem.h"
|
|
#include "include/UdpContext.h"
|
|
//#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
|
|
|
|
// ssdp ipv6 is FF05::C
|
|
// lwip-v2's igmp_joingroup only supports IPv4
|
|
#define 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"
|
|
"<?xml version=\"1.0\"?>"
|
|
"<root xmlns=\"urn:schemas-upnp-org:device-1-0\">"
|
|
"<specVersion>"
|
|
"<major>1</major>"
|
|
"<minor>0</minor>"
|
|
"</specVersion>"
|
|
"<URLBase>http://%u.%u.%u.%u:%u/</URLBase>" // WiFi.localIP(), _port
|
|
"<device>"
|
|
"<deviceType>%s</deviceType>"
|
|
"<friendlyName>%s</friendlyName>"
|
|
"<presentationURL>%s</presentationURL>"
|
|
"<serialNumber>%s</serialNumber>"
|
|
"<modelName>%s</modelName>"
|
|
"<modelNumber>%s</modelNumber>"
|
|
"<modelURL>%s</modelURL>"
|
|
"<manufacturer>%s</manufacturer>"
|
|
"<manufacturerURL>%s</manufacturerURL>"
|
|
"<UDN>uuid:%s</UDN>"
|
|
"</device>"
|
|
//"<iconList>"
|
|
//"<icon>"
|
|
//"<mimetype>image/png</mimetype>"
|
|
//"<height>48</height>"
|
|
//"<width>48</width>"
|
|
//"<depth>24</depth>"
|
|
//"<url>icon48.png</url>"
|
|
//"</icon>"
|
|
//"<icon>"
|
|
//"<mimetype>image/png</mimetype>"
|
|
//"<height>120</height>"
|
|
//"<width>120</width>"
|
|
//"<depth>24</depth>"
|
|
//"<url>icon120.png</url>"
|
|
//"</icon>"
|
|
//"</iconList>"
|
|
"</root>\r\n"
|
|
"\r\n";
|
|
|
|
|
|
struct SSDPTimer {
|
|
ETSTimer timer;
|
|
};
|
|
|
|
SSDPClass::SSDPClass() :
|
|
_server(0),
|
|
_timer(new SSDPTimer),
|
|
_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() {
|
|
delete _timer;
|
|
}
|
|
|
|
bool SSDPClass::begin() {
|
|
_pending = false;
|
|
if (strcmp(_uuid,"") == 0) {
|
|
uint32_t chipId = ESP.getChipId();
|
|
sprintf(_uuid, "38323636-4558-4dda-9188-cda0e6%02x%02x%02x",
|
|
(uint16_t) ((chipId >> 16) & 0xff),
|
|
(uint16_t) ((chipId >> 8) & 0xff),
|
|
(uint16_t) chipId & 0xff );
|
|
}
|
|
|
|
#ifdef DEBUG_SSDP
|
|
DEBUG_SSDP.printf("SSDP UUID: %s\n", (char *)_uuid);
|
|
#endif
|
|
|
|
if (_server) {
|
|
_server->unref();
|
|
_server = 0;
|
|
}
|
|
|
|
_server = new UdpContext;
|
|
_server->ref();
|
|
|
|
IPAddress local = WiFi.localIP();
|
|
IPAddress mcast(SSDP_MULTICAST_ADDR);
|
|
|
|
if (igmp_joingroup(local, mcast) != ERR_OK ) {
|
|
DEBUGV("SSDP failed to join igmp group");
|
|
return false;
|
|
}
|
|
|
|
if (!_server->listen(IP_ADDR_ANY, SSDP_PORT)) {
|
|
return false;
|
|
}
|
|
|
|
_server->setMulticastInterface(local);
|
|
_server->setMulticastTTL(_ttl);
|
|
_server->onRx(std::bind(&SSDPClass::_update, this));
|
|
if (!_server->connect(mcast, SSDP_PORT)) {
|
|
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
|
|
);
|
|
|
|
_server->append(buffer, len);
|
|
|
|
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(IPAddress(remoteAddr));
|
|
DEBUG_SSDP.print(":");
|
|
DEBUG_SSDP.println(remotePort);
|
|
#endif
|
|
|
|
_server->send(remoteAddr, remotePort);
|
|
}
|
|
|
|
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() {
|
|
if (!_pending && _server->next()) {
|
|
ssdp_method_t method = NONE;
|
|
|
|
_respondToAddr = _server->getRemoteAddress();
|
|
_respondToPort = _server->getRemotePort();
|
|
|
|
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};
|
|
|
|
while (_server->getSize() > 0) {
|
|
char c = _server->read();
|
|
|
|
(c == '\r' || c == '\n') ? cr++ : cr = 0;
|
|
|
|
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 = millis();
|
|
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 (_pending && (millis() - _process_time) > _delay) {
|
|
_pending = false; _delay = 0;
|
|
_send(NONE);
|
|
} else if(_notify_time == 0 || (millis() - _notify_time) > (SSDP_INTERVAL * 1000L)){
|
|
_notify_time = millis();
|
|
_send(NOTIFY);
|
|
}
|
|
|
|
if (_pending) {
|
|
while (_server->next())
|
|
_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::setUUID(const char *uuid) {
|
|
strlcpy(_uuid, uuid, sizeof(_uuid));
|
|
}
|
|
|
|
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) {
|
|
self->_update();
|
|
}
|
|
|
|
void SSDPClass::_startTimer() {
|
|
ETSTimer* tm = &(_timer->timer);
|
|
const int interval = 1000;
|
|
os_timer_disarm(tm);
|
|
os_timer_setfn(tm, reinterpret_cast<ETSTimerFunc*>(&SSDPClass::_onTimerStatic), reinterpret_cast<void*>(this));
|
|
os_timer_arm(tm, interval, 1 /* repeat */);
|
|
}
|
|
|
|
#if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_SSDP)
|
|
SSDPClass SSDP;
|
|
#endif
|