Merge branch 'feature/idf4.0_compat' into 'master'

IDF 4.0 compatibility mode

See merge request app-frameworks/esp-rainmaker!154

Author: shahpiyushv

README.md

@@ -18,6 +18,10 @@ The key features of ESP RainMaker are:
 2. Zero configuration required on the Cloud.
 3. Phone apps that dynamically render the UI as per the device information.
 
+## Supported ESP-IDF versions
+
+ESP RainMaker can work with ESP IDF 4.0 and above.
+
 ## Phone Apps
 
 ### Android

components/esp_rainmaker/src/mqtt/esp_rmaker_mqtt.c

@@ -19,9 +19,24 @@
 #include <freertos/event_groups.h>
 #include <esp_log.h>
 #include <mqtt_client.h>
-
 #include <esp_rmaker_mqtt.h>
 
+#include <esp_idf_version.h>
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 1, 0)
+// Features supported in 4.1
+
+#ifdef CONFIG_ESP_RMAKER_MQTT_PORT_443
+#define ESP_RMAKER_MQTT_USE_PORT_443
+#endif
+
+#else
+
+#ifdef CONFIG_ESP_RMAKER_MQTT_PORT_443
+#warning "Port 443 not supported in idf versions below 4.1. Using 8883 instead."
+#endif
+
+#endif /* !IDF4.1 */
+
 static const char *TAG = "esp_rmaker_mqtt";
 
 #define MAX_MQTT_SUBSCRIPTIONS      5
@@ -212,9 +227,9 @@ esp_err_t esp_rmaker_mqtt_disconnect(void)
     }
     return err;
 }
-#ifdef CONFIG_ESP_RMAKER_MQTT_PORT_443
+#ifdef ESP_RMAKER_MQTT_USE_PORT_443
 static const char *alpn_protocols[] = { "x-amzn-mqtt-ca", NULL };
-#endif /* CONFIG_ESP_RMAKER_MQTT_PORT_443 */
+#endif /* ESP_RMAKER_MQTT_USE_PORT_443 */
 esp_err_t esp_rmaker_mqtt_init(esp_rmaker_mqtt_config_t *config)
 {
     if (mqtt_data) {
@@ -229,13 +244,12 @@ esp_err_t esp_rmaker_mqtt_init(esp_rmaker_mqtt_config_t *config)
     mqtt_data->config = config;
     const esp_mqtt_client_config_t mqtt_client_cfg = {
         .host = config->mqtt_host,
-#ifdef CONFIG_ESP_RMAKER_MQTT_PORT_443
+#ifdef ESP_RMAKER_MQTT_USE_PORT_443
         .port = 443,
         .alpn_protos = alpn_protocols,
-#endif /* CONFIG_ESP_RMAKER_MQTT_PORT_443 */
-#ifdef CONFIG_ESP_RMAKER_MQTT_PORT_8883
+#else
         .port = 8883,
-#endif /* CONFIG_ESP_RMAKER_MQTT_PORT_8883 */
+#endif /* !ESP_RMAKER_MQTT_USE_PORT_443 */
         .cert_pem = (const char *)config->server_cert,
         .client_cert_pem = (const char *)config->client_cert,
         .client_key_pem = (const char *)config->client_key,

components/led_strip/CMakeLists.txt

@@ -0,0 +1,9 @@
+if(CONFIG_WS2812_LED_ENABLE)
+    set(srcs "ws2812_led.c" "led_strip_rmt_ws2812.c")
+else()
+    set(srcs "ws2812_led.c")
+endif()
+
+idf_component_register(SRCS ${srcs}
+                    INCLUDE_DIRS "."
+                    PRIV_REQUIRES "driver")

components/led_strip/component.mk

@@ -0,0 +1,18 @@
+menu "WS2812 RGB LED"
+    visible if IDF_TARGET_ESP32S2
+
+    config WS2812_LED_ENABLE
+        bool "Enable RGB LED"
+        depends on IDF_TARGET_ESP32S2
+        default y 
+        help
+            Disable the WS2812 RGB LED.
+
+    config WS2812_LED_GPIO
+        int "WS2812 LED GPIO"
+        default 18
+        depends on WS2812_LED_ENABLE
+        help
+            Set the WS2812 RGB LED GPIO.
+
+endmenu

components/ws2812_led/CMakeLists.txt

@@ -0,0 +1,5 @@
+COMPONENT_ADD_INCLUDEDIRS := .
+COMPONENT_SRCDIRS := .
+ifndef CONFIG_WS2812_LED_ENABLE
+    COMPONENT_OBJEXCLUDE += led_strip_rmt_ws2812.c
+endif

components/ws2812_led/Kconfig

@@ -0,0 +1,159 @@
+/*  WS2812 RGB LED helper functions
+
+   This example code is in the Public Domain (or CC0 licensed, at your option.)
+
+   Unless required by applicable law or agreed to in writing, this
+   software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+   CONDITIONS OF ANY KIND, either express or implied.
+*/
+
+/* It is recommended to copy this code in your example so that you can modify as
+ * per your application's needs.
+ */
+
+
+#include <stdint.h>
+#include <esp_err.h>
+#include <esp_log.h>
+
+static const char *TAG = "ws2812_led";
+
+#ifdef CONFIG_WS2812_LED_ENABLE
+#include <driver/rmt.h>
+#include "led_strip.h"
+#define RMT_TX_CHANNEL RMT_CHANNEL_0
+
+static led_strip_t *g_strip;
+
+/**
+ * @brief Simple helper function, converting HSV color space to RGB color space
+ *
+ * Wiki: https://en.wikipedia.org/wiki/HSL_and_HSV
+ *
+ */
+static void ws2812_led_hsv2rgb(uint32_t h, uint32_t s, uint32_t v, uint32_t *r, uint32_t *g, uint32_t *b)
+{
+    h %= 360; // h -> [0,360]
+    uint32_t rgb_max = v * 2.55f;
+    uint32_t rgb_min = rgb_max * (100 - s) / 100.0f;
+
+    uint32_t i = h / 60;
+    uint32_t diff = h % 60;
+
+    // RGB adjustment amount by hue
+    uint32_t rgb_adj = (rgb_max - rgb_min) * diff / 60;
+
+    switch (i) {
+    case 0:
+        *r = rgb_max;
+        *g = rgb_min + rgb_adj;
+        *b = rgb_min;
+        break;
+    case 1:
+        *r = rgb_max - rgb_adj;
+        *g = rgb_max;
+        *b = rgb_min;
+        break;
+    case 2:
+        *r = rgb_min;
+        *g = rgb_max;
+        *b = rgb_min + rgb_adj;
+        break;
+    case 3:
+        *r = rgb_min;
+        *g = rgb_max - rgb_adj;
+        *b = rgb_max;
+        break;
+    case 4:
+        *r = rgb_min + rgb_adj;
+        *g = rgb_min;
+        *b = rgb_max;
+        break;
+    default:
+        *r = rgb_max;
+        *g = rgb_min;
+        *b = rgb_max - rgb_adj;
+        break;
+    }
+}
+
+esp_err_t ws2812_led_set_rgb(uint32_t red, uint32_t green, uint32_t blue)
+{
+    if (!g_strip) {
+        return ESP_ERR_INVALID_STATE;
+    }
+    g_strip->set_pixel(g_strip, 0, red, green, blue);
+    g_strip->refresh(g_strip, 100);
+    return ESP_OK;
+}
+
+esp_err_t ws2812_led_set_hsv(uint32_t hue, uint32_t saturation, uint32_t value)
+{
+    if (!g_strip) {
+        return ESP_ERR_INVALID_STATE;
+    }
+    uint32_t red = 0;
+    uint32_t green = 0;
+    uint32_t blue = 0;
+    ws2812_led_hsv2rgb(hue, saturation, value, &red, &green, &blue);
+    return ws2812_led_set_rgb(red, green, blue);
+}
+
+esp_err_t ws2812_led_clear(void)
+{
+    if (!g_strip) {
+        return ESP_ERR_INVALID_STATE;
+    }
+    g_strip->clear(g_strip, 100);
+    return ESP_OK;
+}
+
+esp_err_t ws2812_led_init(void)
+{
+    rmt_config_t config = RMT_DEFAULT_CONFIG_TX(CONFIG_WS2812_LED_GPIO, RMT_TX_CHANNEL);
+    // set counter clock to 40MHz
+    config.clk_div = 2;
+
+    if (rmt_config(&config) != ESP_OK) {
+        ESP_LOGE(TAG, "RMT Config failed.");
+        return ESP_FAIL;
+    }
+    if (rmt_driver_install(config.channel, 0, 0) != ESP_OK) {
+        ESP_LOGE(TAG, "RMT Driver install failed.");
+        return ESP_FAIL;
+    }
+
+    // install ws2812 driver
+    led_strip_config_t strip_config = LED_STRIP_DEFAULT_CONFIG(1, (led_strip_dev_t)config.channel);
+    g_strip = led_strip_new_rmt_ws2812(&strip_config);
+    if (!g_strip) {
+        ESP_LOGE(TAG, "Install WS2812 driver failed.");
+        return ESP_FAIL;
+    }
+    return ESP_OK;
+}
+#else /* !CONFIG_WS2812_LED_ENABLE */
+esp_err_t ws2812_led_set_rgb(uint32_t red, uint32_t green, uint32_t blue)
+{
+    /* Empty function, since WS2812 RGB LED has been disabled.  */
+    return ESP_OK;
+}
+
+esp_err_t ws2812_led_set_hsv(uint32_t hue, uint32_t saturation, uint32_t value)
+{
+    /* Empty function, since WS2812 RGB LED has been disabled.  */
+    return ESP_OK;
+}
+
+esp_err_t ws2812_led_clear(void)
+{
+    /* Empty function, since WS2812 RGB LED has been disabled.  */
+    return ESP_OK;
+}
+
+esp_err_t ws2812_led_init(void)
+{
+    ESP_LOGW(TAG, "WS2812 LED is disabled");
+    return ESP_OK;
+}
+#endif /* !CONFIG_WS2812_LED_ENABLE */

components/ws2812_led/component.mk

@@ -0,0 +1,44 @@
+/*
+   This example code is in the Public Domain (or CC0 licensed, at your option.)
+
+   Unless required by applicable law or agreed to in writing, this
+   software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+   CONDITIONS OF ANY KIND, either express or implied.
+*/
+#pragma once
+#include <esp_err.h>
+
+/** Initialize the WS2812 RGB LED
+ *
+ * @return ESP_OK on success.
+ * @return error in case of failure.
+ */
+esp_err_t ws2812_led_init(void);
+
+/** Set RGB value for the WS2812 LED
+ *
+ * @param[in] red Intensity of Red color (0-100)
+ * @param[in] green Intensity of Green color (0-100)
+ * @param[in] blue Intensity of Green color (0-100)
+ *
+ * @return ESP_OK on success.
+ * @return error in case of failure.
+ */
+esp_err_t ws2812_led_set_rgb(uint32_t red, uint32_t green, uint32_t blue);
+
+/** Set HSV value for the WS2812 LED
+ *
+ * @param[in] hue Value of hue in arc degrees (0-360)
+ * @param[in] saturation Saturation in percentage (0-100)
+ * @param[in] value Value (also called Intensity) in percentage (0-100)
+ *
+ * @return ESP_OK on success.
+ * @return error in case of failure.
+ */
+esp_err_t ws2812_led_set_hsv(uint32_t hue, uint32_t saturation, uint32_t value);
+
+/** Clear (turn off) the WS2812 LED
+ * @return ESP_OK on success.
+ * @return error in case of failure.
+ */
+esp_err_t ws2812_led_clear(void);

components/led_strip/include/led_strip.h renamed to components/ws2812_led/led_strip.h

@@ -12,6 +12,18 @@
 #include <esp_wifi.h>
 #include <esp_event.h>
 #include <esp_log.h>
+#include <esp_idf_version.h>
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 1, 0)
+// Features supported in 4.1+
+#define ESP_NETIF_SUPPORTED
+#endif
+
+#ifdef ESP_NETIF_SUPPORTED
+#include <esp_netif.h>
+#else
+#include <tcpip_adapter.h>
+#endif
+
 #include <wifi_provisioning/manager.h>
 #ifdef CONFIG_APP_WIFI_PROV_TRANSPORT_BLE
 #include <wifi_provisioning/scheme_ble.h>
@@ -181,7 +193,11 @@ static esp_err_t get_device_pop(char *pop, size_t max, app_wifi_pop_type_t pop_t
 void app_wifi_init(void)
 {
     /* Initialize TCP/IP */
+#ifdef ESP_NETIF_SUPPORTED
     esp_netif_init();
+#else
+    tcpip_adapter_init();
+#endif
 
     /* Initialize the event loop */
     ESP_ERROR_CHECK(esp_event_loop_create_default());
@@ -193,7 +209,9 @@ void app_wifi_init(void)
     ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_STA_GOT_IP, &event_handler, NULL));
 
     /* Initialize Wi-Fi including netif with default config */
+#ifdef ESP_NETIF_SUPPORTED
     esp_netif_create_default_wifi_sta();
+#endif
     wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
     ESP_ERROR_CHECK(esp_wifi_init(&cfg));
 }
@@ -236,7 +254,9 @@ esp_err_t app_wifi_start(app_wifi_pop_type_t pop_type)
     /* If device is not yet provisioned start provisioning service */
     if (!provisioned) {
         ESP_LOGI(TAG, "Starting provisioning");
+#ifdef ESP_NETIF_SUPPORTED
         esp_netif_create_default_wifi_ap();
+#endif
 
         /* What is the Device Service Name that we want
          * This translates to :

components/led_strip/src/led_strip_rmt_ws2812.c renamed to components/ws2812_led/led_strip_rmt_ws2812.c

@@ -19,7 +19,7 @@ I (16073) app_main: Received value = true for Fan - power
 
 ### LED not working?
 
-The ESP32-S2-Saola-1 board has the RGB LED connected to GPIO 18. However, a few earlier boards may have it on GPIO 17. Please use `CONFIG_APP_LED_GPIO` to set the appropriate value.
+The ESP32-S2-Saola-1 board has the RGB LED connected to GPIO 18. However, a few earlier boards may have it on GPIO 17. Please use `CONFIG_WS2812_LED_GPIO` to set the appropriate value.
 
 ### Reset to Factory