compass5.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 COMPASS5_H
#define COMPASS5_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_i2c_master.h"
 
#define COMPASS5_DEVICE_ID_NUM                  0X0C
#define COMPASS5_COMPANI_ID_NUM                 0X48
#define COMPASS5_COMPANI_ID                     0x00
#define COMPASS5_DEVICE_ID                      0x01
 
#define COMPASS5_DATA_STATUS_1                  0x10
                                    
#define COMPASS5_X_AXIS_DATA_L                  0x11
#define COMPASS5_X_AXIS_DATA_H                  0x12
#define COMPASS5_Y_AXIS_DATA_L                  0x13
#define COMPASS5_Y_AXIS_DATA_H                  0x14
#define COMPASS5_Z_AXIS_DATA_L                  0x15
#define COMPASS5_Z_AXIS_DATA_H                  0x16
  
#define COMPASS5_DUMMY_TMPS                     0x17
#define COMPASS5_DATA_STATUS_2                  0x18
 
#define COMPASS5_DUMMY_CNTL1                    0x30
#define COMPASS5_CONTROL_2_SETTINGS             0x31
#define COMPASS5_CONTROL_3_SETTINGS             0x32
#define COMPASS5_TEST_TS1                       0x33
#define COMPASS5_TEST_TS2                       0x34
 
 // compass5_reg
 
#define COMPASS5_MODE_POWER_DOWN                0x00
#define COMPASS5_MODE_SINGLE_MEASUREMENT        0x01
#define COMPASS5_MODE_CON_MEASUREMENT_10HZ      0x02
#define COMPASS5_MODE_CON_MEASUREMENT_20HZ      0x04
#define COMPASS5_MODE_CON_MEASUREMENT_50HZ      0x06
#define COMPASS5_MODE_CON_MEASUREMENT_100HZ     0x08
#define COMPASS5_MODE_SELF_TEST                 0x10
 
#define COMPASS5_SRST_BIT                       0x01
#define COMPASS5_HOFL_BIT                       0x08
#define COMPASS5_DOR_BIT                        0x02
#define COMPASS5_DRDY_BIT                       0x01
 
#define COMPASS5_DATA_NO_READY                  0x00
#define COMPASS5_DATA_READY                     0x01
 
#define COMPASS5_BIT_MASK_BIT0                  0x01
 
#define COMPASS5_SET_DEV_ADDR  0x0C
 
 // compass5_set
 
#define COMPASS5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
 
 // compass5_map
 // compass5
 
typedef struct
{
    // Modules
    i2c_master_t i2c;                 
    // I2C slave address           
    uint8_t slave_address;            
} compass5_t;
 
typedef struct
{
    pin_name_t  scl;                  
    pin_name_t  sda;                  
    uint32_t  i2c_speed;              
    uint8_t   i2c_address;            
} compass5_cfg_t;
 
typedef enum
{
   COMPASS5_OK = 0,
   COMPASS5_ERROR = -1
 
} compass5_return_value_t;
 
void compass5_cfg_setup ( compass5_cfg_t *cfg );
 
err_t compass5_init ( compass5_t *ctx, compass5_cfg_t *cfg );
 
err_t compass5_generic_write ( compass5_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t compass5_generic_read ( compass5_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
void compass5_write_byte ( compass5_t *ctx, uint8_t reg, uint8_t tx_data );
 
uint8_t compass5_read_byte ( compass5_t *ctx, uint8_t reg );
 
void compass5_sw_reset ( compass5_t *ctx );
 
void compass5_get_id ( compass5_t *ctx, uint8_t *company_id, uint8_t *device_id );
 
uint8_t compass5_check_data_ready ( compass5_t *ctx );
 
uint8_t compass5_check_data_overrun ( compass5_t *ctx );
 
uint8_t compass5_set_operation_mode ( compass5_t *ctx, uint8_t op_mode );
 
uint8_t compass5_get_operation_mode ( compass5_t *ctx );
 
void compass5_measurement_axis ( compass5_t *ctx, int16_t *axis_x, int16_t *axis_y, int16_t *axis_z );
 
void compass5_get_mag_data ( compass5_t *ctx, int16_t *axis_x, int16_t *axis_y, int16_t *axis_z );
#ifdef __cplusplus
}
#endif
#endif // COMPASS5_H
 
 // compass5
 
// ------------------------------------------------------------------------ END