methane.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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 METHANE_H
#define METHANE_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"
 
#define METHANE_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); 
  
 
 // methane_map
 // methane
 
typedef struct
{
    analog_in_t  adc;       
} methane_t;
 
typedef struct
{
    pin_name_t  an;     
    analog_in_resolution_t  resolution;     
    float                   vref;           
} methane_cfg_t;
 
typedef enum
{
   METHANE_OK = 0,
   METHANE_ERROR = -1
 
} methane_return_value_t;
 
void methane_cfg_setup ( methane_cfg_t *cfg );
 
err_t methane_init ( methane_t *ctx, methane_cfg_t *cfg );
 
err_t methane_read_an_pin_value ( methane_t *ctx, uint16_t *data_out );
 
err_t methane_read_an_pin_voltage ( methane_t *ctx, float *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // METHANE_H
 
 // methane
 
// ------------------------------------------------------------------------ END