Joulescope Driver
Welcome to the Joulescope™ Driver project. Joulescope is an affordable, precision DC energy analyzer that enables you to build better products.
This user-space C library communicates with Joulescope products to configure
operation and receive data. It supports the JS110, JS220, and JS320
Joulescope models. The first-generation driver introduced in 2019 was
written in Python. While Python proved to be a very flexible language enabling
many user scripts, it was difficult to support other languages.
This second-generation driver launched in 2022 addresses several issues
with the first-generation python driver including:
- Improved event-driven API based upon PubSub for easier integration with user interfaces and other complicated software packages.
- Improved portability for easier language bindings.
- Improved performance.
For more information, see:
- getting started (Python and C lifecycle)
- streaming topics (statistics and sample payloads)
- source code
- documentation
- pypi
- Joulescope (Joulescope web store)
- jls (Joulescope file format)
- forum
Python Installation
The python bindings work with Python 3.12 and later. To use the python bindings, ensure that you have a compatible version of python installed on your host computer. Then:
python -m pip install pyjoulescope_driver
For Ubuntu, you will also need to install the udev rules.
You can then run the pyjoulescope_driver python entry points:
python -m pyjoulescope_driver --help
python -m pyjoulescope_driver scan
python -m pyjoulescope_driver info
python -m pyjoulescope_driver values --device js320
Note that you may need to change "python" to "python3" or the full path.
You can also use a python
virtual environment.
Building
Ensure that your computer has a development environment including CMake.
Windows
Install cmake and your favorite build toolchain such as Visual Studio, mingw64, wsl, ninja.
macOS
For macOS, install homebrew, then:
brew install pkgconfig python3
Ubuntu 26.04 LTS
For Ubuntu:
sudo apt install cmake build-essential ninja-build libudev-dev
You will also need to install the udev rules. If you are using a modern Linux distribution managed by systemd, using tag-based rules is most likely the right choice:
$ wget https://raw.githubusercontent.com/jetperch/joulescope_driver/main/72-joulescope.rules
$ sudo cp 72-joulescope.rules /etc/udev/rules.d/
$ sudo udevadm control --reload-rules
If your system is not managed by systemd or your user is not assigned a proper login seat (as may be the case when logging in via SSH), using group-based rules is necessery (note that the plugdev group must exist/be created and your user must belong to it):
$ wget https://raw.githubusercontent.com/jetperch/joulescope_driver/main/99-joulescope.rules
$ sudo cp 99-joulescope.rules /etc/udev/rules.d/
$ sudo udevadm control --reload-rules
Common
cd {your/repos/joulescope_driver}
mkdir build && cd build
cmake ..
cmake --build . && ctest .
This package includes a command-line tool, jsdrv:
jsdrv --help
jsdrv scan
The build also produces jsdrv_quickstart from
example/quickstart.c, the minimal C program
described in doc/getting_started.md.
Build python bindings
Install a compatible version of Python 3.12 or later. To install the pyjoulescope_driver dependencies:
cd {your/repos/joulescope_driver}
python -m pip install -U -r requirements.txt
You should then be able to build the native bindings:
python setup.py build_ext --inplace
You can build the package using isolation:
python -m build
Depending upon your system configuration, you may need to replace "python" with "python3" or the full path to your desired python installation.
On Windows, you may be prompted to install the Microsoft C++ Build Tools.
License
The Joulescope driver source code is licensed under the Apache-2.0 license. The project is free for commercial and non-commercial use. The bundled third-party libraries are provided under their respective licenses, as recorded in REUSE.toml.
The project is compliant with Reuse Software.
python -m pip install reuse[charset-normalizer]
python -m reuse lint
The reuse tool can generate a software bill of materials (SBOM) in SPDX format.
python -m reuse spdx
Each GitHub release includes this SPDX SBOM as the
joulescope_driver-vX.Y.Z.spdx asset.
1 maintainer
Metadata
1 maintainer
Release files for pyjoulescope-driver 2.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pyjoulescope_driver-2.5.0.tar.gz | 4.8 MB | Details |
Built distributions (wheels)
Total release size: 87.1 MB
Release files / pyjoulescope_driver-2.5.0.tar.gz
| Download URL | pyjoulescope_driver-2.5.0.tar.gz |
|---|---|
| Size | 4.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
68da2cb88df777a4529f00c672477d34c7d23498566233c67a0c708bab260f5c
|
|
BLAKE2b-256 checksum How to use checksums |
cdf414939f50a0a2bc0e2f1bfe7dced7780656fc1106b853c3cf4bcaf9362978
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / pyjoulescope_driver-2.5.0-cp314-cp314-win_arm64.whl
| Download URL | pyjoulescope_driver-2.5.0-cp314-cp314-win_arm64.whl |
|---|---|
| Size | 4.0 MB |
| Tags | CPython 3.14 Windows ARM64 |
|
SHA-256 checksum How to use checksums |
64533c7e6617a0a60d8383565622b3bc59b35e6a0c101047c28d4a2068415d50
|
|
BLAKE2b-256 checksum How to use checksums |
e00336a9f62880a5d24cb6f7e546c4fae7da273a6dc9f5909ed32f67b273188f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / pyjoulescope_driver-2.5.0-cp314-cp314-win_amd64.whl
| Download URL | pyjoulescope_driver-2.5.0-cp314-cp314-win_amd64.whl |
|---|---|
| Size | 4.0 MB |
| Tags | CPython 3.14 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
ada05944d42eea2e4c1f10a65004687a4e316dfef111ab69ca98b54d4338c5de
|
|
BLAKE2b-256 checksum How to use checksums |
86c3f265b668d4066d3de5d6cd6e473b7399d436cb4a6f6e766974629739ec72
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / pyjoulescope_driver-2.5.0-cp314-cp314-manylinux_2_28_x86_64.whl
| Download URL | pyjoulescope_driver-2.5.0-cp314-cp314-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 7.2 MB |
| Tags | CPython 3.14 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
7e5a0922bc7c0baaf447072e5b519b73e810185d03f1fe5fc998b319ec210e11
|
|
BLAKE2b-256 checksum How to use checksums |
b1e5040dd938f4a5fa931f7b642f1e1490a53b31250c45a36908a61503acb89e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / pyjoulescope_driver-2.5.0-cp314-cp314-manylinux_2_28_aarch64.whl
| Download URL | pyjoulescope_driver-2.5.0-cp314-cp314-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 7.1 MB |
| Tags | CPython 3.14 Linux glibc 2.28+ ARM64 |
|
SHA-256 checksum How to use checksums |
ee89fbb783f884f169bedd8e6c37eedb05f85a32b6cd1a6ade582eeb01e24fb3
|
|
BLAKE2b-256 checksum How to use checksums |
7f564ef52b25fdc4068c85aa99baa79a0121e4da0df94d79d04abc4e8323a976
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / pyjoulescope_driver-2.5.0-cp314-cp314-macosx_10_15_universal2.whl
| Download URL | pyjoulescope_driver-2.5.0-cp314-cp314-macosx_10_15_universal2.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.14 macOS 10.15+ universal2 (ARM64, x86-64) |
|
SHA-256 checksum How to use checksums |
4fb0375441082de38c9706c52d099767c4a591ec30e55fdba83e6477ce565687
|
|
BLAKE2b-256 checksum How to use checksums |
6f17b121a4f2f0b9b4e8293e94410a5a86921f5f930f71cfedad733c6920e574
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / pyjoulescope_driver-2.5.0-cp313-cp313-win_arm64.whl
| Download URL | pyjoulescope_driver-2.5.0-cp313-cp313-win_arm64.whl |
|---|---|
| Size | 4.0 MB |
| Tags | CPython 3.13 Windows ARM64 |
|
SHA-256 checksum How to use checksums |
f6df2de3e68e1e5ed915152339f06edcce7192dcdc331af07183935004cb8551
|
|
BLAKE2b-256 checksum How to use checksums |
ef1082effb1179bd24c9d77dc98ca6f629d03b9b753c617a9607f16d211a214e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / pyjoulescope_driver-2.5.0-cp313-cp313-win_amd64.whl
| Download URL | pyjoulescope_driver-2.5.0-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 4.0 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
a77fdf0bbdc0808d151c972c66bbe820574dc4a7fa5b45eeaa13dd68fb26f432
|
|
BLAKE2b-256 checksum How to use checksums |
013059d0183ae1857f854a2afb01d8d58674f8cf86578f233c799fdf8cb223f3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / pyjoulescope_driver-2.5.0-cp313-cp313-manylinux_2_28_x86_64.whl
| Download URL | pyjoulescope_driver-2.5.0-cp313-cp313-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 7.2 MB |
| Tags | CPython 3.13 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
99954ba2bb2bd696eb1e6b501b6fe5d94afc77dac3565f9fea9ea80e436fb7b2
|
|
BLAKE2b-256 checksum How to use checksums |
59c628810a7c8088c1b683be01a79499ee829197f4d924f6d8cba406ad79536e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / pyjoulescope_driver-2.5.0-cp313-cp313-manylinux_2_28_aarch64.whl
| Download URL | pyjoulescope_driver-2.5.0-cp313-cp313-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 7.1 MB |
| Tags | CPython 3.13 Linux glibc 2.28+ ARM64 |
|
SHA-256 checksum How to use checksums |
34eff7c4c8f79b81ee18ea191198fa40fe23a67c0a0721610c344ca5f8f90c32
|
|
BLAKE2b-256 checksum How to use checksums |
c95104997acf9933debe7192719b39e1425854b5f4a9dafbb3bace317280fb78
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / pyjoulescope_driver-2.5.0-cp313-cp313-macosx_10_13_universal2.whl
| Download URL | pyjoulescope_driver-2.5.0-cp313-cp313-macosx_10_13_universal2.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.13 macOS 10.13+ universal2 (ARM64, x86-64) |
|
SHA-256 checksum How to use checksums |
74ffdcada671b93f04b5e9f8b802ce507cce0c4c8a5592991e4b540486e4de74
|
|
BLAKE2b-256 checksum How to use checksums |
019442d7359f25c43cdf5406e92acb196e73ab09b64870c9b05c7db062096c24
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / pyjoulescope_driver-2.5.0-cp312-cp312-win_arm64.whl
| Download URL | pyjoulescope_driver-2.5.0-cp312-cp312-win_arm64.whl |
|---|---|
| Size | 4.0 MB |
| Tags | CPython 3.12 Windows ARM64 |
|
SHA-256 checksum How to use checksums |
14d98b4292de918d08a52842c6af950b410320222488b4df0d883f025c0fb3a5
|
|
BLAKE2b-256 checksum How to use checksums |
0ecd410ca7f6cee51d2ab583b22ec61fa893aed977cda8442ceff4532d3dcbf1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / pyjoulescope_driver-2.5.0-cp312-cp312-win_amd64.whl
| Download URL | pyjoulescope_driver-2.5.0-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 4.0 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
b7b8e0af430228bc9ccd80c8b6e6eaf99bd4b1ded012e2ea85292da119893527
|
|
BLAKE2b-256 checksum How to use checksums |
c8331f5cfc2ec5b9889c358289cf43293ed6128d61dee4baeadd0f809e936cf4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / pyjoulescope_driver-2.5.0-cp312-cp312-manylinux_2_28_x86_64.whl
| Download URL | pyjoulescope_driver-2.5.0-cp312-cp312-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 7.2 MB |
| Tags | CPython 3.12 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
ca2816689f098ca27009016000873d451aaea3e99add915e90973544f95b1dc9
|
|
BLAKE2b-256 checksum How to use checksums |
1ef84fa9dc387f443cfeb2b21b9094aeee2d2a4f8171f9be0d8f47a5f7bafcc6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / pyjoulescope_driver-2.5.0-cp312-cp312-manylinux_2_28_aarch64.whl
| Download URL | pyjoulescope_driver-2.5.0-cp312-cp312-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 7.1 MB |
| Tags | CPython 3.12 Linux glibc 2.28+ ARM64 |
|
SHA-256 checksum How to use checksums |
c148fc106e069c4267ded77741b1893948e29e35ce3fc710aafd847b53741802
|
|
BLAKE2b-256 checksum How to use checksums |
7a0cd3c3c267aa652d2c4ceb8d6673a46829a4bbb824a6f5f82b6a5c4231e52e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / pyjoulescope_driver-2.5.0-cp312-cp312-macosx_10_13_universal2.whl
| Download URL | pyjoulescope_driver-2.5.0-cp312-cp312-macosx_10_13_universal2.whl |
|---|---|
| Size | 5.2 MB |
| Tags | CPython 3.12 macOS 10.13+ universal2 (ARM64, x86-64) |
|
SHA-256 checksum How to use checksums |
c250c5e5111280a1b6430af19003b4af42717b5ec9970c72e8397e71fbf237dd
|
|
BLAKE2b-256 checksum How to use checksums |
bff5087ad20482f7cc08ecedf50415a368d716477a6a2ea03c2581acf50bc1af
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency log
