Skip to main content

hx711-multi

Upload to PyPI Downloads

HX711 class to sample a 24-bit ADC (or multiple) with Python 3 on a Raspberry Pi Rasperry Pi Zero, 2 or 3

Description

This library allows the user to configure and read from one or multiple HX711 ADCs with a Raspberry Pi. It was developed and tested in Python 3.8 on Raspberry Pi 4B with Raspberry Pi OS Lite v5.10.

Capabilities:

  • Configure Raspberry Pi digital pins for reading measurements
  • Configure Raspberry Pi SCK pin, or clock pin, used for configuring channel and triggering measurements
  • Configure Channel (A | B)
  • Configure Channel A Gain (128 | 64)
  • Power down ADC
  • Power up ADC
  • Zero ADC at start
  • Configure individual weight multiples for calibration of each scale to real-world weight
  • Read raw measurements from ADCs
  • Read weight measurements from ADCs

This package requires RPi.GPIO to be installed in Python 3.

Hardware

General HX711 documentation is included in Docs folder.

The default sample rate of the HX711 is 10Hz, unless you wire the power to the RATE pin (15), at which point you can sample at 80Hz. I've included a picture of this wiring if desired. The SparkFun board includes a jumper option for this.

SparkFun Hookup Guide - great resource for understanding the wiring to your HX711

SparkFun Load Cells Guide - great resource for understanding load cells

Getting started

Install with pip3 install hx711_multi

Basic usage example:

(also found at /tests/simple_read_test.py)

#!/usr/bin/env python3

from hx711_multi import HX711
from time import perf_counter
import RPi.GPIO as GPIO  # import GPIO

# init GPIO (should be done outside HX711 module in case you are using other GPIO functionality)
GPIO.setmode(GPIO.BCM)  # set GPIO pin mode to BCM numbering

readings_to_average = 10
sck_pin = 1
dout_pins = [2, 3, 4, 14, 15]
weight_multiples = [-5176, -5500, -5690, -5484, -5455]

# create hx711 instance
hx711 = HX711(dout_pins=dout_pins,
              sck_pin=sck_pin,
              channel_A_gain=128,
              channel_select='A',
              all_or_nothing=False,
              log_level='CRITICAL')
# reset ADC, zero it
hx711.reset()
try:
    hx711.zero(readings_to_average=readings_to_average*3)
except Exception as e:
    print(e)
# uncomment below loop to see raw 2's complement and read integers
# for adc in hx711._adcs:
#     print(adc.raw_reads)  # these are the 2's complemented values read bitwise from the hx711
#     print(adc.reads)  # these are the raw values after being converted to signed integers
hx711.set_weight_multiples(weight_multiples=weight_multiples)

# read until keyboard interrupt
try:
    while True:
        start = perf_counter()

        # perform read operation, returns signed integer values as delta from zero()
        # readings aare filtered for bad data and then averaged
        raw_vals = hx711.read_raw(readings_to_average=readings_to_average)

        # request weights using multiples set previously with set_weight_multiples()
        # This function call will not perform a new measurement, it will just use what was acquired during read_raw()
        weights = hx711.get_weight()

        read_duration = perf_counter() - start
        sample_rate = readings_to_average/read_duration
        print('\nread duration: {:.3f} seconds, rate: {:.1f} Hz'.format(read_duration, sample_rate))
        print(
            'raw',
            ['{:.3f}'.format(x) if x is not None else None for x in raw_vals])
        print(' wt',
              ['{:.3f}'.format(x) if x is not None else None for x in weights])
        # uncomment below loop to see raw 2's complement and read integers
        # for adc in hx711._adcs:
        #     print(adc.raw_reads)  # these are the 2's complemented values read bitwise from the hx711
        #     print(adc.reads)  # these are the raw values after being converted to signed integers
except KeyboardInterrupt:
    print('Keyboard interrupt..')
except Exception as e:
    print(e)

# cleanup GPIO
GPIO.cleanup()

Calibration sequence

Each HX711 ADC needs to be calibrated separately in order to account for variance in raw measurements compared to real world weight. For example, the ADC may return a value of 5000 which corresponds to 1 gram. In this case, the weight multiple for this ADC should be set to 5000.

Run the calibration sequence with known weights after initializing your HX711 object with the below command. Optional input for known weights included so that you can run through the process faster without needing to type in the weights throughout the sequence. If no known weights are input, it will prompt user before each measurement. This should only need to be performed once during hardware setup, or if the measurement environment changes (temperature, humidity, etc).

(full example can be found at /tests/calibrate.py)

weight_multiple = hx711.run_calibration(known_weights=[5, 10, 50, 100])
print(f'Weight multiple = {weight_multiple}')

Author

License

  • Free software: MIT license

Credits

Metadata

Release files for hx711-multi 1.2.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hx711-multi 1.2.5
File Size Uploaded Provenance Actions
hx711_multi-1.2.5.tar.gz 14.3 kB Without provenance Details for hx711_multi-1.2.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for hx711-multi 1.2.5
File Interpreter ABI Platform Actions
hx711_multi-1.2.5-py3-none-any.whl Python 3 none any Details for hx711_multi-1.2.5-py3-none-any.whl

Total release size: 27.2 kB

Release files / hx711_multi-1.2.5.tar.gz

Download URL hx711_multi-1.2.5.tar.gz
Size 14.3 kB
Tags Source
SHA-256 checksum
How to use checksums
e9263f7fadb662afc24f03ae8a86b5a952041a02cce8bd0c2537289fabff924c
BLAKE2b-256 checksum
How to use checksums
7ec93a2984f5a1b1fadcacacf0ed4610fab788b1f29eb40366cf66f9656ef8b7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

Release files / hx711_multi-1.2.5-py3-none-any.whl

Download URL hx711_multi-1.2.5-py3-none-any.whl
Size 12.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
490346e1ffe0f06f39024576cac6e96d6ef3f7bfafc5b58e8523549ea1d1b17b
BLAKE2b-256 checksum
How to use checksums
4ea12c2b4e0c3fe2caeb8426109b08012227fcc0a23559dcda216585f4063ca2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

Security for hx711-multi 1.2.5

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page