From ab65373fd91aa978dcdfb98256bc124c7d544b03 Mon Sep 17 00:00:00 2001 From: Jake Carter Date: Fri, 4 Oct 2024 17:24:32 -0600 Subject: [PATCH] Update README --- Examples/MAX32690/Unity_Test/README.md | 43 +++++++++++++++----------- 1 file changed, 25 insertions(+), 18 deletions(-) diff --git a/Examples/MAX32690/Unity_Test/README.md b/Examples/MAX32690/Unity_Test/README.md index 995d7a129c..961ccec778 100644 --- a/Examples/MAX32690/Unity_Test/README.md +++ b/Examples/MAX32690/Unity_Test/README.md @@ -1,39 +1,46 @@ ## Description -A basic example showing unit testing. +A basic unit testing example that leverages the Unity Test Project. In this example, a function that adds two `uint8_t` is tested. The tests can be run on the target microcontroller, or from the developer's host PC. -## Software - -Unity is configure to work both on target and your local PC. -By running make test you will trigger the test files to be ran on the PC, the compiler can be overwritten, but defaults to gcc. +Additional documentation on the Unity Test Project and its integration with the MSDK can also be found in the [MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/). +## Software ### Project Usage Universal instructions on building, flashing, and debugging this project can be found in the **[MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/)**. +Alternatively, the unit tests can be run from the developer's host PC with `make test`. + ### Project-Specific Build Notes -* This project comes pre-configured for the MAX32655EVKIT. See [Board Support Packages](https://analogdevicesinc.github.io/msdk/USERGUIDE/#board-support-packages) in the MSDK User Guide for instructions on changing the target board. +- Run `make test` to run the host-side unit tests. This will pull from the `test` folder inside the project and run them on the developer's host PC. ## Required Connections -If using the MAX32655EVKIT (EvKit\_V1): -- Connect a USB cable between the PC and the CN1 (USB/PWR) connector. -- Connect pins JP4(RX_SEL) and JP5(TX_SEL) to RX0 and TX0 header. -- Open an terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. -- Close jumper JP2 (LED0 EN). -- Close jumper JP3 (LED1 EN). -If using the MAX32655FTHR (FTHR\_Apps\_P1): -- Connect a USB cable between the PC and the J4 (USB/PWR) connector. -- Open an terminal application on the PC and connect to the board's console UART at 115200, 8-N-1. +If using the MAX32690EVKIT: +- Connect a USB cable between the PC and the CN2 (USB/PWR) connector. +- Install JP7(RX_EN) and JP8(TX_EN) headers. +- Open a terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. +- Close jumper JP5 (LED1 EN). +- Close jumper JP6 (LED2 EN). + +If using the MAX32690FTHR: +- Connect a USB cable between the PC and the J5 (USB/PWR) connector. +- Open a terminal application on the PC and connect to the EV kit's console UART at 115200, 8-N-1. + +If using the AD-APARD32690-SL: +- Connect a USB cable between the PC and the P10 (USB-C) connector. +- Connect a MAXPICO Debug adapter to P9 (SWD Connector) +- Open a terminal application on the PC and connect to the MAXPICO's console UART at 115200, 8-N-1. ## Expected Output The Console UART of the device will output these messages: ``` -Running Tests - -:49::FAIL: Expected 8 Was 7 +----------------------- +2 Tests 0 Failures 0 Ignored +OK ``` +