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/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
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/9e/90/d70a5bb9d1173d95b98b70c836d0efab0fce6c72f25ce4e8c7813a7c5db2/adafruit_circuitpython_hx711-1.0.5.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/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\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.5",
"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": "cad4f35210723fa7856a0ef235a812b5d5df9f03e7061578795d40401062b3b4",
"md5": "b5d005e28669776ca9406691d91583a5",
"sha256": "2ae13a7ee3d8fc15825b035bd1553ca1fd47228178e06704867082ab53ba2902"
},
"downloads": -1,
"filename": "adafruit_circuitpython_hx711-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b5d005e28669776ca9406691d91583a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6024,
"upload_time": "2025-02-04T01:36:33",
"upload_time_iso_8601": "2025-02-04T01:36:33.991912Z",
"url": "https://files.pythonhosted.org/packages/ca/d4/f35210723fa7856a0ef235a812b5d5df9f03e7061578795d40401062b3b4/adafruit_circuitpython_hx711-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9e90d70a5bb9d1173d95b98b70c836d0efab0fce6c72f25ce4e8c7813a7c5db2",
"md5": "3e0d408727063bc75926d7ca5db79141",
"sha256": "9bd47dc03a68029e37028ba87f635a4bfdbf8d65d96a9f9fc93998ae8f7f1069"
},
"downloads": -1,
"filename": "adafruit_circuitpython_hx711-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "3e0d408727063bc75926d7ca5db79141",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27219,
"upload_time": "2025-02-04T01:36:35",
"upload_time_iso_8601": "2025-02-04T01:36:35.830947Z",
"url": "https://files.pythonhosted.org/packages/9e/90/d70a5bb9d1173d95b98b70c836d0efab0fce6c72f25ce4e8c7813a7c5db2/adafruit_circuitpython_hx711-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-04 01:36:35",
"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"
}
JSON
