arduino-ci

Author: as-iotex

.github/workflows/arduino-ci.yaml

@@ -0,0 +1,44 @@
+name: Arduino CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  arduino:
+    strategy:
+      matrix:
+          arduino-platform: ["arduino:samd", "esp32:esp32"]
+          include:
+            - arduino-platform: "arduino:samd"
+              fqbn: "arduino:samd:nano_33_iot"
+            - arduino-platform: "esp32:esp32"
+              fqbn: "esp32:esp32:nodemcu-32s"
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Arduino Lint
+        uses: arduino/arduino-lint-action@v1
+
+      - name: Install Arduino CLI
+        uses: arduino/setup-arduino-cli@v1
+      
+      - name: Add ESP32 package index URL
+        run: arduino-cli config add board_manager.additional_urls https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
+
+      - name: Install platform
+        run: |
+          arduino-cli core update-index
+          arduino-cli core install ${{ matrix.arduino-platform }}
+
+      - name: Build examples with Arduino
+        uses: Arduino-CI/action@stable-1.x
+
+      # - name: Compile Sketch
+      #   run: arduino-cli compile --fqbn ${{ matrix.fqbn }} ./blink
+  

CMakeLists.txt

@@ -9,7 +9,7 @@ set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 project(
-  ArduinoPSA
+  PSACrypto
   VERSION 1.0
   LANGUAGES C CXX
 )

README.md

@@ -1,10 +1,10 @@
-# ArduinoPSA Library
+# PSACrypto Library
 
 [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
 [![GitHub release](https://img.shields.io/github/release/machinefi/arduino-psa.svg)](https://github.com/machinefi/arduino-psa/releases)
 [![GitHub CI](https://github.com/machinefi/arduino-psa/actions/workflows/ci.yml/badge.svg)](https://github.com/machinefi/arduino-psa/actions/workflows/ci.yml)
 
-ArduinoPSA is an Arduino library that implements the cryptography functionality of the Platform Security Architecture (PSA) API. It provides a standardized and easy-to-use interface for cryptographic operations on Arduino boards, ensuring secure communication, data integrity, and confidentiality.
+PSACrypto is an Arduino library that implements the cryptography functionality of the Platform Security Architecture (PSA) API. It provides a standardized and easy-to-use interface for cryptographic operations on Arduino boards, ensuring secure communication, data integrity, and confidentiality.
 
 ## Features
 
@@ -18,58 +18,58 @@ ArduinoPSA is an Arduino library that implements the cryptography functionality
 
 ### Arduino IDE
 
-To install the ArduinoPSA library using the Arduino IDE, follow these steps:
+To install the PSACrypto library using the Arduino IDE, follow these steps:
 
 1. Open the Arduino IDE.
 2. Go to **Sketch > Include Library > Manage Libraries**.
 3. The Library Manager window will open, showing a list of available libraries.
-4. In the search bar, type "ArduinoPSA" and press Enter.
-5. Locate the "ArduinoPSA" library in the search results.
+4. In the search bar, type "PSACrypto" and press Enter.
+5. Locate the "PSACrypto" library in the search results.
 6. Click on the library entry to open its details.
 7. Click the "Install" button to install the library.
 8. Wait for the installation process to complete.
 9. After installation, close the Library Manager window.
-10. The ArduinoPSA library is now installed and ready to be used.
+10. The PSACrypto library is now installed and ready to be used.
 
 ### Manual Installation
 
-To install the ArduinoPSA library manually, follow these steps:
+To install the PSACrypto library manually, follow these steps:
 
-1. Download the ArduinoPSA library from the [GitHub repository](https://github.com/machinefi/arduino-psa).
+1. Download the PSACrypto library from the [GitHub repository](https://github.com/machinefi/arduino-psa).
 2. Extract the downloaded ZIP file.
-3. Rename the extracted folder to "ArduinoPSA".
-4. Move the "ArduinoPSA" folder to your Arduino libraries directory. The default locations are:
+3. Rename the extracted folder to "PSACrypto".
+4. Move the "PSACrypto" folder to your Arduino libraries directory. The default locations are:
    - **Windows**: `Documents\Arduino\libraries`
    - **Mac**: `Documents/Arduino/libraries`
    - **Linux**: `Arduino/libraries`
 5. Restart the Arduino IDE.
-6. The ArduinoPSA library should now be available under **Sketch > Include Library** menu.
+6. The PSACrypto library should now be available under **Sketch > Include Library** menu.
 7. You can now include the library in your Arduino sketches and use its features.
 
 ### PlatformIO
 
-To install the ArduinoPSA library using PlatformIO, follow these steps:
+To install the PSACrypto library using PlatformIO, follow these steps:
 
 1. Create a new PlatformIO project or open an existing one.
 2. Open the `platformio.ini` file located in the root of your project.
 3. Add the following line to the `[env:<your_board>]` section:
 
 ```ini
 lib_deps =
-    ArduinoPSA
+    PSACrypto
 ```
 
 Replace <your_board> with the target board/platform for your project (e.g., esp32, arduino_due, etc.).
 
 1. Save the platformio.ini file.
-2. PlatformIO will automatically install the ArduinoPSA library and its dependencies when you build/upload your project.
+2. PlatformIO will automatically install the PSACrypto library and its dependencies when you build/upload your project.
 
 ## Usage
 
 ### Arduino IDE
 
 1. Open the Arduino IDE.
-2. Go to File > Examples > ArduinoPSA to access the example sketches.
+2. Go to File > Examples > PSACrypto to access the example sketches.
 3. Select an example sketch to open it.
 4. Modify the sketch as needed to fit your requirements.
 5. Upload the sketch to your Arduino board.
@@ -80,24 +80,24 @@ Replace <your_board> with the target board/platform for your project (e.g., esp3
 1. Open your PlatformIO project.
 2. Navigate to the src folder.
 3. Create a new .cpp file or open an existing one.
-4. Include the ArduinoPSA library by adding the following line at the top of your file:
+4. Include the PSACrypto library by adding the following line at the top of your file:
 
 ```c++
-# include <ArduinoPSA.h>
+# include <psacrypto.h>
 ```
 
-For detailed information on using the ArduinoPSA library, including usage examples and API reference, please refer to the [Documentation](docs/).
+For detailed information on using the PSACrypto library, including usage examples and API reference, please refer to the [Documentation](docs/).
 
 ## Compatible Hardware
 
-The ArduinoPSA library has been tested and is compatible with the following hardware:
+The PSACrypto library has been tested and is compatible with the following hardware:
 
 - ESP32
 - Arduino Nano 33 IoT
 
 Please note that the library may also work with other Arduino-compatible boards, but it has specifically been tested and verified with the above-mentioned hardware.
 
-It's recommended to check the official documentation of your specific board or consult the manufacturer's specifications to ensure compatibility with the ArduinoPSA library.
+It's recommended to check the official documentation of your specific board or consult the manufacturer's specifications to ensure compatibility with the PSACrypto library.
 
 ## Contributing
 

examples/Aes/Aes.ino

@@ -1,4 +1,4 @@
-#include "arduinopsa.h"
+#include "psacrypto.h"
 
 void setup()
 {

examples/AesMultipart/AesMultipart.ino

@@ -1,4 +1,4 @@
-#include "arduinopsa.h"
+#include "psacrypto.h"
 
 void setup()
 {

examples/GenerateKey/GenerateKey.ino

@@ -1,4 +1,4 @@
-#include "arduinopsa.h"
+#include "psacrypto.h"
 
 void setup()
 {

examples/GenerateRandom/GenerateRandom.ino

@@ -1,4 +1,4 @@
-#include "arduinopsa.h"
+#include "psacrypto.h"
 
 void setup()
 {

examples/Hash/Hash.ino

@@ -1,4 +1,4 @@
-#include "arduinopsa.h"
+#include "psacrypto.h"
 
 void setup()
 {

examples/HashMultipart/HashMultipart.ino

@@ -1,4 +1,4 @@
-#include "arduinopsa.h"
+#include "psacrypto.h"
 
 void setup()
 {

examples/SignMessage/SignMessage.ino

@@ -1,4 +1,4 @@
-#include "arduinopsa.h"
+#include "psacrypto.h"
 
 void setup() {
   Serial.begin(115200);

library.json

@@ -1,6 +1,6 @@
 {
-  "name": "ArduinoPSA",
-  "description": "A simple PSA-API client implementation in C++ for the IoTeX blockchain.",
+  "name": "PSACrypto",
+  "description": "An implementation of the Platform Security Architecture Crypto API for Arduino.",
   "repository": {
     "type": "git",
     "url": "https://github.com/machinefi/arduino-psa"

library.properties

@@ -1,10 +1,10 @@
-name=ArduinoPSA
+name=PSACrypto
 version=0.1.0
 author=IoTeX
 maintainer=IoTeX
 sentence=An implementation of the Platform Security Architecture Crypto API for Arduino.
-paragraph=ArduinoPSA is a library that provides an implementation of the Platform Security Architecture (PSA) Crypto API for Arduino boards. It enables developers to securely perform cryptographic operations on Arduino devices, such as encryption, decryption, hashing, and more. The library is designed to be easy to use and compatible with various Arduino boards.
+paragraph=PSACrypto is a library that provides an implementation of the Platform Security Architecture (PSA) Crypto API for Arduino boards. It enables developers to securely perform cryptographic operations on Arduino devices, such as encryption, decryption, hashing, and more. The library is designed to be easy to use and compatible with various Arduino boards.
 category=Communication
 url=https://github.com/machinefi/arduino-psa
 architectures=*
-includes=arduinopsa.h
+includes=psacrypto.h

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "ArduinoPsa",
+  "name": "PSACrypto",
   "version": "0.3.1",
   "description": "A simple PSA-API client implementation in C++ for the IoTeX blockchain.",
   "main": "",

src/arduinopsa.h renamed to src/psacrypto.h

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaCipherDecrypt : public ::testing::Test {

tests/test_psa_cipher_decrypt.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaCipherDecryptSetup : public ::testing::Test {

tests/test_psa_cipher_decrypt_setup.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaCipherEncrypt : public ::testing::Test {

tests/test_psa_cipher_encrypt.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaCipherEncryptSetup : public ::testing::Test {

tests/test_psa_cipher_encrypt_setup.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaCipherGenerateIv : public ::testing::Test {

tests/test_psa_cipher_generate_iv.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaCipherUpdate : public ::testing::Test {

tests/test_psa_cipher_update.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaCopyKey : public ::testing::Test {

tests/test_psa_copy_key.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaCryptoInitTest : public ::testing::Test {

tests/test_psa_crypto_init.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaDestroyKey : public ::testing::Test {

tests/test_psa_destroy_key.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaExportKey : public ::testing::Test {

tests/test_psa_export_key.cpp

@@ -1,7 +1,7 @@
 #include <gtest/gtest.h>
 #include <string>
 #include <algorithm>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaExportPublicKey : public ::testing::Test {

tests/test_psa_export_public_key.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaGenerateKey : public ::testing::Test {

tests/test_psa_generate_key.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaGenerateRandomTest : public ::testing::Test {

tests/test_psa_generate_random.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaHashAbort : public ::testing::Test {

tests/test_psa_hash_abort.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaHashClone : public ::testing::Test {

tests/test_psa_hash_clone.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaHashCompare : public ::testing::Test {

tests/test_psa_hash_compare.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaHashCompute : public ::testing::Test {

tests/test_psa_hash_compute.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaHashFinish : public ::testing::Test {

tests/test_psa_hash_finish.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaHashSetup : public ::testing::Test {

tests/test_psa_hash_setup.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaHashUpdate : public ::testing::Test {

tests/test_psa_hash_update.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaHashVerify : public ::testing::Test {

tests/test_psa_hash_verify.cpp

@@ -1,5 +1,5 @@
 #include <gtest/gtest.h>
-#include "arduinopsa.h"
+#include "psacrypto.h"
 #include "test_helpers.h"
 
 class PsaImportKey : public ::testing::Test {