/* xdrv_28_pcf8574.ino - PCF8574 I2C support for Tasmota Copyright (C) 2021 Stefan Bode 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 the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . */ #ifdef USE_I2C #ifdef USE_PCF8574 /*********************************************************************************************\ * PCF8574 - I2C IO Expander * * I2C Address: PCF8574 = 0x20 .. 0x27 (0x27 is not supported), * PCF8574A = 0x39 .. 0x3F (0x38 is not supported) \*********************************************************************************************/ #define XDRV_28 28 #define XI2C_02 2 // See I2CDEVICES.md #define PCF8574_ADDR1 0x20 // PCF8574 #define PCF8574_ADDR2 0x38 // PCF8574A struct PCF8574 { int error; uint8_t pin[64]; uint8_t address[MAX_PCF8574]; uint8_t pin_mask[MAX_PCF8574] = { 0 }; #ifdef USE_PCF8574_MQTTINPUT uint8_t last_input[MAX_PCF8574] = { 0 }; #endif uint8_t max_connected_ports = 0; // Max numbers of devices comming from PCF8574 modules uint8_t max_devices = 0; // Max numbers of PCF8574 modules char stype[9]; bool type = false; } Pcf8574; uint8_t Pcf8574Read(uint8_t idx) { Wire.requestFrom(Pcf8574.address[idx],(uint8_t)1); return Wire.read(); } uint8_t Pcf8574Write(uint8_t idx) { Wire.beginTransmission(Pcf8574.address[idx]); Wire.write(Pcf8574.pin_mask[idx]); return Wire.endTransmission(); } void Pcf8574SwitchRelay(void) { for (uint32_t i = 0; i < TasmotaGlobal.devices_present; i++) { uint8_t relay_state = bitRead(XdrvMailbox.index, i); if (Pcf8574.max_devices > 0 && Pcf8574.pin[i] < 99) { uint8_t board = Pcf8574.pin[i]>>3; uint8_t pin = Pcf8574.pin[i]&0x7; uint8_t oldpinmask = Pcf8574.pin_mask[board]; uint8_t _val = bitRead(TasmotaGlobal.rel_inverted, i) ? !relay_state : relay_state; //AddLog(LOG_LEVEL_DEBUG, PSTR("PCF: SwitchRelay %d=%d => PCF-%d.D%d=%d"), i, relay_state, board +1, pin, _val); bitWrite(Pcf8574.pin_mask[board], pin, _val); if (oldpinmask != Pcf8574.pin_mask[board]) { Pcf8574.error = Pcf8574Write(board); } //else AddLog(LOG_LEVEL_DEBUG, PSTR("PCF: SwitchRelay skipped")); } } } void Pcf8574Init(void) { uint8_t pcf8574_address = PCF8574_ADDR1; while ((Pcf8574.max_devices < MAX_PCF8574) && (pcf8574_address < PCF8574_ADDR2 +8)) { #ifdef USE_MCP230xx_ADDR if (USE_MCP230xx_ADDR == pcf8574_address) { AddLog(LOG_LEVEL_INFO, PSTR("PCF: Address 0x%02x reserved for MCP320xx skipped"), pcf8574_address); pcf8574_address++; if ((PCF8574_ADDR1 +7) == pcf8574_address) { // Support I2C addresses 0x20 to 0x26 and 0x39 to 0x3F pcf8574_address = PCF8574_ADDR2 +1; } } #endif // AddLog(LOG_LEVEL_DEBUG, PSTR("PCF: Probing addr: 0x%x for PCF8574"), pcf8574_address); if (I2cSetDevice(pcf8574_address)) { Pcf8574.type = true; Pcf8574.address[Pcf8574.max_devices] = pcf8574_address; Pcf8574.max_devices++; strcpy(Pcf8574.stype, "PCF8574"); if (pcf8574_address >= PCF8574_ADDR2) { strcpy(Pcf8574.stype, "PCF8574A"); } I2cSetActiveFound(pcf8574_address, Pcf8574.stype); } pcf8574_address++; if ((PCF8574_ADDR1 +7) == pcf8574_address) { // Support I2C addresses 0x20 to 0x26 and 0x39 to 0x3F pcf8574_address = PCF8574_ADDR2 +1; } } if (Pcf8574.type) { for (uint32_t i = 0; i < sizeof(Pcf8574.pin); i++) { Pcf8574.pin[i] = 99; } TasmotaGlobal.devices_present = TasmotaGlobal.devices_present - Pcf8574.max_connected_ports; // reset no of devices to avoid duplicate ports on duplicate init. Pcf8574.max_connected_ports = 0; // reset no of devices to avoid duplicate ports on duplicate init. for (uint32_t idx = 0; idx < Pcf8574.max_devices; idx++) { // suport up to 8 boards PCF8574 uint8_t gpio = Pcf8574Read(idx); Pcf8574.pin_mask[idx] = gpio; #ifdef USE_PCF8574_MQTTINPUT Pcf8574.last_input[idx] = gpio & ~Settings.pcf8574_config[idx]; #endif // #ifdef USE_PCF8574_MQTTINPUT //AddLog(LOG_LEVEL_DEBUG, PSTR("PCF: PCF-%d config=0x%02x, gpio=0x%02X"), idx +1, Settings.pcf8574_config[idx], gpio); for (uint32_t i = 0; i < 8; i++, gpio>>=1) { uint8_t _result = Settings.pcf8574_config[idx] >> i &1; //AddLog(LOG_LEVEL_DEBUG, PSTR("PCF: I2C shift i %d: %d. Powerstate: %d, TasmotaGlobal.devices_present: %d"), i,_result, Settings.power>>i&1, TasmotaGlobal.devices_present); if (_result > 0) { Pcf8574.pin[TasmotaGlobal.devices_present] = i + 8 * idx; bitWrite(TasmotaGlobal.rel_inverted, TasmotaGlobal.devices_present, Settings.flag3.pcf8574_ports_inverted); // SetOption81 - Invert all ports on PCF8574 devices if (!Settings.flag.save_state && !Settings.flag3.no_power_feedback) { // SetOption63 - Don't scan relay power state at restart - #5594 and #5663 //AddLog(LOG_LEVEL_DEBUG, PSTR("PCF: Set power from from chip state")); uint8_t power_state = Settings.flag3.pcf8574_ports_inverted ? 1 & ~gpio : 1 & gpio; bitWrite(TasmotaGlobal.power, TasmotaGlobal.devices_present, power_state); bitWrite(Settings.power, TasmotaGlobal.devices_present, power_state); } //else AddLog(LOG_LEVEL_DEBUG, PSTR("PCF: DON'T set power from chip state")); TasmotaGlobal.devices_present++; Pcf8574.max_connected_ports++; } } } //AddLog(LOG_LEVEL_DEBUG, PSTR("PCF: Settings.power=0x%08X, TasmotaGlobal.power=0x%08X"), Settings.power, TasmotaGlobal.power); AddLog(LOG_LEVEL_INFO, PSTR("PCF: Total devices %d, PCF8574 output ports %d"), Pcf8574.max_devices, Pcf8574.max_connected_ports); } } /*********************************************************************************************\ * Presentation \*********************************************************************************************/ #ifdef USE_WEBSERVER #define WEB_HANDLE_PCF8574 "pcf" const char HTTP_BTN_MENU_PCF8574[] PROGMEM = "

"; const char HTTP_FORM_I2C_PCF8574_1[] PROGMEM = "
 " D_PCF8574_PARAMETERS " " "
" "


"; const char HTTP_FORM_I2C_PCF8574_2[] PROGMEM = "" D_DEVICE " %d " D_PORT " %d"; const char HTTP_SNS_PCF8574_GPIO[] PROGMEM = "{s}PCF8574%c%d D%d{m}%d{e}"; // {s} = , {m} = , {e} = void HandlePcf8574(void) { if (!HttpCheckPriviledgedAccess()) { return; } AddLog(LOG_LEVEL_DEBUG, PSTR(D_LOG_HTTP D_CONFIGURE_PCF8574)); if (Webserver->hasArg("save")) { Pcf8574SaveSettings(); WebRestart(1); return; } WSContentStart_P(D_CONFIGURE_PCF8574); WSContentSendStyle(); WSContentSend_P(HTTP_FORM_I2C_PCF8574_1, (Settings.flag3.pcf8574_ports_inverted) ? PSTR(" checked") : ""); // SetOption81 - Invert all ports on PCF8574 devices WSContentSend_P(HTTP_TABLE100); for (uint32_t idx = 0; idx < Pcf8574.max_devices; idx++) { for (uint32_t idx2 = 0; idx2 < 8; idx2++) { // 8 ports on PCF8574 uint8_t helper = 1 << idx2; WSContentSend_P(HTTP_FORM_I2C_PCF8574_2, idx +1, idx2, idx2 + 8*idx, idx2 + 8*idx, ((helper & Settings.pcf8574_config[idx]) >> idx2 == 0) ? PSTR(" selected ") : " ", ((helper & Settings.pcf8574_config[idx]) >> idx2 == 1) ? PSTR(" selected ") : " " ); } } WSContentSend_P(PSTR("")); WSContentSend_P(HTTP_FORM_END); WSContentSpaceButton(BUTTON_CONFIGURATION); WSContentStop(); } #if defined(USE_PCF8574_SENSOR) || defined(USE_PCF8574_DISPLAYINPUT) void Pcf8574Show(bool json) { #ifdef USE_PCF8574_SENSOR if (json) { for (int idx = 0 ; idx < Pcf8574.max_devices ; idx++) { uint8_t gpio = Pcf8574Read(idx); ResponseAppend_P(PSTR(",\"PCF8574%c%d\":{\"D0\":%i,\"D1\":%i,\"D2\":%i,\"D3\":%i,\"D4\":%i,\"D5\":%i,\"D6\":%i,\"D7\":%i"), IndexSeparator(), idx +1, (gpio>>0)&1,(gpio>>1)&1,(gpio>>2)&1,(gpio>>3)&1,(gpio>>4)&1,(gpio>>5)&1,(gpio>>6)&1,(gpio>>7)&1); } ResponseJsonEnd(); } #endif // #ifdef USE_PCF8574_SENSOR #if defined(USE_WEBSERVER) && defined(USE_PCF8574_DISPLAYINPUT) if(!json) { for (int idx = 0 ; idx < Pcf8574.max_devices ; idx++) { uint8_t input_mask = ~Settings.pcf8574_config[idx]; //invert to 1 = input uint8_t gpio = Pcf8574Read(idx); for (int pin = 0 ; pin < 8 ; ++pin, input_mask>>=1, gpio>>=1) { if (input_mask & 1) WSContentSend_P(HTTP_SNS_PCF8574_GPIO, IndexSeparator(), idx +1, pin, gpio & 1); } } } #endif // defined(USE_WEBSERVER) && defined(USE_PCF8574_DISPLAYINPUT) } #endif // #if defined(USE_PCF8574_SENSOR) || defined(USE_PCF8574_DISPLAYINPUT) #ifdef USE_PCF8574_MQTTINPUT void Pcf8574CheckForInputChange(void) { for (int idx = 0 ; idx < Pcf8574.max_devices ; idx++) { uint8_t input_mask = ~Settings.pcf8574_config[idx]; //invert to 1 = input uint8_t input = Pcf8574Read(idx) & input_mask; uint8_t last_input = Pcf8574.last_input[idx]; if (input != last_input) { // don't scan bits if no change (EVERY_50_MS !) for (uint8_t pin = 0 ; pin < 8 ; ++pin) { if (bitRead(input_mask,pin) && bitRead(input,pin) != bitRead(last_input,pin)) { ResponseTime_P(PSTR(",\"PCF8574%c%d_INP\":{\"D%i\":%i}}"), IndexSeparator(), idx +1, pin, bitRead(input,pin)); MqttPublishPrefixTopicRulesProcess_P(RESULT_OR_STAT, PSTR("PCF8574_INP")); if (Settings.flag3.hass_tele_on_power) { // SetOption59 - Send tele/%topic%/SENSOR in addition to stat/%topic%/RESULT MqttPublishSensor(); } } Pcf8574.last_input[idx] = input; } } } } #endif //#ifdef USE_PCF8574_MQTTINPUT void Pcf8574SaveSettings(void) { char stemp[7]; char tmp[100]; //AddLog(LOG_LEVEL_DEBUG, PSTR("PCF: Start working on Save arguements: inverted:%d")), Webserver->hasArg("b1"); Settings.flag3.pcf8574_ports_inverted = Webserver->hasArg("b1"); // SetOption81 - Invert all ports on PCF8574 devices for (byte idx = 0; idx < Pcf8574.max_devices; idx++) { byte count=0; byte n = Settings.pcf8574_config[idx]; while(n!=0) { n = n&(n-1); count++; } if (count <= TasmotaGlobal.devices_present) { TasmotaGlobal.devices_present = TasmotaGlobal.devices_present - count; } for (byte i = 0; i < 8; i++) { snprintf_P(stemp, sizeof(stemp), PSTR("i2cs%d"), i+8*idx); WebGetArg(stemp, tmp, sizeof(tmp)); byte _value = (!strlen(tmp)) ? 0 : atoi(tmp); if (_value) { Settings.pcf8574_config[idx] = Settings.pcf8574_config[idx] | 1 << i; TasmotaGlobal.devices_present++; Pcf8574.max_connected_ports++; } else { Settings.pcf8574_config[idx] = Settings.pcf8574_config[idx] & ~(1 << i ); } } //Settings.pcf8574_config[0] = (!strlen(webServer->arg("i2cs0").c_str())) ? 0 : atoi(webServer->arg("i2cs0").c_str()); //AddLog(LOG_LEVEL_INFO, PSTR("PCF: I2C Board: %d, Config: %2x")), idx, Settings.pcf8574_config[idx]; } } #endif // USE_WEBSERVER /*********************************************************************************************\ * Interface \*********************************************************************************************/ bool Xdrv28(uint8_t function) { if (!I2cEnabled(XI2C_02)) { return false; } bool result = false; if (FUNC_PRE_INIT == function) { Pcf8574Init(); } else if (Pcf8574.type) { switch (function) { case FUNC_SET_POWER: Pcf8574SwitchRelay(); break; #ifdef USE_PCF8574_MQTTINPUT case FUNC_EVERY_50_MSECOND: Pcf8574CheckForInputChange(); break; #endif // #ifdef USE_PCF8574_MQTTINPUT #ifdef USE_PCF8574_SENSOR case FUNC_JSON_APPEND: Pcf8574Show(1); break; #endif // #ifdef USE_PCF8574_SENSOR #ifdef USE_WEBSERVER case FUNC_WEB_ADD_BUTTON: WSContentSend_P(HTTP_BTN_MENU_PCF8574); break; case FUNC_WEB_ADD_HANDLER: WebServer_on(PSTR("/" WEB_HANDLE_PCF8574), HandlePcf8574); break; #ifdef USE_PCF8574_DISPLAYINPUT case FUNC_WEB_SENSOR: Pcf8574Show(0); break; #endif // #ifdef USE_PCF8574_DISPLAYINPUT #endif // USE_WEBSERVER } } return result; } #endif // USE_PCF8574 #endif // USE_I2C