https://github.com/raleighlittles/gq_geiger_counter_comm_protocol

[WIP] A Rust implementation of the GQ Geiger Communication Protocol
https://github.com/raleighlittles/gq_geiger_counter_comm_protocol

egui-example geiger-counter gq-gmc rfc1801 rust

Last synced: 3 months ago
JSON representation

[WIP] A Rust implementation of the GQ Geiger Communication Protocol

• Host: GitHub
• URL: https://github.com/raleighlittles/gq_geiger_counter_comm_protocol
• Owner: raleighlittles
• Created: 2023-08-11T07:10:07.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-03-17T05:20:27.000Z (3 months ago)
• Last Synced: 2025-03-17T06:27:54.380Z (3 months ago)
• Topics: egui-example, geiger-counter, gq-gmc, rfc1801, rust
• Language: Rust
• Homepage:
• Size: 1.47 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
![build-badge](https://github.com/raleighlittles/GQ_Geiger_Counter_Comm_Protocol/actions/workflows/main.yml/badge.svg)

# Background

A company called GQ makes "smart" nuclear radiation detecting devices aka ["geiger counters"](https://en.wikipedia.org/wiki/Geiger_counter). These devices come with a USB port which provides a serial interface to the device, intended for data logging usage.

![geiger counter photo](./docs/gq_gmc_500-product-photo.jpg)

GQ published their "RFC" which provides the serial port interface specifications. See `RFC1801.txt`.

# About

This project consists of helper tools for using your GQ GMC.

There's 3 main functionalities provided:

1. A simple GUI application for controlling system parameters and device buttons:

![GUI screenshot](./docs/gui.png)

This is particularly useful if your device is out of reach or if the physical buttons no longer work for whatever reason.

2. A "timesync" feature, allowing you to synchronize your geiger counter with your host PC's time. This is useful since these devices don't have any kind of NTP functionality.

3. A CSV logging feature. This logs the geiger counter's readings directly to a CSV file, and is useful when you need to take long-running measurements that would exceed the geiger counter's on-device storage.

![csv example](./docs/csv_screenshot.png)

5. A config dump feature. 🚧 This lets you see a parsed version of the device's configuration memory and take backups of it.

# Usage

Run the binary providing the first and second arguments as the serial device name and baud rate, and then thirdly, the option you wish to use, e.g.:

```bash

$ ./gq_gmc /dev/ttyUSB0 115200 --gui

```

to launch the GUI

```bash

$ ./gq_gmc /dev/ttyUSB0 115200 --timesync

```

to do the time synchronization

```bash

$ ./gq_gmc /dev/ttyUSB0 115200 --log 

```

to store records to CSV file.