c3dhall6.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 C3DHALL6_H
#define C3DHALL6_H
 
#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_spi_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define C3DHALL6_MAP_MIKROBUS( cfg, mikrobus ) \
   cfg.miso  = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
   cfg.mosi  = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
   cfg.sck   = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
   cfg.cs    = MIKROBUS( mikrobus, MIKROBUS_CS )
#define C3DHALL6_OK             0
#define C3DHALL6_ERROR         -1
#define C3DHALL6_CHANNEL_0      0x00
#define C3DHALL6_CHANNEL_1      0x40
#define C3DHALL6_CHANNEL_2      0x80
#define C3DHALL6_CHANNEL_3      0xC0
#define C3DHALL6_DIE_A          0x01
#define C3DHALL6_DIE_B          0x02
#define SINGLE_PI_CONST         3.14
#define HALF_PI_CONST            1.57
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct 
{
    uint16_t aux_ch0;
    uint16_t aux_ch1;
    uint16_t aux_ch2;
    uint16_t aux_ch3;
    
} c3dhall6_aux_ch_t;
 
typedef struct 
{
    float aux_float_ch0;
    float aux_float_ch1;
    float aux_float_ch2;
    float aux_float_ch3;
    
} c3dhall6_aux_float_ch_t ;
 
typedef struct 
{
   float aux_ref_adc_ch0;
   float aux_ref_adc_ch1;
   float aux_ref_adc_ch2;
   float aux_ref_adc_ch3;
   float aux_ref_volt;
   
} c3dhall6_aux_ref_t ;
 
typedef struct
{
    // Modules 
    spi_master_t spi;
    pin_name_t chip_select;
    
    c3dhall6_aux_ref_t device_aux_ref;
    c3dhall6_aux_ch_t device_aux_ch;
    c3dhall6_aux_float_ch_t device_float_ch;
 
} c3dhall6_t;
 
typedef struct
{
    // Communication gpio pins 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // static variable 
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
    
    c3dhall6_aux_ref_t  dev_aux_ref;
 
} c3dhall6_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void c3dhall6_cfg_setup ( c3dhall6_cfg_t *cfg );
 
err_t c3dhall6_init ( c3dhall6_t *ctx, c3dhall6_cfg_t *cfg );
 
void c3dhall6_default_cfg ( c3dhall6_t *ctx );
 
void c3dhall6_set_reference_values ( c3dhall6_t *ctx, c3dhall6_aux_ref_t ref_val );
 
void c3dhall6_get_adc_value ( c3dhall6_t *ctx, uint8_t channel_no, uint16_t *adc_value );
 
void c3dhall6_get_volt( c3dhall6_t *ctx, uint8_t channel_no, float *channel_voltage );
 
void c3dhall6_get_angle_deg ( c3dhall6_t *ctx, uint8_t die, float *angle_value );
 
void c3dhall6_get_angle_rad ( c3dhall6_t *ctx, uint8_t die, float *angle_value );
 
#ifdef __cplusplus
}
#endif
#endif  // _C3DHALL6_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END