thumbwheel  2.0.0.0
thumbwheel.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef THUMBWHEEL_H
29 #define THUMBWHEEL_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_one_wire.h"
38 
59 #define THUMBWHEEL_CMD_CHANNEL_ACCESS_READ 0xF5
60 #define THUMBWHEEL_CMD_RESET_ACTIVITY_LATCHES 0xC3
61 #define THUMBWHEEL_CMD_WRITE_COND_SEARCH_REG 0xCC
62 #define THUMBWHEEL_CMD_READ_PIO_REG 0xF0
63  // thumbwheel_cmd
65 
80 #define THUMBWHEEL_REG_CONTROL_STATUS 0x008D
81 #define THUMBWHEEL_REG_COND_SEARCH_SELECTION 0x008B
82 #define THUMBWHEEL_REG_PIO_LOGIC 0x0088
83  // thumbwheel_reg
85 
95 #define THUMBWHEEL_FAMILY_CODE 0x29
96 #define THUMBWHEEL_CONFIG_RESERVED_BITS 0x70
97  // thumbwheel_set
99 
114 #define THUMBWHEEL_MAP_MIKROBUS( cfg, mikrobus ) \
115  cfg.gp0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
116  cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
117  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );
118  // thumbwheel_map // thumbwheel
121 
126 typedef enum
127 {
132 
137 typedef struct
138 {
139  // Output pins
140  digital_out_t rst;
142  // Modules
143  one_wire_t ow;
145  one_wire_rom_address_t rom_addr;
147 } thumbwheel_t;
148 
153 typedef struct
154 {
155  // Communication gpio pins
156  pin_name_t gp0;
157  pin_name_t gp1;
159  // Additional gpio pins
160  pin_name_t rst;
165 
170 typedef enum
171 {
173  THUMBWHEEL_ERROR = -1
174 
176 
193 
209 
225 
238 
251 err_t thumbwheel_write_register ( thumbwheel_t *ctx, uint16_t reg, uint8_t data_in );
252 
265 err_t thumbwheel_read_register ( thumbwheel_t *ctx, uint16_t reg, uint8_t *data_out );
266 
278 
290 err_t thumbwheel_get_position ( thumbwheel_t *ctx, uint8_t *position );
291 
301 void thumbwheel_set_rst_pin ( thumbwheel_t *ctx, uint8_t state );
302 
303 #ifdef __cplusplus
304 }
305 #endif
306 #endif // THUMBWHEEL_H
307  // thumbwheel
309 
310 // ------------------------------------------------------------------------ END
thumbwheel_get_position
err_t thumbwheel_get_position(thumbwheel_t *ctx, uint8_t *position)
Thumbwheel get position function.
thumbwheel_cfg_setup
void thumbwheel_cfg_setup(thumbwheel_cfg_t *cfg)
Thumbwheel configuration object setup function.
THUMBWHEEL_OK
@ THUMBWHEEL_OK
Definition: thumbwheel.h:172
thumbwheel_t::rst
digital_out_t rst
Definition: thumbwheel.h:140
thumbwheel_check_communication
err_t thumbwheel_check_communication(thumbwheel_t *ctx)
Thumbwheel check communication function.
thumbwheel_return_value_t
thumbwheel_return_value_t
Thumbwheel Click return value data.
Definition: thumbwheel.h:171
thumbwheel_cfg_t::gp1
pin_name_t gp1
Definition: thumbwheel.h:157
THUMBWHEEL_GPIO_0
@ THUMBWHEEL_GPIO_0
Definition: thumbwheel.h:128
thumbwheel_gpio_selection
void thumbwheel_gpio_selection(thumbwheel_cfg_t *cfg, thumbwheel_gpio_sel_t gpio_sel)
Thumbwheel driver interface setup function.
thumbwheel_set_rst_pin
void thumbwheel_set_rst_pin(thumbwheel_t *ctx, uint8_t state)
Thumbwheel set reset pin function.
thumbwheel_reset_latches
err_t thumbwheel_reset_latches(thumbwheel_t *ctx)
Thumbwheel reset latches function.
thumbwheel_gpio_sel_t
thumbwheel_gpio_sel_t
Thumbwheel Click gpio selector.
Definition: thumbwheel.h:127
thumbwheel_write_register
err_t thumbwheel_write_register(thumbwheel_t *ctx, uint16_t reg, uint8_t data_in)
Thumbwheel write register function.
thumbwheel_init
err_t thumbwheel_init(thumbwheel_t *ctx, thumbwheel_cfg_t *cfg)
Thumbwheel initialization function.
thumbwheel_t::ow
one_wire_t ow
Definition: thumbwheel.h:143
thumbwheel_cfg_t::gp0
pin_name_t gp0
Definition: thumbwheel.h:156
thumbwheel_cfg_t::gpio_sel
thumbwheel_gpio_sel_t gpio_sel
Definition: thumbwheel.h:162
THUMBWHEEL_GPIO_1
@ THUMBWHEEL_GPIO_1
Definition: thumbwheel.h:129
THUMBWHEEL_ERROR
@ THUMBWHEEL_ERROR
Definition: thumbwheel.h:173
thumbwheel_t
Thumbwheel Click context object.
Definition: thumbwheel.h:138
thumbwheel_cfg_t::rst
pin_name_t rst
Definition: thumbwheel.h:160
thumbwheel_read_register
err_t thumbwheel_read_register(thumbwheel_t *ctx, uint16_t reg, uint8_t *data_out)
Thumbwheel read register function.
thumbwheel_t::rom_addr
one_wire_rom_address_t rom_addr
Definition: thumbwheel.h:145
thumbwheel_cfg_t
Thumbwheel Click configuration object.
Definition: thumbwheel.h:154