magneto9.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 MAGNETO9_H
#define MAGNETO9_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"
#include "drv_i2c_master.h"
 
#define MAGNETO9_SET_DEV_ADDR           0x4D
 
#define MAGNETO9_ADC_RESOLUTION         0x0FFF
#define MAGNETO9_VREF_5V                5.0
 
#define MAGNETO9_QUIESCENT_VOUT         2.5
#define MAGNETO9_AN_SENSITIVITY_V_PER_G 0.009
#define MAGNETO9_GAUSS_TO_MILITESLA     0.1
 
#define MAGNETO9_VOLTAGE_TO_FIELD_STRENGTH( voltage )   ( ( ( voltage - MAGNETO9_QUIESCENT_VOUT ) / \
                                                            MAGNETO9_AN_SENSITIVITY_V_PER_G ) * \
                                                          MAGNETO9_GAUSS_TO_MILITESLA )
 
 // magneto9_set
 
#define MAGNETO9_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // magneto9_map
 // magneto9
 
typedef struct
{
    digital_in_t pwm;           
    analog_in_t  adc;           
    i2c_master_t i2c;           
    uint8_t slave_address;      
} magneto9_t;
 
typedef struct
{
    pin_name_t  an;             
    pin_name_t  pwm;            
    pin_name_t  scl;            
    pin_name_t  sda;            
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
    analog_in_resolution_t  resolution;  
    float                   vref;        
} magneto9_cfg_t;
 
typedef enum
{
    MAGNETO9_OK = 0,
    MAGNETO9_ERROR = -1
 
} magneto9_return_value_t;
 
void magneto9_cfg_setup ( magneto9_cfg_t *cfg );
 
err_t magneto9_init ( magneto9_t *ctx, magneto9_cfg_t *cfg );
 
err_t magneto9_read_an_pin_value ( magneto9_t *ctx, uint16_t *data_out );
 
err_t magneto9_read_an_pin_voltage ( magneto9_t *ctx, float *data_out );
 
err_t magneto9_read_raw_adc ( magneto9_t *ctx, uint16_t *raw_adc );
 
err_t magneto9_read_adc_voltage ( magneto9_t *ctx, float *voltage );
 
uint8_t magneto9_get_pwm_pin ( magneto9_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // MAGNETO9_H
 
 // magneto9
 
// ------------------------------------------------------------------------ END