joystick3.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 JOYSTICK3_H
#define JOYSTICK3_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_spi_master.h"
#include "spi_specifics.h"
 
#define JOYSTICK3_ADC_START_BIT             0x04
#define JOYSTICK3_ADC_SINGLE_ENDED          0x02
#define JOYSTICK3_ADC_CHANNEL_X             0x00
#define JOYSTICK3_ADC_CHANNEL_Y             0x40
#define JOYSTICK3_ADC_DATA_RESOLUTION       0x0FFF
#define JOYSTICK3_ADC_DATA_RESOLUTION_HALF  ( ( float ) JOYSTICK3_ADC_DATA_RESOLUTION / 2 )
 
#define JOYSTICK3_RADIANS_TO_DEGREES        57.295779513
#define JOYSTICK3_ANGLE_ZERO_OFFSET         180.0
#define JOYSTICK3_PI_RAD_OFFSET             1.0
#define JOYSTICK3_NEUTRAL_POSITION_OFFSET   ( ( float ) JOYSTICK3_ADC_DATA_RESOLUTION / 8 )
#define JOYSTICK3_FULL_ANGLE                360.0f
#define JOYSTICK3_ZERO_ANGLE                0.0f
#define JOYSTICK3_ANGLE_POSITION_STEP       45.0f
 
#define JOYSTICK3_POSITION_NEUTRAL          0
#define JOYSTICK3_POSITION_UP               1
#define JOYSTICK3_POSITION_UPPER_RIGHT      2
#define JOYSTICK3_POSITION_RIGHT            3
#define JOYSTICK3_POSITION_LOWER_RIGHT      4
#define JOYSTICK3_POSITION_DOWN             5
#define JOYSTICK3_POSITION_LOWER_LEFT       6
#define JOYSTICK3_POSITION_LEFT             7
#define JOYSTICK3_POSITION_UPPER_LEFT       8
 
#define JOYSTICK3_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define JOYSTICK3_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // joystick3_set
 
#define JOYSTICK3_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 );
 
 // joystick3_map
 // joystick3
 
typedef struct
{
    // Modules
    spi_master_t spi;                   
    pin_name_t   chip_select;           
} joystick3_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;  
} joystick3_cfg_t;
 
typedef enum
{
    JOYSTICK3_OK = 0,
    JOYSTICK3_ERROR = -1
 
} joystick3_return_value_t;
 
void joystick3_cfg_setup ( joystick3_cfg_t *cfg );
 
err_t joystick3_init ( joystick3_t *ctx, joystick3_cfg_t *cfg );
 
err_t joystick3_read_raw_adc ( joystick3_t *ctx, uint16_t *raw_x, uint16_t *raw_y );
 
float joystick3_get_angle ( uint16_t raw_x, uint16_t raw_y );
 
uint8_t joystick3_get_position ( uint16_t raw_x, uint16_t raw_y );
 
#ifdef __cplusplus
}
#endif
#endif // JOYSTICK3_H
 
 // joystick3
 
// ------------------------------------------------------------------------ END