Skip to main content

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

Reason this release was yanked:

The colormaps not being loaded correctly in build sdists and wheels.

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, run the following command:

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

Examples

For beginners, there are some examples in the examples folder.

These examples provide a set of actual use cases of the senxor library.

  • Connect device, read thermal data, convert data to image, use cv2 to display the image stream.
  • Use thread to read data in background.
  • Create a simple GUI application to display the thermal camera stream.

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.1.tar.gz (53.4 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.1-py3-none-any.whl (63.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pysenxor_lite-3.1.1.tar.gz
Algorithm Hash digest
SHA256 9c18dc1ea095629a13b58306344c6e9b0ea8d7e416fa9dc41f345f69b696be2e
MD5 fc821aaa94990c5ac2446010c9b8dc70
BLAKE2b-256 bc46d9b7edad78ede7c2fa912ec8d0c63a5033d0810a3c47dd3fd47a935f6d9a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pysenxor_lite-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 aafa21ef8b620802fb1b34076993e998cd28287fe5a022c2c28133b53802cee1
MD5 10efe14180333b3018e06e2c639e3f64
BLAKE2b-256 e174e222c6849bb9f1ce03e0d8d75c4b5e45bfe45668272ca7c772c13dcb2863

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