From 169718aa5cb88951f41bf5006ea04a1957902146 Mon Sep 17 00:00:00 2001 From: Theo Arends <11044339+arendst@users.noreply.github.com> Date: Tue, 2 Jul 2019 12:26:04 +0200 Subject: [PATCH] Refactor Sonoff L1 support Refactor Sonoff L1 support --- sonoff/my_user_config.h | 2 +- sonoff/sonoff_post.h | 8 +- sonoff/xdrv_19_ps16dz_dimmer.ino | 217 +++++++++++++------------------ 3 files changed, 93 insertions(+), 134 deletions(-) diff --git a/sonoff/my_user_config.h b/sonoff/my_user_config.h index 83b9e0743..5c692ee95 100644 --- a/sonoff/my_user_config.h +++ b/sonoff/my_user_config.h @@ -404,7 +404,7 @@ #define USE_TUYA_DIMMER // Add support for Tuya Serial Dimmer #define TUYA_DIMMER_ID 0 // Default dimmer Id #define USE_ARMTRONIX_DIMMERS // Add support for Armtronix Dimmers (+1k4 code) -#define USE_PS_16_DZ // Add support for PS-16-DZ Dimmer and Sonoff L1 (+2k7 code) +#define USE_PS_16_DZ // Add support for PS-16-DZ Dimmer and Sonoff L1 (+2k code) //#define ROTARY_V1 // Add support for MI Desk Lamp //#define USE_AZ7798 // Add support for AZ-Instrument 7798 CO2 datalogger (+1k6 code) //#define USE_PN532_HSU // Add support for PN532 using HSU (Serial) interface (+1k8 code, 140 bytes mem) diff --git a/sonoff/sonoff_post.h b/sonoff/sonoff_post.h index 9abeea234..1f25c308a 100644 --- a/sonoff/sonoff_post.h +++ b/sonoff/sonoff_post.h @@ -137,7 +137,7 @@ void KNX_CB_Action(message_t const &msg, void *arg); #ifndef TUYA_DIMMER_ID #define TUYA_DIMMER_ID 0 // Default dimmer Id #endif -#define USE_PS_16_DZ // Add support for PS-16-DZ Dimmer and Sonoff L1 (+2k7 code) +#define USE_PS_16_DZ // Add support for PS-16-DZ Dimmer and Sonoff L1 (+2k code) //#define USE_AZ7798 // Add support for AZ-Instrument 7798 CO2 datalogger #define USE_PN532_HSU // Add support for PN532 using HSU (Serial) interface (+1k8 code, 140 bytes mem) #define USE_PZEM004T // Add support for PZEM004T Energy monitor (+2k code) @@ -208,7 +208,7 @@ void KNX_CB_Action(message_t const &msg, void *arg); #undef USE_MP3_PLAYER // Disable DFPlayer Mini MP3 Player RB-DFR-562 commands: play, volume and stop #undef USE_TUYA_DIMMER // Disable support for Tuya Serial Dimmer #undef USE_ARMTRONIX_DIMMERS // Disable support for Armtronix Dimmers (+1k4 code) -#undef USE_PS_16_DZ // Disable support for PS-16-DZ Dimmer and Sonoff L1 (+2k7 code) +#undef USE_PS_16_DZ // Disable support for PS-16-DZ Dimmer and Sonoff L1 (+2k code) #undef USE_AZ7798 // Disable support for AZ-Instrument 7798 CO2 datalogger #undef USE_PN532_HSU // Disable support for PN532 using HSU (Serial) interface (+1k8 code, 140 bytes mem) #undef USE_PZEM004T // Disable PZEM004T energy sensor @@ -341,7 +341,7 @@ void KNX_CB_Action(message_t const &msg, void *arg); #undef USE_MP3_PLAYER // Disable DFPlayer Mini MP3 Player RB-DFR-562 commands: play, volume and stop //#undef USE_TUYA_DIMMER // Disable support for Tuya Serial Dimmer #undef USE_ARMTRONIX_DIMMERS // Disable support for Armtronix Dimmers (+1k4 code) -#undef USE_PS_16_DZ // Disable support for PS-16-DZ Dimmer and Sonoff L1 (+2k7 code) +#undef USE_PS_16_DZ // Disable support for PS-16-DZ Dimmer and Sonoff L1 (+2k code) #undef USE_AZ7798 // Disable support for AZ-Instrument 7798 CO2 datalogger #undef USE_PN532_HSU // Disable support for PN532 using HSU (Serial) interface (+1k8 code, 140 bytes mem) #undef USE_PZEM004T // Disable PZEM004T energy sensor @@ -412,7 +412,7 @@ void KNX_CB_Action(message_t const &msg, void *arg); #undef USE_MP3_PLAYER // Disable DFPlayer Mini MP3 Player RB-DFR-562 commands: play, volume and stop #undef USE_TUYA_DIMMER // Disable support for Tuya Serial Dimmer #undef USE_ARMTRONIX_DIMMERS // Disable support for Armtronix Dimmers (+1k4 code) -#undef USE_PS_16_DZ // Disable support for PS-16-DZ Dimmer and Sonoff L1 (+2k7 code) +#undef USE_PS_16_DZ // Disable support for PS-16-DZ Dimmer and Sonoff L1 (+2k code) #undef USE_AZ7798 // Disable support for AZ-Instrument 7798 CO2 datalogger #undef USE_PN532_HSU // Disable support for PN532 using HSU (Serial) interface (+1k8 code, 140 bytes mem) #undef USE_PZEM004T // Disable PZEM004T energy sensor diff --git a/sonoff/xdrv_19_ps16dz_dimmer.ino b/sonoff/xdrv_19_ps16dz_dimmer.ino index 74c7cd070..3b240a12f 100644 --- a/sonoff/xdrv_19_ps16dz_dimmer.ino +++ b/sonoff/xdrv_19_ps16dz_dimmer.ino @@ -1,7 +1,7 @@ /* - xdrv_19_ps16dz_dimmer.ino - PS_16_DZ dimmer support for Sonoff-Tasmota + xdrv_19_ps16dz_dimmer.ino - PS_16_DZ dimmer and Sonoff L1 support for Sonoff-Tasmota - Copyright (C) 2019 Joel Stein and Theo Arends + Copyright (C) 2019 Joel Stein and Theo Arends This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -19,6 +19,9 @@ #ifdef USE_LIGHT #ifdef USE_PS_16_DZ +/*********************************************************************************************\ + * PS 16 DZ Serial Dimmer and Sonoff L1 +\*********************************************************************************************/ #define XDRV_19 19 @@ -41,65 +44,31 @@ TasmotaSerial *PS16DZSerial = nullptr; +char *ps16dz_tx_buffer = nullptr; // Serial transmit buffer +char *ps16dz_rx_buffer = nullptr; // Serial receive buffer +int ps16dz_byte_counter = 0; +uint8_t ps16dz_color[3]; // Most recent serial sent/received values +uint8_t ps16dz_dimmer = 0; bool ps16dz_supports_color = false; bool ps16dz_switch = false; -uint8_t ps16dz_dimmer = 0; -uint8_t ps16dz_color[3]; // Most recent serial sent/received values -char *ps16dz_tx_buffer = nullptr; // Serial transmit buffer -char *ps16dz_rx_buffer = nullptr; // Serial receive buffer -int ps16dz_byte_counter = 0; /*********************************************************************************************\ * Internal Functions \*********************************************************************************************/ -bool PS16DZSetPower(void) +void PS16DZSerialSendTxBuffer(void) { - return PS16DZSerialSendUpdateCommandIfRequired(); + AddLog_P2(LOG_LEVEL_DEBUG, PSTR("PSZ: Send serial command: %s"), ps16dz_tx_buffer); + + PS16DZSerial->print(ps16dz_tx_buffer); + PS16DZSerial->write(0x1B); + PS16DZSerial->flush(); } -bool PS16DZSetChannels(void) +void PS16DZSerialSendOkCommand(void) { - return PS16DZSerialSendUpdateCommandIfRequired(); -} - -bool PS16DZSerialSendUpdateCommandIfRequired() -{ - if(!PS16DZSerial) return true; - - bool is_switch_change = PS16DZSwitchHasChanged(); - bool is_brightness_change = PS16DZDimmerHasChanged(); - bool is_color_change = ps16dz_supports_color && PS16DZColorHasChanged(); - - bool change_has_occurred = is_switch_change || is_brightness_change || is_color_change; - if(change_has_occurred) - { - PS16DZSerialSendUpdateCommand(); - } - - return true; -} - -bool PS16DZSwitchHasChanged() -{ - int16_t source = XdrvMailbox.payload; - bool source_is_valid = source != SRC_SWITCH; - return source_is_valid; -} - -bool PS16DZDimmerHasChanged() -{ - uint8_t light_state_dimmer = light_state.getDimmer(); - bool dimmer_has_changed = light_state_dimmer != ps16dz_dimmer; - return dimmer_has_changed; -} - -bool PS16DZColorHasChanged() -{ - uint8_t light_state_rgb[3]; - light_state.getRGB(&light_state_rgb[0], &light_state_rgb[1], &light_state_rgb[2]); - bool color_has_changed = memcmp(light_state_rgb, ps16dz_color, 3) != 0; - return color_has_changed; + snprintf_P(ps16dz_tx_buffer, PS16DZ_BUFFER_SIZE, PSTR("AT+SEND=ok")); + PS16DZSerialSendTxBuffer(); } // Send a serial update command to the LED controller @@ -107,60 +76,47 @@ bool PS16DZColorHasChanged() // AT+UPDATE="sequence":"1554682835320","switch":"on":"bright":100 // For color types: // AT+UPDATE="sequence":"1554682835320","switch":"on":,"bright":100,"mode":1,"colorR":255,"colorG":46,"colorB":101,"light_types":1 -void PS16DZSerialSendUpdateCommand() +void PS16DZSerialSendUpdateCommand(void) { - uint8_t light_state_dimmer; - light_state_dimmer = light_state.getDimmer(); + uint8_t light_state_dimmer = light_state.getDimmer(); // Dimming acts odd below 10% - this mirrors the threshold set on the faceplate itself light_state_dimmer = (light_state_dimmer < 10) ? 10 : light_state_dimmer; - snprintf_P(ps16dz_tx_buffer, PS16DZ_BUFFER_SIZE, PSTR( "AT+UPDATE=\"sequence\":\"")); - snprintf_P(ps16dz_tx_buffer, PS16DZ_BUFFER_SIZE, PSTR( "%s%d%03d"), ps16dz_tx_buffer, LocalTime(), millis()%1000); - snprintf_P(ps16dz_tx_buffer, PS16DZ_BUFFER_SIZE, PSTR( "%s\",\"switch\":\"%s\""), ps16dz_tx_buffer, power?"on":"off"); - snprintf_P(ps16dz_tx_buffer, PS16DZ_BUFFER_SIZE, PSTR( "%s,\"bright\":%d"), ps16dz_tx_buffer, light_state_dimmer); + snprintf_P(ps16dz_tx_buffer, PS16DZ_BUFFER_SIZE, PSTR( "AT+UPDATE=\"sequence\":\"%d%03d\",\"switch\":\"%s\",\"bright\":%d"), + LocalTime(), millis()%1000, power?"on":"off", light_state_dimmer); - if(ps16dz_supports_color) - { - int light_types_value = 1; + if (ps16dz_supports_color) { uint8_t light_state_rgb[3]; light_state.getRGB(&light_state_rgb[0], &light_state_rgb[1], &light_state_rgb[2]); - snprintf_P(ps16dz_tx_buffer, PS16DZ_BUFFER_SIZE, PSTR( "%s,\"mode\":%d"), ps16dz_tx_buffer, PS16DZ_SONOFF_L1_MODE_COLORFUL); - snprintf_P(ps16dz_tx_buffer, PS16DZ_BUFFER_SIZE, PSTR( "%s,\"colorR\":%d"), ps16dz_tx_buffer, light_state_rgb[0]); - snprintf_P(ps16dz_tx_buffer, PS16DZ_BUFFER_SIZE, PSTR( "%s,\"colorG\":%d"), ps16dz_tx_buffer, light_state_rgb[1]); - snprintf_P(ps16dz_tx_buffer, PS16DZ_BUFFER_SIZE, PSTR( "%s,\"colorB\":%d"), ps16dz_tx_buffer, light_state_rgb[2]); - snprintf_P(ps16dz_tx_buffer, PS16DZ_BUFFER_SIZE, PSTR( "%s,\"light_types\":%d"), ps16dz_tx_buffer, light_types_value); + snprintf_P(ps16dz_tx_buffer, PS16DZ_BUFFER_SIZE, PSTR("%s,\"mode\":%d,\"colorR\":%d,\"colorG\":%d,\"colorB\":%d,\"light_types\":1"), + ps16dz_tx_buffer, PS16DZ_SONOFF_L1_MODE_COLORFUL, light_state_rgb[0], light_state_rgb[1], light_state_rgb[2]); } PS16DZSerialSendTxBuffer(); } -void PS16DZSerialSendOkCommand() -{ - snprintf_P(ps16dz_tx_buffer, PS16DZ_BUFFER_SIZE, PSTR( "AT+SEND=ok")); - PS16DZSerialSendTxBuffer(); -} - -void PS16DZSerialSendTxBuffer() -{ - AddLog_P2(LOG_LEVEL_DEBUG, PSTR("PSZ: Send serial command: %s"), ps16dz_tx_buffer ); - PS16DZSerial->print(ps16dz_tx_buffer); - PS16DZSerial->write(0x1B); - PS16DZSerial->flush(); -} - -void PS16DZResetWifi(void) -{ - if (!Settings.flag.button_restrict) { - char scmnd[20]; - snprintf_P(scmnd, sizeof(scmnd), D_CMND_WIFICONFIG " %d", 2); - ExecuteCommand(scmnd, SRC_BUTTON); - } -} - /*********************************************************************************************\ * API Functions \*********************************************************************************************/ +bool PS16DZSerialSendUpdateCommandIfRequired(void) +{ + if (!PS16DZSerial) { return true; } + + bool is_switch_change = (XdrvMailbox.payload != SRC_SWITCH); + bool is_brightness_change = (light_state.getDimmer() != ps16dz_dimmer); + + uint8_t light_state_rgb[3]; + light_state.getRGB(&light_state_rgb[0], &light_state_rgb[1], &light_state_rgb[2]); + bool is_color_change = (ps16dz_supports_color && (memcmp(light_state_rgb, ps16dz_color, 3) != 0)); + + if (is_switch_change || is_brightness_change || is_color_change) { + PS16DZSerialSendUpdateCommand(); + } + + return true; +} + bool PS16DZModuleSelected(void) { switch (my_module_type) @@ -179,7 +135,7 @@ bool PS16DZModuleSelected(void) void PS16DZInit(void) { - ps16dz_supports_color = light_state.getColorMode() == LCM_RGB; + ps16dz_supports_color = (light_state.getColorMode() == LCM_RGB); ps16dz_tx_buffer = (char*)(malloc(PS16DZ_BUFFER_SIZE)); if (ps16dz_tx_buffer != nullptr) { @@ -199,22 +155,23 @@ void PS16DZSerialInput(void) while (PS16DZSerial->available()) { yield(); uint8_t serial_in_byte = PS16DZSerial->read(); - if (serial_in_byte != 0x1B){ + if (serial_in_byte != 0x1B) { if (ps16dz_byte_counter >= PS16DZ_BUFFER_SIZE - 1) { memset(ps16dz_rx_buffer, 0, PS16DZ_BUFFER_SIZE); ps16dz_byte_counter = 0; } - if (ps16dz_byte_counter || (!ps16dz_byte_counter && serial_in_byte == 'A')) { + if (ps16dz_byte_counter || (!ps16dz_byte_counter && ('A' == serial_in_byte))) { ps16dz_rx_buffer[ps16dz_byte_counter++] = serial_in_byte; } - } - else { + } else { ps16dz_rx_buffer[ps16dz_byte_counter++] = 0x00; + AddLog_P2(LOG_LEVEL_DEBUG, PSTR("PSZ: command received: %s"), ps16dz_rx_buffer); - if(!strncmp(ps16dz_rx_buffer+3, "UPDATE", 6)) { + + if (!strncmp(ps16dz_rx_buffer+3, "UPDATE", 6)) { char *end_str; char *string = ps16dz_rx_buffer+10; - char* token = strtok_r(string, ",", &end_str); + char *token = strtok_r(string, ",", &end_str); bool color_updated[3] = { false, false, false }; memcpy(ps16dz_color, Settings.light_color, 3); @@ -227,19 +184,22 @@ void PS16DZSerialInput(void) char* token2 = strtok_r(token, ":", &end_token); char* token3 = strtok_r(nullptr, ":", &end_token); - if(!strncmp(token2, "\"switch\"", 8)){ + if (!strncmp(token2, "\"switch\"", 8)) { + + ps16dz_switch = !strncmp(token3, "\"on\"", 4) ? true : false; - ps16dz_switch = !strncmp(token3, "\"on\"", 4)?true:false; AddLog_P2(LOG_LEVEL_DEBUG, PSTR("PSZ: switch received: %d"), ps16dz_switch); - is_switch_change = ps16dz_switch != power; + is_switch_change = (ps16dz_switch != power); + + if (is_switch_change) { + +// AddLog_P2(LOG_LEVEL_DEBUG, PSTR("PSZ: Send CMND_POWER=%d"), ps16dz_switch ); - if(is_switch_change) { - AddLog_P2(LOG_LEVEL_DEBUG, PSTR("PSZ: Send CMND_POWER=%d"), ps16dz_switch ); ExecuteCommandPower(1, ps16dz_switch, SRC_SWITCH); // send SRC_SWITCH? to use as flag to prevent loop from inbound states from faceplate interaction } } - else if(!strncmp(token2, "\"color", 6)) { + else if (!strncmp(token2, "\"color", 6)) { char color_channel_name = token2[6]; int color_index; @@ -260,52 +220,56 @@ void PS16DZSerialInput(void) bool all_color_channels_updated = color_updated[0] && color_updated[1] && color_updated[2]; - if(all_color_channels_updated) - { - AddLog_P2(LOG_LEVEL_DEBUG, PSTR("PSZ: color received: R:%d, G:%d, B:%d"), - ps16dz_color[0], ps16dz_color[1], ps16dz_color[2]); + if (all_color_channels_updated) { + AddLog_P2(LOG_LEVEL_DEBUG, PSTR("PSZ: color received: R:%d, G:%d, B:%d"), ps16dz_color[0], ps16dz_color[1], ps16dz_color[2]); - is_color_change = memcmp(ps16dz_color, Settings.light_color, 3) != 0; + is_color_change = (memcmp(ps16dz_color, Settings.light_color, 3) != 0); } - if(power && is_color_change) - { - snprintf_P(scmnd, sizeof(scmnd), PSTR(D_CMND_COLOR "2 %02x%02x%02x"), - ps16dz_color[0], ps16dz_color[1], ps16dz_color[2]); + if (power && is_color_change) { + snprintf_P(scmnd, sizeof(scmnd), PSTR(D_CMND_COLOR "2 %02x%02x%02x"), ps16dz_color[0], ps16dz_color[1], ps16dz_color[2]); + +// AddLog_P2(LOG_LEVEL_DEBUG, PSTR("PSZ: Send CMND_COLOR_STR=%s"), scmnd ); - AddLog_P2(LOG_LEVEL_DEBUG, PSTR("PSZ: Send CMND_COLOR_STR=%s"), scmnd ); ExecuteCommand(scmnd, SRC_SWITCH); } } - else if(!strncmp(token2, "\"bright\"", 8)){ + else if (!strncmp(token2, "\"bright\"", 8)) { ps16dz_dimmer = atoi(token3); + AddLog_P2(LOG_LEVEL_DEBUG, PSTR("PSZ: brightness received: %d"), ps16dz_dimmer); is_brightness_change = ps16dz_dimmer != Settings.light_dimmer; - if(power && ps16dz_dimmer > 0 && is_brightness_change) { - snprintf_P(scmnd, sizeof(scmnd), PSTR(D_CMND_DIMMER " %d"), ps16dz_dimmer ); - AddLog_P2(LOG_LEVEL_DEBUG, PSTR("PSZ: Send CMND_DIMMER_STR=%s"), scmnd ); + if (power && (ps16dz_dimmer > 0) && is_brightness_change) { + snprintf_P(scmnd, sizeof(scmnd), PSTR(D_CMND_DIMMER " %d"), ps16dz_dimmer); + +// AddLog_P2(LOG_LEVEL_DEBUG, PSTR("PSZ: Send CMND_DIMMER_STR=%s"), scmnd); + ExecuteCommand(scmnd, SRC_SWITCH); } } - else if(!strncmp(token2, "\"sequence\"", 10)){ - + else if (!strncmp(token2, "\"sequence\"", 10)) { AddLog_P2(LOG_LEVEL_DEBUG, PSTR("PSZ: sequence received: %s"), token3); } token = strtok_r(nullptr, ",", &end_str); } - if(!is_color_change && !is_brightness_change) - { + if (!is_color_change && !is_brightness_change) { AddLog_P2(LOG_LEVEL_DEBUG, PSTR("PSZ: Update received")); + PS16DZSerialSendOkCommand(); } } - else if(!strncmp(ps16dz_rx_buffer+3, "SETTING", 7)) { - AddLog_P(LOG_LEVEL_DEBUG, PSTR("PSZ: Reset")); - PS16DZResetWifi(); + else if (!strncmp(ps16dz_rx_buffer+3, "SETTING", 7)) { +// AddLog_P(LOG_LEVEL_DEBUG, PSTR("PSZ: Reset")); + + if (!Settings.flag.button_restrict) { + char scmnd[20]; + snprintf_P(scmnd, sizeof(scmnd), PSTR(D_CMND_WIFICONFIG " 2")); + ExecuteCommand(scmnd, SRC_BUTTON); + } } memset(ps16dz_rx_buffer, 0, PS16DZ_BUFFER_SIZE); ps16dz_byte_counter = 0; @@ -313,8 +277,6 @@ void PS16DZSerialInput(void) } } - - /*********************************************************************************************\ * Interface \*********************************************************************************************/ @@ -323,8 +285,7 @@ bool Xdrv19(uint8_t function) { bool result = false; - if (PS_16_DZ == my_module_type || - SONOFF_L1 == my_module_type) { + if ((PS_16_DZ == my_module_type) || (SONOFF_L1 == my_module_type)) { switch (function) { case FUNC_LOOP: if (PS16DZSerial) { PS16DZSerialInput(); } @@ -336,10 +297,8 @@ bool Xdrv19(uint8_t function) PS16DZInit(); break; case FUNC_SET_DEVICE_POWER: - result = PS16DZSetPower(); - break; case FUNC_SET_CHANNELS: - result = PS16DZSetChannels(); + result = PS16DZSerialSendUpdateCommandIfRequired(); break; } }