python-chi-edge 0.3.1

Manage edge devices for use with the CHI@Edge IoT/Edge testbed.

python-chi-edge

CLI for enrolling and managing your own edge devices in the Chameleon testbed.

What this is for

You have a single-board computer (Like a Raspberry Pi 4/5, Nvidia Jetson, ...) and you want to add it to CHI@Edge so that it can be used for Computer Science related Research and Education, by yourself, classmates or coworkers, or the larger Chameleon user community. This tool handles device registration, OS image configuration, and ongoing device management.

You do NOT need this tool to use devices that are already enrolled. If you just want to reserve and run containers on existing CHI@Edge hardware, use the web dashboard or the python-chi SDK.

Prerequisites

• A Chameleon account with an active allocation
• A clouds.yaml or openrc file from the CHI@Edge dashboard
• Python 3.9+
• Physical access to the device you're enrolling

Install

pip install python-chi-edge

Enrollment workflow

1. Register your device

chi-edge device register \
  --contact-email [e-mail] \
  --machine-name raspberrypi5 \
  my-device

After this stage, the device will appear with (2/4 checks) passing.

2. Bake the OS image

Download the appropriate balenaOS image for your device, then configure it for the testbed:

chi-edge device bake --image balena.img <device-uuid>

3. Flash and boot

Write the baked image to your device's storage (microSD or eMMC) using balenaEtcher or dd, then power on. The device should appear healthy (4/4 checks) within a few minutes.

Device management

Command	Description
chi-edge device list	List your registered devices
chi-edge device show <name>	Show device details and health
chi-edge device set	Update device configuration
chi-edge device delete <name>	Remove a device
chi-edge device sync <name>	Force device re-sync

Configuration

Uses OpenStack clouds.yaml or environment variables for authentication. Specify the cloud with --os-cloud or set OS_CLOUD.

Documentation

• CHI@Edge enrollment guide — full walkthrough with screenshots
• CHI@Edge user docs — reservations, containers, peripherals
• Chameleon docs — broader platform documentation

License

Apache 2.0