diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-hx711-rpi-py.spec | 507 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 509 insertions, 0 deletions
@@ -0,0 +1 @@ +/hx711-rpi-py-1.59.0.tar.gz diff --git a/python-hx711-rpi-py.spec b/python-hx711-rpi-py.spec new file mode 100644 index 0000000..21bac80 --- /dev/null +++ b/python-hx711-rpi-py.spec @@ -0,0 +1,507 @@ +%global _empty_manifest_terminate_build 0 +Name: python-hx711-rpi-py +Version: 1.59.0 +Release: 1 +Summary: Python bindings for Raspberry Pi HX711 C++ Library +License: MIT +URL: https://github.com/endail/hx711-rpi-py +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/8c/df/87163bb6b28d1904a02b899f472f9aaaa4630e53219e29ff94a858cb3660/hx711-rpi-py-1.59.0.tar.gz +BuildArch: noarch + + +%description +# Raspberry Pi HX711 Python Bindings + +[](https://github.com/endail/hx711-rpi-py/actions/workflows/build_and_upload.yml) [](https://pepy.tech/project/hx711-rpi-py) + +Python bindings for [Raspberry Pi HX711 C++ Library](https://github.com/endail/hx711) + +- Use with Raspberry Pi +- Read from a HX711 using Python +- Code tested inside [virtual Raspberry Pi Zero/3/4 environments](.github/workflows/build_and_upload.yml) on GitHub and builds automatically uploaded to PyPI +- This repo automatically rebuilds when the C++ library is updated + +## Sample Output + + + +The .gif above illustrates the output of a [simple Python script](src/test.py) on a Raspberry Pi Zero W where the HX711 chip was operating at 80Hz. In this example, each time the `.weight` function is called the median of three samples was used to calculate the weight in grams. + +## Examples + +```python +from HX711 import * + +# create a SimpleHX711 object using GPIO pin 2 as the data pin, +# GPIO pin 3 as the clock pin, -370 as the reference unit, and +# -367471 as the offset +with SimpleHX711(2, 3, -370, -367471) as hx: + + # set the scale to output weights in ounces + hx.setUnit(Mass.Unit.OZ) + + # zero the scale + hx.zero() + + # constantly output weights using the median of 35 samples + while True: + print(hx.weight(35)) #eg. 1.08 oz +``` + +### Alternative Syntax (w/out `with`) + +```python +from HX711 import * + +hx = SimpleHX711(2, 3, -370, -367471) +hx.setUnit(Mass.Unit.OZ) +hx.zero() +while True: + print(hx.weight(35)) +``` + +Keep in mind that calling `.weight()` will return a `Mass` object, but you can do the following: + +```python +# set the scale to output weights in ounces +hx.setUnit(Mass.Unit.OZ) + +# obtain a median reading from 35 samples as a Mass object in ounces +m = hx.weight(35) + +# number in ounces +num = float(m) # eg. 1.08 + +# string representation of the Mass +s = str(m) # eg. 1.08 oz + +# print the Mass object +print(m) # eg. 1.08 oz + +# change the unit to grams +m.setUnit(Mass.Unit.G) +grams_as_str = str(m) # eg. 30.62 g + +# or obtain a new Mass object +m2 = m.convertTo(Mass.Unit.KG) +kgs_as_str = str(m2) # eg. 0.031 kg +``` + +The list of different `Mass.Unit`s can be viewed [here](https://github.com/endail/hx711#mass). + +### Time-Based Sampling + +You can use [`datetime.timedelta`](https://docs.python.org/3/library/datetime.html#timedelta-objects) to obtain as many samples as possible within the time period. + +```python +from HX711 import * +from datetime import timedelta + +with SimpleHX711(2, 3, -370, -367471) as hx: + while True: + # eg. obtain as many samples as possible within 1 second + print(hx.weight(timedelta(seconds=1))) +``` + +### Options + +`.weight()`, `.zero()`, and `.read()` can all take an `Options` parameter. You can use this to fine tune how you want the scale to behave. + +```python + +# zero the scale by using the average value of all samples obtained within 1 second +hx.zero(Options( + timedelta(seconds=1), + ReadType.Average)) + +# obtain a raw value from the scale using the median of 100 samples +num = hx.read(Options( + 100, + ReadType.Median)) + +# obtain a Mass object using the median of three samples +# all four statements below are equivalent +m = hx.weight() +m = hx.weight(3) +m = hx.weight(Options()) +m = hx.weight(Options( + 3, + ReadType.Median)) + +# Options can also be created separately +opts = Options() +opts.timeout = timedelta(seconds=5) +opts.stratType = StrategyType.Time +m = hx.weight(opts) +``` + +## Install + +1. Install [libhx711](https://github.com/endail/hx711) + +2. `pip3 install --upgrade hx711-rpi-py` + +## Calibrate + +There is a Python script in the `src` directory you can use to calibrate your load cell and obtain the reference unit and offset values referred to above. The simplest way to use it after installing `hx711-rpi-py` is as follows: + +```console +pi@raspberrypi:~ $ wget https://github.com/endail/hx711-rpi-py/blob/master/src/calibrate.py +pi@raspberrypi:~ $ python3 calibrate.py [data pin] [clock pin] +``` + +Substitute `[data pin]` and `[clock pin]` with the [GPIO pin numbers](https://pinout.xyz/) which are connected to the HX711's data pin and clock pin, respectively. + +## Documentation + +As the Python code relies upon the [underlying C++ library](https://github.com/endail/hx711#documentation), the documentation is identical. However, not all of the code is exposed to Python. You can check precisely which functionality is accessible through Python in the [bindings.cpp file](src/bindings.cpp). + + +%package -n python3-hx711-rpi-py +Summary: Python bindings for Raspberry Pi HX711 C++ Library +Provides: python-hx711-rpi-py +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-hx711-rpi-py +# Raspberry Pi HX711 Python Bindings + +[](https://github.com/endail/hx711-rpi-py/actions/workflows/build_and_upload.yml) [](https://pepy.tech/project/hx711-rpi-py) + +Python bindings for [Raspberry Pi HX711 C++ Library](https://github.com/endail/hx711) + +- Use with Raspberry Pi +- Read from a HX711 using Python +- Code tested inside [virtual Raspberry Pi Zero/3/4 environments](.github/workflows/build_and_upload.yml) on GitHub and builds automatically uploaded to PyPI +- This repo automatically rebuilds when the C++ library is updated + +## Sample Output + + + +The .gif above illustrates the output of a [simple Python script](src/test.py) on a Raspberry Pi Zero W where the HX711 chip was operating at 80Hz. In this example, each time the `.weight` function is called the median of three samples was used to calculate the weight in grams. + +## Examples + +```python +from HX711 import * + +# create a SimpleHX711 object using GPIO pin 2 as the data pin, +# GPIO pin 3 as the clock pin, -370 as the reference unit, and +# -367471 as the offset +with SimpleHX711(2, 3, -370, -367471) as hx: + + # set the scale to output weights in ounces + hx.setUnit(Mass.Unit.OZ) + + # zero the scale + hx.zero() + + # constantly output weights using the median of 35 samples + while True: + print(hx.weight(35)) #eg. 1.08 oz +``` + +### Alternative Syntax (w/out `with`) + +```python +from HX711 import * + +hx = SimpleHX711(2, 3, -370, -367471) +hx.setUnit(Mass.Unit.OZ) +hx.zero() +while True: + print(hx.weight(35)) +``` + +Keep in mind that calling `.weight()` will return a `Mass` object, but you can do the following: + +```python +# set the scale to output weights in ounces +hx.setUnit(Mass.Unit.OZ) + +# obtain a median reading from 35 samples as a Mass object in ounces +m = hx.weight(35) + +# number in ounces +num = float(m) # eg. 1.08 + +# string representation of the Mass +s = str(m) # eg. 1.08 oz + +# print the Mass object +print(m) # eg. 1.08 oz + +# change the unit to grams +m.setUnit(Mass.Unit.G) +grams_as_str = str(m) # eg. 30.62 g + +# or obtain a new Mass object +m2 = m.convertTo(Mass.Unit.KG) +kgs_as_str = str(m2) # eg. 0.031 kg +``` + +The list of different `Mass.Unit`s can be viewed [here](https://github.com/endail/hx711#mass). + +### Time-Based Sampling + +You can use [`datetime.timedelta`](https://docs.python.org/3/library/datetime.html#timedelta-objects) to obtain as many samples as possible within the time period. + +```python +from HX711 import * +from datetime import timedelta + +with SimpleHX711(2, 3, -370, -367471) as hx: + while True: + # eg. obtain as many samples as possible within 1 second + print(hx.weight(timedelta(seconds=1))) +``` + +### Options + +`.weight()`, `.zero()`, and `.read()` can all take an `Options` parameter. You can use this to fine tune how you want the scale to behave. + +```python + +# zero the scale by using the average value of all samples obtained within 1 second +hx.zero(Options( + timedelta(seconds=1), + ReadType.Average)) + +# obtain a raw value from the scale using the median of 100 samples +num = hx.read(Options( + 100, + ReadType.Median)) + +# obtain a Mass object using the median of three samples +# all four statements below are equivalent +m = hx.weight() +m = hx.weight(3) +m = hx.weight(Options()) +m = hx.weight(Options( + 3, + ReadType.Median)) + +# Options can also be created separately +opts = Options() +opts.timeout = timedelta(seconds=5) +opts.stratType = StrategyType.Time +m = hx.weight(opts) +``` + +## Install + +1. Install [libhx711](https://github.com/endail/hx711) + +2. `pip3 install --upgrade hx711-rpi-py` + +## Calibrate + +There is a Python script in the `src` directory you can use to calibrate your load cell and obtain the reference unit and offset values referred to above. The simplest way to use it after installing `hx711-rpi-py` is as follows: + +```console +pi@raspberrypi:~ $ wget https://github.com/endail/hx711-rpi-py/blob/master/src/calibrate.py +pi@raspberrypi:~ $ python3 calibrate.py [data pin] [clock pin] +``` + +Substitute `[data pin]` and `[clock pin]` with the [GPIO pin numbers](https://pinout.xyz/) which are connected to the HX711's data pin and clock pin, respectively. + +## Documentation + +As the Python code relies upon the [underlying C++ library](https://github.com/endail/hx711#documentation), the documentation is identical. However, not all of the code is exposed to Python. You can check precisely which functionality is accessible through Python in the [bindings.cpp file](src/bindings.cpp). + + +%package help +Summary: Development documents and examples for hx711-rpi-py +Provides: python3-hx711-rpi-py-doc +%description help +# Raspberry Pi HX711 Python Bindings + +[](https://github.com/endail/hx711-rpi-py/actions/workflows/build_and_upload.yml) [](https://pepy.tech/project/hx711-rpi-py) + +Python bindings for [Raspberry Pi HX711 C++ Library](https://github.com/endail/hx711) + +- Use with Raspberry Pi +- Read from a HX711 using Python +- Code tested inside [virtual Raspberry Pi Zero/3/4 environments](.github/workflows/build_and_upload.yml) on GitHub and builds automatically uploaded to PyPI +- This repo automatically rebuilds when the C++ library is updated + +## Sample Output + + + +The .gif above illustrates the output of a [simple Python script](src/test.py) on a Raspberry Pi Zero W where the HX711 chip was operating at 80Hz. In this example, each time the `.weight` function is called the median of three samples was used to calculate the weight in grams. + +## Examples + +```python +from HX711 import * + +# create a SimpleHX711 object using GPIO pin 2 as the data pin, +# GPIO pin 3 as the clock pin, -370 as the reference unit, and +# -367471 as the offset +with SimpleHX711(2, 3, -370, -367471) as hx: + + # set the scale to output weights in ounces + hx.setUnit(Mass.Unit.OZ) + + # zero the scale + hx.zero() + + # constantly output weights using the median of 35 samples + while True: + print(hx.weight(35)) #eg. 1.08 oz +``` + +### Alternative Syntax (w/out `with`) + +```python +from HX711 import * + +hx = SimpleHX711(2, 3, -370, -367471) +hx.setUnit(Mass.Unit.OZ) +hx.zero() +while True: + print(hx.weight(35)) +``` + +Keep in mind that calling `.weight()` will return a `Mass` object, but you can do the following: + +```python +# set the scale to output weights in ounces +hx.setUnit(Mass.Unit.OZ) + +# obtain a median reading from 35 samples as a Mass object in ounces +m = hx.weight(35) + +# number in ounces +num = float(m) # eg. 1.08 + +# string representation of the Mass +s = str(m) # eg. 1.08 oz + +# print the Mass object +print(m) # eg. 1.08 oz + +# change the unit to grams +m.setUnit(Mass.Unit.G) +grams_as_str = str(m) # eg. 30.62 g + +# or obtain a new Mass object +m2 = m.convertTo(Mass.Unit.KG) +kgs_as_str = str(m2) # eg. 0.031 kg +``` + +The list of different `Mass.Unit`s can be viewed [here](https://github.com/endail/hx711#mass). + +### Time-Based Sampling + +You can use [`datetime.timedelta`](https://docs.python.org/3/library/datetime.html#timedelta-objects) to obtain as many samples as possible within the time period. + +```python +from HX711 import * +from datetime import timedelta + +with SimpleHX711(2, 3, -370, -367471) as hx: + while True: + # eg. obtain as many samples as possible within 1 second + print(hx.weight(timedelta(seconds=1))) +``` + +### Options + +`.weight()`, `.zero()`, and `.read()` can all take an `Options` parameter. You can use this to fine tune how you want the scale to behave. + +```python + +# zero the scale by using the average value of all samples obtained within 1 second +hx.zero(Options( + timedelta(seconds=1), + ReadType.Average)) + +# obtain a raw value from the scale using the median of 100 samples +num = hx.read(Options( + 100, + ReadType.Median)) + +# obtain a Mass object using the median of three samples +# all four statements below are equivalent +m = hx.weight() +m = hx.weight(3) +m = hx.weight(Options()) +m = hx.weight(Options( + 3, + ReadType.Median)) + +# Options can also be created separately +opts = Options() +opts.timeout = timedelta(seconds=5) +opts.stratType = StrategyType.Time +m = hx.weight(opts) +``` + +## Install + +1. Install [libhx711](https://github.com/endail/hx711) + +2. `pip3 install --upgrade hx711-rpi-py` + +## Calibrate + +There is a Python script in the `src` directory you can use to calibrate your load cell and obtain the reference unit and offset values referred to above. The simplest way to use it after installing `hx711-rpi-py` is as follows: + +```console +pi@raspberrypi:~ $ wget https://github.com/endail/hx711-rpi-py/blob/master/src/calibrate.py +pi@raspberrypi:~ $ python3 calibrate.py [data pin] [clock pin] +``` + +Substitute `[data pin]` and `[clock pin]` with the [GPIO pin numbers](https://pinout.xyz/) which are connected to the HX711's data pin and clock pin, respectively. + +## Documentation + +As the Python code relies upon the [underlying C++ library](https://github.com/endail/hx711#documentation), the documentation is identical. However, not all of the code is exposed to Python. You can check precisely which functionality is accessible through Python in the [bindings.cpp file](src/bindings.cpp). + + +%prep +%autosetup -n hx711-rpi-py-1.59.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-hx711-rpi-py -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 1.59.0-1 +- Package Spec generated @@ -0,0 +1 @@ +5fbf11d449deef2b1b84ac38df9bd069 hx711-rpi-py-1.59.0.tar.gz |