diff --git a/CHANGELOG.md b/CHANGELOG.md index 0d85a1c27e61..7ef78cfd8019 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ All notable changes to this project will be documented in this file. - SML FastExit for binary SML parsing (#21497) ### Changed +- GPIOViewer from v1.5.3 to v1.5.4 (No functional change) - TCP bridge increased baudrate selection (#21528) - Berry coc parser keeps order of variables (#21542) diff --git a/RELEASENOTES.md b/RELEASENOTES.md index b12d6f1f8059..d2588d27407d 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -129,7 +129,7 @@ The latter links can be used for OTA upgrades too like ``OtaUrl https://ota.tasm ### Changed - ESP32 Core3 platform update from 2024.05.11 to 2024.05.13 [#21524](https://github.com/arendst/Tasmota/issues/21524) -- GPIOViewer from v1.5.2 to v1.5.3 +- GPIOViewer from v1.5.2 to v1.5.4 - On universal display remove default backlight power if a PWM channel is used for backlight - TCP bridge increased baudrate selection [#21528](https://github.com/arendst/Tasmota/issues/21528) - Support W5500 SPI ethernet using four SPI GPIOs only without IRQ and RESET diff --git a/lib/default/TasmotaSerial-3.6.0/src/TasmotaSerial.cpp b/lib/default/TasmotaSerial-3.6.0/src/TasmotaSerial.cpp index 72bf19e1daf3..3871fc33bcdd 100644 --- a/lib/default/TasmotaSerial-3.6.0/src/TasmotaSerial.cpp +++ b/lib/default/TasmotaSerial-3.6.0/src/TasmotaSerial.cpp @@ -136,7 +136,12 @@ bool TasmotaSerial::isValidGPIOpin(int pin) { } void TasmotaSerial::setTransmitEnablePin(int tx_enable_pin) { +#ifdef ESP8266 + if ((tx_enable_pin > -1) && (isValidGPIOpin(tx_enable_pin) || (16 == tx_enable_pin))) { +#endif +#ifdef ESP32 if ((tx_enable_pin > -1) && isValidGPIOpin(tx_enable_pin)) { +#endif m_tx_enable_pin = tx_enable_pin; pinMode(m_tx_enable_pin, OUTPUT); digitalWrite(m_tx_enable_pin, LOW); diff --git a/tasmota/berry/drivers/Core200S.be b/tasmota/berry/drivers/Core200S.be new file mode 100644 index 000000000000..2764b8cfb3d7 --- /dev/null +++ b/tasmota/berry/drivers/Core200S.be @@ -0,0 +1,832 @@ +import string +import webserver + +#### +# Feature state classes +# In the section below there Classes that represent state of specific features of the air purifier (e.g. +# if the fan is on or off) +#### + +# Generic parent class that implements the shared functionality of all state classes +class StateEnum + var value_map + var value + + # Init a state + # param value_map map of valid states in readable and binary form (e.g. {"on":1, "off":0} + # param value value that this object reprents + def init(value_map, value) + self.value_map = value_map + if type(value) == 'int' + for v : self.value_map + if v == value + self.value = value + break + end + end + elif type(value) == 'string' + self.value = value_map.find(value) + end + + if self.value == nil + raise "StateEnumError", "Invalid type or value" + end + end + + def tostring() + for k : self.value_map.keys() + if self.value_map[k] == self.value + return k + end + end + return "invalid" + end + + def toint() + return self.value + end + + def ==(other) + return self.value == other.value && type(self) == type(other) + end + +end + +# Generic parent class that implementes On-Off only features (so features that only +# know these two states +class OnOffState : StateEnum + static ON = OnOffState("on") + static OFF = OnOffState("off") + def init(value) + super(self).init({"off": 0, "on": 1}, value) + end +end + +# Class that represent if the fan is running or nor +class FanMode : OnOffState + def init(value) + super(self).init(value) + end +end + +# Class that represents if the child lock is enabled or not +class ChildLockMode : OnOffState + def init(value) + super(self).init(value) + end +end + +# Class that represents if the sleep mode is enabled or not +class SleepMode : OnOffState + def init(value) + super(self).init(value) + end +end + +# Class that represent if the the display auto off mode is enabled or not +class DisplayAutoOffMode : StateEnum + static OFF = DisplayAutoOffMode("off") + static ON = DisplayAutoOffMode("on") + def init(value) + super(self).init({"off": 1, "on": 0}, value) + end +end + +# Class that represents if the display is currently turned on or not +# (Note this just represents the current state and can't only be controlled via +# sleep mode or display auto off mode) +class DisplayMode : StateEnum + def init(value) + super(self).init({"off": 0, "on": 100}, value) + end +end + +# Class that represents the current speed level of the fan +# (Note even if fan is turned off, the last speed state is stored) +class FanSpeedMode : StateEnum + static LOW = FanSpeedMode("low") + static MED = FanSpeedMode("med") + static FULL = FanSpeedMode("full") + + def init(value) + super(self).init({"low": 1, "med": 2, "full": 3}, value) + end +end + +# Class that reprensts the state of the night light +class NightLightMode : StateEnum + static OFF = NightLightMode("off") + static LOW = NightLightMode("low") + static FULL = NightLightMode("full") + def init(value) + super(self).init({"off": 0, "low": 50, "full": 100}, value) + end +end + + + +#### +# Utility classes +#### + +def info_c2s(msg) + log("C2S: " + msg, 2) +end + +def log_c2s(msg) + log("C2S: " + msg, 3) +end + +# Class that implements messaging functionality that is need and not provided by the +# "normal" serial class, such as +# * read byte by byte +# * read ahead (reading without actually consuming the content) +# and some device specifc functionality such a +# * checksum calculation and verification of each message +# * tracking of message count +# * reading of single messages instead of whole serial buffer +class Core200SSerial : serial + var msg_count + var read_buffer + var error_count + var expected_replies + + def init(RX, TX) + super(self).init(RX, TX, 115200) + self.reset_counters() + self.read_buffer = bytes() + end + + def deinit() + self.close() + end + + static def calc_checksum(msg) + var checksum = 0xff + var i = 0 + while i < msg.size() + if (i != 5) + checksum -= msg.get(i) + if checksum < 0 + checksum += 256 + end + end + i += 1 + end + return checksum + end + + # send message and wait for reply + # message counter is set and message checksum are calculated automatically + def send(msg) + self.send_nowait(msg) + tasmota.delay(50) + return self.read_msg() + end + + # send message and don't wait for reply here. Instead the reply needs to be handled asynchronously + def send_nowait(msg) + if msg.size() >= 2 && msg[1] == 0x22 + self.expected_replies += 1 + end + + # increase and set message counter + self.msg_count += 1 + msg[2] = self.msg_count + + # insert checksum + msg[5] = self.calc_checksum(msg) + + # send message + var i = 0 + while i < msg.size() + self.write(msg[i]) + i += 1 + end + + log_c2s(f"Send {msg.tohex()}") + end + + # Return number of available bytes + # (is specified because the available() method from serial would return incorrect values) + def available() + self.read_buffer += self.read() + return self.read_buffer.size() + end + + # read num bytes but don't actually remove them from the buffer + def read_ahead(num) + var content = self.read() + self.read_buffer += content + + if self.read_buffer.size() >= num + return self.read_buffer[0..(num-1)] + end + + return nil + end + + # read num bytes and remove them from buffer + def consume(num) + var content = self.read_ahead(num) + if content != nil + self.read_buffer = self.read_buffer[num..] + end + return content + end + + # Read whole message from internal buffer. Note there might be multiple messages in the buffer. + # Reading a message from the buffer will also consume this message (so it will be removed from the buffer) + def read_msg(allow_no_msg) + var max_read_attempts = 10 + var header = self.read_ahead(6) + if header == nil + header = bytes("0000") + end + + # Search for beginning of message (which is always a522 or a512) and read header information: + # e.g., [a5, 12, 00, message_size, 00, checksum] + # a512 headers indicate replies on messages that originate from the esp + # a522 headers indicate requests that originate from the MCU (which requires us to the a a512 reply) + while header[0] != 0xa5 || (header[1] != 0x12 && header[1] != 0x22) + if header != bytes("0000") + self.consume(1) + else + max_read_attempts -= 1 + if max_read_attempts <= 0 + if !allow_no_msg + info_c2s("Too many read attempts (couldn't read message header)") + self.error_count += 1 + end + return bytes() + end + tasmota.delay(25) + end + header = self.read_ahead(6) + if header == nil + header = bytes("0000") + end + end + + # consume header bytes + if header == bytes("0000") + info_c2s("Too many read attempts (couldn't read message header)") + self.error_count += 1 + return bytes() + else + self.consume(6) + end + + log_c2s(f"Got Header {header.tohex()}") + + # read payload of given size + var payload = self.consume(header[3]) + while payload == nil + max_read_attempts -= 1 + if max_read_attempts <= 0 + if !allow_no_msg + self.error_count += 1 + info_c2s("Too many read attempts (couldn't read message payload)") + end + return bytes() + end + payload = self.consume(header[3]) + end + + var msg = header + payload + info_c2s("Full Message " + msg.tohex()) + + # if we receive a reply, decrease a expected reply counter + if header[1] == 0x12 + self.expected_replies -= 1 + end + + # Verify that checksum is correct + var checksum = self.calc_checksum(msg) + if checksum != msg[5] + info_c2s("Invalid Checksum") + return bytes() + end + + return msg + + end + + # method to check amount of errors + # such errors are not expected, this is just make the implementation more robust + def check_errors() + return self.error_count > 10 || self.expected_replies > 10 + end + + # reset internal counters (should be used in case the whole connection has been re-initiliazed due to too many errors) + def reset_counters() + self.error_count = 0 + self.expected_replies = 0 + self.msg_count = 0 + end +end + +ser = Core200SSerial(16, 17) + +# Class that implements the interaction protocol with the MCU (to set state of specific features) +class Core200S + var wifi_on + var second_counter + var fan_mode + var sl_mode + var fan_speed_mode + var dp_mode + var dp_auto_off_mode + var cl_mode + var nl_mode + var timer_remaining + var timer_total + var init_counter + + def init() + self.wifi_on = nil + self.second_counter = 0 + self.timer_remaining = 0 + self.timer_total = 0 + self.reinit_connection() + end + + def reinit_connection() + ser.reset_counters() + ser.flush() + self.init_counter = 7 + self.init_cmds() + end + + # Connection initalization commands + def init_cmds() + if self.init_counter == 7 + ser.send(bytes("a522010500aa01e2a50000")) + elif self.init_counter == 6 + ser.read_msg(false) + elif self.init_counter == 5 + ser.send_nowait(bytes("a512000400a301604000")) + elif self.init_counter == 4 + ser.send(bytes("a5220204009001614000")) + elif self.init_counter == 3 + self.set_wifi_led(tasmota.wifi("up")) + elif self.init_counter == 2 + self.query_state() + elif self.init_counter == 1 + self.query_timer() + end + + if self.init_counter > 0 + self.init_counter -= 1 + end + end + + # Enable / Disable wifi led + def set_wifi_led(on) + if self.init_counter > 3 + return + end + if self.wifi_on != on + var msg + if on + msg = bytes("a522050a00630129a100017d007d0000") + else + msg = bytes("a522030a00760129a10000f401f40100") + end + ser.send_nowait(msg) + self.wifi_on = on + end + end + + # Query current state. The reply will contain the current state of all features except for the timers. + def query_state() + if self.init_counter <= 2 + ser.send_nowait(bytes("a5220604008c01614000")) + end + end + + # Query current state of timers. The reply will only contain the current state of the timers + def query_timer() + if self.init_counter <= 1 + ser.send_nowait(bytes("a522070400250165a200")) + end + end + + # Set fan speed mode to given mode + def set_fan_speed(mode) + if self.init_counter != 0 + return + end + var msg = bytes("a522070700250160a2000001") + msg.add(mode.toint(), 1) + return ser.send(msg) != bytes() + end + + # Toggle fan speed mode as the button on the air purifier would do (low -> med -> full -> low -> ...) + def toggle_fan_speed() + if self.fan_speed_mode == FanSpeedMode.LOW + return self.set_fan_speed(FanSpeedMode.MED) + elif self.fan_speed_mode == FanSpeedMode.MED + return self.set_fan_speed(FanSpeedMode.FULL) + else + # default case for nil value + return self.set_fan_speed(FanSpeedMode.LOW) + end + end + + # Set fan mode to given mode (on or off) + def set_fan_mode(mode) + if self.init_counter != 0 + return + end + var msg = bytes("a5220705008a0100a000") + msg.add(mode.toint(), 1) + return ser.send(msg) != bytes() + end + + # Toggle fan mode between off and on + def toggle_fan_mode() + if self.fan_mode == FanMode.ON + return self.set_fan_mode(FanMode.OFF) + else + return self.set_fan_mode(FanMode.ON) + end + end + + # Set night light to given mode + def set_night_light_mode(mode) + if self.init_counter != 0 + return + end + var msg = bytes("a522090600210103a00000") + msg.add(mode.toint(), 1) + return ser.send(msg) != bytes() + end + + # Toggle night light mode as the button on the air purifier would do (off -> full -> med -> off -> ...) + def toggle_night_light() + if self.nl_mode == NightLightMode.FULL + return self.set_night_light_mode(NightLightMode.LOW) + elif self.nl_mode == NightLightMode.LOW + return self.set_night_light_mode(NightLightMode.OFF) + else + return self.set_night_light_mode(NightLightMode.FULL) + end + end + + # Set child lock mode to given mode + def set_child_lock_mode(mode) + if self.init_counter != 0 + return + end + var msg = bytes("a5220705005a0100d100") + msg.add(mode.toint(), 1) + return ser.send(msg) != bytes() + end + + # Toggle chiled lock mode between off and on + def toggle_child_lock() + if self.cl_mode == ChildLockMode.ON + return self.set_child_lock_mode(ChildLockMode.OFF) + else + return self.set_child_lock_mode(ChildLockMode.ON) + end + end + + # Set sleep mode to given value + # Not if fan shall exit sleep mode the current fan speed mode needs to be re-set + def set_sleep_mode(mode) + if self.init_counter != 0 + return + end + if mode == SleepMode.ON + var msg = bytes("a522070500a501e0a50001") + return ser.send(msg) != bytes() + else + return self.set_fan_speed(self.fan_speed_mode) + end + end + + # Toggle sleep mode between off an on + def toggle_sleep_mode() + if self.sl_mode == SleepMode.ON + return self.set_sleep_mode(SleepMode.OFF) + else + return self.set_sleep_mode(SleepMode.ON) + end + end + + # Set display auto off mode to given mode + def set_display_auto_off_mode(mode) + if self.init_counter != 0 + return + end + var msg = bytes("a522070500210105a100") + if mode == DisplayAutoOffMode.ON + msg.add(0x00, 1) + else + msg.add(0x64, 1) + end + return ser.send(msg) != bytes() + end + + # Toggle display auto off mode between off an on + def toggle_display_auto_off() + if self.dp_auto_off_mode == DisplayAutoOffMode.ON + return self.set_display_auto_off_mode(DisplayAutoOffMode.OFF) + else + return self.set_display_auto_off_mode(DisplayAutoOffMode.ON) + end + end + + # Set timer (to auto turn off the air purifier) to given amount of seconds. + # Note: + # * Passing 0 will clear the current timer. + # * Maximum amount of seconds that is supported is 24*60*60 -1 + def set_timer(seconds) + if self.init_counter != 0 + return false + end + # check it timer if set and don't try to clean timer if not set + # (The stock firmware also checks if timer is set before it cleans it) + if seconds == 0 && self.timer_total == 0 + return true + end + var msg = bytes("a522080800210164a20000000000") + msg.set(10, seconds, 3) + return ser.send(msg) != bytes() + end + + # Parse a status message (for instance requested by query_status()) and set internal states accordingly + # Please note, on hardware button press on the air purifier the MCU will send a status messages by itself. + def parse_status_message(msg) + var filter_reset_msg = bytes("a522070400250165a200") + + if msg.size() == 22 # Generic status messsage + self.fan_mode = FanMode(msg[13]) + log_c2s(f"FanMode: {self.fan_mode.tostring()}") + self.sl_mode = SleepMode(msg[14]) + log_c2s(f"SleepMode: {self.sl_mode.tostring()}") + self.fan_speed_mode = FanSpeedMode(msg[15]) + log_c2s(f"FanSpeedMode: {self.fan_speed_mode.tostring()}") + self.dp_mode = DisplayMode(msg[16]) + log_c2s(f"DisplayMode: {self.dp_mode.tostring()}") + self.dp_auto_off_mode = DisplayAutoOffMode(msg[17]) + log_c2s(f"DisplayAutoOffMode: {self.dp_auto_off_mode.tostring()}") + self.cl_mode = ChildLockMode(msg[20]) + log_c2s(f"ChildLockMode: {self.cl_mode.tostring()}") + self.nl_mode = NightLightMode(msg[21]) + log_c2s(f"NightLightMode: {self.nl_mode.tostring()}") + + # When timer is set it sends a status message (but not a message that actually contains the timer values) + # Thus on each status update we should query if a timer has been set + if msg[1] == 0x22 + tasmota.delay(50) + self.query_timer() + end + elif filter_reset_msg == msg + # Filter reset is not implemented yet because the state of the filter is actually maintained on the esp not the MCU + info_c2s("Detected Filter Reset. Not Implemented...") + elif msg.size() == 18 # Timer statung message + self.timer_remaining = msg.get(10, 3) + self.timer_total = msg.get(14, 3) + log_c2s(f"TimerRemaining: {self.timer_remaining}") + log_c2s(f"TimerTotal: {self.timer_total}") + end + end + + def every_250ms() + # perform init commands if needed + self.init_cmds() + + var msg = ser.read_msg(true) + + while msg != bytes() + info_c2s(f"Incoming Message {msg.tohex()}") + + if msg[0] == 0xa5 + if msg[1] == 0x22 + # on received request (from the MCU) we need to send a generic reply + ser.send_nowait(bytes("a512000400a301604000")) + self.parse_status_message(msg) + elif msg[1] == 0x12 + self.parse_status_message(msg) + else + log_c2s("Unrecognized message type") + end + end + msg = ser.read_msg(true) + end + end + + def every_second() + self.second_counter += 1 + if self.second_counter == 60 + self.second_counter = 0 + self.set_wifi_led(tasmota.wifi("up")) + self.query_timer() + elif self.second_counter % 5 == 0 + if self.timer_total != 0 + self.query_timer() + end + end + + if ser.check_errors() + self.reinit_connection() + end + end + + def json_append() + tasmota.response_append(",\"C200S\":{") + + tasmota.response_append(f"\"FanSpeedMode\":\"{self.fan_speed_mode}\"") + tasmota.response_append(f",\"FanMode\":\"{self.fan_mode}\"") + tasmota.response_append(f",\"NightLightMode\":\"{self.nl_mode}\"") + tasmota.response_append(f",\"ChildLockMode\":\"{self.cl_mode}\"") + tasmota.response_append(f",\"SleepMode\":\"{self.sl_mode}\"") + tasmota.response_append(f",\"DisplayMode\":\"{self.dp_mode}\"") + tasmota.response_append(f",\"DisplayAutoOff\":\"{self.dp_auto_off_mode}\"") + tasmota.response_append(f",\"TimerTotal\":{self.timer_total}") + tasmota.response_append(f",\"TimerRemaining\":{self.timer_remaining}") + + tasmota.response_append("}") + end + + # Concert seconds to HH:MM:SS timer format + static def secondsToReadableTime(seconds) + var hours = seconds / 3600 + seconds -= hours * 3600 + var minutes = seconds / 60 + seconds -= minutes * 60 + return format("%02d:%02d:%02d", hours, minutes, seconds) + end + + def web_sensor() + var msg = format( + "{s}Fan Mode{m}%s{e}".. + "{s}Fan Speed{m}%s{e}".. + "{s}Night Light{m}%s{e}".. + "{s}Child Lock{m}%s{e}".. + "{s}Sleep Mode{m}%s{e}".. + "{s}Display Mode{m}%s{e}".. + "{s}Display Auto Off{m}%s{e}", + self.fan_mode, self.fan_speed_mode, self.nl_mode, self.cl_mode, + self.sl_mode, self.dp_mode, self.dp_auto_off_mode + ) + tasmota.web_send_decimal(msg) + + if self.timer_total != 0 + var timer_msg = format( + "{s}Timer Remaining{m}%s{e}".. + "{s}Timer Total{m}%s{e}", + self.secondsToReadableTime(self.timer_remaining), self.secondsToReadableTime(self.timer_total) + ) + tasmota.web_send_decimal(timer_msg) + else + tasmota.web_send_decimal("{s}Timer{m}not active{e}") + end + end + + def web_add_main_button() + var button_config = "