thumbwheel 2.0.0.0
thumbwheel.h File Reference

This file contains API for Thumbwheel Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_one_wire.h"

Go to the source code of this file.

Data Structures

struct  thumbwheel_t
 Thumbwheel Click context object. More...
 
struct  thumbwheel_cfg_t
 Thumbwheel Click configuration object. More...
 

Macros

#define THUMBWHEEL_CMD_CHANNEL_ACCESS_READ   0xF5
 Thumbwheel commands list.
 
#define THUMBWHEEL_CMD_RESET_ACTIVITY_LATCHES   0xC3
 
#define THUMBWHEEL_CMD_WRITE_COND_SEARCH_REG   0xCC
 
#define THUMBWHEEL_CMD_READ_PIO_REG   0xF0
 
#define THUMBWHEEL_REG_CONTROL_STATUS   0x008D
 Thumbwheel register addresses.
 
#define THUMBWHEEL_REG_COND_SEARCH_SELECTION   0x008B
 
#define THUMBWHEEL_REG_PIO_LOGIC   0x0088
 
#define THUMBWHEEL_FAMILY_CODE   0x29
 Thumbwheel family code value and config.
 
#define THUMBWHEEL_CONFIG_RESERVED_BITS   0x70
 
#define THUMBWHEEL_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  thumbwheel_gpio_sel_t { THUMBWHEEL_GPIO_0 , THUMBWHEEL_GPIO_1 }
 Thumbwheel Click gpio selector. More...
 
enum  thumbwheel_return_value_t { THUMBWHEEL_OK = 0 , THUMBWHEEL_ERROR = -1 }
 Thumbwheel Click return value data. More...
 

Functions

void thumbwheel_cfg_setup (thumbwheel_cfg_t *cfg)
 Thumbwheel configuration object setup function.
 
void thumbwheel_gpio_selection (thumbwheel_cfg_t *cfg, thumbwheel_gpio_sel_t gpio_sel)
 Thumbwheel driver interface setup function.
 
err_t thumbwheel_init (thumbwheel_t *ctx, thumbwheel_cfg_t *cfg)
 Thumbwheel initialization function.
 
err_t thumbwheel_check_communication (thumbwheel_t *ctx)
 Thumbwheel check communication function.
 
err_t thumbwheel_write_register (thumbwheel_t *ctx, uint16_t reg, uint8_t data_in)
 Thumbwheel write register function.
 
err_t thumbwheel_read_register (thumbwheel_t *ctx, uint16_t reg, uint8_t *data_out)
 Thumbwheel read register function.
 
err_t thumbwheel_reset_latches (thumbwheel_t *ctx)
 Thumbwheel reset latches function.
 
err_t thumbwheel_get_position (thumbwheel_t *ctx, uint8_t *position)
 Thumbwheel get position function.
 
void thumbwheel_set_rst_pin (thumbwheel_t *ctx, uint8_t state)
 Thumbwheel set reset pin function.
 

Detailed Description

This file contains API for Thumbwheel Click Driver.

Enumeration Type Documentation

◆ thumbwheel_gpio_sel_t

Thumbwheel Click gpio selector.

Selects gpio pin of Thumbwheel Click driver.

Enumerator
THUMBWHEEL_GPIO_0 

GPIO 0 pin.

THUMBWHEEL_GPIO_1 

GPIO 1 pin.

◆ thumbwheel_return_value_t

Thumbwheel Click return value data.

Predefined enum values for driver return values.

Enumerator
THUMBWHEEL_OK 
THUMBWHEEL_ERROR