Merge pull request DavidAntliff#3 from DavidAntliff/ESP-IDF_v3.3

Support Esp idf v3.3

Author: DavidAntliff

.travis.yml

@@ -1,18 +1,6 @@
 dist: bionic
-env:
-  global:
-    # Set Python 3.7.1 as the default python
-    - PATH=/opt/python/3.7.1/bin:$PATH
-    - MAKEFLAGS="-j 2"
-
-language: bash
-
-addons:
-  apt:
-    packages:
-      - gperf
-      - python3
-      - python3-pip
+language: python
+python: "3.8"
 
 before_install:
   # Save path to the git respository
@@ -37,12 +25,9 @@ install:
   # Set the path to ESP-IDF directory
   - export IDF_PATH=~/esp/esp-idf
   # Install python dependencies
-  - pip install --user --requirement $IDF_PATH/requirements.txt
+  - pip install --requirement $IDF_PATH/requirements.txt
 
 script:
-  # Go back to the git repository
+  # Build project within the original repository
   - cd $PROJECT_PATH
-  # Update configuration so that kconfig doesn't start interactive mode
-  - make defconfig
-  # Build project from the git repository
-  - make
+  - $IDF_PATH/tools/idf.py build

CMakeLists.txt

@@ -0,0 +1,9 @@
+# The following five lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.5)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(esp32-i2c-lcd1602-example)
+
+# Ignore false clang warnings about `struct foo = { 0 }`
+target_compile_options(${IDF_PROJECT_EXECUTABLE} PRIVATE -Wno-missing-braces -Wmissing-field-initializers)

README.md

@@ -7,7 +7,9 @@
 
 This is an example application for the HD4470-compatible LCD1602 device connected via an I2C backpack.
 
-It is written and tested for v2.1.1 and v3.0 of the [ESP-IDF](https://github.com/espressif/esp-idf) environment, using the xtensa-esp32-elf toolchain (gcc version 5.2.0).
+This application is also usable with an LCD2004 module (20 columns, 4 rows), by uncommenting the `LCD_NUM_ROWS`, `LCD_NUM_COLUMNS`, and `LCD_NUM_VISIBLE_COLUMNS` definitions at the top of `app_main.c`.
+
+It is written and tested for v3.3 of the [ESP-IDF](https://github.com/espressif/esp-idf) environment, using the xtensa-esp32-elf toolchain (gcc version 5.2.0).
 
 Ensure that submodules are cloned:
 
@@ -16,8 +18,9 @@ Ensure that submodules are cloned:
 Build the application with:
 
     $ cd esp32-i2c-lcd1602-example.git
-    $ make menuconfig    # set your serial configuration and the I2C GPIO - see below
-    $ make flash monitor
+    $ idf.py menuconfig    # set your serial configuration and the I2C GPIO - see below
+    $ idf.py build
+    $ idf.py -p (PORT) flash monitor
 
 The program should detect your connected device and display some demonstration text on the LCD.
 
@@ -32,7 +35,9 @@ This application makes use of the following components (included as submodules):
 
 To run this example, connect one LCD1602 device to two GPIOs on the ESP32 (I2C SDA and SCL). If external pull-up resistors are not provided with the sensor, add a 10 KOhm resistor from each GPIO to the 3.3V supply.
 
-`make menuconfig` can be used to set the I2C GPIOs and LCD1602 device I2C address.
+`idf.py menuconfig` can be used to set the I2C GPIOs and LCD1602 device I2C address.
+
+Note that the 3.3V supply may be insufficient to run the display satisfactorily. In this case I suggest using a 5V supply to the LCD display, and using appropriate level shifter circuitry on the I2C SCL and SDA connections.
 
 ## Features
 

components/esp32-i2c-lcd1602

@@ -0,0 +1,5 @@
+set(COMPONENT_SRCDIRS ".")
+set(COMPONENT_ADD_INCLUDEDIRS ".")
+
+register_component()
+

components/esp32-smbus

@@ -42,6 +42,16 @@
 
 #define TAG "app"
 
+// LCD1602
+#define LCD_NUM_ROWS               2
+#define LCD_NUM_COLUMNS            32
+#define LCD_NUM_VISIBLE_COLUMNS    16
+
+// LCD2004
+//#define LCD_NUM_ROWS               4
+//#define LCD_NUM_COLUMNS            40
+//#define LCD_NUM_VISIBLE_COLUMNS    20
+
 // Undefine USE_STDIN if no stdin is available (e.g. no USB UART) - a fixed delay will occur instead of a wait for a keypress.
 #define USE_STDIN  1
 //#undef USE_STDIN
@@ -69,18 +79,20 @@ static void i2c_master_init(void)
                        I2C_MASTER_TX_BUF_LEN, 0);
 }
 
-// WARNING: ESP32 does not support blocking input from stdin yet, so this polls
-// the UART and effectively hangs up the SDK.
+// uart_rx_one_char_block() causes a watchdog trigger, so use the non-blocking
+// uart_rx_one_char() and delay briefly to reset the watchdog.
 static uint8_t _wait_for_user(void)
 {
     uint8_t c = 0;
+
 #ifdef USE_STDIN
     while (!c)
     {
        STATUS s = uart_rx_one_char(&c);
        if (s == OK) {
           printf("%c", c);
        }
+       vTaskDelay(1);
     }
 #else
     vTaskDelay(1000 / portTICK_RATE_MS);
@@ -97,12 +109,15 @@ void lcd1602_task(void * pvParameter)
 
     // Set up the SMBus
     smbus_info_t * smbus_info = smbus_malloc();
-    smbus_init(smbus_info, i2c_num, address);
-    smbus_set_timeout(smbus_info, 1000 / portTICK_RATE_MS);
+    ESP_ERROR_CHECK(smbus_init(smbus_info, i2c_num, address));
+    ESP_ERROR_CHECK(smbus_set_timeout(smbus_info, 1000 / portTICK_RATE_MS));
 
     // Set up the LCD1602 device with backlight off
     i2c_lcd1602_info_t * lcd_info = i2c_lcd1602_malloc();
-    i2c_lcd1602_init(lcd_info, smbus_info, true);
+    ESP_ERROR_CHECK(i2c_lcd1602_init(lcd_info, smbus_info, true,
+                                     LCD_NUM_ROWS, LCD_NUM_COLUMNS, LCD_NUM_VISIBLE_COLUMNS));
+
+    ESP_ERROR_CHECK(i2c_lcd1602_reset(lcd_info));
 
     // turn off backlight
     ESP_LOGI(TAG, "backlight off");
@@ -149,7 +164,7 @@ void lcd1602_task(void * pvParameter)
     _wait_for_user();
     i2c_lcd1602_set_display(lcd_info, false);
 
-    ESP_LOGI(TAG, "display F at 7,1");
+    ESP_LOGI(TAG, "display F at 7,1 (display disabled)");
     _wait_for_user();
     i2c_lcd1602_move_cursor(lcd_info, 7, 1);
     i2c_lcd1602_write_char(lcd_info, 'F');
@@ -166,20 +181,20 @@ void lcd1602_task(void * pvParameter)
     _wait_for_user();
     i2c_lcd1602_set_cursor(lcd_info, false);
 
-    ESP_LOGI(TAG, "display alphabet at 0,0");  // should overflow to second line at "ABC..."
+    ESP_LOGI(TAG, "display alphabet from 0,0");  // should overflow to second line at "ABC..."
     _wait_for_user();
     i2c_lcd1602_home(lcd_info);
     i2c_lcd1602_write_string(lcd_info, "abcdefghijklmnopqrstuvwxyz0123456789.,-+ABCDEFGHIJKLMNOPQRSTUVWXYZ");
 
-    ESP_LOGI(TAG, "scroll left 8 places slowly");
+    ESP_LOGI(TAG, "scroll display left 8 places slowly");
     _wait_for_user();
     for (int i = 0; i < 8; ++i)
     {
         i2c_lcd1602_scroll_display_left(lcd_info);
         vTaskDelay(200 / portTICK_RATE_MS);
     }
 
-    ESP_LOGI(TAG, "scroll right 8 places quickly");
+    ESP_LOGI(TAG, "scroll display right 8 places quickly");
     _wait_for_user();
     for (int i = 0; i < 8; ++i)
     {
@@ -246,7 +261,7 @@ void lcd1602_task(void * pvParameter)
     i2c_lcd1602_clear(lcd_info);
     i2c_lcd1602_set_cursor(lcd_info, false);
 
-    ESP_LOGI(TAG, "create custom character and display");
+    ESP_LOGI(TAG, "create and display custom characters");
     _wait_for_user();
     // https://github.com/agnunez/ESP8266-I2C-LCD1602/blob/master/examples/CustomChars/CustomChars.ino
     uint8_t bell[8]  = {0x4, 0xe, 0xe, 0xe, 0x1f, 0x0, 0x4};
@@ -267,9 +282,6 @@ void lcd1602_task(void * pvParameter)
     i2c_lcd1602_define_char(lcd_info, I2C_LCD1602_INDEX_CUSTOM_7, retarrow);
 
     // after defining custom characters, DDRAM address must be set by home() or moving the cursor
-
-    ESP_LOGI(TAG, "display custom characters");
-    _wait_for_user();
     i2c_lcd1602_move_cursor(lcd_info, 0, 0);
     i2c_lcd1602_write_char(lcd_info, I2C_LCD1602_CHARACTER_CUSTOM_0);
     i2c_lcd1602_write_char(lcd_info, I2C_LCD1602_CHARACTER_CUSTOM_1);
@@ -298,7 +310,7 @@ void lcd1602_task(void * pvParameter)
     i2c_lcd1602_write_char(lcd_info, I2C_LCD1602_CHARACTER_DIVIDE);
     i2c_lcd1602_write_char(lcd_info, I2C_LCD1602_CHARACTER_BLOCK);
 
-    ESP_LOGI(TAG, "display all characters");
+    ESP_LOGI(TAG, "display all characters (loop)");
     _wait_for_user();
     i2c_lcd1602_clear(lcd_info);
     i2c_lcd1602_set_cursor(lcd_info, true);
@@ -309,13 +321,13 @@ void lcd1602_task(void * pvParameter)
     {
         i2c_lcd1602_write_char(lcd_info, c);
         vTaskDelay(100 / portTICK_RATE_MS);
-        ESP_LOGI(TAG, "col %d, row %d, char 0x%02x", col, row, c);
+        ESP_LOGD(TAG, "col %d, row %d, char 0x%02x", col, row, c);
         ++c;
         ++col;
-        if (col >= I2C_LCD1602_NUM_VISIBLE_COLUMNS)
+        if (col >= LCD_NUM_VISIBLE_COLUMNS)
         {
             ++row;
-            if (row >= I2C_LCD1602_NUM_ROWS)
+            if (row >= LCD_NUM_ROWS)
             {
                 row = 0;
             }
@@ -331,4 +343,3 @@ void app_main()
 {
     xTaskCreate(&lcd1602_task, "lcd1602_task", 4096, NULL, 5, NULL);
 }
-