Skip to main content

Python library for interaction with Meridian Innovation's SenXor(TM)

Project description

pysenxor

Python

A Python Library for Meridian Innovation's thermal imaging devices.

Overview

This package can let users interact with Meridian Innovation's thermal imaging devices.

Features

  • Device discovery and listing
  • Multiple interfaces supported(USB serial, TCP/IP, GPIO, etc.)(Coming soon)
  • Easy device connection and management
  • Configuration and status read and write
  • Non-blocking mode for frame reading
  • Thermal data processing utilities
  • Thread-safe for multi-threaded use
  • Lightweight and minimal dependencies(no cv2 or matplotlib required)

Installation

Production Installation

To install the library from PyPI, run the following command:

python -m pip install pysenxor-lite

To get the latest nightly version, you can install the library from the GitHub repository:

python -m pip install git+https://github.com/MeridianInnovation/pysenxor-lite.git

Development Installation

For development, you can install the project in editable mode:

git clone https://github.com/MeridianInnovation/pysenxor-lite.git
cd pysenxor-lite
python -m pip install -e .

or use uv:

git clone https://github.com/MeridianInnovation/pysenxor-lite.git
cd pysenxor-lite
uv sync

Usage

This section gives a short overview of how to use the pysenxor library. For more detailed examples, see the documentation.

Connect to a device

You can list available devices and connect to the first one:

from senxor import connect, list_senxor

devices = list_senxor("serial")
if not devices:
    raise ValueError("No devices found")

dev = connect(devices[0])

To check the connection and device info:

print(f"Connected to {dev.name}, is_streaming: {dev.is_streaming}")
print(f"Module: {dev.get_module_type()}, FW: {dev.get_fw_version()}, SN: {dev.get_sn()}")

When you are done, close the device:

dev.close()

Stream and read frames

After connecting, you can start the stream and read frames. read() returns (header, frame): header is a uint16 array or None, and frame is a 2D float32 array of temperature in Celsius.

dev.start_stream()

header, frame = dev.read()
print(f"Frame shape: {frame.shape}, dtype: {frame.dtype}")
print(f"Min: {frame.min()} C, max: {frame.max()} C, mean: {frame.mean():.1f} C")

By default read() blocks until a frame is available. If you pass block=False, it returns immediately and header and frame may be None when no frame is ready:

header, frame = dev.read(block=False)
if frame is None:
    print("No new frame")

To stop streaming but keep the connection open, call stop_stream(). To stop and disconnect, use close().

Process and visualize data

Frames are NumPy arrays, so you can index, slice, and use methods like .min(), .max(), and .mean(). The senxor.proc module provides normalization, scaling, and colormaps (without requiring cv2 or matplotlib):

import numpy as np
from senxor.proc import normalize, enlarge, colormaps, apply_colormap

uint8_image = normalize(frame, dtype=np.uint8)
float32_image = normalize(frame, dtype=np.float32)
enlarged = enlarge(frame, scale=2)

To get an RGB image, you can apply a built-in colormap such as inferno, jet, viridis, magma, plasma, or turbo:

cmap = colormaps["inferno"]
normalized = normalize(frame, dtype=np.float32)
colored_image = apply_colormap(normalized, lut=cmap)

You can display or save the result with cv2 or matplotlib. Note that cv2 uses BGR order:

import cv2
bgr = cv2.cvtColor(colored_image, cv2.COLOR_RGB2BGR)
cv2.imshow("senxor", bgr)
cv2.waitKey(0)
cv2.destroyAllWindows()
import matplotlib.pyplot as plt
plt.imshow(colored_image)
plt.show()

Learn more

License

This project is licensed under the Apache License 2.0.

You may freely use, modify, and distribute this software for both open-source and commercial purposes, subject to the terms of the license.

Copyright

Unless otherwise specified, all files in the source code directory(senxor/) are copyrighted by Meridian Innovation.

Copyright (c) 2025 Meridian Innovation. All rights reserved.

Contributing

We welcome contributions from the community.

By submitting a pull request, you certify compliance with the Developer Certificate of Origin (DCO). This means you assert that:

  • You wrote the code or have the right to submit it;
  • You grant us the right to use your contribution under the project license.

Please add the following line to your Git commit message to confirm DCO compliance:

Signed-off-by: Your Name your.email@example.com

You can automate this with git commit -s.

See more details in Contributing Guide.

Contact

For support or inquiries, please contact:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pysenxor_lite-3.1.3.tar.gz (66.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pysenxor_lite-3.1.3-py3-none-any.whl (78.6 kB view details)

Uploaded Python 3

File details

Details for the file pysenxor_lite-3.1.3.tar.gz.

File metadata

  • Download URL: pysenxor_lite-3.1.3.tar.gz
  • Upload date:
  • Size: 66.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.6.16

File hashes

Hashes for pysenxor_lite-3.1.3.tar.gz
Algorithm Hash digest
SHA256 509059d345d7e499099bebced90f2e7abc133e0c28b397f767fa6ac92857ebcb
MD5 228a5ae67f8c0b4113202a764e47ae71
BLAKE2b-256 a9f06753812a746253b6a6e03e70839de87ce98cc80058a841387be5790a20c0

See more details on using hashes here.

File details

Details for the file pysenxor_lite-3.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for pysenxor_lite-3.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6b0768da0ef6962f782c291399c73e911edf94f6c14dccff048968aca2fe4a18
MD5 84fc771d375e6060d3d52687789e7edb
BLAKE2b-256 9c0ad792d43225a72fac831df1ce19fb1dfe2496ba8e2bd93a0770c0e295eb0f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page