mirror of
https://github.com/hyperion-project/hyperion.ng.git
synced 2025-03-01 10:33:28 +00:00
LED Device Features, Fixes and Refactoring (Resubmit PR855) (#875)
* Refactor LedDevices - Initial version * Small renamings * Add WLED as own device * Lpd8806 Remove open() method * remove dependency on Qt 5.10 * Lpd8806 Remove open() method * Update WS281x * Update WS2812SPI * Add writeBlack for WLED powerOff * WLED remove extra bracket * Allow different Nanoleaf panel numbering sequence (Feature req.#827) * build(deps): bump websocket-extensions from 0.1.3 to 0.1.4 in /docs (#826) * Bumps [websocket-extensions](https://github.com/faye/websocket-extensions-node) from 0.1.3 to 0.1.4. - [Release notes](https://github.com/faye/websocket-extensions-node/releases) - [Changelog](https://github.com/faye/websocket-extensions-node/blob/master/CHANGELOG.md) - [Commits](https://github.com/faye/websocket-extensions-node/compare/0.1.3...0.1.4) * Fix typos * Nanoleaf clean-up * Yeelight support, generalize wizard elements * Update Yeelight to handle quota in music mode * Yeelight extend rage for extraTimeDarkness for testing * Clean-up - Add commentary, Remove development debug statements * Fix brightnessSwitchOffOnMinimum typo and default value * Yeelight support restoreOriginalState, additional Fixes * WLED - Remove UDP-Port, as it is not configurable * Fix merging issue * Remove QHostAddress::operator=(const QString&)' is deprecated * Windows compile errors and (Qt 5.15 deprecation) warnings * Fix order includes * LedDeviceFile Support Qt5.7 and greater * Windows compatibility and other Fixes * Fix Qt Version compatability * Rs232 - Resolve portname from unix /dev/ style, fix DMX sub-type support * Disable WLED Wizard Button (until Wizard is available) * Yeelight updates * Add wrong log-type as per #505 * Fixes and Clean-up after clang-tidy report * Fix udpe131 not enabled for generated CID * Change timer into dynamic for Qt Thread-Affinity * Hue clean-up and diyHue workaround * Updates after review feedback by m-seker * Add "chrono" includes
This commit is contained in:
LordGrey
GitHub
@@ -1,7 +1,12 @@
|
||||
#pragma once
|
||||
#ifndef SSDPDISCOVER_H
|
||||
#define SSDPDISCOVER_H
|
||||
|
||||
#include <utils/Logger.h>
|
||||
#include <QHostAddress>
|
||||
#include <QUrl>
|
||||
#include <QRegularExpression>
|
||||
|
||||
#include <chrono>
|
||||
|
||||
class QUdpSocket;
|
||||
|
||||
@@ -11,6 +16,23 @@ enum class searchType{
|
||||
STY_JSONSERVER
|
||||
};
|
||||
|
||||
struct SSDPService {
|
||||
QString cacheControl;
|
||||
QUrl location;
|
||||
QString server;
|
||||
QString searchTarget;
|
||||
QString uniqueServiceName;
|
||||
QMap <QString,QString> otherHeaders;
|
||||
};
|
||||
|
||||
// Default values
|
||||
static const char DEFAULT_SEARCH_ADDRESS[] = "239.255.255.250";
|
||||
static const int DEFAULT_SEARCH_PORT = 1900;
|
||||
static const char DEFAULT_FILTER[] = ".*";
|
||||
static const char DEFAULT_FILTER_HEADER[] = "ST";
|
||||
|
||||
constexpr std::chrono::milliseconds DEFAULT_SSDP_TIMEOUT{5000}; // timeout in ms
|
||||
|
||||
///
|
||||
/// @brief Search for SSDP sessions, used by stand-alone capture binaries
|
||||
///
|
||||
@@ -37,6 +59,120 @@ public:
|
||||
///
|
||||
const QString getFirstService(const searchType &type = searchType::STY_WEBSERVER,const QString &st = "urn:hyperion-project.org:device:basic:1", const int &timeout_ms = 3000);
|
||||
|
||||
///
|
||||
/// @brief Discover services via ssdp.
|
||||
///
|
||||
/// Records meeting the search target and filter criteria ( setSearchFilter() ) are stored in a map using the given element as a key.
|
||||
///
|
||||
/// The search result can be accessed via getServicesDiscoveredJson() or getServicesDiscovered()
|
||||
///
|
||||
/// Usage sample:
|
||||
/// @code
|
||||
///
|
||||
/// SSDPDiscover discover;
|
||||
///
|
||||
/// discover.skipDuplicateKeys(true);
|
||||
/// QString searchTargetFilter = "(.*)IpBridge(.*)";
|
||||
/// discover.setSearchFilter(searchTargetFilter, "SERVER");
|
||||
/// QString searchTarget = "upnp:rootdevice";
|
||||
///
|
||||
/// if ( discover.discoverServices(searchTarget) > 0 )
|
||||
/// deviceList = discover.getServicesDiscoveredJson();
|
||||
///
|
||||
///@endcode
|
||||
///
|
||||
/// @param[in] searchTarget The ssdp discovery search target (ST)
|
||||
/// @param[in] key Element used as key for the result map
|
||||
///
|
||||
/// @return Number of service records found (meeting the search & filter criteria)
|
||||
///
|
||||
int discoverServices(const QString &searchTarget="ssdp:all", const QString &key="LOCATION");
|
||||
|
||||
///
|
||||
/// @brief Get services discovered during discoverServices()
|
||||
///
|
||||
/// @return Map of discovered services
|
||||
///
|
||||
const QMap<QString, SSDPService> getServicesDiscovered () { return _services; }
|
||||
|
||||
///
|
||||
/// @brief Get services discovered during discoverServices().
|
||||
///
|
||||
/// Hostname and domain are resolved from IP-address and stored in extra elements
|
||||
///
|
||||
/// Sample result:
|
||||
/// @code
|
||||
///
|
||||
/// [{
|
||||
/// "cache-control": "max-age=100",
|
||||
/// "domain": "fritz.box",
|
||||
/// "hostname": "ubuntu1910",
|
||||
/// "id": "http://192.168.2.152:8081/description.xml",
|
||||
/// "ip": "192.168.2.152",
|
||||
/// "location": "http://192.168.2.152:8081/description.xml",
|
||||
/// "other": { "ext": "", "host": "239.255.255.250:1900", "hue-bridgeid": "000C29FFFED8D52D"},
|
||||
/// "port": 8081,
|
||||
/// "server": "Linux/3.14.0 UPnP/1.0 IpBridge/1.19.0",
|
||||
/// "st": "upnp:rootdevice",
|
||||
/// "usn": "uuid:2f402f80-da50-11e1-9b23-000c29d8d52d::upnp:rootdevice"
|
||||
/// }]
|
||||
///
|
||||
///@endcode
|
||||
///
|
||||
/// @return Discovered services as JSON-document
|
||||
///
|
||||
QJsonArray getServicesDiscoveredJson();
|
||||
|
||||
///
|
||||
/// @brief Set the ssdp discovery address (HOST)
|
||||
///
|
||||
/// @param[in] IP-address used during discovery
|
||||
///
|
||||
void setAddress ( const QString &address) { _ssdpAddr = QHostAddress(address); }
|
||||
|
||||
///
|
||||
/// @brief Set the ssdp discovery port (HOST)
|
||||
///
|
||||
/// @param[in] port used during discovery
|
||||
///
|
||||
void setPort ( quint16 port) { _ssdpPort = port; }
|
||||
|
||||
///
|
||||
/// @brief Set the ssdp discovery max wait time (MX)
|
||||
///
|
||||
/// @param[in] maxWaitResponseTime
|
||||
///
|
||||
void setMaxWaitResponseTime ( int maxWaitResponseTime) { _ssdpMaxWaitResponseTime = maxWaitResponseTime; }
|
||||
|
||||
///
|
||||
/// @brief Set the ssdp discovery search target (ST)
|
||||
///
|
||||
/// @param[in] searchTarget
|
||||
///
|
||||
void setSearchTarget ( const QString &searchTarget) { _searchTarget = searchTarget; }
|
||||
|
||||
///
|
||||
/// @brief Set the ssdp discovery search target filter
|
||||
///
|
||||
/// @param[in] filter as regular expression
|
||||
/// @param[in] filterHeader Header element the filter is applied to
|
||||
///
|
||||
/// @return True, if valid regular expression
|
||||
///
|
||||
bool setSearchFilter ( const QString &filter=DEFAULT_FILTER, const QString &filterHeader="ST");
|
||||
|
||||
///
|
||||
/// @brief Set the ssdp discovery search target and filter to default values
|
||||
///
|
||||
void clearSearchFilter () { _filter=DEFAULT_FILTER; _filterHeader="ST"; }
|
||||
|
||||
///
|
||||
/// @brief Skip duplicate records with the same key-value
|
||||
///
|
||||
/// @param[in] skip True: skip records with duplicate key-values, False: Allow duplicate key-values
|
||||
///
|
||||
void skipDuplicateKeys( bool skip ) { _skipDupKeys = skip; }
|
||||
|
||||
signals:
|
||||
///
|
||||
/// @brief Emits whenever a new service has been found, search started with searchForService()
|
||||
@@ -60,6 +196,21 @@ private:
|
||||
|
||||
Logger* _log;
|
||||
QUdpSocket* _udpSocket;
|
||||
QString _searchTarget;
|
||||
QHostAddress _ssdpAddr;
|
||||
quint16 _ssdpPort;
|
||||
|
||||
int _ssdpMaxWaitResponseTime;
|
||||
int _ssdpTimeout;
|
||||
|
||||
QMap<QString, SSDPService> _services;
|
||||
|
||||
QStringList _usnList;
|
||||
QString _searchTarget;
|
||||
|
||||
QString _filter;
|
||||
QString _filterHeader;
|
||||
QRegularExpression _regExFilter;
|
||||
bool _skipDupKeys;
|
||||
};
|
||||
|
||||
#endif // SSDPDISCOVER_H
|
||||
|
||||
Reference in New Issue
Block a user