RadEye Comms SDK — Quick Guide

This quick guide is for developers integrating the RadEye Comms SDK (radeye-comms-sdk).

1. Overview

RadEye Comms is a proprietary device that enables direct communication between a RadEye device and a PC via a USB cable. This SDK is for further software development to integrate into your systems.

The SDK currently supports RadEye G-10 and SX. We are adding supports for more devices.

You can use RadEye Comms to read dosage rates and device configurations. In the future, we can add functions to configure RadEye devices.

2. System requirements


Python version	3.10 / 3.13
Platform	Windows x64 / Linux x64 / macOS arm64

If you require support for a specific Python version or system architecture, please contact us and we will try out best to fulfill your requirement.

2.1 Dependencies

pyserial ≥ 3.5

2.2 Hardware link

RadEye instrument (currently we support G-10 and SX, more device supports are coming)
Serial connection via a USB cable. Serial port name examples:
- Windows: COM3, COM10, …
- Linux: /dev/ttyACM0, …
- macOS: /dev/tty.usbmodern*, …

3. Installation

3.1 Install the wheel

Wheel tag (example)	Platform	Python Version
`cp310-cp310-win_amd64`	Windows x64	3.10
`cp310-cp313-win_amd64`	Windows x64	3.13
`cp310-cp310-linux_*_x86_64`	Linux x64	3.10
`cp310-cp313-linux_*_x86_64`	Linux x64	3.13
`cp310-cp310-macosx_*_arm64`	macOS Apple Silicon	3.10
`cp310-cp313-macosx_*_arm64`	macOS Apple Silicon	3.13

Copy the wheel file correct for your system environment and run:

python -m pip install radeye_comms_sdk-0.0.1-cp310-cp310-win_amd64.whl

3.2 Verify installation

python -c "import radeye_comms_sdk; print(radeye_comms_sdk.__file__)"

4. Examples

A few examples are supplied with the binary ready for you to test:

python examples/example_autosend.py COM10
# replace COM10 with the correct port name. See 2.3 for possible names.

5. License

Redistribution or reverse engineering of the binary is strictly prohibited. See LICENSE file supplied with the binary for details.