Skip to content

Commit e40eb3c

Browse files
author
gojimmypi
committed
Update Arduino examples; add wolfcrypt breadcrumbs.
1 parent 39ad676 commit e40eb3c

16 files changed

Lines changed: 1955 additions & 350 deletions

File tree

.gitignore

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,16 +82,19 @@ snifftest
8282
output
8383
mcapi/test
8484
testsuite/testsuite
85-
tests/unit
8685
testsuite/testsuite.test
86+
testsuite/*.der
87+
testsuite/*.pem
88+
testsuite/*.raw
89+
testsuite/*.obj
90+
testsuite/*.pdb
91+
testsuite/*.idb
92+
tests/unit
8793
tests/unit.test
8894
tests/bio_write_test.txt
8995
tests/test-log-dump-to-file.txt
9096
tests/cert_cache.tmp
9197
test-write-dhparams.pem
92-
testsuite/*.der
93-
testsuite/*.pem
94-
testsuite/*.raw
9598
cert.der
9699
cert.pem
97100
certecc.der
@@ -402,7 +405,7 @@ XXX-fips-test
402405
# Generated user_settings_asm.h.
403406
user_settings_asm.h
404407

405-
# VisualGD
408+
# VisualGDB
406409
**/.visualgdb
407410

408411
# Espressif sdk config default should be saved in sdkconfig.defaults
Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
11
# Arduino wolfSSL Library
22

3-
The library is modified from wolfSSL Release ${WOLFSSL_VERSION} for the Arduino platform.
3+
This library is restructured from [wolfSSL](https://github.com/wolfSSL/wolfssl/) Release ${WOLFSSL_VERSION} for the Arduino platform.
44

5+
The Official wolfSSL Arduino Library is found in [The Library Manager index](http://downloads.arduino.cc/libraries/library_index.json).
6+
7+
See the [Arduino-wolfSSL logs](https://downloads.arduino.cc/libraries/logs/github.com/wolfSSL/Arduino-wolfSSL/).
8+
9+
## Arduino Releases
10+
11+
The first Official wolfSSL Arduino Library is `5.6.6-Arduino.1`: a slightly modified, post [release 5.6.6](https://github.com/wolfSSL/wolfssl/releases/tag/v5.6.6-stable) version update.
12+
13+
See other [wolfSSL releases versions](https://github.com/wolfSSL/wolfssl/releases). The `./wolfssl-arduino.sh INSTALL` [script](https://github.com/wolfSSL/wolfssl/tree/master/IDE/ARDUINO) can be used to install specific GitHub versions as needed.

IDE/ARDUINO/README.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# wolfSSL with Arduino
22

3+
See the [example sketches](./sketches/README.md):
4+
5+
- [sketches/wolfssl_server](./sketches/wolfssl_server/README.md)
6+
- [sketches/wolfssl_client](./sketches/wolfssl_client/README.md)
7+
8+
When publishing a new version to the Arduino Registry, be sure to edit `WOLFSSL_VERSION_ARUINO_SUFFIX` in the `wolfssl-arduino.sh` script.
9+
10+
## Boards
11+
312
Many of the supported boards are natively built-in to the [Arduino IDE Board Manager](https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-board-manager/)
413
and by adding [additional cores](https://docs.arduino.cc/learn/starting-guide/cores/) as needed.
514

@@ -12,7 +21,7 @@ https://github.com/stm32duino/BoardManagerFiles/raw/main/package_stmicroelectron
1221

1322
## Using wolfSSL from the Arduino IDE
1423

15-
Coming soon! https://github.com/wolfSSL/arduino-wolfSSL See [PR #1](https://github.com/wolfSSL/Arduino-wolfSSL/pull/1).
24+
The Official wolfSSL: https://github.com/wolfSSL/arduino-wolfSSL See [PR #1](https://github.com/wolfSSL/Arduino-wolfSSL/pull/1).
1625

1726
This option will allow wolfSSL to be installed directly using the native Arduino tools.
1827

@@ -28,7 +37,7 @@ directory and creates a stub header file called `wolfssl.h` inside that director
2837

2938
### Step 1:
3039

31-
To configure wolfSSL with Arduino, enter one of the following commands
40+
To configure wolfSSL with Arduino, enter ONE of the following 4 commands
3241
from within the `wolfssl/IDE/ARDUINO` directory:
3342

3443
1. `./wolfssl-arduino.sh`
@@ -93,9 +102,25 @@ Open an example Arduino sketch for wolfSSL:
93102

94103
#### Script Examples
95104

96-
Publish wolfSSL from WSL to a repository.
105+
Refresh the local Windows Arduino wolfSSL library from GitHub repository directory using WSL:
106+
107+
Don't forget to edit `WOLFSSL_VERSION_ARUINO_SUFFIX`!
108+
109+
```bash
110+
# Change to the wolfSSL Arduino IDE directory
111+
cd /mnt/c/workspace/wolfssl-$USER/IDE/ARDUINO
112+
113+
# remove current Arduino wolfSSL library
114+
rm -rf /mnt/c/Users/$USER/Documents/Arduino/libraries/wolfssl
115+
116+
# Install wolfSSL as an Arduino library
117+
./wolfssl-arduino.sh INSTALL
118+
```
119+
120+
Publish wolfSSL from WSL to a `Arduino-wolfSSL-$USER` repository.
97121

98122
```bash
123+
cd /mnt/c/workspace/wolfssl-$USER/IDE/ARDUINO
99124
rm -rf /mnt/c/Users/$USER/Documents/Arduino/libraries/wolfSSL
100125
rm -rf /mnt/c/workspace/wolfssl-$USER/IDE/ARDUINO/wolfSSL
101126
./wolfssl-arduino.sh INSTALL /mnt/c/workspace/Arduino-wolfSSL-$USER/

IDE/ARDUINO/include.am

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,5 @@ EXTRA_DIST+= IDE/ARDUINO/sketches/wolfssl_client/README.md
1111
EXTRA_DIST+= IDE/ARDUINO/sketches/wolfssl_client/wolfssl_client.ino
1212
EXTRA_DIST+= IDE/ARDUINO/sketches/wolfssl_server/README.md
1313
EXTRA_DIST+= IDE/ARDUINO/sketches/wolfssl_server/wolfssl_server.ino
14+
EXTRA_DIST+= IDE/ARDUINO/wolfssl.h
1415
EXTRA_DIST+= IDE/ARDUINO/wolfssl-arduino.sh

IDE/ARDUINO/library.properties.template

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
name=wolfSSL
1+
name=wolfssl
22
version=${WOLFSSL_VERSION}${WOLFSSL_VERSION_ARUINO_SUFFIX}
3-
author=wolfSSL inc
3+
author=wolfSSL Inc.
44
maintainer=wolfSSL inc <support@wolfssl.com>
55
sentence=A lightweight SSL/TLS library written in ANSI C and targeted for embedded, RTOS, and resource-constrained environments.
66
paragraph=Manual: https://www.wolfssl.com/documentation/manuals/wolfssl/index.html.

0 commit comments

Comments
 (0)