adafruit-circuitpython-hx711


Nameadafruit-circuitpython-hx711 JSON
Version 1.0.8 PyPI version JSON
download
home_pageNone
SummaryCircuitPython driver for the HX711 24-bit ADC for Load Cells / Strain Gauges
upload_time2025-10-20 16:47:28
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython hx711 adc strain gauge
VCS
bugtrack_url
requirements Adafruit-Blinka
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============


.. image:: https://readthedocs.org/projects/adafruit-circuitpython-hx711/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/hx711/en/latest/
    :alt: Documentation Status


.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
    :target: https://adafru.it/discord
    :alt: Discord


.. image:: https://github.com/adafruit/Adafruit_CircuitPython_HX711/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_HX711/actions
    :alt: Build Status


.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Code Style: Ruff

CircuitPython driver for the HX711 24-bit ADC for Load Cells / Strain Gauges


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.

`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5974>`_

This driver does not support MCU's without longint support.

Installing from PyPI
=====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-hx711/>`_.
To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-hx711

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-hx711

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .venv
    source .env/bin/activate
    pip3 install adafruit-circuitpython-hx711

Installing to a Connected CircuitPython Device with Circup
==========================================================

Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the
following command to install:

.. code-block:: shell

    circup install adafruit_hx711

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example
=============

.. code-block:: python

    import time
    import board
    import digitalio
    from adafruit_hx711.hx711 import HX711
    from adafruit_hx711.analog_in import AnalogIn

    data = digitalio.DigitalInOut(board.D2)
    data.direction = digitalio.Direction.INPUT
    clock = digitalio.DigitalInOut(board.D3)
    clock.direction = digitalio.Direction.OUTPUT

    hx711 = HX711(data, clock)
    channel_a = AnalogIn(hx711, HX711.CHAN_A_GAIN_128)

    while True:
        print(f"Reading: {channel_a.value}")
        time.sleep(1)


Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/hx711/en/latest/>`_.

For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_HX711/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-hx711",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, hx711, ADC, , strain, gauge",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/85/1e/4e257fed8b30059a2d458fd0d41bbd3d935cb38340a4e92438a6cc270057/adafruit_circuitpython_hx711-1.0.8.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-hx711/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/hx711/en/latest/\n    :alt: Documentation Status\n\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n    :target: https://adafru.it/discord\n    :alt: Discord\n\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_HX711/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_HX711/actions\n    :alt: Build Status\n\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n    :target: https://github.com/astral-sh/ruff\n    :alt: Code Style: Ruff\n\nCircuitPython driver for the HX711 24-bit ADC for Load Cells / Strain Gauges\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5974>`_\n\nThis driver does not support MCU's without longint support.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-hx711/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-hx711\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-hx711\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n    mkdir project-name && cd project-name\n    python3 -m venv .venv\n    source .env/bin/activate\n    pip3 install adafruit-circuitpython-hx711\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n    pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n    circup install adafruit_hx711\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n    circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n    import time\n    import board\n    import digitalio\n    from adafruit_hx711.hx711 import HX711\n    from adafruit_hx711.analog_in import AnalogIn\n\n    data = digitalio.DigitalInOut(board.D2)\n    data.direction = digitalio.Direction.INPUT\n    clock = digitalio.DigitalInOut(board.D3)\n    clock.direction = digitalio.Direction.OUTPUT\n\n    hx711 = HX711(data, clock)\n    channel_a = AnalogIn(hx711, HX711.CHAN_A_GAIN_128)\n\n    while True:\n        print(f\"Reading: {channel_a.value}\")\n        time.sleep(1)\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/hx711/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_HX711/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython driver for the HX711 24-bit ADC for Load Cells / Strain Gauges",
    "version": "1.0.8",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_HX711"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " hx711",
        " adc",
        " ",
        " strain",
        " gauge"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "0e185de1ed9fa54b811a81d8922d5466fbbe6e02869c49c472e74c35e59a8acc",
                "md5": "cdeeec54a9216934214f5a6b37475855",
                "sha256": "2bda37de89f84ea0871d9622525f1ed4e7b5b05a89d6f6b82dbeceefb7b75d5b"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_hx711-1.0.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cdeeec54a9216934214f5a6b37475855",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6003,
            "upload_time": "2025-10-20T16:47:27",
            "upload_time_iso_8601": "2025-10-20T16:47:27.152817Z",
            "url": "https://files.pythonhosted.org/packages/0e/18/5de1ed9fa54b811a81d8922d5466fbbe6e02869c49c472e74c35e59a8acc/adafruit_circuitpython_hx711-1.0.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "851e4e257fed8b30059a2d458fd0d41bbd3d935cb38340a4e92438a6cc270057",
                "md5": "5d4cf17c67c9d4b02bc4567408e0176b",
                "sha256": "83be130a88513d926ade43d7feefba358516831aca052107db95c0819e781b39"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_hx711-1.0.8.tar.gz",
            "has_sig": false,
            "md5_digest": "5d4cf17c67c9d4b02bc4567408e0176b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 23953,
            "upload_time": "2025-10-20T16:47:28",
            "upload_time_iso_8601": "2025-10-20T16:47:28.335302Z",
            "url": "https://files.pythonhosted.org/packages/85/1e/4e257fed8b30059a2d458fd0d41bbd3d935cb38340a4e92438a6cc270057/adafruit_circuitpython_hx711-1.0.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-20 16:47:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_HX711",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-hx711"
}
        
Elapsed time: 9.38427s