hallcurrent825a.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 HALLCURRENT825A_H
#define HALLCURRENT825A_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 HALLCURRENT825A_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.oc1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.oc2 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // hallcurrent825a_map
 // hallcurrent825a
 
typedef struct
{
    digital_in_t oc1;       
    digital_in_t oc2;       
    analog_in_t  adc;       
    float offset;           
} hallcurrent825a_t;
 
typedef struct
{
    pin_name_t  an;     
    pin_name_t  oc1;    
    pin_name_t  oc2;    
    analog_in_resolution_t  resolution;     
    float                   vref;           
} hallcurrent825a_cfg_t;
 
typedef enum
{
   HALLCURRENT825A_OK = 0,
   HALLCURRENT825A_ERROR = -1
 
} hallcurrent825a_return_value_t;
 
void hallcurrent825a_cfg_setup ( hallcurrent825a_cfg_t *cfg );
 
err_t hallcurrent825a_init ( hallcurrent825a_t *ctx, hallcurrent825a_cfg_t *cfg );
 
err_t hallcurrent825a_read_pin_value ( hallcurrent825a_t *ctx, uint16_t *data_out );
 
err_t hallcurrent825a_read_pin_volt ( hallcurrent825a_t *ctx, float *data_out );
 
err_t hallcurrent825a_calibration ( hallcurrent825a_t *ctx );
 
err_t hallcurrent825a_get_voltage ( hallcurrent825a_t *ctx, float *avr_voltage );
 
err_t hallcurrent825a_get_current ( hallcurrent825a_t *ctx, float *current );
 
uint8_t hallcurrent825a_get_odc1 ( hallcurrent825a_t *ctx );
 
uint8_t hallcurrent825a_get_odc2 ( hallcurrent825a_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // HALLCURRENT825A_H
 
 // hallcurrent825a
 
// ------------------------------------------------------------------------ END