<!--
# Copyright 2014-2023 Jetperch LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
-->
[](https://github.com/jetperch/joulescope_driver/actions/workflows/packaging.yml)
# Joulescope Driver
Welcome to the Joulescope™ Driver project.
[Joulescope](https://www.joulescope.com) 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. 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:
1. Improved event-driven API based upon PubSub for easier integration with
user interfaces and other complicated software packages.
2. Improved portability for easier language bindings.
3. Improved performance.
For more information, see:
* [source code](https://github.com/jetperch/joulescope_driver)
* [documentation](https://joulescope-driver.readthedocs.io/en/latest/)
* [pypi](https://pypi.org/project/pyjoulescope-driver/)
* [Joulescope](https://www.joulescope.com/) (Joulescope web store)
* [jls](https://github.com/jetperch/jls) (Joulescope file format)
* [forum](https://forum.joulescope.com/)
## Python Installation
The python bindings work with Python 3.9 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](#ubuntu-2204-lts).
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 info * --verbose
Note that you may need to change "python" to "python3" or the full path.
You can also use a python
[virtual environment](https://docs.python.org/3/tutorial/venv.html).
## 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 22.04 LTS
For Ubuntu:
sudo apt install cmake build-essential ninja-build libudev-dev
You will also need to install the udev rules:
$ 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
### Build python bindings
Install a compatible version of Python 3.9 or later. To install
the pyjoulescope_driver dependencies:
cd {your/repos/joulescope_driver}
python -m pip install -U 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](https://visualstudio.microsoft.com/visual-cpp-build-tools/).
Raw data
{
"_id": null,
"home_page": "https://joulescope.readthedocs.io",
"name": "pyjoulescope-driver",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.9",
"maintainer_email": null,
"keywords": "Joulescope",
"author": "Jetperch LLC",
"author_email": "joulescope-dev@jetperch.com",
"download_url": "https://files.pythonhosted.org/packages/23/8a/fb59620be740e7b18fb9a37ec388e6e483024b59a06cbd1f454d7c28bc95/pyjoulescope_driver-1.5.2.tar.gz",
"platform": null,
"description": "<!--\n# Copyright 2014-2023 Jetperch LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n-->\n\n[](https://github.com/jetperch/joulescope_driver/actions/workflows/packaging.yml)\n\n\n# Joulescope Driver\n\nWelcome to the Joulescope\u2122 Driver project.\n[Joulescope](https://www.joulescope.com) is an affordable, precision DC energy\nanalyzer that enables you to build better products.\n\nThis user-space C library communicates with Joulescope products to configure \noperation and receive data. The first-generation driver introduced in 2019 was\nwritten in Python. While Python proved to be a very flexible language enabling\nmany user scripts, it was difficult to support other languages. \nThis second-generation driver launched in 2022 addresses several issues\nwith the first-generation python driver including:\n\n1. Improved event-driven API based upon PubSub for easier integration with \n user interfaces and other complicated software packages.\n2. Improved portability for easier language bindings.\n3. Improved performance.\n\nFor more information, see:\n\n* [source code](https://github.com/jetperch/joulescope_driver)\n* [documentation](https://joulescope-driver.readthedocs.io/en/latest/)\n* [pypi](https://pypi.org/project/pyjoulescope-driver/)\n* [Joulescope](https://www.joulescope.com/) (Joulescope web store)\n* [jls](https://github.com/jetperch/jls) (Joulescope file format)\n* [forum](https://forum.joulescope.com/)\n\n\n## Python Installation\n\nThe python bindings work with Python 3.9 and later.\nTo use the python bindings, ensure that you have a compatible version\nof python installed on your host computer. Then:\n\n python -m pip install pyjoulescope_driver\n\nFor Ubuntu, you will also need to [install the udev rules](#ubuntu-2204-lts).\n\nYou can then run the pyjoulescope_driver python entry points:\n\n python -m pyjoulescope_driver --help\n python -m pyjoulescope_driver scan\n python -m pyjoulescope_driver info\n python -m pyjoulescope_driver info * --verbose\n\nNote that you may need to change \"python\" to \"python3\" or the full path. \nYou can also use a python\n[virtual environment](https://docs.python.org/3/tutorial/venv.html).\n\n\n## Building\n\nEnsure that your computer has a development environment including CMake. \n\n\n### Windows\n\nInstall cmake and your favorite build toolchain such as \nVisual Studio, mingw64, wsl, ninja.\n\n### macOS\n\nFor macOS, install homebrew, then:\n\n brew install pkgconfig python3\n\n\n### Ubuntu 22.04 LTS\n\nFor Ubuntu:\n\n sudo apt install cmake build-essential ninja-build libudev-dev\n\nYou will also need to install the udev rules:\n\n $ wget https://raw.githubusercontent.com/jetperch/joulescope_driver/main/99-joulescope.rules\n $ sudo cp 99-joulescope.rules /etc/udev/rules.d/\n $ sudo udevadm control --reload-rules\n\n\n### Common\n\n cd {your/repos/joulescope_driver}\n mkdir build && cd build\n cmake ..\n cmake --build . && ctest .\n\nThis package includes a command-line tool, jsdrv:\n\n jsdrv --help\n jsdrv scan\n\n\n### Build python bindings\n\nInstall a compatible version of Python 3.9 or later. To install\nthe pyjoulescope_driver dependencies:\n\n cd {your/repos/joulescope_driver}\n python -m pip install -U requirements.txt\n\nYou should then be able to build the native bindings:\n\n python setup.py build_ext --inplace\n\nYou can build the package using isolation:\n\n python -m build\n\nDepending upon your system configuration, you may need to replace\n\"python\" with \"python3\" or the full path to your desired python installation.\n\nOn Windows, you may be prompted to install the \n[Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/).\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Joulescope\u2122 driver",
"version": "1.5.2",
"project_urls": {
"Bug Reports": "https://github.com/jetperch/pyjoulescope_driver/issues",
"Funding": "https://www.joulescope.com",
"Homepage": "https://joulescope.readthedocs.io",
"Source": "https://github.com/jetperch/pyjoulescope_driver/",
"Twitter": "https://twitter.com/joulescope"
},
"split_keywords": [
"joulescope"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f45f884d457125d56c6fec7ec578e7202756bc1ea6d5b598401a41ca85f8fe17",
"md5": "95a487443b1b7d230eba008ada334788",
"sha256": "ee8835affaf2e05c17273addc5f94cada15d23ed979085c5041d9f254ee1702f"
},
"downloads": -1,
"filename": "pyjoulescope_driver-1.5.2-cp310-cp310-macosx_10_9_universal2.whl",
"has_sig": false,
"md5_digest": "95a487443b1b7d230eba008ada334788",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": "~=3.9",
"size": 3357502,
"upload_time": "2024-05-08T15:02:35",
"upload_time_iso_8601": "2024-05-08T15:02:35.575324Z",
"url": "https://files.pythonhosted.org/packages/f4/5f/884d457125d56c6fec7ec578e7202756bc1ea6d5b598401a41ca85f8fe17/pyjoulescope_driver-1.5.2-cp310-cp310-macosx_10_9_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "225433aed7e63b8479c86cca973ce67cdf5239a185e61574c2c2752728c73828",
"md5": "fe8c50e2ea5f875615997b9db54d351b",
"sha256": "166d01f9947e78494b18b46840f2000e1de03e6b289fbaa76b00f41788058cbb"
},
"downloads": -1,
"filename": "pyjoulescope_driver-1.5.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "fe8c50e2ea5f875615997b9db54d351b",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": "~=3.9",
"size": 4544231,
"upload_time": "2024-05-08T15:02:38",
"upload_time_iso_8601": "2024-05-08T15:02:38.535359Z",
"url": "https://files.pythonhosted.org/packages/22/54/33aed7e63b8479c86cca973ce67cdf5239a185e61574c2c2752728c73828/pyjoulescope_driver-1.5.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e003442b04ab3ee06c2626a6b9f5a8cf1e405431e8a327688963c3e1a2cc2dd1",
"md5": "d8ad3e54aaca20a802c5f13b5d9e2cc5",
"sha256": "6a883df13f03e0b8649d021ef4d3c8be7c20dad8f2a270d21ceee57a5c9c40c2"
},
"downloads": -1,
"filename": "pyjoulescope_driver-1.5.2-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "d8ad3e54aaca20a802c5f13b5d9e2cc5",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": "~=3.9",
"size": 3009312,
"upload_time": "2024-05-08T15:02:40",
"upload_time_iso_8601": "2024-05-08T15:02:40.272323Z",
"url": "https://files.pythonhosted.org/packages/e0/03/442b04ab3ee06c2626a6b9f5a8cf1e405431e8a327688963c3e1a2cc2dd1/pyjoulescope_driver-1.5.2-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "28ca4c271879eef52e8912667230f33f3d11a2630bdad3b033be3c3bd3fdd963",
"md5": "8a7e225af5208f3960a53f513b6f523e",
"sha256": "78d0ec52869d0825105f7565d81c61145ccf5dd180813cc286236e8f57e64168"
},
"downloads": -1,
"filename": "pyjoulescope_driver-1.5.2-cp311-cp311-macosx_10_9_universal2.whl",
"has_sig": false,
"md5_digest": "8a7e225af5208f3960a53f513b6f523e",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": "~=3.9",
"size": 3357230,
"upload_time": "2024-05-08T15:02:41",
"upload_time_iso_8601": "2024-05-08T15:02:41.969552Z",
"url": "https://files.pythonhosted.org/packages/28/ca/4c271879eef52e8912667230f33f3d11a2630bdad3b033be3c3bd3fdd963/pyjoulescope_driver-1.5.2-cp311-cp311-macosx_10_9_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "97e16e2e0746552c32decc77f0b519ef21fa020555169f4fb038bcda9b48c1ce",
"md5": "4e2af5d22d7cad654fabb2cfc7d2f15c",
"sha256": "b27b4ed1e17db821249b175149061cc05ce3c399d39c89be1edb799bab3d45b5"
},
"downloads": -1,
"filename": "pyjoulescope_driver-1.5.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "4e2af5d22d7cad654fabb2cfc7d2f15c",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": "~=3.9",
"size": 4601602,
"upload_time": "2024-05-08T15:02:43",
"upload_time_iso_8601": "2024-05-08T15:02:43.612182Z",
"url": "https://files.pythonhosted.org/packages/97/e1/6e2e0746552c32decc77f0b519ef21fa020555169f4fb038bcda9b48c1ce/pyjoulescope_driver-1.5.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1a1860de483a2ff7b9365ca17ce71ad3e3da22a307ff4123661b9b2255236ac8",
"md5": "ab9f7896d810d4f99a5a490fe622ecb7",
"sha256": "d776cbdd18726b7b2b8949469adfb35fac359f5767624d9ca0148ad02347ddb1"
},
"downloads": -1,
"filename": "pyjoulescope_driver-1.5.2-cp311-cp311-win_amd64.whl",
"has_sig": false,
"md5_digest": "ab9f7896d810d4f99a5a490fe622ecb7",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": "~=3.9",
"size": 3009250,
"upload_time": "2024-05-08T15:02:45",
"upload_time_iso_8601": "2024-05-08T15:02:45.386598Z",
"url": "https://files.pythonhosted.org/packages/1a/18/60de483a2ff7b9365ca17ce71ad3e3da22a307ff4123661b9b2255236ac8/pyjoulescope_driver-1.5.2-cp311-cp311-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5be8f0402412225d79f7f2f822ea65c7aebdbf713c7cab19bbd7509cfc5d03c6",
"md5": "9f666bbb1bf8b5b4e8f5fa6ab78d494b",
"sha256": "ba5e9405d29f782ad8dff6d5bc463cae40bb8e37a915e4deb0b537efad9ac18c"
},
"downloads": -1,
"filename": "pyjoulescope_driver-1.5.2-cp312-cp312-macosx_10_9_universal2.whl",
"has_sig": false,
"md5_digest": "9f666bbb1bf8b5b4e8f5fa6ab78d494b",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": "~=3.9",
"size": 3354250,
"upload_time": "2024-05-08T15:02:47",
"upload_time_iso_8601": "2024-05-08T15:02:47.540182Z",
"url": "https://files.pythonhosted.org/packages/5b/e8/f0402412225d79f7f2f822ea65c7aebdbf713c7cab19bbd7509cfc5d03c6/pyjoulescope_driver-1.5.2-cp312-cp312-macosx_10_9_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b6cdf4d59850629b53084e2c4d56d2deb6e4f0ae0a8d3268e4bc7a0081dcf8c9",
"md5": "5d5e866735c365aeb9b15c2bafccac3e",
"sha256": "bd85ee2f4f5fae9ede048681ee18bc9b376e1abaa646794fae7c0aeb8201de73"
},
"downloads": -1,
"filename": "pyjoulescope_driver-1.5.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "5d5e866735c365aeb9b15c2bafccac3e",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": "~=3.9",
"size": 4599828,
"upload_time": "2024-05-08T15:02:49",
"upload_time_iso_8601": "2024-05-08T15:02:49.823873Z",
"url": "https://files.pythonhosted.org/packages/b6/cd/f4d59850629b53084e2c4d56d2deb6e4f0ae0a8d3268e4bc7a0081dcf8c9/pyjoulescope_driver-1.5.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "312efb83a62113cfec4ac15fd4fbc786b122afb2dfc6784d89c5ff90a57e8807",
"md5": "5ec143a292b581965bd531fa5b824175",
"sha256": "636b173b3ed881c33842f39efd04145be69e7226ae970797c6cf5772c65c84dd"
},
"downloads": -1,
"filename": "pyjoulescope_driver-1.5.2-cp312-cp312-win_amd64.whl",
"has_sig": false,
"md5_digest": "5ec143a292b581965bd531fa5b824175",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": "~=3.9",
"size": 3005658,
"upload_time": "2024-05-08T15:02:52",
"upload_time_iso_8601": "2024-05-08T15:02:52.325134Z",
"url": "https://files.pythonhosted.org/packages/31/2e/fb83a62113cfec4ac15fd4fbc786b122afb2dfc6784d89c5ff90a57e8807/pyjoulescope_driver-1.5.2-cp312-cp312-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "272dc4a0424ad7abccc039a14e111eb1f21fd570ee892ab954258e0c0cdaf59d",
"md5": "25a56613e5168a3cc594ef9afac823c7",
"sha256": "2df6a09f8d31ee7dfaa2a31941d43138d968f02f23943f082543aaed5d07914b"
},
"downloads": -1,
"filename": "pyjoulescope_driver-1.5.2-cp39-cp39-macosx_10_9_universal2.whl",
"has_sig": false,
"md5_digest": "25a56613e5168a3cc594ef9afac823c7",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": "~=3.9",
"size": 3358495,
"upload_time": "2024-05-08T15:02:54",
"upload_time_iso_8601": "2024-05-08T15:02:54.043165Z",
"url": "https://files.pythonhosted.org/packages/27/2d/c4a0424ad7abccc039a14e111eb1f21fd570ee892ab954258e0c0cdaf59d/pyjoulescope_driver-1.5.2-cp39-cp39-macosx_10_9_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "929283a2e27937db01e2c3e8b123602168c972f245450f5954c6f4beb8942583",
"md5": "90e1462af37378dbbe6f63fe80db224f",
"sha256": "b994dc23dee973c7f4ea0855e062c7681c1c373c4f29c63ea65f7cd52593622d"
},
"downloads": -1,
"filename": "pyjoulescope_driver-1.5.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "90e1462af37378dbbe6f63fe80db224f",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": "~=3.9",
"size": 4547318,
"upload_time": "2024-05-08T15:02:56",
"upload_time_iso_8601": "2024-05-08T15:02:56.599490Z",
"url": "https://files.pythonhosted.org/packages/92/92/83a2e27937db01e2c3e8b123602168c972f245450f5954c6f4beb8942583/pyjoulescope_driver-1.5.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ea743e30015c445b2bc9db3297d2707beb7e8e4014a749831e392614a728e902",
"md5": "a30b2a02a21eeae0b631a85f1493d0f5",
"sha256": "20299073d7d8a17826d16f01002198d5bd2a90cd505a886ba897b39b2df0a1f5"
},
"downloads": -1,
"filename": "pyjoulescope_driver-1.5.2-cp39-cp39-win_amd64.whl",
"has_sig": false,
"md5_digest": "a30b2a02a21eeae0b631a85f1493d0f5",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": "~=3.9",
"size": 3010009,
"upload_time": "2024-05-08T15:02:58",
"upload_time_iso_8601": "2024-05-08T15:02:58.986389Z",
"url": "https://files.pythonhosted.org/packages/ea/74/3e30015c445b2bc9db3297d2707beb7e8e4014a749831e392614a728e902/pyjoulescope_driver-1.5.2-cp39-cp39-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "238afb59620be740e7b18fb9a37ec388e6e483024b59a06cbd1f454d7c28bc95",
"md5": "c40e47ff23b225461222d7558d10c1c6",
"sha256": "f6b651bf9926bce2a2d0a7d89b7ab2287ca614ea022282826c8c01ea3acbdeb8"
},
"downloads": -1,
"filename": "pyjoulescope_driver-1.5.2.tar.gz",
"has_sig": false,
"md5_digest": "c40e47ff23b225461222d7558d10c1c6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.9",
"size": 3392564,
"upload_time": "2024-05-08T15:03:00",
"upload_time_iso_8601": "2024-05-08T15:03:00.772041Z",
"url": "https://files.pythonhosted.org/packages/23/8a/fb59620be740e7b18fb9a37ec388e6e483024b59a06cbd1f454d7c28bc95/pyjoulescope_driver-1.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-08 15:03:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jetperch",
"github_project": "pyjoulescope_driver",
"github_not_found": true,
"lcname": "pyjoulescope-driver"
}
JSON
