neng-mag-logger

Professional real-time magnetometer GUI for NEnG 3Dmag instruments.

Built with Tkinter and matplotlib. Connects via USB serial or WiFi TCP to a 3Dmag SCPI server running CircuitPython firmware, providing live magnetic field visualization and optional CSV data logging.

Features

• Real-time live chart — Bx, By, Bz field components (top) and |B| magnitude + temperature (bottom)
• Live readings panel — large numeric display of Bx, By, Bz (Gauss), |B|, Temperature (°C)
• USB and WiFi connection — Auto/Force USB/WiFi with auto-discovery of WiFi IP via USB
• Sensor detection — model, serial, firmware, sensor type (MLX90393/TLV493D/LIS2MDL/MMC5603), I2C address
• MLX90393 profile switching — FAST / DEFAULT / HIACC with one click
• CSV data logging — configurable output file, sampling rate (50–2000 ms), max buffer points
• SCPI console — direct command entry with Up/Down arrow history navigation
• Dark / Light theme — full matplotlib chart recolouring on toggle
• Thread-safe — all SCPI communication protected by threading.Lock

Supported Sensors

Installation

pip install neng-mag-logger

Or from source:

git clone https://gitlab.flavio.be/flavio/mag-logger.git
cd mag-logger
pip install -e .

Usage

mag-logger              # Launch the GUI
mag-logger --version    # Show version

Connection

All NEnG instruments support two transport modes, switchable at runtime in the GUI.

USB Serial

WiFi TCP

WiFi requires the device to be in PROD or DEV USB mode (not DEBUG) and a WiFi network configured on the device.

SCPI Quick Reference

Measurement

Connection & System

WiFi config persistence: CIRCUITPY must be unmounted (device in PROD mode) for :WIFI:CONFIG:SAVE to survive reboots. In DEV/DEBUG mode the filesystem is read-only from CircuitPython's side — saves apply only until the next power cycle.

Development

pip install -e ".[dev]"
./verify-code.sh          # lint + tests
./verify-code.sh --fix    # auto-fix lint issues

Release

./release.sh patch          # bug fix
./release.sh minor          # new feature
./release.sh minor --pypi   # also publish to PyPI

Tokens: ~/.config/mag-logger/release.env (see release.env.example)

License

Proprietary — (c) 2024-2026 Prof. Flavio ABREU ARAUJO, UCLouvain. All rights reserved.