/* LIGHT MODULE Copyright (C) 2016-2017 by Xose PĂ©rez */ #if LIGHT_PROVIDER != LIGHT_PROVIDER_NONE #include #include #include #if LIGHT_PROVIDER == LIGHT_PROVIDER_DIMMER #define PWM_CHANNEL_NUM_MAX LIGHT_CHANNELS extern "C" { #include "libs/pwm.h" } #endif // ----------------------------------------------------------------------------- Ticker _light_save_ticker; Ticker _light_transition_ticker; typedef struct { unsigned char pin; bool reverse; unsigned char value; // target or nominal value unsigned char shadow; // represented value double current; // transition value } channel_t; std::vector _light_channel; bool _light_state = false; bool _light_use_transitions = false; bool _light_has_color = false; bool _light_use_white = false; bool _light_use_gamma = false; unsigned long _light_steps_left = 1; unsigned int _light_brightness = LIGHT_MAX_BRIGHTNESS; #if LIGHT_PROVIDER == LIGHT_PROVIDER_MY92XX #include my92xx * _my92xx; ARRAYINIT(unsigned char, _light_channel_map, MY92XX_MAPPING); #endif // Gamma Correction lookup table (8 bit) // TODO: move to PROGMEM const unsigned char _light_gamma_table[] = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 4, 4, 4, 4, 5, 5, 5, 5, 6, 6, 6, 7, 7, 7, 7, 8, 8, 8, 9, 9, 9, 10, 10, 11, 11, 11, 12, 12, 13, 13, 14, 14, 14, 15, 15, 16, 16, 17, 17, 18, 18, 19, 19, 20, 20, 21, 22, 22, 23, 23, 24, 25, 25, 26, 26, 27, 28, 28, 29, 30, 30, 31, 32, 33, 33, 34, 35, 35, 36, 37, 38, 39, 39, 40, 41, 42, 43, 43, 44, 45, 46, 47, 48, 49, 50, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 71, 72, 73, 74, 75, 76, 77, 78, 80, 81, 82, 83, 84, 86, 87, 88, 89, 91, 92, 93, 94, 96, 97, 98, 100, 101, 102, 104, 105, 106, 108, 109, 110, 112, 113, 115, 116, 118, 119, 121, 122, 123, 125, 126, 128, 130, 131, 133, 134, 136, 137, 139, 140, 142, 144, 145, 147, 149, 150, 152, 154, 155, 157, 159, 160, 162, 164, 166, 167, 169, 171, 173, 175, 176, 178, 180, 182, 184, 186, 187, 189, 191, 193, 195, 197, 199, 201, 203, 205, 207, 209, 211, 213, 215, 217, 219, 221, 223, 225, 227, 229, 231, 233, 235, 238, 240, 242, 244, 246, 248, 251, 253, 255 }; // ----------------------------------------------------------------------------- // UTILS // ----------------------------------------------------------------------------- void _fromLong(unsigned long value, bool brightness) { if (brightness) { _light_channel[0].value = (value >> 24) & 0xFF; _light_channel[1].value = (value >> 16) & 0xFF; _light_channel[2].value = (value >> 8) & 0xFF; _light_brightness = (value & 0xFF) * LIGHT_MAX_BRIGHTNESS / 255; } else { _light_channel[0].value = (value >> 16) & 0xFF; _light_channel[1].value = (value >> 8) & 0xFF; _light_channel[2].value = (value) & 0xFF; } } void _fromRGB(const char * rgb) { char * p = (char *) rgb; if (strlen(p) == 0) return; // if color begins with a # then assume HEX RGB if (p[0] == '#') { if (_light_has_color) { ++p; unsigned long value = strtoul(p, NULL, 16); // RGBA values are interpreted like RGB + brightness _fromLong(value, strlen(p) > 7); } // it's a temperature in mireds } else if (p[0] == 'M') { if (_light_has_color) { unsigned long mireds = atol(p + 1); _fromMireds(mireds); } // it's a temperature in kelvin } else if (p[0] == 'K') { if (_light_has_color) { unsigned long kelvin = atol(p + 1); _fromKelvin(kelvin); } // otherwise assume decimal values separated by commas } else { char * tok; unsigned char count = 0; unsigned char channels = _light_channel.size(); tok = strtok(p, ","); while (tok != NULL) { _light_channel[count].value = atoi(tok); if (++count == channels) break; tok = strtok(NULL, ","); } // RGB but less than 3 values received if (_light_has_color && (count < 3)) { _light_channel[1].value = _light_channel[0].value; _light_channel[2].value = _light_channel[0].value; } } } void _toRGB(char * rgb, size_t len, bool applyBrightness) { if (!_light_has_color) return; float b = applyBrightness ? (float) _light_brightness / LIGHT_MAX_BRIGHTNESS : 1; unsigned long value = 0; value += _light_channel[0].value * b; value <<= 8; value += _light_channel[1].value * b; value <<= 8; value += _light_channel[2].value * b; snprintf_P(rgb, len, PSTR("#%06X"), value); } void _toRGB(char * rgb, size_t len) { _toRGB(rgb, len, false); } // HSV string is expected to be "H,S,V", where: // 0 <= H <= 360 // 0 <= S <= 100 // 0 <= V <= 100 void _fromHSV(const char * hsv) { char * ptr = (char *) hsv; if (strlen(ptr) == 0) return; if (!_light_has_color) return; char * tok; unsigned char count = 0; unsigned int value[3] = {0}; tok = strtok(ptr, ","); while (tok != NULL) { value[count] = atoi(tok); if (++count == 3) break; tok = strtok(NULL, ","); } if (count != 3) return; // HSV to RGB transformation ----------------------------------------------- double h = (value[0] == 360) ? 0 : (double) value[0] / 60.0; double f = (h - floor(h)); double s = (double) value[1] / 100.0; unsigned char v = round((double) value[2] * 255.0 / 100.0); unsigned char p = round(v * (1.0 - s)); unsigned char q = round(v * (1.0 - s * f)); unsigned char t = round(v * (1.0 - s * (1.0 - f))); switch (int(h)) { case 0: _light_channel[0].value = v; _light_channel[1].value = t; _light_channel[2].value = p; break; case 1: _light_channel[0].value = q; _light_channel[1].value = v; _light_channel[2].value = p; break; case 2: _light_channel[0].value = p; _light_channel[1].value = v; _light_channel[2].value = t; break; case 3: _light_channel[0].value = p; _light_channel[1].value = q; _light_channel[2].value = v; break; case 4: _light_channel[0].value = t; _light_channel[1].value = p; _light_channel[2].value = v; break; case 5: _light_channel[0].value = v; _light_channel[1].value = p; _light_channel[2].value = q; break; default: _light_channel[0].value = 0; _light_channel[1].value = 0; _light_channel[2].value = 0; break; } _light_brightness = LIGHT_MAX_BRIGHTNESS; } void _toHSV(char * hsv, size_t len) { if (!_light_has_color) return; double min, max; double h, s, v; double r = (double) _light_channel[0].value / 255.0; double g = (double) _light_channel[1].value / 255.0; double b = (double) _light_channel[2].value / 255.0; min = (r < g) ? r : g; min = (min < b) ? min : b; max = (r > g) ? r : g; max = (max > b) ? max : b; v = 100.0 * max; if (v == 0) { h = s = 0; } else { s = 100.0 * (max - min) / max; if (s == 0) { h = 0; } else { if (max == r) { if (g >= b) { h = 0.0 + 60.0 * (g - b) / (max - min); } else { h = 360.0 + 60.0 * (g - b) / (max - min); } } else if (max == g) { h = 120.0 + 60.0 * (b - r) / (max - min); } else { h = 240.0 + 60.0 * (r - g) / (max - min); } } } // String snprintf_P(hsv, len, PSTR("%d,%d,%d"), round(h), round(s), round(v)); } void _toLong(char * color, size_t len, bool applyBrightness) { if (!_light_has_color) return; float b = applyBrightness ? (float) _light_brightness / LIGHT_MAX_BRIGHTNESS : 1; snprintf_P(color, len, PSTR("%d,%d,%d"), (int) (_light_channel[0].value * b), (int) (_light_channel[1].value * b), (int) (_light_channel[2].value * b) ); } void _toLong(char * color, size_t len) { _toLong(color, len, false); } // Thanks to Sacha Telgenhof for sharing this code in his AiLight library // https://github.com/stelgenhof/AiLight void _fromKelvin(unsigned long kelvin) { // Check we have RGB channels if (!_light_has_color) return; // Calculate colors unsigned int red = (kelvin <= 66) ? LIGHT_MAX_VALUE : 329.698727446 * pow((kelvin - 60), -0.1332047592); unsigned int green = (kelvin <= 66) ? 99.4708025861 * log(kelvin) - 161.1195681661 : 288.1221695283 * pow(kelvin, -0.0755148492); unsigned int blue = (kelvin >= 66) ? LIGHT_MAX_VALUE : ((kelvin <= 19) ? 0 : 138.5177312231 * log(kelvin - 10) - 305.0447927307); // Save values _light_channel[0].value = constrain(red, 0, LIGHT_MAX_VALUE); _light_channel[1].value = constrain(green, 0, LIGHT_MAX_VALUE); _light_channel[2].value = constrain(blue, 0, LIGHT_MAX_VALUE); } // Color temperature is measured in mireds (kelvin = 1e6/mired) void _fromMireds(unsigned long mireds) { if (mireds == 0) mireds = 1; unsigned long kelvin = constrain(1000000UL / mireds, 1000, 40000) / 100; _fromKelvin(kelvin); } // ----------------------------------------------------------------------------- // PROVIDER // ----------------------------------------------------------------------------- unsigned int _toPWM(unsigned long value, bool bright, bool gamma, bool reverse) { value = constrain(value, 0, LIGHT_MAX_VALUE); if (bright) value *= ((float) _light_brightness / LIGHT_MAX_BRIGHTNESS); if (gamma) value = _light_gamma_table[value]; if (LIGHT_MAX_VALUE != LIGHT_LIMIT_PWM) value = map(value, 0, LIGHT_MAX_VALUE, 0, LIGHT_LIMIT_PWM); if (reverse) value = LIGHT_LIMIT_PWM - value; return value; } // Returns a PWM value for the given channel ID unsigned int _toPWM(unsigned char id) { if (id >= _light_channel.size()) return 0; bool isColor = _light_has_color && (id < 3); bool bright = isColor; bool gamma = isColor & _light_use_gamma; return _toPWM(_light_channel[id].shadow, bright, gamma, _light_channel[id].reverse); } void _shadow() { // Update transition ticker _light_steps_left--; if (_light_steps_left == 0) _light_transition_ticker.detach(); // Transitions unsigned char target; for (unsigned int i=0; i < _light_channel.size(); i++) { target = _light_state ? _light_channel[i].value : 0; if (_light_steps_left == 0) { _light_channel[i].current = target; } else { double difference = (double) (target - _light_channel[i].current) / (_light_steps_left + 1); _light_channel[i].current = _light_channel[i].current + difference; } _light_channel[i].shadow = _light_channel[i].current; } // Use white channel for same RGB if (_light_use_white && _light_has_color) { if (_light_channel[0].shadow == _light_channel[1].shadow && _light_channel[1].shadow == _light_channel[2].shadow ) { _light_channel[3].shadow = _light_channel[0].shadow * ((float) _light_brightness / LIGHT_MAX_BRIGHTNESS); _light_channel[2].shadow = 0; _light_channel[1].shadow = 0; _light_channel[0].shadow = 0; } } } void _lightProviderUpdate() { _shadow(); #if LIGHT_PROVIDER == LIGHT_PROVIDER_MY92XX for (unsigned char i=0; i<_light_channel.size(); i++) { _my92xx->setChannel(_light_channel_map[i], _toPWM(i)); } _my92xx->setState(true); _my92xx->update(); #endif #if LIGHT_PROVIDER == LIGHT_PROVIDER_DIMMER for (unsigned int i=0; i < _light_channel.size(); i++) { pwm_set_duty(_toPWM(i), i); } pwm_start(); #endif } // ----------------------------------------------------------------------------- // PERSISTANCE // ----------------------------------------------------------------------------- void _lightColorSave() { for (unsigned int i=0; i < _light_channel.size(); i++) { setSetting("ch", i, _light_channel[i].value); } setSetting("brightness", _light_brightness); saveSettings(); } void _lightColorRestore() { for (unsigned int i=0; i < _light_channel.size(); i++) { _light_channel[i].value = getSetting("ch", i, i==0 ? 255 : 0).toInt(); } _light_brightness = getSetting("brightness", LIGHT_MAX_BRIGHTNESS).toInt(); lightUpdate(false, false); } // ----------------------------------------------------------------------------- // MQTT // ----------------------------------------------------------------------------- #if MQTT_SUPPORT void _lightMQTTCallback(unsigned int type, const char * topic, const char * payload) { if (type == MQTT_CONNECT_EVENT) { if (_light_has_color) { mqttSubscribe(MQTT_TOPIC_BRIGHTNESS); mqttSubscribe(MQTT_TOPIC_MIRED); mqttSubscribe(MQTT_TOPIC_KELVIN); mqttSubscribe(MQTT_TOPIC_COLOR); // DEPRECATE mqttSubscribe(MQTT_TOPIC_COLOR_RGB); mqttSubscribe(MQTT_TOPIC_COLOR_HSV); } char buffer[strlen(MQTT_TOPIC_CHANNEL) + 3]; snprintf_P(buffer, sizeof(buffer), PSTR("%s/+"), MQTT_TOPIC_CHANNEL); mqttSubscribe(buffer); } if (type == MQTT_MESSAGE_EVENT) { // Match topic String t = mqttSubtopic((char *) topic); // Color temperature in mireds if (t.equals(MQTT_TOPIC_MIRED)) { _fromMireds(atol(payload)); lightUpdate(true, mqttForward()); } // Color temperature in kelvins if (t.equals(MQTT_TOPIC_KELVIN)) { _fromKelvin(atol(payload)); lightUpdate(true, mqttForward()); } // Color if (t.equals(MQTT_TOPIC_COLOR) || t.equals(MQTT_TOPIC_COLOR_RGB)) { // DEPRECATE MQTT_TOPIC_COLOR lightColor(payload, true); lightUpdate(true, mqttForward()); } if (t.equals(MQTT_TOPIC_COLOR_HSV)) { lightColor(payload, false); lightUpdate(true, mqttForward()); } // Brightness if (t.equals(MQTT_TOPIC_BRIGHTNESS)) { _light_brightness = constrain(atoi(payload), 0, LIGHT_MAX_BRIGHTNESS); lightUpdate(true, mqttForward()); } // Channel if (t.startsWith(MQTT_TOPIC_CHANNEL)) { unsigned int channelID = t.substring(strlen(MQTT_TOPIC_CHANNEL)+1).toInt(); if (channelID >= _light_channel.size()) { DEBUG_MSG_P(PSTR("[LIGHT] Wrong channelID (%d)\n"), channelID); return; } lightChannel(channelID, atoi(payload)); lightUpdate(true, mqttForward()); } } } void lightMQTT() { char buffer[12]; if (_light_has_color) { // Color if (getSetting("useCSS", LIGHT_USE_CSS).toInt() == 1) { _toRGB(buffer, sizeof(buffer), false); } else { _toLong(buffer, sizeof(buffer), false); } mqttSend(MQTT_TOPIC_COLOR, buffer); // DEPRECATE mqttSend(MQTT_TOPIC_COLOR_RGB, buffer); _toHSV(buffer, sizeof(buffer)); mqttSend(MQTT_TOPIC_COLOR_HSV, buffer); // Brightness snprintf_P(buffer, sizeof(buffer), PSTR("%d"), _light_brightness); mqttSend(MQTT_TOPIC_BRIGHTNESS, buffer); } // Channels for (unsigned int i=0; i < _light_channel.size(); i++) { snprintf_P(buffer, sizeof(buffer), PSTR("%d"), _light_channel[i].value); mqttSend(MQTT_TOPIC_CHANNEL, i, buffer); } } #endif // ----------------------------------------------------------------------------- // API // ----------------------------------------------------------------------------- unsigned char lightChannels() { return _light_channel.size(); } bool lightHasColor() { return _light_has_color; } unsigned char lightWhiteChannels() { return _light_channel.size() % 3; } void lightUpdate(bool save, bool forward) { // Configure color transition _light_steps_left = _light_use_transitions ? LIGHT_TRANSITION_STEPS : 1; _light_transition_ticker.attach_ms(LIGHT_TRANSITION_STEP, _lightProviderUpdate); // Report color & brightness to MQTT broker #if MQTT_SUPPORT if (forward) lightMQTT(); #endif // Report color to WS clients (using current brightness setting) #if WEB_SUPPORT wsSend(_lightWebSocketOnSend); #endif #if LIGHT_SAVE_ENABLED // Delay saving to EEPROM 5 seconds to avoid wearing it out unnecessarily if (save) _light_save_ticker.once(LIGHT_SAVE_DELAY, _lightColorSave); #endif }; #if LIGHT_SAVE_ENABLED == 0 void lightSave() { _lightColorSave(); } #endif void lightState(bool state) { _light_state = state; } bool lightState() { return _light_state; } void lightColor(const char * color, bool rgb) { DEBUG_MSG_P(PSTR("[LIGHT] %s: %s\n"), rgb ? "RGB" : "HSV", color); if (rgb) { _fromRGB(color); } else { _fromHSV(color); } } void lightColor(const char * color) { lightColor(color, true); } void lightColor(unsigned long color) { _fromLong(color, false); } String lightColor(bool rgb) { char str[12]; if (rgb) { _toRGB(str, sizeof(str), false); } else { _toHSV(str, sizeof(str)); } return String(str); } String lightColor() { return lightColor(true); } unsigned int lightChannel(unsigned char id) { if (id <= _light_channel.size()) { return _light_channel[id].value; } return 0; } void lightChannel(unsigned char id, unsigned int value) { if (id <= _light_channel.size()) { _light_channel[id].value = constrain(value, 0, LIGHT_MAX_VALUE); } } unsigned int lightBrightness() { return _light_brightness; } void lightBrightness(int b) { _light_brightness = constrain(b, 0, LIGHT_MAX_BRIGHTNESS); } void lightBrightnessStep(int steps) { lightBrightness(_light_brightness + steps * LIGHT_STEP); } // ----------------------------------------------------------------------------- // SETUP // ----------------------------------------------------------------------------- #if WEB_SUPPORT void _lightWebSocketOnSend(JsonObject& root) { root["colorVisible"] = 1; root["useColor"] = _light_has_color; root["useWhite"] = _light_use_white; root["useGamma"] = _light_use_gamma; root["useTransitions"] = _light_use_transitions; root["useCSS"] = getSetting("useCSS", LIGHT_USE_CSS).toInt() == 1; bool useRGB = getSetting("useRGB", LIGHT_USE_RGB).toInt() == 1; root["useRGB"] = useRGB; if (_light_has_color) { if (useRGB) { root["rgb"] = lightColor(true); root["brightness"] = lightBrightness(); } else { root["hsv"] = lightColor(false); } } JsonArray& channels = root.createNestedArray("channels"); for (unsigned char id=0; id < lightChannels(); id++) { channels.add(lightChannel(id)); } } void _lightWebSocketOnAction(const char * action, JsonObject& data) { if (_light_has_color) { if (strcmp(action, "color") == 0) { if (data.containsKey("rgb")) { lightColor(data["rgb"], true); lightUpdate(true, true); } if (data.containsKey("hsv")) { lightColor(data["hsv"], false); lightUpdate(true, true); } if (data.containsKey("brightness")) { lightBrightness(data["brightness"]); lightUpdate(true, true); } } } if (strcmp(action, "channel") == 0) { if (data.containsKey("id") && data.containsKey("value")) { lightChannel(data["id"], data["value"]); lightUpdate(true, true); } } } void _lightAPISetup() { // API entry points (protected with apikey) if (_light_has_color) { // DEPRECATE apiRegister(MQTT_TOPIC_COLOR, MQTT_TOPIC_COLOR, [](char * buffer, size_t len) { if (getSetting("useCSS", LIGHT_USE_CSS).toInt() == 1) { _toRGB(buffer, len, false); } else { _toLong(buffer, len, false); } }, [](const char * payload) { lightColor(payload, true); lightUpdate(true, true); } ); apiRegister(MQTT_TOPIC_COLOR_RGB, MQTT_TOPIC_COLOR_RGB, [](char * buffer, size_t len) { if (getSetting("useCSS", LIGHT_USE_CSS).toInt() == 1) { _toRGB(buffer, len, false); } else { _toLong(buffer, len, false); } }, [](const char * payload) { lightColor(payload, true); lightUpdate(true, true); } ); apiRegister(MQTT_TOPIC_COLOR_HSV, MQTT_TOPIC_COLOR_HSV, [](char * buffer, size_t len) { _toHSV(buffer, len); }, [](const char * payload) { lightColor(payload, false); lightUpdate(true, true); } ); apiRegister(MQTT_TOPIC_BRIGHTNESS, MQTT_TOPIC_BRIGHTNESS, [](char * buffer, size_t len) { snprintf_P(buffer, len, PSTR("%d"), _light_brightness); }, [](const char * payload) { lightBrightness(atoi(payload)); lightUpdate(true, true); } ); apiRegister(MQTT_TOPIC_KELVIN, MQTT_TOPIC_KELVIN, [](char * buffer, size_t len) {}, [](const char * payload) { _fromKelvin(atol(payload)); lightUpdate(true, true); } ); apiRegister(MQTT_TOPIC_MIRED, MQTT_TOPIC_MIRED, [](char * buffer, size_t len) {}, [](const char * payload) { _fromMireds(atol(payload)); lightUpdate(true, true); } ); } for (unsigned int id=0; id