/// 
/// @file hih6130-dev.h
/// @authors k. headley
/// @date 06 nov 2012
/// 
/// Max31855 SPI Thermocouple-to-Digital Converter API
/// 
/// @sa doxygen-examples.c for more examples of Doxygen markup

/////////////////////////
// Terms of use 
/////////////////////////
/*
 Copyright Information
 
 xFOCE - software for ocean acidification experiments
 Copyright 2002-2013 MBARI
 Monterey Bay Aquarium Research Institute, all rights reserved.
 
 Terms of Use
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 3 of the License, or
 (at your option) any later version. You can access the GPLv3 license at
 http://www.gnu.org/licenses/gpl-3.0.html
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details 
 (http://www.gnu.org/licenses/gpl-3.0.html)
 
 MBARI provides the documentation and software code "as is", with no warranty,
 express or implied, as to the software, title, non-infringement of third party 
 rights, merchantability, or fitness for any particular purpose, the accuracy of
 the code, or the performance or results which you may obtain from its use. You 
 assume the entire risk associated with use of the code, and you agree to be 
 responsible for the entire cost of repair or servicing of the program with 
 which you are using the code.
 
 In no event shall MBARI be liable for any damages, whether general, special,
 incidental or consequential damages, arising out of your use of the software, 
 including, but not limited to, the loss or corruption of your data or damages 
 of any kind resulting from use of the software, any prohibited use, or your 
 inability to use the software. You agree to defend, indemnify and hold harmless
 MBARI and its officers, directors, and employees against any claim, loss, 
 liability or expense, including attorneys' fees, resulting from loss of or 
 damage to property or the injury to or death of any person arising out of the 
 use of the software.
 
 The MBARI software is provided without obligation on the part of the 
 Monterey Bay Aquarium Research Institute to assist in its use, correction, 
 modification, or enhancement.
 
 MBARI assumes no responsibility or liability for any third party and/or 
 commercial software required for the database or applications. Licensee agrees 
 to obtain and maintain valid licenses for any additional third party software 
 required.
 */ 

// Always do this.
#ifndef HIH6130_DEV_H
#define HIH6130_DEV_H

/////////////////////////
// Includes 
/////////////////////////
#include "xf-driver.h"
#include "xf-spi.h"

/////////////////////////
// Type Definitions
/////////////////////////

/////////////////////////
// Macros
/////////////////////////

/////////////////////////
// Exports
/////////////////////////

////////////////////////////////////////////////////////
// Device API implementation
// - pass in ioport or other resources
// - independent of gateway, driver
////////////////////////////////////////////////////////

////////////////////////////////////////////////////////
// Utility
////////////////////////////////////////////////////////
/// @fn double hih6130_temp(byte *raw_bytes)
/// @brief extract temperature value from raw data
/// @param[in] raw_bytes raw reading
/// @return temperature on success, NULL otherwise;
double
hih6130_temp(byte *raw_bytes);

/// @fn double hih6130_rh(byte *raw_bytes)
/// @brief extract RH value from raw data
/// @param[in] raw_bytes raw reading
/// @return relative humidity on success, NULL otherwise;
double
hih6130_rh(byte *raw_bytes);

/// @fn byte hih6130_status(byte *raw_bytes)
/// @brief extract status byte from raw data
/// @param[in] raw_bytes raw reading
/// @return status byte success (caller owns memory, must free), 0xFF otherwise;
byte
hih6130_status(byte *raw_bytes);

/// @fn char *hih6130_raw2str(byte *raw_bytes)
/// @brief format raw bytes as string
/// @param[in] raw_bytes raw reading
/// @return string on success (caller owns memory, must free), NULL otherwise;
char *
hih6130_raw2str(byte *raw_bytes);

/// @fn int hih6130_read(spi_port_t *io_port, uint32_t *data)
/// @brief read the device.
/// @param[in] io_port spi_port
/// @param[in] data buffer holds return data
/// @return 0 on success (value in data), -1 otherwise;
int
hih6130_read(spi_port_t *io_port, byte *data);

////////////////////////////////////////////////////////
// Driver API implementation 
////////////////////////////////////////////////////////

////////////////////////////////////////////////////////
// Device properties API implementation 
////////////////////////////////////////////////////////

#endif // THIS_FILE