NOTE: DOCUMENTATION IS OLD. REFER TOthe test code for an example

Clone

Method 1

git clone --recurse-submodules --remote-submodules https://github.com/endail/pico-scale

#include"../include/hx711_scale_adaptor.h"#include"../include/scale.h"

Method 2

git submodule add https://github.com/endail/pico-scale extern/pico-scalegit submodule update --init --remote --recursive

#include"extern/pico-scale/include/hx711_scale_adaptor.h"#include"extern/pico-scale/include/scale.h"

Documentation

Initialise the HX711

How to Use the HX711 as a Scale

scale_tsc;// the values obtained when calibrating the scale// if you don't know them, read the following section How to Calibratemass_unit_tscaleUnit=mass_g;int32_trefUnit=-432;int32_toffset=-367539;scale_init(&sc,&hx,// pass a pointer to the hx711_tscaleUnit,refUnit,offset);// 3. Set options for how the scale will read and interpret values// SCALE_DEFAULT_OPTIONS will give some default settings which you// do not have to usescale_options_topt=SCALE_DEFAULT_OPTIONS;// scale_options_t has the following options//// opt.strat, which defines how the scale will collect data. By default,// data is collected according to the number of samples. So opt.strat// is set to strategy_type_samples. opt.samples defines how many samples// to obtain. You can also set opt.strat to read_type_time which will// collect as many samples as possible within the timeout period. The// timeout period is defined by opt.timeout and is given in microseconds// (us). For example, 1 second is equal to 1,000,000 us.//// opt.read, which defines how the scale will interpret data. By default,// data is interpreted according to the median value. So opt.read is set// to read_type_median. You can also set opt.read to read_type_average// which will calculate the average value.//// Example://// opt.strat = strategy_type_time;// opt.read = read_type_average;// opt.timeout = 250000;//// These options mean... collect as many samples as possible within 250ms// and then use the average of all those samples.// 4. Zero the scale (OPTIONAL) (aka. tare)if(scale_zero(&sc,&opt)) {printf("Scale zeroed successfully\n");}else {printf("Scale failed to zero\n");}// 5. Obtain the weightmass_tmass;if(scale_weight(&sc,&mass,&opt)) {// mass will contain the weight on the scale obtanined and interpreted// according to the given options and be in the unit defined by the// mass_unit_t 'scaleUnit' variable above//// you can now:// get the weight as a numeric value according to the mass_unit_tdoubleval;mass_get_value(&mass,&val);// convert the mass to a stringcharbuff[MASS_TO_STRING_BUFF_SIZE];mass_to_string(&mass,buff);printf("%s\n",buff);// or do other operations (see: mass.h file)}else {printf("Failed to read weight\n");}

How to Calibrate

FAQ

// 1. setting the scale_t// when you initialise the scalescale_init(&sc,&hx,mass_imp_ton,//change the scaleUnit to your chosen mass_unit_trefUnit,offset);// or, if you've already initialised the scalesc.unit=mass_imp_ton;// 2. change the mass_t// if, for whatever reason, you are initialising a mass_tmass_init(&m,mass_lb,//your desired mass_unit_tval);// or, if you've already initialised a mass_tm.unit=mass_lb;

// 1. get the underlying valuedoubleval;mass_get_value(&m,&val);if(val >=10.5) {//do something if val is greater than or equal to 10.5}//2. built-in functionsif(mass_gteq(&m1,&m2)) {//do something if m1 is greater than m2}