thermo16.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright (c) 2019, MikroElektronika - www.mikroe.com
 * All rights reserved.
 *
 * 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.
 */
 
#ifndef THERMO16_H
#define THERMO16_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_analog_in.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
 
#define THERMO16_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.an_pin  = MIKROBUS( mikrobus, MIKROBUS_AN )
#define THERMO16_RETVAL  uint8_t
 
#define THERMO16_OK           0x00
#define THERMO16_INIT_ERROR   0xFF
#define THERMO16_TEMP_IN_CELSIUS    0x00
#define THERMO16_TEMP_IN_KELVIN     0x01
#define THERMO16_TEMP_IN_FAHRENHEIT 0x02
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef  uint16_t thermo16_data_t;
 
typedef struct
{
    // Modules 
 
    analog_in_t adc;
    analog_in_resolution_t  adc_res;
 
} thermo16_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t an_pin;
 
    // static variable 
 
    analog_in_resolution_t  resolution;   // Resolution
    float vref;   // VRef    
 
} thermo16_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void thermo16_cfg_setup ( thermo16_cfg_t *cfg );
 
THERMO16_RETVAL thermo16_init ( thermo16_t *ctx, thermo16_cfg_t *cfg );
 
thermo16_data_t thermo16_generic_read ( thermo16_t *ctx );
 
float thermo16_get_temperature ( thermo16_t *ctx, uint8_t temp_format );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _THERMO16_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------ END