magneticrotary5.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 MAGNETICROTARY5_H
#define MAGNETICROTARY5_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 MAGNETICROTARY5_CMD_WRITE_CONFIG            0x17
#define MAGNETICROTARY5_CMD_SET_MT_COUNTER          0x14
#define MAGNETICROTARY5_CMD_EN_PROG                 0x10
#define MAGNETICROTARY5_CMD_RD_MT_COUNTER           0x04
#define MAGNETICROTARY5_CMD_RD_ANGLE                0x00
#define MAGNETICROTARY5_CMD_WRITE_OTP               0x1F
#define MAGNETICROTARY5_CMD_PROG_OTP                0x19
#define MAGNETICROTARY5_CMD_READ_OTP                0x0F
#define MAGNETICROTARY5_CMD_READ_ANA                0x09
 
 // magneticrotary5_reg
 
#define MAGNETICROTARY5_MASK_AGC_BITS               0x3F
#define MAGNETICROTARY5_MASK_ANGLE_MSB              0x01
#define MAGNETICROTARY5_MASK_MT_CNT_MSB             0x01FE
#define MAGNETICROTARY5_MASK_MT_CNT_LSB             0x01
#define MAGNETICROTARY5_MASK_5_LSB                  0x1F
#define MAGNETICROTARY5_MASK_3_LSB                  0x07
#define MAGNETICROTARY5_MAX_DATA_LEN                8
#define MAGNETICROTARY5_MIN_DATA_LEN                1
#define MAGNETICROTARY5_MAX_MT_CNT                  255
#define MAGNETICROTARY5_MIN_MT_CNT                  (-256)
#define MAGNETICROTARY5_DEFAULT_MT_CNT              0
 
#define MAGNETICROTARY5_VREF_3V3                    3.3
#define MAGNETICROTARY5_VREF_5V                     5.0
 
 // magneticrotary5_set
 
#define MAGNETICROTARY5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.dio   = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.ddclk = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs    = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.an    = MIKROBUS( mikrobus, MIKROBUS_AN );
 
 // magneticrotary5_map
 // magneticrotary5
 
typedef struct
{
    digital_out_t ddclk;            
    digital_out_t cs;               
    pin_name_t    dio;              
    analog_in_t   adc;              
} magneticrotary5_t;
 
typedef struct
{
    pin_name_t ddclk;               
    pin_name_t cs;                  
    pin_name_t dio;                 
    pin_name_t an;                  
    analog_in_resolution_t resolution;      
    float                  vref;            
} magneticrotary5_cfg_t;
 
typedef enum
{
    MAGNETICROTARY5_OK = 0,
    MAGNETICROTARY5_ERROR = -1
 
} magneticrotary5_return_value_t;
 
void magneticrotary5_cfg_setup ( magneticrotary5_cfg_t *cfg );
 
err_t magneticrotary5_init ( magneticrotary5_t *ctx, magneticrotary5_cfg_t *cfg );
 
err_t magneticrotary5_default_cfg ( magneticrotary5_t *ctx );
 
err_t magneticrotary5_write_cmd ( magneticrotary5_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len );
 
err_t magneticrotary5_read_cmd ( magneticrotary5_t *ctx, uint8_t cmd, uint8_t *data_out, uint8_t len );
 
err_t magneticrotary5_read_angle ( magneticrotary5_t *ctx, uint8_t *agc, uint16_t *angle );
 
err_t magneticrotary5_read_mt_cnt ( magneticrotary5_t *ctx, int16_t *mt_cnt );
 
err_t magneticrotary5_set_mt_cnt ( magneticrotary5_t *ctx, int16_t mt_cnt );
 
err_t magneticrotary5_read_raw_adc ( magneticrotary5_t *ctx, uint16_t *raw_adc );
 
err_t magneticrotary5_read_voltage ( magneticrotary5_t *ctx, float *voltage );
 
err_t magneticrotary5_set_vref ( magneticrotary5_t *ctx, float vref );
 
#ifdef __cplusplus
}
#endif
#endif // MAGNETICROTARY5_H
 
 // magneticrotary5
 
// ------------------------------------------------------------------------ END