jeans/WLED
jeans/WLED
1
0
Fork 0
mirror of https://github.com/wled/WLED.git synced 2025-04-24 06:47:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Delete usermods/smartnest directory

Browse Source
This commit is contained in:
devilpro1 2024-05-26 12:46:34 +02:00 committed by GitHub
parent 501f988b0f
commit 627bea30ed
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 0 additions and 232 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
usermods/smartnest/readme.md
View File

@ -1,61 +0,0 @@
# Smartnest
Enables integration with `smartnest.cz` service which provides MQTT integration with voice assistants.
In order to setup Smartnest follow the [documentation](https://www.docu.smartnest.cz/).
## MQTT API
The API is described in the Smartnest [Github repo](https://github.com/aososam/Smartnest/blob/master/Devices/lightRgb/lightRgb.ino).
## Usermod installation
1. Register the usermod by adding `#include "../usermods/smartnest/usermod_smartnest.h"` at the top and `usermods.add(new Smartnest());` at the bottom of `usermods_list.cpp`.
or
2. Use `#define USERMOD_SMARTNEST` in wled.h or `-D USERMOD_SMARTNEST` in your platformio.ini
Example **usermods_list.cpp**:
```cpp
#include "wled.h"
/*
* Register your v2 usermods here!
* (for v1 usermods using just usermod.cpp, you can ignore this file)
*/
/*
* Add/uncomment your usermod filename here (and once more below)
* || || ||
* \/ \/ \/
*/
//#include "usermod_v2_example.h"
//#include "usermod_temperature.h"
#include "../usermods/usermod_smartnest.h"
void registerUsermods()
{
/*
* Add your usermod class name here
* || || ||
* \/ \/ \/
*/
//usermods.add(new MyExampleUsermod());
//usermods.add(new UsermodTemperature());
usermods.add(new Smartnest());
}
```
## Configuration
Usermod has no configuration, but it relies on the MQTT configuration.\
Under Config > Sync Interfaces > MQTT:
* Enable MQTT check box
* Set the `Broker` field to: `smartnest.cz`
* The `Username` and `Password` fields are the login information from the `smartnest.cz` website.
* `Client ID` field is obtained from the device configuration panel in `smartnest.cz`.
## Change log
2022-09
* First implementation.

171
usermods/smartnest/usermod_smartnest.h
View File

@ -1,171 +0,0 @@
#ifndef WLED_ENABLE_MQTT
#error "This user mod requires MQTT to be enabled."
#endif
#pragma once
#include "wled.h"
class Smartnest : public Usermod
{
private:
void sendToBroker(const char *const topic, const char *const message)
{
if (!WLED_MQTT_CONNECTED)
{
return;
}
String topic_ = String(mqttClientID) + "/" + String(topic);
mqtt->publish(topic_.c_str(), 0, true, message);
}
void turnOff()
{
setBrightness(0);
turnOnAtBoot = false;
offMode = true;
sendToBroker("report/powerState", "OFF");
}
void turnOn()
{
setBrightness(briLast);
turnOnAtBoot = true;
offMode = false;
sendToBroker("report/powerState", "ON");
}
void setBrightness(int value)
{
if (value == 0 && bri > 0) briLast = bri;
bri = value;
stateUpdated(CALL_MODE_DIRECT_CHANGE);
}
void setColor(int r, int g, int b)
{
strip.setColor(0, r, g, b);
stateUpdated(CALL_MODE_DIRECT_CHANGE);
char msg[18] {};
sprintf(msg, "rgb(%d,%d,%d)", r, g, b);
sendToBroker("report/color", msg);
}
int splitColor(const char *const color, int * const rgb)
{
char *color_ = NULL;
const char delim[] = ",";
char *cxt = NULL;
char *token = NULL;
int position = 0;
// We need to copy the string in order to keep it read only as strtok_r function requires mutable string
color_ = (char *)malloc(strlen(color));
if (NULL == color_) {
return -1;
}
strcpy(color_, color);
token = strtok_r(color_, delim, &cxt);
while (token != NULL)
{
rgb[position++] = (int)strtoul(token, NULL, 10);
token = strtok_r(NULL, delim, &cxt);
}
free(color_);
return position;
}
public:
// Functions called by WLED
/**
* handling of MQTT message
* topic should look like: /<mqttClientID>/<Command>/<Message>
*/
bool onMqttMessage(char *topic, char *message)
{
String topic_{topic};
String topic_prefix{mqttClientID + String("/directive/")};
if (!topic_.startsWith(topic_prefix))
{
return false;
}
String subtopic = topic_.substring(topic_prefix.length());
String message_(message);
if (subtopic == "powerState")
{
if (strcmp(message, "ON") == 0)
{
turnOn();
}
else if (strcmp(message, "OFF") == 0)
{
turnOff();
}
return true;
}
if (subtopic == "percentage")
{
int val = (int)strtoul(message, NULL, 10);
if (val >= 0 && val <= 100)
{
setBrightness(map(val, 0, 100, 0, 255));
}
return true;
}
if (subtopic == "color")
{
// Parse the message which is in the format "rgb(<0-255>,<0-255>,<0-255>)"
int rgb[3] = {};
String colors = message_.substring(String("rgb(").length(), message_.lastIndexOf(')'));
if (3 != splitColor(colors.c_str(), rgb))
{
return false;
}
setColor(rgb[0], rgb[1], rgb[2]);
return true;
}
return false;
}
/**
* subscribe to MQTT topic and send publish current status.
*/
void onMqttConnect(bool sessionPresent)
{
String topic = String(mqttClientID) + "/#";
mqtt->subscribe(topic.c_str(), 0);
sendToBroker("report/online", (bri ? "true" : "false")); // Reports that the device is online
delay(100);
sendToBroker("report/firmware", versionString); // Reports the firmware version
delay(100);
sendToBroker("report/ip", (char *)WiFi.localIP().toString().c_str()); // Reports the ip
delay(100);
sendToBroker("report/network", (char *)WiFi.SSID().c_str()); // Reports the network name
delay(100);
String signal(WiFi.RSSI(), 10);
sendToBroker("report/signal", signal.c_str()); // Reports the signal strength
delay(100);
}
/**
* getId() allows you to optionally give your V2 usermod an unique ID (please define it in const.h!).
* This could be used in the future for the system to determine whether your usermod is installed.
*/
uint16_t getId()
{
return USERMOD_ID_SMARTNEST;
}
};