digital-multimeter


Namedigital-multimeter JSON
Version 0.5.3 PyPI version JSON
download
home_page
SummaryDigital Multimeter provides both a CLI interface and a Python API interface to receive data from a variety of digital multimeters.
upload_time2023-07-31 07:53:15
maintainer
docs_urlNone
authorNicholas de Jong
requires_python>=3.8,<4.0
licenseBSD-2-Clause
keywords multimeter digital multimeter dmm digitech digitek tekpower unitrend voltcraft
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Digital Multimeter
[![PyPi](https://img.shields.io/pypi/v/digital-multimeter.svg)](https://pypi.python.org/pypi/digital-multimeter/)
[![Python Versions](https://img.shields.io/pypi/pyversions/digital-multimeter.svg)](https://github.com/ndejong/digital-multimeter/)
[![Read the Docs](https://img.shields.io/readthedocs/digital-multimeter)](https://digital-multimeter.readthedocs.io)
![License](https://img.shields.io/github/license/ndejong/digital-multimeter.svg)

Digital Multimeter provides both a CLI and Python API interface to receive data 
from a variety of digital multimeters.  

See the list of supported multimeters [here](https://digital-multimeter.readthedocs.io/en/latest/supported-multimeters/).

## Features
* Command line and Python module interface to digital multimeters
* Continuous live data readings (using `--count 0`)
* Output in **json** or **csv** formats
* Output to console or file, allowing other tools to pickup and use the data
* Configuration via config-file or environment-variables
* Easy to expand for new digital-multimeter protocols
* Easy installation using PyPI `pip`
* Documentation and examples at [digital-multimeter.readthedocs.io](https://digital-multimeter.readthedocs.io)

## Installation
```shell
user@computer:~$ pip install [--upgrade] digital-multimeter
```

## CLI Usage Example
Continuously read the digital-multimeter and pipe the JSON output through `jq` to 
make the JSON output look prettier.
```shell
user@computer:~$ dmm read --connect /dev/ttyUSB0 --count 0 | jq .
{
  "reading": {
    "value": 156.70000000000002,
    "unit_name": "volts",
    "unit_symbol": "V",
    "scale": 0.001,
    "scale_name": "milli",
    "scale_symbol": "m",
    "scaled_value": 0.15670000000000003,
    "is_relative": false
  },
  "instrument": {
    "module": "MultimeterDigitechQM1538",
    "operation_mode": "voltage_dc",
    "low_battery": false,
    "is_hold": false
  },
  "time": {
    "elapsed": 0.349347334,
    "interval": 0.349347334,
    "timestamp": 1605936374.7694516,
    "unit_name": "second",
    "unit_symbol": "s"
  }
}
```

## Python API Usage
Python-module documentation is available [here](https://digital-multimeter.readthedocs.io/en/latest/api/digitalmultimeter/).

## Project
* Github - [github.com/ndejong/digital-multimeter](https://github.com/ndejong/digital-multimeter)
* PyPI - [pypi.python.org/pypi/digital-multimeter](https://pypi.python.org/pypi/digital-multimeter/)
* ReadTheDocs - [digital-multimeter.readthedocs.io](https://digital-multimeter.readthedocs.io)

---
Copyright &copy; 2021-2023 [Nicholas de Jong](https://www.nicholasdejong.com)


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "digital-multimeter",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "multimeter,digital multimeter,dmm,Digitech,Digitek,TekPower,UniTrend,Voltcraft",
    "author": "Nicholas de Jong",
    "author_email": "contact@nicholasdejong.com",
    "download_url": "https://files.pythonhosted.org/packages/d3/7d/4b997d5d106eabae2001942d1415de242cb0afb9128e21b1aacb2bc4dc68/digital_multimeter-0.5.3.tar.gz",
    "platform": null,
    "description": "# Digital Multimeter\n[![PyPi](https://img.shields.io/pypi/v/digital-multimeter.svg)](https://pypi.python.org/pypi/digital-multimeter/)\n[![Python Versions](https://img.shields.io/pypi/pyversions/digital-multimeter.svg)](https://github.com/ndejong/digital-multimeter/)\n[![Read the Docs](https://img.shields.io/readthedocs/digital-multimeter)](https://digital-multimeter.readthedocs.io)\n![License](https://img.shields.io/github/license/ndejong/digital-multimeter.svg)\n\nDigital Multimeter provides both a CLI and Python API interface to receive data \nfrom a variety of digital multimeters.  \n\nSee the list of supported multimeters [here](https://digital-multimeter.readthedocs.io/en/latest/supported-multimeters/).\n\n## Features\n* Command line and Python module interface to digital multimeters\n* Continuous live data readings (using `--count 0`)\n* Output in **json** or **csv** formats\n* Output to console or file, allowing other tools to pickup and use the data\n* Configuration via config-file or environment-variables\n* Easy to expand for new digital-multimeter protocols\n* Easy installation using PyPI `pip`\n* Documentation and examples at [digital-multimeter.readthedocs.io](https://digital-multimeter.readthedocs.io)\n\n## Installation\n```shell\nuser@computer:~$ pip install [--upgrade] digital-multimeter\n```\n\n## CLI Usage Example\nContinuously read the digital-multimeter and pipe the JSON output through `jq` to \nmake the JSON output look prettier.\n```shell\nuser@computer:~$ dmm read --connect /dev/ttyUSB0 --count 0 | jq .\n{\n  \"reading\": {\n    \"value\": 156.70000000000002,\n    \"unit_name\": \"volts\",\n    \"unit_symbol\": \"V\",\n    \"scale\": 0.001,\n    \"scale_name\": \"milli\",\n    \"scale_symbol\": \"m\",\n    \"scaled_value\": 0.15670000000000003,\n    \"is_relative\": false\n  },\n  \"instrument\": {\n    \"module\": \"MultimeterDigitechQM1538\",\n    \"operation_mode\": \"voltage_dc\",\n    \"low_battery\": false,\n    \"is_hold\": false\n  },\n  \"time\": {\n    \"elapsed\": 0.349347334,\n    \"interval\": 0.349347334,\n    \"timestamp\": 1605936374.7694516,\n    \"unit_name\": \"second\",\n    \"unit_symbol\": \"s\"\n  }\n}\n```\n\n## Python API Usage\nPython-module documentation is available [here](https://digital-multimeter.readthedocs.io/en/latest/api/digitalmultimeter/).\n\n## Project\n* Github - [github.com/ndejong/digital-multimeter](https://github.com/ndejong/digital-multimeter)\n* PyPI - [pypi.python.org/pypi/digital-multimeter](https://pypi.python.org/pypi/digital-multimeter/)\n* ReadTheDocs - [digital-multimeter.readthedocs.io](https://digital-multimeter.readthedocs.io)\n\n---\nCopyright &copy; 2021-2023 [Nicholas de Jong](https://www.nicholasdejong.com)\n\n",
    "bugtrack_url": null,
    "license": "BSD-2-Clause",
    "summary": "Digital Multimeter provides both a CLI interface and a Python API interface to receive data from a variety of digital multimeters.",
    "version": "0.5.3",
    "project_urls": {
        "Bug Tracker": "https://github.com/ndejong/digital-multimeter/issues",
        "Documentation": "https://digital-multimeter.readthedocs.io/en/latest/",
        "Homepage": "https://digital-multimeter.readthedocs.io/en/latest/",
        "Repository": "https://github.com/ndejong/digital-multimeter.git"
    },
    "split_keywords": [
        "multimeter",
        "digital multimeter",
        "dmm",
        "digitech",
        "digitek",
        "tekpower",
        "unitrend",
        "voltcraft"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1a183a36acc59a6348c359569ffadb3c40736da27ceae9ed607c52b7183f9331",
                "md5": "a33ae7b446d087a481df9257d7f31972",
                "sha256": "c32a1f1e73398b26e524c644a11594bb736494cfbe117634e3a6420054a4026f"
            },
            "downloads": -1,
            "filename": "digital_multimeter-0.5.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a33ae7b446d087a481df9257d7f31972",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 18906,
            "upload_time": "2023-07-31T07:53:13",
            "upload_time_iso_8601": "2023-07-31T07:53:13.516980Z",
            "url": "https://files.pythonhosted.org/packages/1a/18/3a36acc59a6348c359569ffadb3c40736da27ceae9ed607c52b7183f9331/digital_multimeter-0.5.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d37d4b997d5d106eabae2001942d1415de242cb0afb9128e21b1aacb2bc4dc68",
                "md5": "fc9d58b49ea9e2977b512261ee78d2b0",
                "sha256": "35ce69696366be0b83b2092e91f3d25d4ca08b3750fde6cfcf4cb5aec80023b4"
            },
            "downloads": -1,
            "filename": "digital_multimeter-0.5.3.tar.gz",
            "has_sig": false,
            "md5_digest": "fc9d58b49ea9e2977b512261ee78d2b0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 15009,
            "upload_time": "2023-07-31T07:53:15",
            "upload_time_iso_8601": "2023-07-31T07:53:15.454868Z",
            "url": "https://files.pythonhosted.org/packages/d3/7d/4b997d5d106eabae2001942d1415de242cb0afb9128e21b1aacb2bc4dc68/digital_multimeter-0.5.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-31 07:53:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ndejong",
    "github_project": "digital-multimeter",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "digital-multimeter"
}
        
Elapsed time: 0.10271s