thumbwheel.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 THUMBWHEEL_H
#define THUMBWHEEL_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_one_wire.h"
 
#define THUMBWHEEL_CMD_CHANNEL_ACCESS_READ         0xF5
#define THUMBWHEEL_CMD_RESET_ACTIVITY_LATCHES      0xC3
#define THUMBWHEEL_CMD_WRITE_COND_SEARCH_REG       0xCC
#define THUMBWHEEL_CMD_READ_PIO_REG                0xF0
 
 // thumbwheel_cmd
 
#define THUMBWHEEL_REG_CONTROL_STATUS              0x008D
#define THUMBWHEEL_REG_COND_SEARCH_SELECTION       0x008B  
#define THUMBWHEEL_REG_PIO_LOGIC                   0x0088
 
 // thumbwheel_reg
 
#define THUMBWHEEL_FAMILY_CODE                     0x29
#define THUMBWHEEL_CONFIG_RESERVED_BITS            0x70
 
 // thumbwheel_set
 
#define THUMBWHEEL_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.gp0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );
 
 // thumbwheel_map
 // thumbwheel
 
typedef enum
{
    THUMBWHEEL_GPIO_0,                  
    THUMBWHEEL_GPIO_1                   
} thumbwheel_gpio_sel_t;
 
typedef struct
{
    // Output pins
    digital_out_t rst;                  
    // Modules
    one_wire_t ow;                      
    one_wire_rom_address_t rom_addr;    
} thumbwheel_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t gp0;                     
    pin_name_t gp1;                     
    // Additional gpio pins
    pin_name_t rst;                     
    thumbwheel_gpio_sel_t gpio_sel;     
} thumbwheel_cfg_t;
 
typedef enum
{
    THUMBWHEEL_OK = 0,
    THUMBWHEEL_ERROR = -1
 
} thumbwheel_return_value_t;
 
void thumbwheel_cfg_setup ( thumbwheel_cfg_t *cfg );
 
void thumbwheel_gpio_selection ( thumbwheel_cfg_t *cfg, thumbwheel_gpio_sel_t gpio_sel );
 
err_t thumbwheel_init ( thumbwheel_t *ctx, thumbwheel_cfg_t *cfg );
 
err_t thumbwheel_check_communication ( thumbwheel_t *ctx );
 
err_t thumbwheel_write_register ( thumbwheel_t *ctx, uint16_t reg, uint8_t data_in ); 
 
err_t thumbwheel_read_register ( thumbwheel_t *ctx, uint16_t reg, uint8_t *data_out );
 
err_t thumbwheel_reset_latches ( thumbwheel_t *ctx ); 
 
err_t thumbwheel_get_position ( thumbwheel_t *ctx, uint8_t *position ); 
 
void thumbwheel_set_rst_pin ( thumbwheel_t *ctx, uint8_t state );
 
#ifdef __cplusplus
}
#endif
#endif // THUMBWHEEL_H
 
 // thumbwheel
 
// ------------------------------------------------------------------------ END