capwheel.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 CAPWHEEL_H
#define CAPWHEEL_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_i2c_master.h"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define CAPWHEEL_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg. clr = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg. rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
#define CAPWHEEL_RETVAL  uint8_t
 
#define CAPWHEEL_OK           0x00
#define CAPWHEEL_INIT_ERROR   0xFF
#define CAPWHEEL_DEVICE_ADDR                            0x64
#define CAPWHEEL_DEVICE_INFO_REG                        0x00
#define CAPWHEEL_SYSTEM_FLAGS_REG                       0x01
#define CAPWHEEL_WHEEL_COORDNT_REG                      0x02
#define CAPWHEEL_TOUCH_BYTES_REG                        0x03
#define CAPWHEEL_COUNTS_REG                             0x04
#define CAPWHEEL_LTA_REG                                0x05
#define CAPWHEEL_MULTIPLIERS_REG                        0x06
#define CAPWHEEL_COMPENS_REG                            0x07
#define CAPWHEEL_PROXSETT_REG                           0x08
#define CAPWHEEL_THRESH_REG                             0x09
#define CAPWHEEL_TIMINGS_REG                            0x0A
#define CAPWHEEL_TARGETS_REG                            0x0B
#define CAPWHEEL_PWM_DUTY_REG                           0x0C
#define CAPWHEEL_PWM_LIM_REG                            0x0D
#define CAPWHEEL_ACTIVE_CHANN_REG                       0x0E
#define CAPWHEEL_BUZZER_REG                             0x0F
#define CAPWHEEL_DEV_INFO_NBYTES                        2
#define CAPWHEEL_SYST_FLAGS_NBYTES                      1
#define CAPWHEEL_WHEEL_NBYTES                           4
#define CAPWHEEL_TOUCH_NBYTES                           2
#define CAPWHEEL_COUNTS_NBYTES                          18
#define CAPWHEEL_LTA_NBYTES                             18
#define CAPWHEEL_MULTIPL_NBYTES                         9
#define CAPWHEEL_COMPENS_NBYTES                         9
#define CAPWHEEL_PROXSETT_NBYTES                        6
#define CAPWHEEL_THRESH_NBYTES                          10
#define CAPWHEEL_TIMINGS_NBYTES                         13
#define CAPWHEEL_TARGETS_NBYTES                         10
#define CAPWHEEL_PWM_DUTY_NBYTES                        8
#define CAPWHEEL_PWM_LIM_NBYTES                         2
#define CAPWHEEL_ACT_CHANN_NBYTES                       2
#define CAPWHEEL_BUZZER_NBYTES                          1
#define CAPWHEEL_BUZZER_EN                              0x80
#define CAPWHEEL_BUZZER_DC_HIGH                         0x04
#define CAPWHEEL_BUZZER_DC_LOW                          0x00
#define CAPWHEEL_BUZZER_PERM_EN                         0x02
#define CAPWHEEL_BUZZER_BURST_EN                        0x01
#define CAPWHEEL_CH0_PROX_EN                           0x001
#define CAPWHEEL_CH1_EN                                0x002
#define CAPWHEEL_CH2_EN                                0x004
#define CAPWHEEL_CH3_EN                                0x008
#define CAPWHEEL_CH4_EN                                0x010
#define CAPWHEEL_CH5_EN                                0x020
#define CAPWHEEL_CH6_EN                                0x040
#define CAPWHEEL_CH7_EN                                0x080
#define CAPWHEEL_CH8_EN                                0x100
#define CAPWHEEL_CH9_EN                                0x200
#define CAPWHEEL_PWM_OFF                                0x00
#define CAPWHEEL_PWM_CONST                              0x20
#define CAPWHEEL_PWM_DECR_0_PERCENTS                    0x80
#define CAPWHEEL_PWM_DECR_LIM                           0xA0
#define CAPWHEEL_PWM_INCR_100_PERCENTS                  0xC0
#define CAPWHEEL_PWM_INCR_LIM                           0xE0
#define CAPWHEEL_PWM_DUTY_0_PERCENTS                    0x00
#define CAPWHEEL_PWM_DUTY_25_PERCENTS                   0x10
#define CAPWHEEL_PWM_DUTY_50_PERCENTS                   0x18
#define CAPWHEEL_PWM_DUTY_75_PERCENTS                   0x1C
#define CAPWHEEL_PWM_DUTY_100_PERCENTS                  0x1F
#define CAPWHEEL_DATA_READY                             0
#define CAPWHEEL_DATA_NOT_READY                         1
#define CAPWHEEL_ADDR_ERROR                             0xFF
#define CAPWHEEL_NBYTES_ERROR                           0xFE
#define CAPWHEEL_CH_SEL_ERROR                           0xFD
#define CAPWHEEL_OK                                     0x00
#define CAPWHEEL_LED_BRIGHTNESS_INTENSITY               0
#define CAPWHEEL_LED_BRIGHTNESS_NUMBER                  1
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t  clr;
 
    // Input pins 
 
    digital_in_t  rdy;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} capwheel_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t  clr;
    pin_name_t  rdy;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} capwheel_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void capwheel_cfg_setup ( capwheel_cfg_t *cfg );
 
CAPWHEEL_RETVAL capwheel_init ( capwheel_t *ctx, capwheel_cfg_t *cfg );
 
void capwheel_default_cfg ( capwheel_t *ctx );
 
void capwheel_generic_write ( capwheel_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void capwheel_generic_read ( capwheel_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
uint8_t capwheel_write_reg ( capwheel_t *ctx, uint8_t register_address, uint8_t *data_in, uint8_t n_bytes );
 
uint8_t capwheel_read_reg ( capwheel_t *ctx, uint8_t register_address, uint8_t *data_out, uint8_t n_bytes );
 
uint8_t capwheel_check_data_ready ( capwheel_t *ctx );
 
uint8_t capwheel_enable_chann ( capwheel_t *ctx, uint16_t sel_chann );
 
void capwheel_get_data ( capwheel_t *ctx, uint16_t *wheel_data );
 
void capwheel_set_output( capwheel_t *ctx, uint16_t input_data, uint8_t output_mode );
 
void capwheel_set_threshold ( capwheel_t *ctx, uint8_t thresh_value );
 
void capwheel_reset ( capwheel_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _CAPWHEEL_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END