cn_tester

KO | EN

gitlite — search

#python #hacktoberfest #llm #golang #machine-learning #rust #docker #macos #java #windows #cli #vue #awesome-list #mcp

(★ 35)

c!n tester is a hardware and software system designed for testing ProMicro-like microcontrollers.

cn_tester Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# c!n tester: ProMicro-like Microcontroller Tester

## 🚀 Project Overview

The **c!n tester** is a dedicated hardware and software solution designed for automated functional testing of ProMicro-like microcontrollers (MCUs). Its primary goal is to provide a fast and reliable way to verify basic pin connectivity and functionality before deployment.

### 🚧 Current Status: Work In Progress (WIP)

The core testing logic and fundamental functionality are fully operational. However, active development is focused on improving the GUI and enhancing the overall user experience.

> [!IMPORTANT]
> **Bug Reports & Logging:**
> * **Any bug reports must be accompanied by logs.** Reports without logs cannot be diagnosed and will be closed.
> * **How to access logs:** Inside the GUI, click on the **USB connector image** at the center of the pinout visualization. This will open the log view showing real-time console outputs for both Master and Target MCUs.
> * If the application fails to start entirely, look for the `app_error.log` file created in the same directory as the executable.

## 🧱 Hardware System

![H032](https://raw.githubusercontent.com/aroum/cn_tester/main/pics/assembly.jpg)

The hardware consists of a custom Printed Circuit Board (PCB) housing two microcontrollers:

1. **Master MCU:** Controls the entire testing process, communicates with the host application, and manages test sequences.

2. **Target MCU:** This is the ProMicro-like microcontroller under test.

Essentially, the PCB represents a direct connection of the pins of the two microcontrollers; the same setup can be achieved using regular wires.

## 💻 Software System

![app)win_dark](https://raw.githubusercontent.com/aroum/cn_tester/main/pics/app_screenshot_win_dark.png)

**Technology Stack:**

* Python 3.10+
* PySide6 — used to create the graphical user interface (GUI).
* Nuitka — used to compile Python code into standalone executable files.
* platformio — used to compile MCU firmware.
* adafruit-nrfutil — used for flashing firmware onto microcontrollers.
* pyserial — provides communication between the computer and microcontrollers via COM ports.

All communication between the host application (software) and the MCUs is conducted via serial ports (COM ports).

Currently, there is no fully developed CLI application, but since both the Target and Master microcontrollers are connected to the computer via COM ports, you can interact with them directly using standard terminal commands.

## ⚙️ Testing Process Details

The system is designed for quick, repeatable functional checks. The Master MCU and the Target MCU communicate over dedicated lines to perform the tests.

### Test Sequence

The system uses an orchestrated handshake process to ensure reliable communication. On power-up, both MCUs send discovery messages. Once the application identifies and initializes the ports, the following sequence is performed under direct application control:

1. **Handshake & Initialization:** The application scans all COM ports (via **Auto Search** or manual selection), identifies the Master and Target, and sends an `INIT` command to synchronize them.

2. **All Pins HIGH:** The application commands both MCUs to enter the `ALL_HIGH` stage. The Target drives all pins HIGH, and the Master verifies the connectivity.

3. **All Pins LOW:** The application commands both MCUs to enter the `ALL_LOW` stage. The Target drives all pins LOW, and the Master verifies the state.

4. **Individual Pin Sequence:** The application orchestrates a per-pin sequence. It commands the Target to toggle a specific pin and then commands the Master to verify that specific pin's state. This step-by-step approach ensures maximum reliability and clear diagnostic feedback.

### Test Indicators

* **GUI Indicators:** The application provides real-time feedback for each test stage (All High, All Low, Sequence).
* **Pinout View:** A dynamic visualization shows exactly which pins passed or failed the test.
* **Master Hardware Button:** You can start the test by pressing the physical button on the Master MCU after it has been initialized by the application.

### Workflow for Testing a New Target

1. Connect the **Master MCU** to the host computer.
2. Open the **c!n tester** application.
3. Connect the new **Target MCU**.
4. Click **"Auto Search"** to automatically find and initialize both MCUs.
5. Click **"Run Test"** in the app OR press the physical **Button** on the Master MCU.
6. Wait for the test completion and observe the results in the Pinout View.
7. Insert a new Target MCU and repeat.

For now, the Master MCU is flashed manually using a uf2 file. Put the MCU into bootloader mode and copy the file to it.

## 📝 Usage Guide

The recommended and simplest way to use the application is by using the **pre-compiled binaries** available in the project's [Releases](https://github.com/aroum/cn_tester/releases/) section.

### 📦 Running Standalone Binaries (Recommended)

1. Download the executable file for your operating system from the project's [Releases](https://github.com/aroum/cn_tester/releases/) page.

2. **For Linux/macOS:** You must grant execution permissions before launching the binary:

```bash
   chmod +x cn_tester_app
   ```

3. **For Linux:** To allow the application to access /dev/ttyACM*, you need to add the current user to the dialout group:

```bash
   sudo usermod -a -G dialout $USERÍ
   ```

4. Flashing Feature Dependency: If you plan to use the target MCU flashing function, you must have the adafruit-nrfutil utility available on your system. You can ensure this in two ways:
     * Install via Pip : `pip install adafruit-nrfutil`.
     * Local Binary: Download a pre-compiled binary of [adafruit-nrfutil](https://github.com/adafruit/Adafruit_nRF52_nrfutil/releases) from its project releases and place it alongside the C!N tester app executable.
5. Launch the application:
   * **For Linux:** `./cn_tester_app_linux_x64`
   * **macOS:** `./cn_tester_app_macos_aarch64`
   * **Windows:** `cn_tester_win_x64.exe`

> [!TIP]
> To view or copy the logs for debugging, click on the **USB connector image** at the center of the pinout view in the application. See the note on [Bug Reports & Logging](#-project-overview) at the top of this document.

### 🐍 Running from Source (Development)

This method is recommended only for development or if you wish to modify the source code.

#### Prerequisites

Python 3.10 or newer.

#### Dowloand source code

```
git clone https://github.com/aroum/cn_tester.git
```

#### Install Dependencies

```
pip install -r requirements.txt
```

if you use conda:

```
conda install libpython-static
```

#### Execute the Application

```
python main.py
```

### 🏗️ Building Standalone Binaries (Nuitka)

To compile the application into a standalone executable that does not require a local Python 3.10+ environment, use the Nuitka compiler. For details, see the [nuitka documentation](https://nuitka.net/user-documentation/user-manual.html).

#### Dowloand source code

```
git clone https://github.com/aroum/cn_tester.git
```

#### Install dependencies

```
pip install -r requirements_build.txt
```

#### 🍏 macOS Compilation

##### Prerequisites

* [Xcode](https://apps.apple.com/us/app/xcode/id497799835?mt=12)
* [Homebrew](https://brew.sh)

##### Create and activate a clean environment

``` bash
brew install python@3.10 nuitka
python3.10 -m venv /tmp/cleanenv
source /tmp/cleanenv/bin/activate
# source /tmp/cleanenv/bin/activate.fish #for fish
pip install -r requirements_build.txt
```

##### Compilation

``` bash
nuitka  \
   --onefile  \
   --macos-create-app-bundle \
   --macos-app-icon=ICON_PATH \
   --macos-app-name=MACOS_APP_NAME \
   --macos-app-icon=icon/icon.png=icon/icon.png 
   --enable-plugin=pyside6  \
   --include-data-files=icon/icon.png=icon/icon.png \
   --include-data-dir=mcu_firmware=mcu_firmware \
   --include-data-files=mcu_firmware/firmware_target.hex=mcu_firmware/firmware_target.hex \
   --output-dir=build \
   --product-name="C!N Tester GUI" \
   --clean-cache=all \
   --output-filename=cn_tester_app.app \
   main.py
```

#### 🪟 Windows Compilation

##### Prerequisites

* Visual Studio C++ build tools

##### Compilation

``` bash
call "C:\Program Files\Microsoft Visual Studio\2022\BuildTools\VC\Auxiliary\Build\vcvars64.bat"

nuitka ^
  --onefile ^
  --windows-console-mode=disable ^
  --enable-plugin=pyside6 ^
  --windows-icon-from-ico=icon/icon.ico ^
  --include-data-files=icon/icon.png=icon/icon.png ^
  --include-data-dir=mcu_firmware=mcu_firmware ^
  --include-data-files=mcu_firmware/firmware_target.hex=mcu_firmware/firmware_target.hex ^
  --output-dir=build ^
  --product-name="C!N Tester GUI" ^
  --file-version=0.1.0 ^
  --clean-cache=all ^
  --output-filename=cn_tester_app.exe ^
  main.py
```

#### 🐧 Linux Compilation

##### Prerequisites

* python3-dev package
* GCC
* patchelf

##### Compilation

``` bash
nuitka  \
   --onefile  \
   --enable-plugin=pyside6  \
   --include-data-files=icon/icon.png=icon/icon.png \
   --include-data-dir=mcu_firmware=mcu_firmware \
   --include-data-files=mcu_firmware/firmware_target.hex=mcu_firmware/firmware_target.hex \
   --output-dir=build \
   --product-name="C!N Tester GUI" \
   --clean-cache=all \
   --output-filename=cn_tester_app.bin \
   main.py
```

### 💡 Future Plans

We have several improvements planned for the upcoming sprints:

* Bluetooth Functionality Testing: Planning and implementation of test sequences to verify the basic operation of the Target MCU's Bluetooth features.
* Setup CI/CD with GitHub Actions: Implement GitHub Actions workflows for automated cross-platform compilation of the application binaries and firmware flashing.
* Add some renders of the PCB and case, as well as screenshots of the app.
* Work on the documentation.

### 🙏 Acknowledgements

A special thank you to the following community members:

Compilation & Testing: [@Rowb](https://github.com/Rowb), [@turtle-bazon](https://github.com/turtle-bazon)

cn_tester

cn_tester Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

cn_tester

cn_tester Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README