Jan/WLED_MM_Infinity
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Add weather usermod

Browse Source
This commit is contained in:
Ewowi
2022-08-09 22:44:44 +02:00
parent a8785570df
commit 4d2cb2016e
7 changed files with 555 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
usermods/usermod_v2_weather/readme.md Normal file
View File

@@ -0,0 +1,10 @@
# Usermods API v2 example usermod
In this usermod file you can find the documentation on how to take advantage of the new version 2 usermods!
## Installation
Copy `usermod_v2_example.h` to the wled00 directory.
Uncomment the corresponding lines in `usermods_list.cpp` and compile!
_(You shouldn't need to actually install this, it does nothing useful)_

348
usermods/usermod_v2_weather/usermod_v2_weather.h Normal file
View File

@@ -0,0 +1,348 @@
#pragma once
#include "wled.h"
#define FX_MODE_2DWEATHER 185 // can we do this here? Can we also increase modeCount here?
#define pushLoopIndex 0
#define tempsIndex 1
#define timesIndex 2
#define minTempIndex 3
#define maxTempIndex 4
//utility function, move somewhere else???
void epochToString(time_t time, char *timeString) {
tmElements_t tm;
breakTime(time, tm);
sprintf(timeString, "%04d-%02d-%02d %02d:%02d:%02d", tm.Year + 1970, tm.Month, tm.Day, tm.Hour, tm.Minute, tm.Second);
}
//effect function
uint16_t mode_2DWeather(void) {
//or use um_data or make vars global static ...??? Looking at the amount of extra code, global static cleaner?
um_data_t *um_data;
if (!usermods.getUMData(&um_data, USERMOD_ID_WEATHER)) {
SEGMENT.fill(SEGCOLOR(0));
return FRAMETIME;
}
uint32_t *pushLoop = (uint32_t*)um_data->u_data[pushLoopIndex]; //pointer as it is set here
float *temps = (float*)um_data->u_data[tempsIndex];
time_t *times = (time_t*)um_data->u_data[timesIndex];
float minTemp = *(float*)um_data->u_data[minTempIndex];
float maxTemp = *(float*)um_data->u_data[maxTempIndex];
*pushLoop = millis(); //will be reset to 0 in usermod loop
SEGMENT.fadeToBlackBy(10);
float currentTemp = 0;
// time_t currentTime = 0;
for (int x=0; x<SEGMENT.virtualWidth(); x++) {
CRGB color;
currentTemp = temps[0];
// currentTime = times[0];
if (times[x%100] < localTime && times[(x+1)%100] >= localTime) {
color = RED;
currentTemp = map(localTime, times[x%100], times[(x+1)%100], temps[x%100] * 1000, temps[(x+1)%100] * 1000) / 1000.0;
// currentTime = localTime;
}
else
color = ColorFromPalette(SEGPALETTE, map((uint8_t)temps[x%100], 0, 40, 0, 255), 255, LINEARBLEND);
for (int y=0; y<SEGMENT.virtualHeight() * (temps[x%100]-minTemp)/(maxTemp - minTemp); y++) {
SEGMENT.setPixelColorXY(x, SEGMENT.virtualHeight() - y, color);
}
// Serial.print(" ");
// Serial.print(temps[x%16]);
}
if (localTime < times[0])
currentTemp = map(localTime, times[0], times[1], temps[0] * 1000, temps[1] * 1000) / 1000.0;
// Serial.print(" time ");
// char timeString[64];
// epochToString(currentTime, timeString);
// Serial.print(timeString);
// Serial.print(" temp ");
char tempString[5] = "";
sprintf(tempString, "%5.2f", currentTemp);
// Serial.println();
CRGB color = ColorFromPalette(SEGPALETTE, map((uint8_t)currentTemp, 0, 40, 0, 255), 255, LINEARBLEND);
if (SEGMENT.virtualWidth() < 16) {
SEGMENT.drawCharacter(tempString[0], 0, -2, 5, 8, color);
SEGMENT.drawCharacter(tempString[1], 4, -2, 5, 8, color);
SEGMENT.setPixelColorXY(8, 4, color);
SEGMENT.drawCharacter(tempString[3], 9, -2, 5, 8, color);
}
else {
SEGMENT.drawCharacter(tempString[0], 0, -2, 5, 8, color);
SEGMENT.drawCharacter(tempString[1], 5, -2, 5, 8, color);
SEGMENT.setPixelColorXY(10, 4, color);
SEGMENT.drawCharacter(tempString[3], 12, -2, 5, 8, color);
SEGMENT.drawCharacter(tempString[4], 17, -2, 5, 8, color);
}
return FRAMETIME;
}
static const char _data_FX_MODE_2DWEATHER[] PROGMEM = "Weather@;!;!;pal=54,2d"; //temperature palette
class WeatherUsermod : public Usermod {
private:
unsigned long lastTime = 0; //will be used to download new forecast every hour
uint32_t pushLoop = 0; //effect pushes loop to execute. might be interesting for audioreactive too
static const char _name[]; //usermod name
//config variables
String apiKey = "get one from OpenWeatherMap.org";
uint8_t units = 1; //metric (celsius) is default. (Standard=Kelvin, Imperial is Fahrenheit)
float minTemp = 0;
float maxTemp = 40;
float temps[100]; //array of temperatures
time_t times[100]; //array of corresponding times
public:
void setup() {
um_data = new um_data_t;
um_data->u_size = 5;
um_data->u_type = new um_types_t[um_data->u_size];
um_data->u_data = new void*[um_data->u_size];
um_data->u_data[pushLoopIndex] = &pushLoop;
um_data->u_type[pushLoopIndex] = UMT_UINT32;
um_data->u_data[tempsIndex] = temps;
um_data->u_type[tempsIndex] = UMT_FLOAT_ARR;
um_data->u_data[timesIndex] = times;
um_data->u_type[timesIndex] = UMT_UINT32_ARR;
um_data->u_data[minTempIndex] = &minTemp;
um_data->u_type[minTempIndex] = UMT_FLOAT;
um_data->u_data[maxTempIndex] = &maxTemp;
um_data->u_type[maxTempIndex] = UMT_FLOAT;
strip.addEffect(FX_MODE_2DWEATHER, &mode_2DWeather, _data_FX_MODE_2DWEATHER);
}
void connected() {
}
void loop() {
//execute only if effect pushes it or every hour
if (pushLoop > millis() - 1000 && (lastTime == 0 || millis() - lastTime > 3600 * 1000)) {
lastTime = millis();
//https://arduinojson.org/v6/example/http-client/
//is this the most compact way to do http get and put it in arduinojson object???
WiFiClient client;
client.setTimeout(10000);
if (!client.connect("api.openweathermap.org", 80)) {
Serial.println(F("Connection failed"));
return;
}
Serial.println(F("Connected!"));
char url[180];
sprintf(url, "GET /data/2.5/forecast?lat=%f&lon=%f&appid=%s&units=%s HTTP/1.0", latitude, longitude, apiKey.c_str(), units==0?"standard":units==1?"metric":"imperial");
Serial.println(url);
// Send HTTP request
client.println(url);
client.println(F("Host: api.openweathermap.org"));
client.println(F("Connection: close"));
if (client.println() == 0) {
Serial.println(F("Failed to send request"));
client.stop();
return;
}
// Check HTTP status
char status[32] = {0};
client.readBytesUntil('\r', status, sizeof(status));
if (strcmp(status, "HTTP/1.1 200 OK") != 0) {
Serial.print(F("Unexpected response: "));
Serial.println(status);
client.stop();
return;
}
Serial.println(status);
// Skip HTTP headers
char endOfHeaders[] = "\r\n\r\n";
if (!client.find(endOfHeaders)) {
Serial.println(F("Invalid response"));
client.stop();
return;
}
// Allocate the JSON document
// Use arduinojson.org/v6/assistant to compute the capacity.
// const size_t capacity = JSON_OBJECT_SIZE(3) + JSON_ARRAY_SIZE(2) + 60;
DynamicJsonDocument weatherDoc(20000);
// Parse JSON object
DeserializationError error = deserializeJson(weatherDoc, client);
if (error) {
Serial.print(F("deserializeJson() failed: "));
Serial.println(error.f_str());
client.stop();
return;
}
// Disconnect
client.stop();
JsonObject weatherDocObject = weatherDoc.as<JsonObject>();
JsonArray list = weatherDocObject[F("list")];
uint8_t i = 0;
for (JsonObject listElement: list) {
JsonObject main = listElement["main"];
char timeString[64];
epochToString(listElement["dt"], timeString);
Serial.print(timeString);
float temp = main["temp"];
Serial.print(" temp ");
Serial.print(temp);
temps[i%100] = temp;
times[i%100] = listElement["dt"];
JsonObject city = weatherDocObject["city"];
Serial.print(" city ");
Serial.print((const char *)city["name"]);
Serial.print(" - ");
Serial.print((const char *)city["country"]);
Serial.print(" sunrise ");
char sunriseString[64];
epochToString(city["sunrise"], sunriseString);
Serial.print(sunriseString);
Serial.print(" localtime ");
char localTimeString[64];
epochToString(localTime, localTimeString);
Serial.print(localTimeString);
Serial.println();
i++;
}
}
pushLoop = 0;
}
bool getUMData(um_data_t **data) //do not forget this or um_data doesn't work!! Can it be moved to superclass?
{
if (!data) return false; // no pointer provided by caller or not enabled -> exit
*data = um_data;
return true;
}
/*
* addToJsonInfo() can be used to add custom entries to the /json/info part of the JSON API.
* Creating an "u" object allows you to add custom key/value pairs to the Info section of the WLED web UI.
* Below it is shown how this could be used for e.g. a light sensor
*/
/*
void addToJsonInfo(JsonObject& root)
{
int reading = 20;
//this code adds "u":{"Light":[20," lux"]} to the info object
JsonObject user = root["u"];
if (user.isNull()) user = root.createNestedObject("u");
JsonArray lightArr = user.createNestedArray("Light"); //name
lightArr.add(reading); //value
lightArr.add(" lux"); //unit
}
*/
/*
* addToJsonState() can be used to add custom entries to the /json/state part of the JSON API (state object).
* Values in the state object may be modified by connected clients
*/
void addToJsonState(JsonObject& root)
{
//root["user0"] = userVar0;
}
/*
* readFromJsonState() can be used to receive data clients send to the /json/state part of the JSON API (state object).
* Values in the state object may be modified by connected clients
*/
void readFromJsonState(JsonObject& root)
{
// userVar0 = root["user0"] | userVar0; //if "user0" key exists in JSON, update, else keep old value
//if (root["bri"] == 255) Serial.println(F("Don't burn down your garage!"));
}
void addToConfig(JsonObject& root)
{
JsonObject top = root.createNestedObject(FPSTR(_name));
top["apiKey"] = apiKey;
top["units"] = units;
top["minTemp"] = minTemp;
top["maxTemp"] = maxTemp;
}
bool readFromConfig(JsonObject& root)
{
JsonObject top = root[FPSTR(_name)];
bool configComplete = !top.isNull();
configComplete &= getJsonValue(top["apiKey"], apiKey);
configComplete &= getJsonValue(top["units"], units);
configComplete &= getJsonValue(top["minTemp"], minTemp);
configComplete &= getJsonValue(top["maxTemp"], maxTemp);
// * Return true in case the config values returned from Usermod Settings were complete, or false if you'd like WLED to save your defaults to disk (so any missing values are editable in Usermod Settings)
return configComplete;
}
void appendConfigData()
{
oappend(SET_F("dd=addDropdown('WeatherUserMod','units');"));
oappend(SET_F("addOption(dd,'Kelvin',0);"));
oappend(SET_F("addOption(dd,'Celcius',1);"));
oappend(SET_F("addOption(dd,'Fahrenheit',2);"));
oappend(SET_F("addInfo('WeatherUserMod:units',1,'<i>Set time and location in time settings</i>');"));
oappend(SET_F("addInfo('WeatherUserMod:apiKey',1,'<i>Create acount on openweathermap.org and copy the key</i>');"));
oappend(SET_F("addInfo('WeatherUserMod:minTemp',1,'<i>Reboot if you change apiKey to reload forecast</i>');"));
}
/*
* handleOverlayDraw() is called just before every show() (LED strip update frame) after effects have set the colors.
* Use this to blank out some LEDs or set them to a different color regardless of the set effect mode.
* Commonly used for custom clocks (Cronixie, 7 segment)
*/
void handleOverlayDraw()
{
//strip.setPixelColor(0, RGBW32(0,0,0,0)) // set the first pixel to black
}
/*
* 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_WEATHER;
}
};
// strings to reduce flash memory usage (used more than twice)
const char WeatherUsermod::_name[] PROGMEM = "WeatherUserMod";