Stuce/sTodo-m5paper-client
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

first commit

Browse source
This commit is contained in:
stuce-bot 2025-06-30 20:47:33 +02:00
commit 5893b00dd2
1669 changed files with 1982740 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
libraries/HX711_Arduino_Library/CONTRIBUTORS.md Normal file
View file

@ -0,0 +1,20 @@
# HX711 library contributors
Listed in the order of appearance.
- Weihong Guan: First steps
- Bogdan Necula: Making it real
- Zachary J. Fields: Performance improvements on AVR. Simplify read logic.
- Rodrigo Wirth: Support to read the current `get_offset` and `get_scale`
- Ulrich Wolf: Move pin definition out of constructor
- Alexander Wilms: Improve documentation
- David Holland-Moritz: Improve interrupt safety on AVR
- Geert Roumen et al.: ESP32 support
- Thomas O Fredericks: Support for Teensy 3.2 and non-blocking readings
- Ahmad Elbadri: Improve ESP8266 stability
- Andreas Motl: Spring cleaning, multiarch support
- Clemens Gruber: Hardware testing
- Many bits and pieces by countless people from the community,
see also "doc/backlog.rst" in the repository.
Thanks a bunch!

21
libraries/HX711_Arduino_Library/LICENSE Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2018 Bogdan Necula
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

62
libraries/HX711_Arduino_Library/Makefile Normal file
View file

@ -0,0 +1,62 @@
# ============
# Main targets
# ============
# -------------
# Configuration
# -------------
$(eval venvpath := .venv2)
$(eval pip := $(venvpath)/bin/pip)
$(eval python := $(venvpath)/bin/python)
$(eval platformio := $(venvpath)/bin/platformio)
# Setup Python virtualenv
setup-virtualenv:
@test -e $(python) || `command -v virtualenv` --python=python3 $(venvpath)
# ----------
# PlatformIO
# ----------
install-platformio: setup-virtualenv
@$(pip) install platformio --quiet
build-all: install-platformio
@$(platformio) run
build-env: install-platformio
@$(platformio) run --environment $(environment)
# Note: This are legacy build targets, the new ones are defined through `platformio.ini`.
ci-all: install-platformio
# atmelavr
$(platformio) ci --board=megaatmega2560 --lib="." examples/HX711_basic_example
$(platformio) ci --board=megaatmega2560 --lib="." examples/HX711_timeout_example
$(platformio) ci --board=megaatmega2560 --lib="." examples/HX711_full_example
# atmelavr
$(MAKE) ci-basic board=feather328p
# espressif8266
$(MAKE) ci-basic board=huzzah
# espressif32
$(MAKE) ci-basic board=lopy4
# atmelsam
$(MAKE) ci-basic board=adafruit_feather_m0
$(MAKE) ci-basic board=adafruit_feather_m4
# bluepill
$(MAKE) ci-basic board=bluepill_f103c8
ci-basic:
$(platformio) ci --board=$(board) --lib="." examples/HX711_basic_example --verbose
clean:
$(platformio) run -t clean

215
libraries/HX711_Arduino_Library/README.md Normal file
View file

@ -0,0 +1,215 @@
# HX711
An Arduino library to interface the [Avia Semiconductor HX711 24-Bit Analog-to-Digital Converter (ADC)]
for reading load cells / weight scales.
It supports the architectures `atmelavr`, `espressif8266`, `espressif32`,
`atmelsam`, `teensy` and `ststm32` by corresponding [PlatformIO] targets.
[Avia Semiconductor HX711 24-Bit Analog-to-Digital Converter (ADC)]: http://www.dfrobot.com/image/data/SEN0160/hx711_english.pdf
[PlatformIO]: https://platformio.org/
## Synopsis
### Blocking mode
The library is usually used in blocking mode, i.e. it will wait for the
hardware becoming available before returning a reading.
```c++
#include "HX711.h"
HX711 loadcell;
// 1. HX711 circuit wiring
const int LOADCELL_DOUT_PIN = 2;
const int LOADCELL_SCK_PIN = 3;
// 2. Adjustment settings
const long LOADCELL_OFFSET = 50682624;
const long LOADCELL_DIVIDER = 5895655;
// 3. Initialize library
loadcell.begin(LOADCELL_DOUT_PIN, LOADCELL_SCK_PIN);
loadcell.set_scale(LOADCELL_DIVIDER);
loadcell.set_offset(LOADCELL_OFFSET);
// 4. Acquire reading
Serial.print("Weight: ");
Serial.println(loadcell.get_units(10), 2);
```
### Non-blocking mode
It is also possible to define a maximum timeout to wait for the hardware
to be initialized. This won't send the program into a spinlock when the
scale is disconnected and will probably also account for hardware failures.
```
// 4. Acquire reading without blocking
if (loadcell.wait_ready_timeout(1000)) {
long reading = loadcell.get_units(10);
Serial.print("Weight: ");
Serial.println(reading, 2);
} else {
Serial.println("HX711 not found.");
}
```
## FAQ
https://github.com/bogde/HX711/blob/master/doc/faq.md
## More examples
See `examples` directory in this repository.
## HAL support
- [Arduino AVR core](https://github.com/arduino/ArduinoCore-avr)
- [Arduino core for ESP8266](https://github.com/esp8266/Arduino)
- [Arduino core for ESP32](https://github.com/espressif/arduino-esp32)
- [Arduino core for SAMD21](https://github.com/arduino/ArduinoCore-samd) (untested)
- [Arduino core for SAMD51](https://github.com/adafruit/ArduinoCore-samd) (untested)
- [Arduino core for STM32](https://github.com/stm32duino/Arduino_Core_STM32)
- [Arduino Core for Adafruit Bluefruit nRF52 Boards](https://github.com/adafruit/Adafruit_nRF52_Arduino)
## Hardware support
The library has been tested successfully on the following hardware.
- [ATmega328]: Arduino Uno
- [ESP8266]: WeMos D1 mini, Adafruit HUZZAH
- [ESP32]: ESP32 DEVKIT V1, Heltec WiFi Kit 32, Adafruit Feather HUZZAH32
- [STM32 F1] ([Cortex-M3]): STM32F103C8T6 STM32 Blue Pill Board
- [nRF52]: Adafruit Feather nRF52840 Express
Thanks, @bogde and @ClemensGruber!
[ATmega328]: https://en.wikipedia.org/wiki/ATmega328
[ESP8266]: https://en.wikipedia.org/wiki/ESP8266
[ESP32]: https://en.wikipedia.org/wiki/ESP32
[STM32 F1]: https://en.wikipedia.org/wiki/STM32#STM32_F1
[Cortex-M3]: https://en.wikipedia.org/wiki/ARM_Cortex-M#Cortex-M3
[nRF52]: https://infocenter.nordicsemi.com/index.jsp?topic=%2Fstruct_nrf52%2Fstruct%2Fnrf52.html
## Features
1. It provides a `tare()` function, which "resets" the scale to 0. Many other
implementations calculate the tare weight when the ADC is initialized only.
I needed a way to be able to set the tare weight at any time.
**Use case**: Place an empty container on the scale, call `tare()` to reset
the readings to 0, fill the container and get the weight of the content.
2. It provides a `power_down()` function, to put the ADC into a low power mode.
According to the datasheet,
> When PD_SCK pin changes from low to high and stays at high
> for longer than 60μs, HX711 enters power down mode.
**Use case**: Battery-powered scales. Accordingly, there is a `power_up()`
function to get the chip out of the low power mode.
3. It has a `set_gain(byte gain)` function that allows you to set the gain factor
and select the channel. According to the datasheet,
> Channel A can be programmed with a gain of 128 or 64, corresponding to
a full-scale differential input voltage of ±20mV or ±40mV respectively, when
a 5V supply is connected to AVDD analog power supply pin. Channel B has
a fixed gain of 32.
The same function is used to select the channel A or channel B, by passing
128 or 64 for channel A, or 32 for channel B as the parameter. The default
value is 128, which means "channel A with a gain factor of 128", so one can
simply call `set_gain()`.
This function is also called from the initializer method `begin()`.
4. The `get_value()` and `get_units()` functions can receive an extra parameter "times",
and they will return the average of multiple readings instead of a single reading.
## How to calibrate your load cell
1. Call `set_scale()` with no parameter.
2. Call `tare()` with no parameter.
3. Place a known weight on the scale and call `get_units(10)`.
4. Divide the result in step 3 to your known weight. You should
get about the parameter you need to pass to `set_scale()`.
5. Adjust the parameter in step 4 until you get an accurate reading.
## Build
### All architectures
This will spawn a Python virtualenv in the current directory,
install `platformio` into it and then execute `platformio run`,
effectively building for all environments defined in `platformio.ini`.
make build-all
#### Result
```
Environment feather_328 [SUCCESS]
Environment atmega_2560 [SUCCESS]
Environment huzzah [SUCCESS]
Environment lopy4 [SUCCESS]
Environment teensy31 [SUCCESS]
Environment teensy36 [SUCCESS]
Environment feather_m0 [SUCCESS]
Environment arduino_due [SUCCESS]
Environment feather_m4 [SUCCESS]
Environment bluepill [SUCCESS]
Environment adafruit_feather_nrf52840 [SUCCESS]
```
#### Details
https://gist.github.com/amotl/5ed6b3eb1fcd2bc78552b218b426f6aa
### Specific architecture
You can run a build for a specific architecture by specifying
the appropriate platform label on the command line.
# Build for LoPy4
make build-env environment=lopy4
# Build for Feather M0
make build-env environment=feather_m0
## Deprecation warning
This library received some spring-cleaning in February 2019 (#123),
removing the pin definition within the constructor completely, as
this was not timing safe. (#29) Please use the new initialization
flavor as outlined in the example above.
## Credits
Thanks to Weihong Guan who started the first version of this library in 2012
already (see [[arduino|module]Hx711 electronic scale kit](http://aguegu.net/?p=1327),
[sources](https://github.com/aguegu/ardulibs/tree/master/hx711)), Bogdan Necula
who took over in 2014 and last but not least all others who contributed to this
library over the course of the last years, see also `CONTRIBUTORS.rst` in this
repository.
#### See also
- https://item.taobao.com/item.htm?id=18121631630
- https://item.taobao.com/item.htm?id=544769386300
## Similar libraries
There are other libraries around, enjoy:
- https://github.com/olkal/HX711_ADC
- https://github.com/queuetue/Q2-HX711-Arduino-Library
---
## Appendix
### Considerations about real world effects caused by physics
You should consider getting into the details of strain-gauge load cell
sensors when expecting reasonable results. The range of topics is from
sufficient and stable power supply, using the proper excitation voltage
to the Seebeck effect and temperature compensation.
See also:
- [Overview about real world effects](https://community.hiveeyes.org/t/analog-vs-digital-signal-gain-amplifiers/380/6)
- [Thermoelectric effect](https://en.wikipedia.org/wiki/Thermoelectric_effect) (Seebeck effect)
- Temperature compensation: [Resource collection](https://community.hiveeyes.org/t/temperaturkompensation-fur-waage-hardware-firmware/115), [DIY research](https://community.hiveeyes.org/t/temperaturkompensation-fur-waage-notig-datensammlung/245)
- [Power management for HX711](https://community.hiveeyes.org/t/stromversorgung-hx711/893)

22
libraries/HX711_Arduino_Library/doc/faq.md Normal file
View file

@ -0,0 +1,22 @@
# Frequently Asked Questions
## 1. no matching function for call to 'HX711::HX711(const int&, const int&)'
I'm getting the following error:
```exit status 1 no matching function for call to 'HX711::HX711(const int&, const int&)'```
The new interface is that the begin(...) method will obtain the pin parameters. So instead of using:
```
HX711 scale(LOADCELL_DOUT_PIN, LOADCELL_SCK_PIN);
```
Use:
```
HX711 scale;
```
And then in ```void setup() { ... }``` initialize the pins like this:
```
scale.begin(LOADCELL_DOUT_PIN, LOADCELL_SCK_PIN);
```
Please refer to this example for more details:
https://github.com/bogde/HX711/blob/master/examples/HX711_basic_example/HX711_basic_example.ino#L7-L12

92
libraries/HX711_Arduino_Library/doc/notes.md Normal file
View file

@ -0,0 +1,92 @@
# HX711 library notes
## Backlog
- [o] Get library into https://www.arduinolibraries.info/ and https://platformio.org/
- [o] Maybe use constructor-based initialization again?
It does not necessarily need to starting talking to the hardware yet!
- [o] Unify critical sections / interrupt disabling between platforms?
https://github.com/esp8266/Arduino/issues/2218
- [o] Check out https://github.com/mmarchetti/DirectIO
### Scan more forks
- https://github.com/bigujun/HX711
- https://github.com/OpenCamper/HX711
- https://github.com/compugician/HX711-multi
- https://github.com/CasualTriangle/HX711-multi
- https://github.com/joeybane/HX711-multi
- https://github.com/polmes/HX711-multi
- https://github.com/knifter/HX711
See also
- https://github.com/newAM/LoadCellOccupany
### Add links to pin mappings of popular chips
- https://stackoverflow.com/questions/42022000/which-pins-should-i-take-for-i2c-on-arduino-uno/42022566
- https://www.arduino.cc/en/Hacking/PinMapping32u4
- https://www.arduino.cc/en/Hacking/PinMappingSAM3X
- https://www.avdweb.nl/arduino/samd21/samd21-variant
- https://techtutorialsx.com/2017/04/02/esp8266-nodemcu-pin-mappings/
- https://github.com/esp8266/Arduino/issues/584
- https://www.arduino.cc/en/Hacking/Atmega168Hardware
- https://www.arduino.cc/en/Hacking/PinMapping168
---
# Spring-cleaning issue summary
https://github.com/hiveeyes/HX711/tree/spring-cleaning
## AVR
- [x] AVR interrupt safety
https://github.com/bogde/HX711/pull/62
## ARM/SAMD
### Teensy 3.x
- [x] Thomas O Fredericks
https://github.com/bogde/HX711/pull/96
### Arduino Due
- [x] Drop a line at https://github.com/aguegu/ardulibs/issues/3 re. support for Arduino Due
## Espressif
### ESP8266 arch pragma / yield definition woes
- [x] https://github.com/bogde/HX711/issues/119
- [x] https://github.com/bogde/HX711/issues/114
### ESP8266 constructor initialization freezes
- [x] https://github.com/bogde/HX711/issues/29
- [x] https://github.com/bogde/HX711/pull/40
- [x] https://github.com/bogde/HX711/pull/113
- [x] https://github.com/bogde/HX711/pull/53
- [x] https://github.com/bogde/HX711/pull/122
- [x] https://github.com/bogde/HX711/issues/89
### ESP8266 WDT
- [o] https://github.com/bogde/HX711/issues/67
- [x] https://github.com/bogde/HX711/issues/73
- [x] https://github.com/bogde/HX711/pull/81
- [x] https://github.com/bogde/HX711/pull/86
- [x] https://github.com/bogde/HX711/issues/120
- [x] https://github.com/bogde/HX711/issues/101
- [o] https://github.com/Skaronator/ESP8266-Load-Cell/issues/6
- [x] Q: Would `delay(1)` be better than `delay(0)`?
A: even delay(0) will work. Should be as often as you can spare, but not more than 100ms let's say
-- https://github.com/esp8266/Arduino/issues/2240#issuecomment-230874704
### ESP8266 lacking pin mapping
- [x] https://github.com/bruhautomation/ESP-MQTT-JSON-Multisensor/issues/14
- [x] https://github.com/witnessmenow/simple-arduino-crypto-display/issues/2
- [x] https://github.com/wemos/D1_mini_Examples/issues/21
- [x] https://github.com/esp8266/Arduino/blob/master/variants/nodemcu/pins_arduino.h
### ESP32 too fast
- [x] https://github.com/lemio/HX711
- [x] https://github.com/bogde/HX711/issues/75

39
libraries/HX711_Arduino_Library/doc/platformio-howto.md Normal file
View file

@ -0,0 +1,39 @@
# PlatformIO howto
https://platformio.org/
List installed platforms
platformio platform list
List available boards
platformio boards
Run specific build
platformio ci --board=megaatmega2560 --lib="." examples/HX711_full_example
Run specific environment
platformio run --environment lopy4
Build all environments
platformio run
"Make clean" for all environments
platformio run -t clean
Dump specific build environment
platformio run --environment lopy4 --target envdump
See slot `CPPDEFINES`.

26
libraries/HX711_Arduino_Library/examples/HX711_basic_example/HX711_basic_example.ino Normal file
View file

@ -0,0 +1,26 @@
#include "HX711.h"
// HX711 circuit wiring
const int LOADCELL_DOUT_PIN = 2;
const int LOADCELL_SCK_PIN = 3;
HX711 scale;
void setup() {
Serial.begin(57600);
scale.begin(LOADCELL_DOUT_PIN, LOADCELL_SCK_PIN);
}
void loop() {
if (scale.is_ready()) {
long reading = scale.read();
Serial.print("HX711 reading: ");
Serial.println(reading);
} else {
Serial.println("HX711 not found.");
}
delay(1000);
}

78
libraries/HX711_Arduino_Library/examples/HX711_full_example/HX711_full_example.ino Normal file
View file

@ -0,0 +1,78 @@
/**
*
* HX711 library for Arduino - example file
* https://github.com/bogde/HX711
*
* MIT License
* (c) 2018 Bogdan Necula
*
**/
#include "HX711.h"
// HX711 circuit wiring
const int LOADCELL_DOUT_PIN = 2;
const int LOADCELL_SCK_PIN = 3;
HX711 scale;
void setup() {
Serial.begin(38400);
Serial.println("HX711 Demo");
Serial.println("Initializing the scale");
// Initialize library with data output pin, clock input pin and gain factor.
// Channel selection is made by passing the appropriate gain:
// - With a gain factor of 64 or 128, channel A is selected
// - With a gain factor of 32, channel B is selected
// By omitting the gain factor parameter, the library
// default "128" (Channel A) is used here.
scale.begin(LOADCELL_DOUT_PIN, LOADCELL_SCK_PIN);
Serial.println("Before setting up the scale:");
Serial.print("read: \t\t");
Serial.println(scale.read()); // print a raw reading from the ADC
Serial.print("read average: \t\t");
Serial.println(scale.read_average(20)); // print the average of 20 readings from the ADC
Serial.print("get value: \t\t");
Serial.println(scale.get_value(5)); // print the average of 5 readings from the ADC minus the tare weight (not set yet)
Serial.print("get units: \t\t");
Serial.println(scale.get_units(5), 1); // print the average of 5 readings from the ADC minus tare weight (not set) divided
// by the SCALE parameter (not set yet)
scale.set_scale(2280.f); // this value is obtained by calibrating the scale with known weights; see the README for details
scale.tare(); // reset the scale to 0
Serial.println("After setting up the scale:");
Serial.print("read: \t\t");
Serial.println(scale.read()); // print a raw reading from the ADC
Serial.print("read average: \t\t");
Serial.println(scale.read_average(20)); // print the average of 20 readings from the ADC
Serial.print("get value: \t\t");
Serial.println(scale.get_value(5)); // print the average of 5 readings from the ADC minus the tare weight, set with tare()
Serial.print("get units: \t\t");
Serial.println(scale.get_units(5), 1); // print the average of 5 readings from the ADC minus tare weight, divided
// by the SCALE parameter set with set_scale
Serial.println("Readings:");
}
void loop() {
Serial.print("one reading:\t");
Serial.print(scale.get_units(), 1);
Serial.print("\t| average:\t");
Serial.println(scale.get_units(10), 1);
scale.power_down(); // put the ADC in sleep mode
delay(5000);
scale.power_up();
}

26
libraries/HX711_Arduino_Library/examples/HX711_retry_example/HX711_retry_example.ino Normal file
View file

@ -0,0 +1,26 @@
#include "HX711.h"
// HX711 circuit wiring
const int LOADCELL_DOUT_PIN = 2;
const int LOADCELL_SCK_PIN = 3;
HX711 scale;
void setup() {
Serial.begin(57600);
scale.begin(LOADCELL_DOUT_PIN, LOADCELL_SCK_PIN);
}
void loop() {
if (scale.wait_ready_retry(10)) {
long reading = scale.read();
Serial.print("HX711 reading: ");
Serial.println(reading);
} else {
Serial.println("HX711 not found.");
}
delay(1500);
}

26
libraries/HX711_Arduino_Library/examples/HX711_timeout_example/HX711_timeout_example.ino Normal file
View file

@ -0,0 +1,26 @@
#include "HX711.h"
// HX711 circuit wiring
const int LOADCELL_DOUT_PIN = 2;
const int LOADCELL_SCK_PIN = 3;
HX711 scale;
void setup() {
Serial.begin(57600);
scale.begin(LOADCELL_DOUT_PIN, LOADCELL_SCK_PIN);
}
void loop() {
if (scale.wait_ready_timeout(1000)) {
long reading = scale.read();
Serial.print("HX711 reading: ");
Serial.println(reading);
} else {
Serial.println("HX711 not found.");
}
delay(1500);
}

30
libraries/HX711_Arduino_Library/keywords.txt Normal file
View file

@ -0,0 +1,30 @@
#######################################
# HX711
#######################################
#######################################
# Datatypes (KEYWORD1)
#######################################
HX711 KEYWORD1
#######################################
# Methods and Functions (KEYWORD2)
#######################################
is_ready KEYWORD2
set_gain KEYWORD2
read_average KEYWORD2
get_value KEYWORD2
get_units KEYWORD2
tare KEYWORD2
set_scale KEYWORD2
get_scale KEYWORD2
set_offset KEYWORD2
get_offset KEYWORD2
power_down KEYWORD2
power_up KEYWORD2
#######################################
# Constants (LITERAL1)
#######################################

20
libraries/HX711_Arduino_Library/library.json Normal file
View file

@ -0,0 +1,20 @@
{
"name": "HX711",
"keywords": "hx711, scale, weight",
"description": "An Arduino library to interface the Avia Semiconductor HX711 24-Bit Analog-to-Digital Converter (ADC) for Weight Scales.",
"repository": {
"type": "git",
"url": "https://github.com/bogde/HX711.git"
},
"version": "0.7.5",
"exclude": "tests",
"examples": "examples/*/*.ino",
"frameworks": "arduino",
"platforms": [
"atmelavr",
"espressif8266",
"espressif32",
"atmelsam",
"ststm32"
]
}

8
libraries/HX711_Arduino_Library/library.properties Normal file
View file

@ -0,0 +1,8 @@
name=HX711 Arduino Library
version=0.7.5
author=Bogdan Necula <bogde@bogde.ro>, Andreas Motl <andreas.motl@elmyra.de>
maintainer=Bogdan Necula <bogde@bogde.ro>
sentence=Library to interface the Avia Semiconductor HX711 ADC.
paragraph=An Arduino library to interface the <a href="http://image.dfrobot.com/image/data/SEN0160/hx711_english.pdf">Avia Semiconductor HX711 24-Bit Analog-to-Digital Converter (ADC)</a> for reading load cells / weight scales.
category=Sensors
url=https://github.com/bogde/HX711

132
libraries/HX711_Arduino_Library/platformio.ini Normal file
View file

@ -0,0 +1,132 @@
; PlatformIO Project Configuration File
;
; Build options: build flags, source filter
; Upload options: custom upload port, speed and extra flags
; Library options: dependencies, extra library storages
; Advanced options: extra scripting
;
; Please visit documentation for the other options and examples
; https://docs.platformio.org/page/projectconf.html
[platformio]
src_dir = examples/HX711_basic_example
include_dir = src
[config]
build_flags =
-D VERSION=0.7.5
-D DEBUG=1
src_filter =
+<*>
+<../../src/*.cpp>
[env:feather_328]
platform = atmelavr
framework = arduino
board = feather328p
; Build options
build_flags = ${config.build_flags}
src_filter = ${config.src_filter}
[env:atmega_2560]
platform = atmelavr
framework = arduino
board = megaatmega2560
; Build options
build_flags = ${config.build_flags}
src_filter = ${config.src_filter}
[env:huzzah]
platform = espressif8266
framework = arduino
board = huzzah
; Build options
build_flags = ${config.build_flags}
src_filter = ${config.src_filter}
[env:lopy4]
platform = espressif32
framework = arduino
board = lopy4
; Build options
build_flags = ${config.build_flags}
src_filter = ${config.src_filter}
[env:teensy31]
platform = teensy
framework = arduino
board = teensy31
; Build options
build_flags = ${config.build_flags}
src_filter = ${config.src_filter}
[env:teensy36]
platform = teensy
framework = arduino
board = teensy36
; Build options
build_flags = ${config.build_flags}
src_filter = ${config.src_filter}
[env:feather_m0]
platform = atmelsam
framework = arduino
board = adafruit_feather_m0
; Build options
build_flags = ${config.build_flags}
src_filter = ${config.src_filter}
[env:arduino_due]
platform = atmelsam
framework = arduino
board = dueUSB
; Build options
build_flags = ${config.build_flags}
src_filter = ${config.src_filter}
[env:feather_m4]
platform = atmelsam
framework = arduino
board = adafruit_feather_m4
; Build options
build_flags = ${config.build_flags}
src_filter = ${config.src_filter}
[env:bluepill]
platform = ststm32
framework = arduino
board = bluepill_f103c8
; Build options
;build_flags = ${config.build_flags}
src_filter = ${config.src_filter}
[env:adafruit_feather_nrf52840]
platform = nordicnrf52
framework = arduino
board = adafruit_feather_nrf52840
; Build options
build_flags = ${config.build_flags}
src_filter = ${config.src_filter}

278
libraries/HX711_Arduino_Library/src/HX711.cpp Normal file
View file

@ -0,0 +1,278 @@
/**
*
* HX711 library for Arduino
* https://github.com/bogde/HX711
*
* MIT License
* (c) 2018 Bogdan Necula
*
**/
#include <Arduino.h>
#include "HX711.h"
// TEENSYDUINO has a port of Dean Camera's ATOMIC_BLOCK macros for AVR to ARM Cortex M3.
#define HAS_ATOMIC_BLOCK (defined(ARDUINO_ARCH_AVR) || defined(TEENSYDUINO))
// Whether we are running on either the ESP8266 or the ESP32.
#define ARCH_ESPRESSIF (defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32))
// Whether we are actually running on FreeRTOS.
#define IS_FREE_RTOS defined(ARDUINO_ARCH_ESP32)
// Define macro designating whether we're running on a reasonable
// fast CPU and so should slow down sampling from GPIO.
#define FAST_CPU \
( \
ARCH_ESPRESSIF || \
defined(ARDUINO_ARCH_SAM) || defined(ARDUINO_ARCH_SAMD) || \
defined(ARDUINO_ARCH_STM32) || defined(TEENSYDUINO) \
)
#if HAS_ATOMIC_BLOCK
// Acquire AVR-specific ATOMIC_BLOCK(ATOMIC_RESTORESTATE) macro.
#include <util/atomic.h>
#endif
#if FAST_CPU
// Make shiftIn() be aware of clockspeed for
// faster CPUs like ESP32, Teensy 3.x and friends.
// See also:
// - https://github.com/bogde/HX711/issues/75
// - https://github.com/arduino/Arduino/issues/6561
// - https://community.hiveeyes.org/t/using-bogdans-canonical-hx711-library-on-the-esp32/539
uint8_t shiftInSlow(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder) {
uint8_t value = 0;
uint8_t i;
for(i = 0; i < 8; ++i) {
digitalWrite(clockPin, HIGH);
delayMicroseconds(1);
if(bitOrder == LSBFIRST)
value |= digitalRead(dataPin) << i;
else
value |= digitalRead(dataPin) << (7 - i);
digitalWrite(clockPin, LOW);
delayMicroseconds(1);
}
return value;
}
#define SHIFTIN_WITH_SPEED_SUPPORT(data,clock,order) shiftInSlow(data,clock,order)
#else
#define SHIFTIN_WITH_SPEED_SUPPORT(data,clock,order) shiftIn(data,clock,order)
#endif
#ifdef ARCH_ESPRESSIF
// ESP8266 doesn't read values between 0x20000 and 0x30000 when DOUT is pulled up.
#define DOUT_MODE INPUT
#else
#define DOUT_MODE INPUT_PULLUP
#endif
HX711::HX711() {
}
HX711::~HX711() {
}
void HX711::begin(byte dout, byte pd_sck, byte gain) {
PD_SCK = pd_sck;
DOUT = dout;
pinMode(PD_SCK, OUTPUT);
pinMode(DOUT, DOUT_MODE);
set_gain(gain);
}
bool HX711::is_ready() {
return digitalRead(DOUT) == LOW;
}
void HX711::set_gain(byte gain) {
switch (gain) {
case 128: // channel A, gain factor 128
GAIN = 1;
break;
case 64: // channel A, gain factor 64
GAIN = 3;
break;
case 32: // channel B, gain factor 32
GAIN = 2;
break;
}
}
long HX711::read() {
// Wait for the chip to become ready.
wait_ready();
// Define structures for reading data into.
unsigned long value = 0;
uint8_t data[3] = { 0 };
uint8_t filler = 0x00;
// Protect the read sequence from system interrupts. If an interrupt occurs during
// the time the PD_SCK signal is high it will stretch the length of the clock pulse.
// If the total pulse time exceeds 60 uSec this will cause the HX711 to enter
// power down mode during the middle of the read sequence. While the device will
// wake up when PD_SCK goes low again, the reset starts a new conversion cycle which
// forces DOUT high until that cycle is completed.
//
// The result is that all subsequent bits read by shiftIn() will read back as 1,
// corrupting the value returned by read(). The ATOMIC_BLOCK macro disables
// interrupts during the sequence and then restores the interrupt mask to its previous
// state after the sequence completes, insuring that the entire read-and-gain-set
// sequence is not interrupted. The macro has a few minor advantages over bracketing
// the sequence between `noInterrupts()` and `interrupts()` calls.
#if HAS_ATOMIC_BLOCK
ATOMIC_BLOCK(ATOMIC_RESTORESTATE) {
#elif IS_FREE_RTOS
// Begin of critical section.
// Critical sections are used as a valid protection method
// against simultaneous access in vanilla FreeRTOS.
// Disable the scheduler and call portDISABLE_INTERRUPTS. This prevents
// context switches and servicing of ISRs during a critical section.
portMUX_TYPE mux = portMUX_INITIALIZER_UNLOCKED;
portENTER_CRITICAL(&mux);
#else
// Disable interrupts.
noInterrupts();
#endif
// Pulse the clock pin 24 times to read the data.
data[2] = SHIFTIN_WITH_SPEED_SUPPORT(DOUT, PD_SCK, MSBFIRST);
data[1] = SHIFTIN_WITH_SPEED_SUPPORT(DOUT, PD_SCK, MSBFIRST);
data[0] = SHIFTIN_WITH_SPEED_SUPPORT(DOUT, PD_SCK, MSBFIRST);
// Set the channel and the gain factor for the next reading using the clock pin.
for (unsigned int i = 0; i < GAIN; i++) {
digitalWrite(PD_SCK, HIGH);
#if ARCH_ESPRESSIF
delayMicroseconds(1);
#endif
digitalWrite(PD_SCK, LOW);
#if ARCH_ESPRESSIF
delayMicroseconds(1);
#endif
}
#if IS_FREE_RTOS
// End of critical section.
portEXIT_CRITICAL(&mux);
#elif HAS_ATOMIC_BLOCK
}
#else
// Enable interrupts again.
interrupts();
#endif
// Replicate the most significant bit to pad out a 32-bit signed integer
if (data[2] & 0x80) {
filler = 0xFF;
} else {
filler = 0x00;
}
// Construct a 32-bit signed integer
value = ( static_cast<unsigned long>(filler) << 24
| static_cast<unsigned long>(data[2]) << 16
| static_cast<unsigned long>(data[1]) << 8
| static_cast<unsigned long>(data[0]) );
return static_cast<long>(value);
}
void HX711::wait_ready(unsigned long delay_ms) {
// Wait for the chip to become ready.
// This is a blocking implementation and will
// halt the sketch until a load cell is connected.
while (!is_ready()) {
// Probably will do no harm on AVR but will feed the Watchdog Timer (WDT) on ESP.
// https://github.com/bogde/HX711/issues/73
delay(delay_ms);
}
}
bool HX711::wait_ready_retry(int retries, unsigned long delay_ms) {
// Wait for the chip to become ready by
// retrying for a specified amount of attempts.
// https://github.com/bogde/HX711/issues/76
int count = 0;
while (count < retries) {
if (is_ready()) {
return true;
}
delay(delay_ms);
count++;
}
return false;
}
bool HX711::wait_ready_timeout(unsigned long timeout, unsigned long delay_ms) {
// Wait for the chip to become ready until timeout.
// https://github.com/bogde/HX711/pull/96
unsigned long millisStarted = millis();
while (millis() - millisStarted < timeout) {
if (is_ready()) {
return true;
}
delay(delay_ms);
}
return false;
}
long HX711::read_average(byte times) {
long sum = 0;
for (byte i = 0; i < times; i++) {
sum += read();
// Probably will do no harm on AVR but will feed the Watchdog Timer (WDT) on ESP.
// https://github.com/bogde/HX711/issues/73
delay(0);
}
return sum / times;
}
double HX711::get_value(byte times) {
return read_average(times) - OFFSET;
}
float HX711::get_units(byte times) {
return get_value(times) / SCALE;
}
void HX711::tare(byte times) {
double sum = read_average(times);
set_offset(sum);
}
void HX711::set_scale(float scale) {
SCALE = scale;
}
float HX711::get_scale() {
return SCALE;
}
void HX711::set_offset(long offset) {
OFFSET = offset;
}
long HX711::get_offset() {
return OFFSET;
}
void HX711::power_down() {
digitalWrite(PD_SCK, LOW);
digitalWrite(PD_SCK, HIGH);
}
void HX711::power_up() {
digitalWrite(PD_SCK, LOW);
}

91
libraries/HX711_Arduino_Library/src/HX711.h Normal file
View file

@ -0,0 +1,91 @@
/**
*
* HX711 library for Arduino
* https://github.com/bogde/HX711
*
* MIT License
* (c) 2018 Bogdan Necula
*
**/
#ifndef HX711_h
#define HX711_h
#if ARDUINO >= 100
#include "Arduino.h"
#else
#include "WProgram.h"
#endif
class HX711
{
private:
byte PD_SCK; // Power Down and Serial Clock Input Pin
byte DOUT; // Serial Data Output Pin
byte GAIN; // amplification factor
long OFFSET = 0; // used for tare weight
float SCALE = 1; // used to return weight in grams, kg, ounces, whatever
public:
HX711();
virtual ~HX711();
// Initialize library with data output pin, clock input pin and gain factor.
// Channel selection is made by passing the appropriate gain:
// - With a gain factor of 64 or 128, channel A is selected
// - With a gain factor of 32, channel B is selected
// The library default is "128" (Channel A).
void begin(byte dout, byte pd_sck, byte gain = 128);
// Check if HX711 is ready
// from the datasheet: When output data is not ready for retrieval, digital output pin DOUT is high. Serial clock
// input PD_SCK should be low. When DOUT goes to low, it indicates data is ready for retrieval.
bool is_ready();
// Wait for the HX711 to become ready
void wait_ready(unsigned long delay_ms = 0);
bool wait_ready_retry(int retries = 3, unsigned long delay_ms = 0);
bool wait_ready_timeout(unsigned long timeout = 1000, unsigned long delay_ms = 0);
// set the gain factor; takes effect only after a call to read()
// channel A can be set for a 128 or 64 gain; channel B has a fixed 32 gain
// depending on the parameter, the channel is also set to either A or B
void set_gain(byte gain = 128);
// waits for the chip to be ready and returns a reading
long read();
// returns an average reading; times = how many times to read
long read_average(byte times = 10);
// returns (read_average() - OFFSET), that is the current value without the tare weight; times = how many readings to do
double get_value(byte times = 1);
// returns get_value() divided by SCALE, that is the raw value divided by a value obtained via calibration
// times = how many readings to do
float get_units(byte times = 1);
// set the OFFSET value for tare weight; times = how many times to read the tare value
void tare(byte times = 10);
// set the SCALE value; this value is used to convert the raw data to "human readable" data (measure units)
void set_scale(float scale = 1.f);
// get the current SCALE
float get_scale();
// set OFFSET, the value that's subtracted from the actual reading (tare weight)
void set_offset(long offset = 0);
// get the current OFFSET
long get_offset();
// puts the chip into power down mode
void power_down();
// wakes up the chip after power down mode
void power_up();
};
#endif /* HX711_h */