Skip to content

Build & Upload Guide

This guide explains how to build and upload the latest kurikintons firmware to your OSECHI device.

1. Build Firmware

Build the v2 firmware:

task v2:build

A successful build prints RAM and Flash usage:

RAM:   [=         ]  14.3% (used 46880 bytes from 327680 bytes)
Flash: [===       ]  27.8% (used 363456 bytes from 1310720 bytes)

2. Upload Firmware

Connect your OSECHI device via USB, then upload:

task v2:upload

If the upload fails, check that no other process (e.g. the serial monitor) is holding the serial port open.

3. Monitor Output

After uploading, open the serial monitor to verify detections:

task monitor

This opens a serial monitor at 115200 baud. Press Ctrl-C to quit.

Available commands:

  • S or GET_STATUS - Show device configuration
  • U or GET_UPTIME - Show uptime
  • H or GET_HELP - Show all commands

Output format: JSONL (one JSON object per detection)

Example output:

{"type":"event","status":"ok","sent_us":1748012345678901,"hit1":45,"hit2":38,"hit3":42,"detected_us":1748012345678456}

Field descriptions:

  • sent_us: Timestamp when the message was sent (envelope field)
  • detected_us: Timestamp when the cosmic ray was detected (event payload)
  • hit1, hit2, hit3: Signal counts for each detection channel

Troubleshooting:

  • No output? Check serial port connection
  • Errors? See the Getting Started overview for help

See Also