nus-logger 0.0.3

Auto-reconnecting Nordic UART Service (NUS) BLE logger.

NUS Logger

Auto‑reconnecting Nordic UART Service (NUS) BLE log collector for Zephyr / nRF Connect SDK devices.

---

✨ Highlights

• Zero‑config CLI: discover, connect, stream logs in one command.
• Resilient: automatic reconnect with exponential backoff (capped) & graceful exit.
• Readable timestamps: UTC (--ts) or local (--ts-local).
• Dual view: optional raw hex alongside decoded UTF‑8 text (--raw).
• Log persistence: safe append mode (rotation‑friendly) to any file.
• Cross‑platform: Windows / macOS / Linux using native Bluetooth via bleak.
• Library friendly: small, typed API (NUSClient, NUSLoggerController).
• Dependency‑light: just bleak (+ colorama on Windows for color support).

Installation

pip install nus-logger

Requires Python 3.9+.

Upgrade in place:

pip install -U nus-logger

Quick Start (CLI)

# 1. Zero-config interactive wizard (scan, pick device, choose options)
nus-logger

# 2. List advertising NUS devices (non-interactive)
nus-logger --list

# 3. Connect by (partial) name, show UTC timestamps, also log to file
nus-logger --name my-device --ts --logfile logs/session.txt

# 4. Show local timestamps and raw hex dump
nus-logger --name my-device --ts-local --raw

Module mode (equivalent):

python -m nus_logger --name my-device --ts

Press Ctrl-C to stop; the tool will attempt automatic reconnection until max retries.

CLI Reference

Environment variables override flags when corresponding flags are omitted.

Flag	Description	Env	Notes
--wizard	Interactive scan & option wizard	–	Default when no args
--list	List visible devices then exit	–	Passive scan only
--name SUBSTR	Match advertising name	NUS_NAME	Case-insensitive substring
--filter-addr SUBSTR	Prefer address containing substring	–	Helps disambiguate similar names
--ts / --ts-local	Add UTC or local timestamps	–	Mutually exclusive
--raw	Show hex bytes before decoded line	–	Two aligned columns
--logfile PATH	Append decoded lines to file	NUS_LOGFILE	File is created if missing
--timeout SECS	Scan / connect timeout	NUS_TIMEOUT	Applies to each attempt
--backoff SECS	Initial reconnect backoff	NUS_BACKOFF	Grows up to 15s cap
--max-retries N	Stop after N failed reconnects	NUS_MAX_RETRIES	Omit to retry indefinitely
--verbose	Dump discovered GATT structure once	–	For debugging / inspection

Show full help example

nus-logger --help

Programmatic Use

import asyncio
from nus_logger.ble_nus import NUSClient

async def main():
	client = NUSClient(name_substring="my-device")
	await client.connect()
	try:
		async for line in client.iter_lines():  # yields decoded UTF-8 log lines
			print(line)
			if "READY" in line:
				await client.write(b"ping\n")  # optional upstream write
	finally:
		await client.disconnect()

asyncio.run(main())

See nus_logger.nus_logger:main for full CLI orchestration (reconnect logic, backoff, etc.). Higher level automation can use NUSLoggerController for managed sessions.

Minimal Flow (Conceptual)

┌─────────────┐    BLE (NUS)    ┌──────────────┐            ┌─────────────┐
│ Zephyr App  │ ───────────────▶│   Adapter    │────────────▶│  bleak API  │
└─────────────┘                 └──────────────┘            └─────────────┘
	LOG_INF() lines                │                         │
				       ▼                         ▼
			       NUSClient (async)  ──▶  line iterator
				       │
				       ▼
			      NUSLoggerController
				       │
			stdout / hex column / logfile

Typical Workflow (Zephyr / nRF Connect)

To stream the Zephyr logging subsystem over BLE for nus-logger to consume you should enable the BLE logging backend with CONFIG_LOG_BACKEND_BLE=y. The backend handles formatting, buffering and transport so normal LOG_INF()/LOG_ERR() etc. arrive as text lines.

• Additional Kconfig options (buffer sizes, flow control, etc.) may be required for high log volume or long lines; consult the Zephyr sample: https://docs.zephyrproject.org/latest/samples/subsys/logging/ble_backend/README.html

Troubleshooting

Situation	Hint
No devices on Windows	Toggle Bluetooth off/on or airplane mode, verify advertising.
Linux permission errors	Ensure user in bluetooth group or grant CAP_NET_RAW to Python binary.
macOS permission prompt	Allow Bluetooth access in System Settings > Privacy & Security > Bluetooth.
Frequent disconnects	Reduce distance / interference; backoff resets after ~60s stable link.
Mixed devices with similar names	Use --filter-addr to prefer a known address substring.

Development

git clone https://github.com/smnmsr/nus-logger.git
cd nus-logger
pip install -e .[dev]
pytest

Linting is intentionally minimal; contributions should keep the code small and dependency‑light.

Versioning & Compatibility

The public surface is the CLI plus the NUSClient / NUSLoggerController classes. Minor releases may add kwargs/features; removals will occur only in a major bump following semantic versioning principles.

License

MIT License © 2025 Simon M. See LICENSE file for full text.

---

If this saves you time, a ⭐ on GitHub helps others discover it.