Merge pull request #212 from sorru94/fwd-changes-from-v1.3

Fwd port changes from v1.3

.github/workflows/publish.yaml

@@ -0,0 +1,40 @@
+#
+# This file is part of Astarte.
+#
+# Copyright 2024 SECO Mind Srl
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: LGPL-2.1-or-later OR Apache-2.0
+#
+
+name: ESP registry publish
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    name: Publish release to the ESP registry
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Upload component to the component registry
+      uses: espressif/upload-components-ci-action@v1
+      with:
+        name: "astarte-device-sdk-esp32"
+        version: ${{ github.ref_name }}
+        namespace: "astarte-platform"
+        api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}

.github/workflows/reuse-lint.yaml

@@ -12,4 +12,4 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: REUSE Compliance Check
-      uses: fsfe/reuse-action@v2
+      uses: fsfe/reuse-action@v4

.gitignore

@@ -9,6 +9,7 @@ dependencies.lock
 managed_components
 doc/out
 .vscode
+dist
 
 # Files related to clang-tidy
 warnings.txt

CHANGELOG.md

@@ -10,7 +10,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.1.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [1.3.3] - 2024-09-04
+### Fixed
+- Correctly calling the incoming data callback.
+
+## [1.3.2] - 2024-09-04 [YANKED]
+### Added
+- Automated publishing on the
+[ESP registry](https://components.espressif.com/components/astarte-platform/astarte-device-sdk-esp32).
+
+### Fixed
+- Early exit on reception when data callback is not set.
+
+## [1.3.1] - 2024-01-18
+### Fixed
+- Version number in `idf_component.yml`.
+
+## [1.3.0] - 2023-12-18
 ### Added
 - `user_data` field is added to the `astarte_device_config_t` and `astarte_device_*_event_t`
   structs. This field can be used to pass user data to callback functions.

README.md

@@ -12,8 +12,11 @@ Astarte ESP32 SDK lets you connect your ESP32 device to
 The SDK simplifies all the low-level operations like credentials generation, pairing and so on, and
 exposes a high-level API to publish data from your device.
 
-Have a look at the [examples](examples/README.md) for a usage example showing how to send and
-receive data.
+Check out the examples on the right pane of the
+[astarte-device-sdk-esp32](https://components.espressif.com/components/astarte-platform/astarte-device-sdk-esp32)
+component page or on the
+[GitHub repository](https://github.com/astarte-platform/astarte-device-sdk-esp32/tree/master/examples/README.md)
+.
 
 ## Documentation
 

REUSE.toml

@@ -0,0 +1,8 @@
+# (C) Copyright 2024, SECO Mind Srl
+#
+# SPDX-License-Identifier: Apache-2.0
+
+version = 1
+SPDX-PackageName = "Astarte Device SDK ESP32"
+SPDX-PackageDownloadLocation = "https://github.com/astarte-platform/astarte-device-sdk-esp32"
+annotations = []

SECURITY.md

@@ -10,9 +10,12 @@
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 0.10.x  | :x:                |
+| 1.3.x   | :white_check_mark: |
+| 1.2.x   | :white_check_mark: |
+| 1.1.x   | :white_check_mark: |
+| 1.0.x   | :x:                |
 | 0.11.x  | :x:                |
-| 1.0.x   | :white_check_mark: |
+| 0.10.x  | :x:                |
 
 ## Reporting a Vulnerability
 

doc/docmain.dox

@@ -1,6 +1,6 @@
 /** @mainpage Astarte Device SDK ESP32 Documentation
 
-@version 1.2.99
+@version 1.3.3
 
  * The Astarte device SDK allows connecting an ESP32 device to Astarte.
  *

examples/aggregates/CMakeLists.txt

@@ -22,6 +22,4 @@ cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 
-set(EXTRA_COMPONENT_DIRS ${CMAKE_SOURCE_DIR}/../..)
-
 project(aggregates)

examples/aggregates/main/idf_component.yml

@@ -0,0 +1,26 @@
+#
+# This file is part of Astarte.
+#
+# Copyright 2024 SECO Mind Srl
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: LGPL-2.1-or-later OR Apache-2.0
+#
+
+description: Example for transmission and reception of aggregated datastreams
+dependencies:
+  idf: ">=4.4"
+  astarte-platform/astarte-device-sdk-esp32:
+    version: '1.3.3'
+    override_path: '../../../' # three levels up, pointing the directory with the component itself

examples/aggregates/main/src/wifi_cfg.c

@@ -67,7 +67,7 @@ void wifi_init(void)
     ESP_ERROR_CHECK(esp_event_loop_create_default());
     esp_netif_create_default_wifi_sta();
 
-    wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
+    wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT(); // NOLINT
     ESP_ERROR_CHECK(esp_wifi_init(&cfg));
 
     esp_event_handler_instance_t instance_any_id = NULL;

examples/datastreams/CMakeLists.txt

@@ -22,6 +22,4 @@ cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 
-set(EXTRA_COMPONENT_DIRS ${CMAKE_SOURCE_DIR}/../..)
-
 project(datastreams)

examples/datastreams/main/idf_component.yml

@@ -0,0 +1,26 @@
+#
+# This file is part of Astarte.
+#
+# Copyright 2024 SECO Mind Srl
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: LGPL-2.1-or-later OR Apache-2.0
+#
+
+description: Example for transmission and reception of individual datastreams
+dependencies:
+  idf: ">=4.4"
+  astarte-platform/astarte-device-sdk-esp32:
+    version: '1.3.3'
+    override_path: '../../../' # three levels up, pointing the directory with the component itself

examples/datastreams/main/src/wifi_cfg.c

@@ -67,7 +67,7 @@ void wifi_init(void)
     ESP_ERROR_CHECK(esp_event_loop_create_default());
     esp_netif_create_default_wifi_sta();
 
-    wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
+    wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT(); // NOLINT
     ESP_ERROR_CHECK(esp_wifi_init(&cfg));
 
     esp_event_handler_instance_t instance_any_id = NULL;

examples/encryption/CMakeLists.txt

@@ -22,6 +22,4 @@ cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 
-set(EXTRA_COMPONENT_DIRS ${CMAKE_SOURCE_DIR}/../..)
-
 project(encryption)

examples/encryption/main/idf_component.yml

@@ -0,0 +1,26 @@
+#
+# This file is part of Astarte.
+#
+# Copyright 2024 SECO Mind Srl
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: LGPL-2.1-or-later OR Apache-2.0
+#
+
+description: Example for the use of the Astarte device SDK with encrypted flash partitions
+dependencies:
+  idf: ">=4.4"
+  astarte-platform/astarte-device-sdk-esp32:
+    version: '1.3.3'
+    override_path: '../../../' # three levels up, pointing the directory with the component itself

examples/encryption/main/src/wifi_cfg.c

@@ -67,7 +67,7 @@ void wifi_init(void)
     ESP_ERROR_CHECK(esp_event_loop_create_default());
     esp_netif_create_default_wifi_sta();
 
-    wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
+    wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT(); // NOLINT
     ESP_ERROR_CHECK(esp_wifi_init(&cfg));
 
     esp_event_handler_instance_t instance_any_id = NULL;

examples/non_volatile_storage/CMakeLists.txt

@@ -22,6 +22,4 @@ cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 
-set(EXTRA_COMPONENT_DIRS ${CMAKE_SOURCE_DIR}/../..)
-
 project(non-volatile-storage)

examples/non_volatile_storage/main/idf_component.yml

@@ -0,0 +1,26 @@
+#
+# This file is part of Astarte.
+#
+# Copyright 2024 SECO Mind Srl
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: LGPL-2.1-or-later OR Apache-2.0
+#
+
+description: Example for the use of the Astarte device SDK with non volatile storage enabled
+dependencies:
+  idf: ">=4.4"
+  astarte-platform/astarte-device-sdk-esp32:
+    version: '1.3.3'
+    override_path: '../../../' # three levels up, pointing the directory with the component itself

examples/non_volatile_storage/main/src/wifi_cfg.c

@@ -67,7 +67,7 @@ void wifi_init(void)
     ESP_ERROR_CHECK(esp_event_loop_create_default());
     esp_netif_create_default_wifi_sta();
 
-    wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
+    wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT(); // NOLINT
     ESP_ERROR_CHECK(esp_wifi_init(&cfg));
 
     esp_event_handler_instance_t instance_any_id = NULL;

examples/properties/CMakeLists.txt

@@ -22,6 +22,4 @@ cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 
-set(EXTRA_COMPONENT_DIRS ${CMAKE_SOURCE_DIR}/../..)
-
 project(properties)

examples/properties/main/idf_component.yml

@@ -0,0 +1,26 @@
+#
+# This file is part of Astarte.
+#
+# Copyright 2024 SECO Mind Srl
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: LGPL-2.1-or-later OR Apache-2.0
+#
+
+description: Example for setting and unsetting individual properties
+dependencies:
+  idf: ">=4.4"
+  astarte-platform/astarte-device-sdk-esp32:
+    version: '1.3.3'
+    override_path: '../../../' # three levels up, pointing the directory with the component itself

examples/properties/main/src/wifi_cfg.c

@@ -67,7 +67,7 @@ void wifi_init(void)
     ESP_ERROR_CHECK(esp_event_loop_create_default());
     esp_netif_create_default_wifi_sta();
 
-    wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
+    wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT(); // NOLINT
     ESP_ERROR_CHECK(esp_wifi_init(&cfg));
 
     esp_event_handler_instance_t instance_any_id = NULL;

examples/registration/CMakeLists.txt

@@ -22,6 +22,4 @@ cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 
-set(EXTRA_COMPONENT_DIRS ${CMAKE_SOURCE_DIR}/../..)
-
 project(registration)

examples/registration/main/idf_component.yml

@@ -0,0 +1,26 @@
+#
+# This file is part of Astarte.
+#
+# Copyright 2024 SECO Mind Srl
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: LGPL-2.1-or-later OR Apache-2.0
+#
+
+description: Example for on board registration using a JWT
+dependencies:
+  idf: ">=4.4"
+  astarte-platform/astarte-device-sdk-esp32:
+    version: '1.3.3'
+    override_path: '../../../' # three levels up, pointing the directory with the component itself

examples/registration/main/src/wifi_cfg.c

@@ -67,7 +67,7 @@ void wifi_init(void)
     ESP_ERROR_CHECK(esp_event_loop_create_default());
     esp_netif_create_default_wifi_sta();
 
-    wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
+    wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT(); // NOLINT
     ESP_ERROR_CHECK(esp_wifi_init(&cfg));
 
     esp_event_handler_instance_t instance_any_id = NULL;

examples/toggle_led/CMakeLists.txt

@@ -22,6 +22,4 @@ cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 
-set(EXTRA_COMPONENT_DIRS ${CMAKE_SOURCE_DIR}/../..)
-
 project(toggle-led)