WLED/wled00/fcn_declare.h

310 lines
9.9 KiB
C
Raw Normal View History

2020-04-10 12:30:08 +02:00
#ifndef WLED_FCN_DECLARE_H
#define WLED_FCN_DECLARE_H
#include <Arduino.h>
#include "src/dependencies/espalexa/EspalexaDevice.h"
#include "src/dependencies/e131/ESPAsyncE131.h"
/*
* All globally accessible functions are declared here
*/
//alexa.cpp
void onAlexaChange(EspalexaDevice* dev);
void alexaInit();
void handleAlexa();
void onAlexaChange(EspalexaDevice* dev);
//blynk.cpp
#ifndef WLED_DISABLE_BLYNK
void initBlynk(const char* auth, const char* host, uint16_t port);
2020-04-10 12:30:08 +02:00
void handleBlynk();
void updateBlynk();
#endif
2020-04-10 12:30:08 +02:00
//button.cpp
2021-05-20 19:54:07 +02:00
void shortPressAction(uint8_t b=0);
2022-02-01 09:33:57 +01:00
void longPressAction(uint8_t b=0);
void doublePressAction(uint8_t b=0);
2021-05-20 19:54:07 +02:00
bool isButtonPressed(uint8_t b=0);
2020-04-10 12:30:08 +02:00
void handleButton();
void handleIO();
2020-11-05 22:54:13 +01:00
//cfg.cpp
bool deserializeConfig(JsonObject doc, bool fromFS = false);
void deserializeConfigFromFS();
2020-11-05 22:54:13 +01:00
bool deserializeConfigSec();
void serializeConfig();
void serializeConfigSec();
template<typename DestType>
bool getJsonValue(const JsonVariant& element, DestType& destination) {
if (element.isNull()) {
return false;
}
destination = element.as<DestType>();
return true;
}
template<typename DestType, typename DefaultType>
bool getJsonValue(const JsonVariant& element, DestType& destination, const DefaultType defaultValue) {
if(!getJsonValue(element, destination)) {
destination = defaultValue;
return false;
}
return true;
}
2020-04-10 12:30:08 +02:00
//colors.cpp
inline uint32_t colorFromRgbw(byte* rgbw) { return uint32_t((byte(rgbw[3]) << 24) | (byte(rgbw[0]) << 16) | (byte(rgbw[1]) << 8) | (byte(rgbw[2]))); }
2020-04-10 12:30:08 +02:00
void colorHStoRGB(uint16_t hue, byte sat, byte* rgb); //hue, sat to rgb
void colorKtoRGB(uint16_t kelvin, byte* rgb);
2020-04-10 12:30:08 +02:00
void colorCTtoRGB(uint16_t mired, byte* rgb); //white spectrum to rgb
void colorXYtoRGB(float x, float y, byte* rgb); // only defined if huesync disabled TODO
void colorRGBtoXY(byte* rgb, float* xy); // only defined if huesync disabled TODO
void colorFromDecOrHexString(byte* rgb, char* in);
bool colorFromHexString(byte* rgb, const char* in);
uint32_t colorBalanceFromKelvin(uint16_t kelvin, uint32_t rgb);
uint16_t approximateKelvinFromRGB(uint32_t rgb);
2020-04-10 12:30:08 +02:00
void setRandomColor(byte* rgb);
2020-04-10 12:30:08 +02:00
//dmx.cpp
void initDMX();
void handleDMX();
//e131.cpp
2020-09-28 16:29:01 +02:00
void handleE131Packet(e131_packet_t* p, IPAddress clientIP, byte protocol);
2020-04-10 12:30:08 +02:00
//file.cpp
bool handleFileRead(AsyncWebServerRequest*, String path);
2020-05-08 22:53:59 +02:00
bool writeObjectToFileUsingId(const char* file, uint16_t id, JsonDocument* content);
bool writeObjectToFile(const char* file, const char* key, JsonDocument* content);
2020-05-05 09:01:09 +02:00
bool readObjectFromFileUsingId(const char* file, uint16_t id, JsonDocument* dest);
bool readObjectFromFile(const char* file, const char* key, JsonDocument* dest);
2020-10-07 17:48:22 +02:00
void updateFSInfo();
2020-10-13 01:39:34 +02:00
void closeFile();
2020-04-10 12:30:08 +02:00
//hue.cpp
void handleHue();
void reconnectHue();
void onHueError(void* arg, AsyncClient* client, int8_t error);
void onHueConnect(void* arg, AsyncClient* client);
void sendHuePoll();
void onHueData(void* arg, AsyncClient* client, void *data, size_t len);
//improv.cpp
void handleImprovPacket();
void sendImprovStateResponse(uint8_t state, bool error = false);
void sendImprovInfoResponse();
void sendImprovRPCResponse(uint8_t commandId);
2020-04-10 12:30:08 +02:00
//ir.cpp
//bool decodeIRCustom(uint32_t code);
void applyRepeatActions();
byte relativeChange(byte property, int8_t amount, byte lowerBoundary = 0, byte higherBoundary = 0xFF);
2020-04-10 12:30:08 +02:00
void decodeIR(uint32_t code);
void decodeIR24(uint32_t code);
void decodeIR24OLD(uint32_t code);
void decodeIR24CT(uint32_t code);
void decodeIR40(uint32_t code);
void decodeIR44(uint32_t code);
void decodeIR21(uint32_t code);
void decodeIR6(uint32_t code);
void decodeIR9(uint32_t code);
void decodeIRJson(uint32_t code);
2020-04-10 12:30:08 +02:00
void initIR();
void handleIR();
//json.cpp
#include "ESPAsyncWebServer.h"
#include "src/dependencies/json/ArduinoJson-v6.h"
#include "src/dependencies/json/AsyncJson-v6.h"
#include "FX.h"
2021-06-10 02:52:20 +02:00
void deserializeSegment(JsonObject elem, byte it, byte presetId = 0);
bool deserializeState(JsonObject root, byte callMode = CALL_MODE_DIRECT_CHANGE, byte presetId = 0);
2020-10-13 01:39:34 +02:00
void serializeSegment(JsonObject& root, WS2812FX::Segment& seg, byte id, bool forPreset = false, bool segmentBounds = true);
void serializeState(JsonObject root, bool forPreset = false, bool includeBri = true, bool segmentBounds = true);
2020-04-10 12:30:08 +02:00
void serializeInfo(JsonObject root);
void serveJson(AsyncWebServerRequest* request);
#ifdef WLED_ENABLE_JSONLIVE
bool serveLiveLeds(AsyncWebServerRequest* request, uint32_t wsClient = 0);
#endif
2020-04-10 12:30:08 +02:00
//led.cpp
void setValuesFromSegment(uint8_t s);
void setValuesFromMainSeg();
void setValuesFromFirstSelectedSeg();
2020-04-10 12:30:08 +02:00
void resetTimebase();
void toggleOnOff();
void applyBri();
void applyFinalBri();
void applyValuesToSelectedSegs();
void colorUpdated(byte callMode);
void stateUpdated(byte callMode);
2020-04-10 12:30:08 +02:00
void updateInterfaces(uint8_t callMode);
void handleTransitions();
void handleNightlight();
byte scaledBri(byte in);
2020-04-10 12:30:08 +02:00
//lx_parser.cpp
bool parseLx(int lxValue, byte* rgbw);
void parseLxJson(int lxValue, byte segId, bool secondary);
2020-04-10 12:30:08 +02:00
//mqtt.cpp
bool initMqtt();
void publishMqtt();
//ntp.cpp
2021-05-27 00:09:52 +02:00
void handleTime();
2020-04-10 12:30:08 +02:00
void handleNetworkTime();
void sendNTPPacket();
bool checkNTPResponse();
void updateLocalTime();
void getTimeString(char* out);
bool checkCountdown();
void setCountdown();
byte weekdayMondayFirst();
void checkTimers();
void calculateSunriseAndSunset();
2021-05-27 02:02:02 +02:00
void setTimeFromAPI(uint32_t timein);
2020-04-10 12:30:08 +02:00
//overlay.cpp
void handleOverlayDraw();
void _overlayAnalogCountdown();
void _overlayAnalogClock();
2020-11-11 23:48:14 +01:00
//playlist.cpp
void shufflePlaylist();
2021-02-28 15:34:18 +01:00
void unloadPlaylist();
int16_t loadPlaylist(JsonObject playlistObject, byte presetId = 0);
2020-11-11 23:48:14 +01:00
void handlePlaylist();
2020-11-06 22:12:48 +01:00
//presets.cpp
bool applyPreset(byte index, byte callMode = CALL_MODE_DIRECT_CHANGE);
2022-02-01 09:33:57 +01:00
inline bool applyTemporaryPreset() {return applyPreset(255);};
void savePreset(byte index, const char* pname = nullptr, JsonObject saveobj = JsonObject());
inline void saveTemporaryPreset() {savePreset(255);};
2020-11-06 22:12:48 +01:00
void deletePreset(byte index);
2020-04-10 12:30:08 +02:00
//set.cpp
bool isAsterisksOnly(const char* str, byte maxLen);
void handleSettingsSet(AsyncWebServerRequest *request, byte subPage);
bool handleSet(AsyncWebServerRequest *request, const String& req, bool apply=true);
2020-04-10 12:30:08 +02:00
int getNumVal(const String* req, uint16_t pos);
JSON in/decrementing (#2258) * Initial JSON in/decrementing * Segment brightness in/decrement * Update json-increment (#2290) * Add Basic Overlay support to Usermods. * Add seven segment overlay usermod * Add seven_seg debug build * Add scrolling message to seven seg um * Fixed red color on IP address * bh1750 * Add msg scroll. Add MQTT and Config support * Add readme * Restore platformio.inii * Edit comments * Add strip off refresh option in LED settings. (#2259) * Add strip off refresh option in LED settings. New strip initialization logic. Minor code clen-up. * Dev code removal. * Missing ethernet include * Renamed mainseg to selseg * Fix for preset cycling bounds. * "Preset 0" bugfix. * Auto segments only if segments were not modified Co-authored-by: cschwinne <dev.aircoookie@gmail.com> * Exclude virtual busses from current calculation (#2262) * Refactor string usage * 0.13.0-b4 * Fix MQTT Null publish * Additional Flash string concat * Add AKST/AKDT * UM RGB-Rotary-Encoder: Properly used PinOwner * Cycling bugfix. Co-authored-by: Gregory Schmidt <gregory.b.schmidt@hotmail.com> Co-authored-by: Blaž Kristan <blaz@kristan-sp.si> Co-authored-by: Caleb Mah <calebmah@gmail.com> Co-authored-by: ezcGman <ich@andy-hofmann.com> * Working JSON preset cycle * Fix some Codacy style issues Co-authored-by: Gregory Schmidt <gregory.b.schmidt@hotmail.com> Co-authored-by: Blaž Kristan <blaz@kristan-sp.si> Co-authored-by: Caleb Mah <calebmah@gmail.com> Co-authored-by: ezcGman <ich@andy-hofmann.com>
2021-10-30 14:42:17 +02:00
void parseNumber(const char* str, byte* val, byte minv=0, byte maxv=255);
2020-04-10 12:30:08 +02:00
bool updateVal(const String* req, const char* key, byte* val, byte minv=0, byte maxv=255);
2020-04-13 00:42:27 +02:00
//udp.cpp
void notify(byte callMode, bool followUp=false);
uint8_t realtimeBroadcast(uint8_t type, IPAddress client, uint16_t length, byte *buffer, uint8_t bri=255, bool isRGBW=false);
2020-04-13 00:42:27 +02:00
void realtimeLock(uint32_t timeoutMs, byte md = REALTIME_MODE_GENERIC);
void exitRealtime();
2020-04-13 00:42:27 +02:00
void handleNotifications();
void setRealtimePixel(uint16_t i, byte r, byte g, byte b, byte w);
2021-01-22 16:17:18 +01:00
void refreshNodeList();
2021-03-09 17:21:19 +01:00
void sendSysInfoUDP();
2020-04-13 00:42:27 +02:00
//util.cpp
//bool oappend(const char* txt); // append new c string to temp buffer efficiently
//bool oappendi(int i); // append new number to temp buffer efficiently
//void sappend(char stype, const char* key, int val);
//void sappends(char stype, const char* key, char* val);
//void prepareHostname(char* hostname);
//bool isAsterisksOnly(const char* str, byte maxLen);
bool requestJSONBufferLock(uint8_t module=255);
void releaseJSONBufferLock();
uint8_t extractModeName(uint8_t mode, const char *src, char *dest, uint8_t maxLen);
2020-05-28 02:20:02 +02:00
//um_manager.cpp
class Usermod {
public:
virtual void loop() {}
2021-09-30 05:23:32 +02:00
virtual void handleOverlayDraw() {}
virtual bool handleButton(uint8_t b) { return false; }
2020-05-28 02:20:02 +02:00
virtual void setup() {}
virtual void connected() {}
virtual void addToJsonState(JsonObject& obj) {}
virtual void addToJsonInfo(JsonObject& obj) {}
virtual void readFromJsonState(JsonObject& obj) {}
2020-11-11 15:50:15 +01:00
virtual void addToConfig(JsonObject& obj) {}
virtual bool readFromConfig(JsonObject& obj) { return true; } // Note as of 2021-06 readFromConfig() now needs to return a bool, see usermod_v2_example.h
virtual void onMqttConnect(bool sessionPresent) {}
virtual bool onMqttMessage(char* topic, char* payload) { return false; }
2020-05-28 02:20:02 +02:00
virtual uint16_t getId() {return USERMOD_ID_UNSPECIFIED;}
};
class UsermodManager {
2020-05-28 02:20:02 +02:00
private:
Usermod* ums[WLED_MAX_USERMODS];
byte numMods = 0;
public:
void loop();
2021-09-30 05:23:32 +02:00
void handleOverlayDraw();
bool handleButton(uint8_t b);
2020-05-28 02:20:02 +02:00
void setup();
void connected();
void addToJsonState(JsonObject& obj);
void addToJsonInfo(JsonObject& obj);
void readFromJsonState(JsonObject& obj);
2020-11-11 15:50:15 +01:00
void addToConfig(JsonObject& obj);
2021-06-25 01:26:15 +02:00
bool readFromConfig(JsonObject& obj);
void onMqttConnect(bool sessionPresent);
bool onMqttMessage(char* topic, char* payload);
2020-05-28 02:20:02 +02:00
bool add(Usermod* um);
2021-02-09 17:15:43 +01:00
Usermod* lookup(uint16_t mod_id);
2020-05-28 02:20:02 +02:00
byte getModCount();
};
//usermods_list.cpp
void registerUsermods();
2020-04-10 12:30:08 +02:00
//usermod.cpp
void userSetup();
void userConnected();
void userLoop();
//wled_eeprom.cpp
void applyMacro(byte index);
2020-10-23 17:48:01 +02:00
void deEEP();
2020-11-05 22:54:13 +01:00
void deEEPSettings();
2020-12-10 16:27:23 +01:00
void clearEEPROM();
2020-04-10 12:30:08 +02:00
//wled_serial.cpp
void handleSerial();
2022-02-01 20:02:46 +01:00
void updateBaudRate(uint32_t rate);
2020-04-10 12:30:08 +02:00
//wled_server.cpp
bool isIp(String str);
bool captivePortal(AsyncWebServerRequest *request);
void initServer();
void serveIndexOrWelcome(AsyncWebServerRequest *request);
void serveIndex(AsyncWebServerRequest* request);
String msgProcessor(const String& var);
2020-09-20 01:18:31 +02:00
void serveMessage(AsyncWebServerRequest* request, uint16_t code, const String& headl, const String& subl="", byte optionT=255);
2020-04-10 12:30:08 +02:00
String settingsProcessor(const String& var);
String dmxProcessor(const String& var);
2020-09-20 01:18:31 +02:00
void serveSettings(AsyncWebServerRequest* request, bool post = false);
2020-04-10 12:30:08 +02:00
//ws.cpp
void handleWs();
void wsEvent(AsyncWebSocket * server, AsyncWebSocketClient * client, AwsEventType type, void * arg, uint8_t *data, size_t len);
void sendDataWs(AsyncWebSocketClient * client = nullptr);
2020-04-10 12:30:08 +02:00
//xml.cpp
2020-05-28 02:20:02 +02:00
void XML_response(AsyncWebServerRequest *request, char* dest = nullptr);
void URL_response(AsyncWebServerRequest *request);
2020-04-10 12:30:08 +02:00
void sappend(char stype, const char* key, int val);
void sappends(char stype, const char* key, char* val);
void getSettingsJS(byte subPage, char* dest);
#endif