temp-sensor-mcp9808.h

Go to the documentation of this file.

#ifndef DRIVER_TEMPERATURE_SENSOR_MCP9808_H
#define DRIVER_TEMPERATURE_SENSOR_MCP9808_H
/**********************************************************************/
/*
 * Copyright (c) 2014, Jetro AS
 * All rights reserved.
 *
 * 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. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONRIBUTORS ``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 AUTHOR 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.
 *
 * This file is part of the EVE platform.
 */

/**
 * \file
 * @brief Driver for I2C-based temperature sensor type Microchip MCP9808.
 *
 * @author KLO, Jetro AS
 */ /******************************************************************/

#include <dev/i2c-master.h>

/**
 * \defgroup mcp9808 Microchip MCP9808 temperature sensor driver
 * \ingroup extdrv
 * \{
 *
 * This driver supports the I2C-based temperature sensor type Microchip MCP9808.
 * The temperature sensor accuracy is typical ±0.25°C from -40°C to +125°C
 * (max ±0.5°C from -20°C to +100°C, max ±1°C from -40°C to +125°C).
 * The temperature sensor resolution is selectable from 1/16°C to 0.5°C.
 * The highest sensor resolution is selected.
 * Temperature convertion time is typical 250ms.
 * Temperature measurement range is from -40°C to +125°C.
 *
 * The temperature sensor has 3 address lines.
 * The I2C address range is 0x18 - 0x1f. Max baudrate is 400 kbit/s.
 * Typical current consumption is 200µA in active mode and
 * 0.1µA in power down mode.
 *
 * Both initialization and disabling of the sensor, and reading of
 * temperature at 0.1°C or 1.0°C resolution are supported.
 *
 * The selected I2C port must be initialized before using the driver.
 */

/***********************************************************************
 * Global defines
***********************************************************************/
/**
 * temp_sensor_t structure holds I2C port and slave address to be used.
 *
 */
struct temp_sensor_t
{
  const struct i2c_t *I2c;
  uint8_t SlaveAddress;
};

/**
  * @name Functions called from application programs
  * @{
  */

/**********************************************************************/
/**
 * @brief Name:       TempSensorInit\n
 * Initializes the I2C-based temperature sensor for continously convertion.
 * I2C address range is 0x18 - 0x1f. Max baudrate is 400 kbit/s.
 * Higest resolution is selected (1/16°C).
 * Temperature convertion time is typical 250ms.
 * Temperature measurement range is from -40°C to +125°C.
 * Typical current consumption is 200µA.
 *
 * @param TempSensor  Parameters for the temperature sensor to be used
 * @return            true if OK, else false
 ***********************************************************************/
extern bool TempSensorInit(const struct temp_sensor_t *TempSensor);

/**********************************************************************/
/**
 * @brief Name:       TempSensorDisable\n
 * Disables and powers down the I2C-based temperature sensor.
 * Typical current consumption is 0.1µA in power down mode.
 *
 * @param TempSensor  Parameters for the temperature sensor to be used
 * @return            true if OK, else false
 ***********************************************************************/
extern bool TempSensorDisable(const struct temp_sensor_t *TempSensor);

/**********************************************************************/
/**
 * @brief Name:       TempSensorGet\n
 * Reads temperature value from temperature sensor. Resolution 1.0°C.
 *
 * @param TempSensor  Parameters for the temperature sensor to be used
 * @param Value       Pointer to where to put the temperature value (int8_t)
 * @return            true if OK, else false
 ***********************************************************************/
extern bool TempSensorGet(const struct temp_sensor_t *TempSensor, int8_t *Value);

/**********************************************************************/
/**
 * @brief Name:       TempSensorHighResGet\n
 * Reads temperature value from temperature sensor. Resolution 0.1°C.
 *
 * @param TempSensor  Parameters for the temperature sensor to be used
 * @param Value       Pointer to where to put the temperature value (int16_t)
 * @return            true if OK, else false
 ***********************************************************************/
extern bool TempSensorHighResGet(const struct temp_sensor_t *TempSensor, int16_t *Value);

/** @} */
/** \} */

#endif //DRIVER_TEMPERATURE_SENSOR_MCP9808_H