C0-microSD Utilities

This repository offers a set of common C and Python libraries for building host applications that interact with the Signaloid C0-microSD hot-pluggable hardware module, as well as the C0_microSD_toolkit, which you can use to flash new bitstreams and firmware to the device.

Interfacing with the Signaloid C0-microSD

When connected to a host computer, the Signaloid C0-microSD presents itself as an unformatted block storage device. Communication with the device is achieved through block reads and writes to a set of pre-defined addresses. The C0-microSD can operate in two different modes when connected to a host: Bootloader mode and Signaloid SoC mode.

Bootloader mode: This mode allows flashing new bitstreams and firmware to the device.
Signaloid SoC mode: This is the built-in Signaloid C0 SoC, which features a subset of Signaloid's uncertainty-tracking technology.

Interfacing with the C0-microSD varies depending on the active mode.

In the src/ folder, you will find common functions and classes for building C and Python applications that interact with the C0-microSD when the Signaloid SoC mode is active.

Using the `C0_microSD_toolkit.py` tool

You can use the C0_microSD_toolkit.py Python script to configure the C0-microSD and flash new firmware. The script is written and tested in Python 3.11 on MacOS 14.5 and does not use any additional libraries. Following are the program's command-line arguments and usage examples:

usage: C0_microSD_toolkit.py [-h] -t TARGET_DEVICE [-b INPUT_FILE] [-u | -q | -w | -s | -i] [-f]

Signaloid C0_microSD_toolkit. Version 1.1

options:
  -h, --help        Show this help message and exit.
  -t TARGET_DEVICE  Specify the target device path.
  -b INPUT_FILE     Specify the input file for flashing (required with -u, -q, or -w).
  -p PAD_SIZE       Pad input file with zeros to target size.
  -u                Flash user data.
  -q                Flash new Bootloader bitstream.
  -w                Flash new Signaloid SoC bitstream.
  -s                Switch boot mode.
  -i                Print target C0-microSD information, and run data verification.
  -y                Flash warmboot sector.
  -f                Force flash sequence (do not check for bootloader).

Important

All options except of -s require the C0-microSD to be in Bootloader mode.

Examples:

The following examples assume that the C0-microSD is located in/dev/sda.

Flash new custom user bitstream:

sudo python3 ./C0_microSD_toolkit.py -t /dev/sda -b user-bitstream.bin

Flash new user data:

sudo python3 ./C0_microSD_toolkit.py -t /dev/sda -b program.bin -u

Flash new Bootloader bitstream:

sudo python3 ./C0_microSD_toolkit.py -t /dev/sda -b bootloader-bitstream.bin -q

Flash new Signaloid SoC bitstream:

sudo python3 ./C0_microSD_toolkit.py -t /dev/sda -b signaloid-soc.bin -w

Toggle boot mode of C0-microSD:

sudo python3 ./C0_microSD_toolkit.py -t /dev/sda -s

Print target C0-microSD information and verify loaded bitstreams:

sudo python3 ./C0_microSD_toolkit.py -t /dev/sda -i

Note

Using the -s option will toggle the active configuration. So, if the device has booted in Bootloader mode, this option will switch to Signaloid Core mode, and vice versa.

C0-microSD+ Utilities

This repository includes C and python libraries for the Signaloid C0-microSD+ compute module, as well as the C0_microSD_plus_toolkit, which you can use to flash new bitstreams and firmware to the device.

Interfacing with the Signaloid C0-microSD+

When connected to a host computer, the Signaloid C0-microSD+ presents itself as an unformatted block storage device. The host computer communicates with the device through block reads and writes to a set of pre-defined addresses. In contrast to the C0-microSD, the C0-microSD+ operates in a single mode, which supports flashing and running new application binaries, as well as updating the FPGA bitstream.

Using the `C0_microSD_plus_toolkit.py` tool

You can use the C0_microSD_plus_toolkit.py Python script to configure the C0-microSD+ and flash new firmware. The script is written and tested in Python 3.11 on MacOS 14.5 and does not use any additional libraries. Following are the program's command-line arguments and usage examples:

usage: C0_microSD_plus_toolkit.py [-h] target_device <command> ...

Signaloid C0-microSD-plus-toolkit. Version 1.0

positional arguments:
  target_device      Target device path
  <command>
    info             Print target C0-microSD+ info and run bitstream verification.
    core             Start or stop the Signaloid SoC core
    flash-application
                     Flash an application binary
    flash-bitstream  Flash a bitstream file

options:
  -h, --help         show this help message and exit

Examples:

The following examples assume that the C0-microSD is located in/dev/sda.

Flash new Signaloid SoC application binary:

sudo python C0_microSD_plus_toolkit.py /dev/sda flash-application program.bin

Flash new FPGA bitstream:

sudo python C0_microSD_plus_toolkit.py /dev/sda flash-bitstream bitstream.bin

Print target C0-microSD+ information and verify loaded bitstreams:

sudo python C0_microSD_plus_toolkit.py /dev/sda info

Start Signaloid SoC core:

sudo python C0_microSD_plus_toolkit.py /dev/sda core start

Stop and reset Signaloid SoC core:

sudo python C0_microSD_plus_toolkit.py /dev/sda core stop

SD-Dev utilities

Using the `SD_Dev_toolkit.py` tool

You can use the SD_Dev_toolkit.py to detect and power-cycle the SD cards on-board the SD-Dev.

usage: SD_Dev_toolkit.py [-h] [-p]

Signaloid SD_Dev_toolkit. Version 0.1

options:
  -h, --help         Show this help message and exit.
  -p, --power-cycle  Power-cycle the onboard full-size SD and microSD cards.

Using the `SD_Dev_power_measure.py` tool

You can use the SD_Dev_power_measure.py to read and log power measurement data using the SD-Dev on-board current sense circuitry. ADC channel 0 corresponds to the full-size SD card socket and channel 1 to the microSD card socket. For this functionality to work, you must first enable the I2C kernel module. If you use one of the official Raspberry-Pi OS images, you can do that using the raspi-config command.

usage: SD_Dev_power_measure.py [-h] [-s SMBUS_NUMBER] [-o OUTPUT_FILENAME] [-c {0,1}] [-g {1,2,4,8}] [-r {12,14,16}]

Signaloid SD_Dev_power_measure. Version 0.1

options:
  -h, --help            Show this help message and exit.
  -s SMBUS_NUMBER, --smbus-number SMBUS_NUMBER
                        Specify the target smbus number. (default: 1)
  -o OUTPUT_FILENAME, --output_filename OUTPUT_FILENAME
                        Filename of output csv file. When set, the application will log measurements to this file. (default: None)
  -c {0,1}, --channel {0,1}
                        ADC channel. Channel 0 corresponds to the full-size SD card socket and channel 1 to the microSD card socket. (default: 1)
  -g {1,2,4,8}, --gain {1,2,4,8}
                        ADC Programmable Gain Amplifier (PGA) gain. (default: 4)
  -r {12,14,16}, --samle-rate-bits {12,14,16}
                        Sample bits. (default: 12)

The `signaloid_api` module

You can use the signaloid_api module to build and download binaries for applications that support uncertainty-tracking on the Signaloid SoC, from Signaloid's API. This module provides both a command-line interface and a Python API for programmatic usage.

For detailed documentation and examples, please see the signaloid_api README.

Error Handling

The module provides consistent error handling with detailed error messages. When an error occurs, you'll see output in the following format:

Action: {action_name}
Status Code: {http_status_code}
Headers: {response_headers}
Response Body: {error_details}
{action_name} failed: {error_details}

For example, when hitting the repository limit:

Action: Repository connection
Status Code: 403
Headers: {'Content-Type': 'application/json', ...}
Response Body: {
  "error": "Forbidden",
  "message": "Repositories limit reached. Upgrade your account at https://signaloid.io/billing."
}
Repository connection failed: {'error': 'Forbidden', 'message': 'Repositories limit reached. Upgrade your account at https://signaloid.io/billing.'}

Common error scenarios include:

Repository limit reached
Invalid API key
Repository not found
Build failures
Network errors

Quick Start

# Download a binary using repository ID
python -m src.python.signaloid_api.core_downloader --api-key YOUR_API_KEY --repo-id YOUR_REPO_ID

# Build directly from a GitHub repository URL
python -m src.python.signaloid_api.core_downloader --api-key YOUR_API_KEY --repo-url https://github.com/signaloid/Signaloid-C0-microSD-Demo-Calculator

# For help and more options
python -m src.python.signaloid_api.core_downloader --help

Example Output

When using a GitHub repository URL, the tool will:

Verify the repository exists and has a src directory
Connect the GitHub repository to the Signaloid Cloud Developer Platform
Build the application with the specified core (default: C0-microSD-N)
Download the resulting binary as buildArtifacts.tar.gz

The downloaded binary can then be flashed to your C0-microSD device using the C0_microSD_toolkit.py script.

$ python -m src.python.signaloid_api.core_downloader --api-key YOUR_API_KEY --repo-url https://github.com/signaloid/Signaloid-C0-microSD-Demo-Calculator

Verifying GitHub repository: https://github.com/signaloid/Signaloid-C0-microSD-Demo-Calculator
Repository signaloid/Signaloid-C0-microSD-Demo-Calculator is valid and has a src directory
Creating Signaloid repository from GitHub URL: https://github.com/signaloid/Signaloid-C0-microSD-Demo-Calculator
Repository created with ID: rep_5c8104c6bb47468bbce9e0d1a83d2123

Using C0-microSD-N (default)

Creating build for repository rep_5c8104c6bb47468bbce9e0d1a83d2123 with C0-microSD-N...
Build created with ID: bld_ddff3fd873304eccaf68b7ce6f277123

Waiting for build to complete...
Build status: Initialising
Build status: Completed

Getting build outputs...
Build outputs retrieved

Build output:


Downloading binary...
Binary downloaded to: buildArtifacts.tar.gz

Name		Name	Last commit message	Last commit date
Latest commit History 20 Commits
src		src
.flake8		.flake8
.gitignore		.gitignore
C0_microSD_plus_toolkit.py		C0_microSD_plus_toolkit.py
C0_microSD_toolkit.py		C0_microSD_toolkit.py
LICENSE		LICENSE
README.md		README.md
SD_Dev_power_measure.py		SD_Dev_power_measure.py
SD_Dev_toolkit.py		SD_Dev_toolkit.py
poetry.lock		poetry.lock
poetry.toml		poetry.toml
pyproject.toml		pyproject.toml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

C0-microSD Utilities

Interfacing with the Signaloid C0-microSD

Using the `C0_microSD_toolkit.py` tool

Examples:

C0-microSD+ Utilities

Interfacing with the Signaloid C0-microSD+

Using the `C0_microSD_plus_toolkit.py` tool

Examples:

SD-Dev utilities

Using the `SD_Dev_toolkit.py` tool

Using the `SD_Dev_power_measure.py` tool

The `signaloid_api` module

Error Handling

Quick Start

Example Output

About

Uh oh!

Releases

Packages

Uh oh!

Contributors 2

Languages

License

signaloid/C0-microSD-utilities

Folders and files

Latest commit

History

Repository files navigation

C0-microSD Utilities

Interfacing with the Signaloid C0-microSD

Using the C0_microSD_toolkit.py tool

Examples:

C0-microSD+ Utilities

Interfacing with the Signaloid C0-microSD+

Using the C0_microSD_plus_toolkit.py tool

Examples:

SD-Dev utilities

Using the SD_Dev_toolkit.py tool

Using the SD_Dev_power_measure.py tool

The signaloid_api module

Error Handling

Quick Start

Example Output

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 2

Languages

Using the `C0_microSD_toolkit.py` tool

Using the `C0_microSD_plus_toolkit.py` tool

Using the `SD_Dev_toolkit.py` tool

Using the `SD_Dev_power_measure.py` tool

The `signaloid_api` module

Packages