c3dhall  2.0.0.0
Data Structures | Macros | Functions
c3dhall.h File Reference

This file contains API for c3D Hall Click driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"

Go to the source code of this file.

Data Structures

struct  c3dhall_t
 Click ctx object definition. More...
 
struct  c3dhall_cfg_t
 Click configuration structure definition. More...
 
struct  c3dhall_all_data_t
 All data structure definition. More...
 

Macros

#define C3DHALL_MAP_MIKROBUS(cfg, mikrobus)
 
#define C3DHALL_RETVAL   uint8_t
 
#define C3DHALL_OK   0x00
 
#define C3DHALL_INIT_ERROR   0xFF
 
#define C3DHALL_NO_ERRORS   0x0000
 
#define C3DHALL_F_ADCMONITOR   0x0004
 
#define C3DHALL_F_ADCSATURA   0x0008
 
#define C3DHALL_F_GAINTOOLOW   0x0010
 
#define C3DHALL_F_GAINTOOHIGH   0x0020
 
#define C3DHALL_F_NORMTOOLOW   0x0040
 
#define C3DHALL_F_FIELDTOOLOW   0x0080
 
#define C3DHALL_F_FIELDTOOHIGH   0x0100
 
#define C3DHALL_F_ROCLAMP   0x0200
 
#define C3DHALL_F_DEADZONEALPHA   0x0800
 
#define C3DHALL_F_DEADZONEBETA   0x8000
 
#define C3DHALL_MULTIPLE_ERRORS   0xFFFF
 
#define C3DHALL_START_COMMUNICATION_BYTE   0xFF
 

Functions

void c3dhall_cfg_setup (c3dhall_cfg_t *cfg)
 Config Object Initialization function. More...
 
C3DHALL_RETVAL c3dhall_init (c3dhall_t *ctx, c3dhall_cfg_t *cfg)
 Initialization function. More...
 
void c3dhall_read_all_data (c3dhall_t *ctx, c3dhall_all_data_t *all_data)
 Read 8 bytes data from sensor function. More...
 
uint8_t c3dhall_calculate_angle (c3dhall_t *ctx, uint16_t data_angle)
 Calculate angle function. More...
 

Detailed Description

This file contains API for c3D Hall Click driver.