Merge pull request #204 from sorru94/prepare-esp-registry-pubblishing

Prepare pubblishing for ESP registry

.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 }}

.gitignore

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

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
 

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.1'
+    override_path: '../../../' # three levels up, pointing the directory with the component itself

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.1'
+    override_path: '../../../' # three levels up, pointing the directory with the component itself

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.1'
+    override_path: '../../../' # three levels up, pointing the directory with the component itself

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.1'
+    override_path: '../../../' # three levels up, pointing the directory with the component itself

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.1'
+    override_path: '../../../' # three levels up, pointing the directory with the component itself

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.1'
+    override_path: '../../../' # three levels up, pointing the directory with the component itself

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)

examples/toggle_led/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 with a led toggle for visual demonstration
+dependencies:
+  idf: ">=4.4"
+  astarte-platform/astarte-device-sdk-esp32:
+    version: '1.3.1'
+    override_path: '../../../' # three levels up, pointing the directory with the component itself

idf_component.yml

@@ -20,8 +20,13 @@
 
 version: "1.3.1"
 description: "A component that provides communication and pairing primitives to an Astarte cluster"
-url: "https://github.com/astarte-platform/astarte-device-sdk-esp32"
-documentation: "https://docs.astarte-platform.org/device-sdks/esp32/1.3/api"
+repository: "https://github.com/astarte-platform/astarte-device-sdk-esp32.git"
+url: "https://docs.astarte-platform.org/"
+documentation: "https://docs.astarte-platform.org/device-sdks/index.html"
+license: "Apache-2.0"
+maintainers:
+  - Simone Orru <simone.orru@secomind.com>
+  - Antonio Gisondi <antonio.gisondi@secomind.com>
 
 tags:
   - sdk
@@ -38,8 +43,6 @@ files:
   exclude:
     - "doc/**/*"
     - "doc"
-    - "examples/**/*"
-    - "examples"
     - "python_scripts/**/*"
     - "python_scripts"
     - "tests/**/*"