Abstract out fan setup

Replaces the hard-coded sonoff fan controller settings with macros which
can be changed in the future to more easily enable support for different
types of fan devices.

Author: mzealey

Diff for: sonoff/sonoff.ino

@@ -91,7 +91,8 @@ const char kTasmotaCommands[] PROGMEM =
 
 const char kSleepMode[] PROGMEM = "Dynamic|Normal";
 
-const uint8_t kIFan02Speed[4][3] = {{6,6,6}, {7,6,6}, {7,7,6}, {7,6,7}};
+#define FAN_STAGES 4
+const uint8_t kIFan02Speed[FAN_STAGES][3] = {{6,6,6}, {7,6,6}, {7,7,6}, {7,6,7}};
 
 // Global variables
 SerialConfig serial_config = SERIAL_8N1;    // Serial interface configuration 8 data bits, No parity, 1 stop bit
@@ -375,7 +376,7 @@ uint8_t GetFanspeed(void)
 {
   uint8_t fanspeed = 0;
 
-//  if (SONOFF_IFAN02 == Settings.module) {
+//  if (IS_FAN_MODULE) {
     /* Fanspeed is controlled by relay 2, 3 and 4 as in Sonoff 4CH.
        000x = 0
        001x = 1
@@ -562,18 +563,18 @@ void MqttDataHandler(char* topic, byte* data, unsigned int data_len)
       fallback_topic_flag = 0;
       return;
     }
-    else if ((CMND_FANSPEED == command_code) && (SONOFF_IFAN02 == Settings.module)) {
+    else if ((CMND_FANSPEED == command_code) && IS_FAN_MODULE) {
       if (data_len > 0) {
         if ('-' == dataBuf[0]) {
           payload = (int16_t)GetFanspeed() -1;
-          if (payload < 0) { payload = 3; }
+          if (payload < 0) { payload = FAN_STAGES - 1; }
         }
         else if ('+' == dataBuf[0]) {
           payload = GetFanspeed() +1;
-          if (payload > 3) { payload = 0; }
+          if (payload > FAN_STAGES - 1) { payload = 0; }
         }
       }
-      if ((payload >= 0) && (payload <= 3) && (payload != GetFanspeed())) {
+      if ((payload >= 0) && (payload < FAN_STAGES) && (payload != GetFanspeed())) {
         SetFanspeed(payload);
       }
       snprintf_P(mqtt_data, sizeof(mqtt_data), S_JSON_COMMAND_NVALUE, command, GetFanspeed());
@@ -1351,7 +1352,7 @@ void ExecuteCommandPower(byte device, byte state, int source)
 
 //  ShowSource(source);
 
-  if (SONOFF_IFAN02 == Settings.module) {
+  if (IS_FAN_MODULE) {
     blink_mask &= 1;                 // No blinking on the fan relays
     Settings.flag.interlock = 0;     // No interlock mode as it is already done by the microcontroller
     Settings.pulse_timer[1] = 0;     // No pulsetimers on the fan relays
@@ -1477,7 +1478,7 @@ void PublishStatus(uint8_t payload)
 
   if ((0 == payload) || (99 == payload)) {
     uint8_t maxfn = (devices_present > MAX_FRIENDLYNAMES) ? MAX_FRIENDLYNAMES : (!devices_present) ? 1 : devices_present;
-    if (SONOFF_IFAN02 == Settings.module) { maxfn = 1; }
+    if (IS_FAN_MODULE) { maxfn = 1; }
     stemp[0] = '\0';
     for (byte i = 0; i < maxfn; i++) {
       snprintf_P(stemp, sizeof(stemp), PSTR("%s%s\"%s\"" ), stemp, (i > 0 ? "," : ""), Settings.friendlyname[i]);
@@ -1604,7 +1605,7 @@ void MqttShowState(void)
       LightState(1);
     } else {
       snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("%s,\"%s\":\"%s\""), mqtt_data, GetPowerDevice(stemp1, i +1, sizeof(stemp1), Settings.flag.device_index_enable), GetStateText(bitRead(power, i)));
-      if (SONOFF_IFAN02 == Settings.module) {
+      if (IS_FAN_MODULE) {
         snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("%s,\"" D_CMND_FANSPEED "\":%d"), mqtt_data, GetFanspeed());
         break;
       }
@@ -1663,7 +1664,7 @@ void PerformEverySecond(void)
     AddLog(LOG_LEVEL_DEBUG);
   }
 
-  if ((4 == uptime) && (SONOFF_IFAN02 == Settings.module)) {  // Microcontroller needs 3 seconds before accepting commands
+  if ((4 == uptime) && IS_FAN_MODULE) {  // Microcontroller needs 3 seconds before accepting commands
     SetDevicePower(1, SRC_RETRY);      // Sync with default power on state microcontroller being Light ON and Fan OFF
     SetDevicePower(power, SRC_RETRY);  // Set required power on state
   }

Diff for: sonoff/sonoff_template.h

@@ -512,6 +512,8 @@ const uint8_t kModuleNiceList[MAXMODULE] PROGMEM = {
   WEMOS
 };
 
+#define IS_FAN_MODULE (Settings.module == SONOFF_IFAN02)
+
 // Default module settings
 const mytmplt kModules[MAXMODULE] PROGMEM = {
   { "Sonoff Basic",    // Sonoff Basic (ESP8266)

Diff for: sonoff/xdrv_01_webserver.ino

@@ -625,10 +625,10 @@ void HandleRoot(void)
       }
       page += FPSTR(HTTP_TABLE100);
       page += F("<tr>");
-      if (SONOFF_IFAN02 == Settings.module) {
+      if (IS_FAN_MODULE) {
         snprintf_P(mqtt_data, sizeof(mqtt_data), HTTP_DEVICE_CONTROL, 36, 1, D_BUTTON_TOGGLE, "");
         page += mqtt_data;
-        for (byte i = 0; i < 4; i++) {
+        for (byte i = 0; i < FAN_STAGES; i++) {
           snprintf_P(stemp, sizeof(stemp), PSTR("%d"), i);
           snprintf_P(mqtt_data, sizeof(mqtt_data), HTTP_DEVICE_CONTROL, 16, i +2, stemp, "");
           page += mqtt_data;
@@ -684,7 +684,7 @@ void HandleAjaxStatusRefresh(void)
   if (strlen(tmp)) {
     ShowWebSource(SRC_WEBGUI);
     uint8_t device = atoi(tmp);
-    if (SONOFF_IFAN02 == Settings.module) {
+    if (IS_FAN_MODULE) {
       if (device < 2) {
         ExecuteCommandPower(1, POWER_TOGGLE, SRC_IGNORE);
       } else {
@@ -724,7 +724,7 @@ void HandleAjaxStatusRefresh(void)
   if (devices_present) {
     snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("%s{t}<tr>"), mqtt_data);
     uint8_t fsize = (devices_present < 5) ? 70 - (devices_present * 8) : 32;
-    if (SONOFF_IFAN02 == Settings.module) {
+    if (IS_FAN_MODULE) {
       snprintf_P(mqtt_data, sizeof(mqtt_data), HTTP_DEVICE_STATE,
         mqtt_data, 36, (bitRead(power, 0)) ? "bold" : "normal", 54, GetStateText(bitRead(power, 0)));
       uint8_t fanspeed = GetFanspeed();
@@ -1119,7 +1119,7 @@ void HandleOtherConfiguration(void)
   page += FPSTR(HTTP_FORM_OTHER);
   page.replace(F("{r1"), (Settings.flag.mqtt_enabled) ? F(" checked") : F(""));
   uint8_t maxfn = (devices_present > MAX_FRIENDLYNAMES) ? MAX_FRIENDLYNAMES : (!devices_present) ? 1 : devices_present;
-  if (SONOFF_IFAN02 == Settings.module) { maxfn = 1; }
+  if (IS_FAN_MODULE) { maxfn = 1; }
   for (byte i = 0; i < maxfn; i++) {
     page += FPSTR(HTTP_FORM_OTHER2);
     page.replace(F("{1"), String(i +1));
@@ -1288,7 +1288,7 @@ void HandleInformation(void)
   func += F("}1" D_BOOT_COUNT "}2"); func += String(Settings.bootcount);
   func += F("}1" D_RESTART_REASON "}2"); func += GetResetReason();
   uint8_t maxfn = (devices_present > MAX_FRIENDLYNAMES) ? MAX_FRIENDLYNAMES : devices_present;
-  if (SONOFF_IFAN02 == Settings.module) { maxfn = 1; }
+  if (IS_FAN_MODULE) { maxfn = 1; }
   for (byte i = 0; i < maxfn; i++) {
     func += F("}1" D_FRIENDLY_NAME " "); func += i +1; func += F("}2"); func += Settings.friendlyname[i];
   }

Diff for: sonoff/xdrv_02_mqtt.ino

@@ -333,8 +333,8 @@ void MqttPublishPowerState(byte device)
 
   if ((device < 1) || (device > devices_present)) { device = 1; }
 
-  if ((SONOFF_IFAN02 == Settings.module) && (device > 1)) {
-    if (GetFanspeed() < 4) {  // 4 occurs when fanspeed is 3 and RC button 2 is pressed
+  if ((IS_FAN_MODULE) && (device > 1)) {
+    if (GetFanspeed() < FAN_STAGES) {  // 4 occurs when fanspeed is 3 and RC button 2 is pressed
       snprintf_P(scommand, sizeof(scommand), PSTR(D_CMND_FANSPEED));
       GetTopic_P(stopic, STAT, mqtt_topic, (Settings.flag.mqtt_response) ? scommand : S_RSLT_RESULT);
       snprintf_P(mqtt_data, sizeof(mqtt_data), S_JSON_COMMAND_NVALUE, scommand, GetFanspeed());
@@ -425,7 +425,7 @@ void MqttConnected(void)
     MqttPublishPrefixTopic_P(TELE, PSTR(D_RSLT_INFO "3"));
     for (byte i = 1; i <= devices_present; i++) {
       MqttPublishPowerState(i);
-      if (SONOFF_IFAN02 == Settings.module) { break; }  // Only report status of light relay
+      if (IS_FAN_MODULE) { break; }  // Only report status of light relay
     }
     if (Settings.tele_period) { tele_period = Settings.tele_period -9; }  // Enable TelePeriod in 9 seconds
     rules_flag.system_boot = 1;