drivers/sensors/lm75b/lm75b.h

   1 /**************************************************************************/
   2 /*!
   3     @file     lm75b.h
   4     @author   K. Townsend (microBuilder.eu)
   5     @date     22 March 2010
   6     @version  0.10
   7
   8     @section LICENSE
   9
  10     Software License Agreement (BSD License)
  11
  12     Copyright (c) 2010, microBuilder SARL
  13     All rights reserved.
  14
  15     Redistribution and use in source and binary forms, with or without
  16     modification, are permitted provided that the following conditions are met:
  17     1. Redistributions of source code must retain the above copyright
  18     notice, this list of conditions and the following disclaimer.
  19     2. Redistributions in binary form must reproduce the above copyright
  20     notice, this list of conditions and the following disclaimer in the
  21     documentation and/or other materials provided with the distribution.
  22     3. Neither the name of the copyright holders nor the
  23     names of its contributors may be used to endorse or promote products
  24     derived from this software without specific prior written permission.
  25
  26     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
  27     EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  28     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  29     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
  30     DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  31     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  32     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  33     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  35     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36 */
  37 /**************************************************************************/
  38
  39 #ifndef _LM75B_H_
  40 #define _LM75B_H_
  41
  42 #include "projectconfig.h"
  43 #include "core/i2c/i2c.h"
  44
  45 #define LM75B_ADDRESS (0x90) // 100 1000 shifted left 1 bit = 0x90
  46 #define LM75B_READBIT (0x01)
  47
  48 #define LM75B_REGISTER_TEMPERATURE      (0x00)
  49 #define LM75B_REGISTER_CONFIGURATION    (0x01)
  50
  51 #define LM75B_CONFIG_SHUTDOWN_MASK      (0x01)
  52 #define LM75B_CONFIG_SHUTDOWN_POWERON   (0x00)
  53 #define LM75B_CONFIG_SHUTDOWN_SHUTDOWN  (0x01)
  54
  55 typedef enum
  56 {
  57   LM75B_ERROR_OK = 0,               // Everything executed normally
  58   LM75B_ERROR_I2CINIT,              // Unable to initialise I2C
  59   LM75B_ERROR_I2CBUSY,              // I2C already in use
  60   LM75B_ERROR_LAST
  61 }
  62 lm75bError_e;
  63
  64 lm75bError_e lm75bInit(void);
  65 lm75bError_e lm75bGetTemperature (int32_t *temp);
  66 lm75bError_e lm75bConfigWrite (uint8_t configValue);
  67
  68 #endif
  69
  70