hx711.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Ruslan V. Uss <unclerus@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holder nor the names of itscontributors
 *    may be used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __HX711_H__
#define __HX711_H__
 
#include <driver/gpio.h>
#include <stdbool.h>
#include <esp_err.h>
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    HX711_GAIN_A_128 = 0, 
    HX711_GAIN_B_32,      
    HX711_GAIN_A_64       
} hx711_gain_t;

typedef struct
{
    gpio_num_t dout;
    gpio_num_t pd_sck;
    hx711_gain_t gain;
} hx711_t;

esp_err_t hx711_init(hx711_t *dev);

esp_err_t hx711_power_down(hx711_t *dev, bool down);

esp_err_t hx711_set_gain(hx711_t *dev, hx711_gain_t gain);

esp_err_t hx711_is_ready(hx711_t *dev, bool *ready);

esp_err_t hx711_wait(hx711_t *dev, size_t timeout_ms);

esp_err_t hx711_read_data(hx711_t *dev, int32_t *data);

esp_err_t hx711_read_average(hx711_t *dev, size_t times, int32_t *data);
 
#ifdef __cplusplus
}
#endif

 
#endif /* __HX711_H__ */