Merge pull request #135 from SmartThingsCommunity/develop

Release v 1 8 12

Author: stdk-scm

CMakeLists.txt

@@ -1,8 +1,6 @@
 cmake_minimum_required(VERSION 3.13)
 project(st_device_sdk_c C)
 
-set(CMAKE_C_STANDARD 99)
-
 set(CMAKE_CXX_FLAGS_UNITTEST "-g --coverage -DSUPPORT_TC_ON_STATIC_FUNC" CACHE STRING
     "Flags used by the C++ compiler during unit test builds."
     FORCE)

README.md

@@ -78,6 +78,10 @@ For more information, please review the following documents:
 - [Capabilities Reference](https://developer.smartthings.com/docs/devices/capabilities/capabilities) : This page serves as a reference for the supported capabilities.
 - [Developer Workspace](https://smartthings.developer.samsung.com/workspace/) : It provides functions related to device information registration and device integration in the SmartThings cloud.
 
+## Contact
+
+If you have any issue, or want to commercialize your IoT devices using this SDK, please contact [email protected] or open new issue.
+
 ## License
 
 This library is licensed under the [Apache License Ver2.0](LICENSE).

doc/STDK_QR.md

@@ -1,12 +1,16 @@
-# How to create QR code for SmartThings Device SDK
+# How to create QR code for SmartThings SDK for Direct Connected Devices
 
 ### Introduction
-SmartThings Device SDK allows users to pair their devices with the SmartThings App through a process called device onboarding.
+SmartThings SDK for Direct Connected Devices allows users to pair their devices with the SmartThings App through a process called device onboarding.
 This "device onboarding" process involves confirming whether this device is owned by the user through the user's operation.
-STDK provides four methods for this. These four methods are Just Works, Button Confirm, Pin Code Confirm, and QR Code Confirm.
+SmartThings SDK provides four methods for this. These are `Just Works`, `Button Confirm`, `Pin Code Confirm`, and `QR Code Confirm`.
 When registering an onboarding profile in Developer Workspace, the developer can select methods will be used to check whether the device to be paired with the SmartThings App is owned by the user during onboarding.
 Using QR code is not only used for user verification, but also helps user to onboarding user's device quickly and accurately. 
-In the "Add device" menu of the SmartThings App, the onboarding process starts by only scanning QR provided through the "Scan QR code".
+
+In the "Add device" menu of the SmartThings App, the onboarding process starts by only scanning QR provided through the "Scan QR code".  
+
+:warning: **QR code is required while pairing device when user uses iOS version of SmartThings app, regardless of ownership confirm type.**  
+
 
 ### Information included in QR code
 The QR code includes the following three pieces of information, and the manufacturer can generate the QR code with the information of each device and provide it to the user.

doc/getting_started.md

@@ -63,6 +63,7 @@ The device onboarding guides device owners when their device is first registerin
 
 The product info defines how this device is shown at SmartThings mobile app catalog. 
 You can define device’s category and its regional availability.
+> **_NOTE:_**  If user or tester samsung account country is not in availability list, they can't onboard the device. Please check the regional availability before device test or production.
 
 ![create product info](./res/add-product-info.gif)  
 
@@ -91,7 +92,7 @@ Key generator utility (keygen.py) is located at `st-device-sdk-c/tools/keygen/`.
 Serial number for testing device would be randomly generated by this tool which has STDK + 12-digit alphanumberic format.
 
 ```sh
-$ cd ~/st-device-sdk-c-ref/iot-core/tools/keygen/
+$ cd {SDK_ROOT}/tools/keygen/
 $ python3 stdk-keygen.py --firmware switch_example_001
 Use following serial number and public key
 for the identity of your device in Developer Workspace.

example/esp32/README.md

@@ -2,25 +2,49 @@
 
 ## Build environment
 
-1. Download ESP IDF v4.3.1 SDK version(git commit : 2e74914051d14ec2290fc751a8486fb51d73a31e)
+1. Download ESP IDF v5.0 SDK version from [espressif github](https://github.com/espressif/esp-idf) (checkout release/5.0 branch)
 
-2. Setup ESP32 build environment [guide](https://docs.espressif.com/projects/esp-idf/en/release-v4.3/esp32/get-started/index.html)
+   ```sh
+   $ mkdir -p ~/esp
+   $ cd ~/esp
+   $ git clone -b release/v5.0 --recursive https://github.com/espressif/esp-idf.git
+   ```
 
-## How to build example
+2. Setup ESP32 build environment according to [guide](https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32/get-started/index.html)
+
+> **_NOTE:_** You can also setup other esp32 series like ESP32-S series, ESP32-C series according to their setup guide.
 
-1. To test your registered devices on DevWS, replace onboarding_config.json and device.json with yours before build. (Refer [Getting Started](../..//doc/getting_started.md))
+3. Acquire SmartThings Device SDK workflow reading [Getting Started](../../doc/getting_started.md) Document
 
-2. Build this example and flash image on esp32 board.
+## How to build example
+
+1. Build this example and flash image on esp32 board. (Please refer [espressif guide](https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32/get-started/linux-macos-setup.html#build-the-project))
 
    ```sh
    $ cd st-device-sdk-c/example/esp32
    $ idf.py build
    $ idf.py flash
    ```
-3. Run and monitor esp32
+> **_NOTE:_** The examples's default sdkconfig is for esp32 board. To run the example on other esp32 series, change `CONFIG_IDF_TARGET` in sdkconfig with desired target board before build.
+>
+> For example, to run the example on esp32s3 board, change `CONFIG_IDF_TARGET` in sdkconfig file like below.
+>```vim
+>... (Skip) ...
+>CONFIG_IDF_TARGET="esp32s3"
+>... (Skip) ...
+>```
+>You may need to run fullclean to remove previous target board build configuration before building different target.
+>```sh
+>$ idf.py fullclean
+>```
+
+2. Run and monitor esp32. (Please refer [espressif guide](https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32/get-started/linux-macos-setup.html#monitor-the-output))
 
     ```sh
     $ idf.py monitor
     ```
 
-Please refer [Getting Started](../../doc/getting_started.md) guide for testing example with ST app.
+3. To test your registered devices on DevWS, replace onboarding_config.json and device.json under `main` folder with yours before build. (Refer [Getting Started](../..//doc/getting_started.md#update-device-information))
+
+
+Please refer [Getting Started](../../doc/getting_started.md#test) guide for testing example with ST app.

example/esp32/custom_partitions.csv

@@ -4,5 +4,5 @@ nvs,      data, nvs,     ,        0x4000,
 otadata,  data, ota,     ,        0x2000,
 phy_init, data, phy,     ,        0x1000,
 nvs_key,  data, nvs_keys, ,       0x1000, encrypted
-ota_0,    app,  ota_0,   ,        2M,
-ota_1,    app,  ota_1,   ,        1M,
+ota_0,    app,  ota_0,   ,        0x150000,
+ota_1,    app,  ota_1,   ,        0x150000,

example/esp32/main/CMakeLists.txt

@@ -7,18 +7,5 @@ idf_component_register(SRCS "main.c"
                     )
 
 set(stdk_config ${CMAKE_CURRENT_LIST_DIR}/stdkconfig.cmake)
-
-set(STDK_LINK_LIBRARY
-        __idf_libsodium
-        __idf_json
-   )
-
-set(STDK_INCLUDE_PATH
-        "$ENV{IDF_PATH}/components/freertos/include/freertos"
-        "$ENV{IDF_PATH}/components/nvs_flash/include"
-        "$ENV{IDF_PATH}/components/spi_flash/include"
-        "$ENV{IDF_PATH}/components/bootloader_support/include"
-    )
-
 add_subdirectory(../../.. iotcore)
 target_link_libraries(${COMPONENT_LIB} PUBLIC iotcore)

example/esp32/main/device_control.c

@@ -49,7 +49,7 @@ int get_button_event(int* button_event_type, int* button_event_count)
         vTaskDelay( pdMS_TO_TICKS(BUTTON_DEBOUNCE_TIME_MS) );
         gpio_level = gpio_get_level(GPIO_INPUT_BUTTON);
         if (button_last_state != gpio_level) {
-            printf("Button event, val: %d, tick: %u\n", gpio_level, (uint32_t)xTaskGetTickCount());
+            printf("Button event, val: %ld, tick: %lu\n", gpio_level, (uint32_t)xTaskGetTickCount());
             button_last_state = gpio_level;
             if (gpio_level == BUTTON_GPIO_PRESSED) {
                 button_count++;

example/esp32/main/idf_component.yml

@@ -0,0 +1,17 @@
+## IDF Component Manager Manifest File
+dependencies:
+  espressif/libsodium: "^1.0.20"
+  ## Required IDF version
+  idf:
+    version: ">=4.1.0"
+  # # Put list of dependencies here
+  # # For components maintained by Espressif:
+  # component: "~1.0.0"
+  # # For 3rd party components:
+  # username/component: ">=1.0.0,<2.0.0"
+  # username2/component2:
+  #   version: "~1.0.0"
+  #   # For transient dependencies `public` flag can be set.
+  #   # `public` flag doesn't have an effect dependencies of the `main` component.
+  #   # All dependencies of `main` are public by default.
+  #   public: true

example/esp32/main/iot_uart_cli.c

@@ -215,7 +215,7 @@ static void esp_uart_cli_task()
         memset(data, 0, UART_BUF_SIZE);
 
         // Read data from the UART
-        int len = uart_read_bytes(UART_NUM_0, data, UART_BUF_SIZE, 20 / portTICK_RATE_MS);
+        int len = uart_read_bytes(UART_NUM_0, data, UART_BUF_SIZE, 20 / portTICK_PERIOD_MS);
         for (int i = 0; i < len; i++) {
             switch(data[i])
             {