Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PBrunot committed Apr 28, 2024
1 parent 76ed8f0 commit 49b6196
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,20 @@ Test suite : [![Test suite](https://github.com/PBrunot/rfid-arduino-copy/actions
## Testing Suite

* A set a test scripts based on Platformio+Unity is included in the project.
* There are two ways to run the tests:
* There are three ways to run the tests:

1. Use real hardware (esp32s3, esp32 wroverkit) connected over USB with Platform.io command

```shell
pio test --environment esp32-s3
pio test --environment esp32-s3 --verbose
```

This is the method I am using whenever online tests fail (to narrow the run use <code>-f test_which_failed</code>)

2. Use Wokwi-CLI with test images built by Platform.io. It requires a wokwi access token (free as per Jan 2024). The Github action "tests.yml" uses this mechanism.

3. Run the BIN image generated by <code>pio test --without-uploading --without-testing</code> in VS Code Wokwi plugin.

## DEMO - View it in the browser

* Download latest <code>esp32-wokwi.zip</code> file from Github Actions / platformio.yml / Artifacts
Expand Down Expand Up @@ -154,4 +158,4 @@ upload_port = IP_ADDRESS_HERE or mDNS_NAME.local
|0.4.x | March 2024 | 1st PCB manufactured (rev0.2), FW +IP address announced over MQTT |
|0.5.x | April 2024 | Fully tested on PCB rev0.2 & rev 0.3 |
|0.6.x | April 2024 | Added RFID cache for network interruptions, config portal now opens only by button push |
|0.7.x | May 2024 | Maintenance operation is displayed on LCD, bugfixes |
|0.7.x | April 2024 | Maintenance operation is displayed on LCD, JSON is now used for data persistence in Flash |

0 comments on commit 49b6196

Please sign in to comment.