sht1x.h

Go to the documentation of this file.

/*
 * Author: Jon Trulson <jtrulson@ics.com>
 * Copyright (c) 2016 Intel Corporation.
 *
 * 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.
 */

#pragma once

#include <stdint.h>
#include "upm.h"
#include "mraa/gpio.h"

#include "sht1x_defs.h"

#ifdef __cplusplus
extern "C" {
#endif

  typedef struct _sht1x_context {
    mraa_gpio_context        gpio_clk;
    mraa_gpio_context        gpio_data;

    // high res? (temp/hum 14/12b vs. 12/8b)
    bool                     hires;

    // our data
    float                    temperature;
    float                    humidity;

    // temperature coeff (we only care about C)
    float                    coeff_d1;
    float                    coeff_d2;

    // humidity coeff
    float                    coeff_c1;
    float                    coeff_c2;
    float                    coeff_c3;

    float                    coeff_t1;
    float                    coeff_t2;
  } *sht1x_context;

  sht1x_context sht1x_init(unsigned int clk_pin, unsigned int data_pin);

  void sht1x_close(sht1x_context dev);

  void sht1x_reset(const sht1x_context dev);

  upm_result_t sht1x_update(const sht1x_context dev);

  float sht1x_get_temperature(const sht1x_context dev);

  float sht1x_get_humidity(const sht1x_context dev);

  upm_result_t sht1x_read_status(const sht1x_context dev, uint8_t *status);

  upm_result_t sht1x_write_status(const sht1x_context dev, uint8_t status);

  void sht1x_set_volts(const sht1x_context dev, SHT1X_VOLTS_T volts);

  upm_result_t sht1x_send_command(const sht1x_context dev, SHT1X_CMD_T cmd);

  upm_result_t sht1x_wait_for_response(const sht1x_context dev);

  void sht1x_start_xmit(const sht1x_context dev);

  void sht1x_read_8bits(const sht1x_context dev, uint8_t *value);

  upm_result_t sht1x_write_8bits(const sht1x_context dev, uint8_t byte);

#ifdef __cplusplus
}
#endif