rotaryr2  2.1.0.0
rotaryr2.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 ROTARYR2_H
29 #define ROTARYR2_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_spi_master.h"
38 #include "spi_specifics.h"
39 
55 #define ROTARYR2_SET_LED_OFF 0x0000u
56 #define ROTARYR2_SET_LED_DATA_1 0x0001u
57 #define ROTARYR2_SET_LED_DATA_2 0x0002u
58 #define ROTARYR2_SET_LED_DATA_3 0x0004u
59 #define ROTARYR2_SET_LED_DATA_4 0x0008u
60 #define ROTARYR2_SET_LED_DATA_5 0x0010u
61 #define ROTARYR2_SET_LED_DATA_6 0x0020u
62 #define ROTARYR2_SET_LED_DATA_7 0x0040u
63 #define ROTARYR2_SET_LED_DATA_8 0x0080u
64 #define ROTARYR2_SET_LED_DATA_9 0x0100u
65 #define ROTARYR2_SET_LED_DATA_10 0x0200u
66 #define ROTARYR2_SET_LED_DATA_11 0x0400u
67 #define ROTARYR2_SET_LED_DATA_12 0x0800u
68 #define ROTARYR2_SET_LED_DATA_13 0x1000u
69 #define ROTARYR2_SET_LED_DATA_14 0x2000u
70 #define ROTARYR2_SET_LED_DATA_15 0x4000u
71 #define ROTARYR2_SET_LED_DATA_16 0x8000u
72 
77 #define ROTARYR2_SET_LED_POS_1 1
78 #define ROTARYR2_SET_LED_POS_2 2
79 #define ROTARYR2_SET_LED_POS_3 3
80 #define ROTARYR2_SET_LED_POS_4 4
81 #define ROTARYR2_SET_LED_POS_5 5
82 #define ROTARYR2_SET_LED_POS_6 6
83 #define ROTARYR2_SET_LED_POS_7 7
84 #define ROTARYR2_SET_LED_POS_8 8
85 #define ROTARYR2_SET_LED_POS_9 9
86 #define ROTARYR2_SET_LED_POS_10 10
87 #define ROTARYR2_SET_LED_POS_11 11
88 #define ROTARYR2_SET_LED_POS_12 12
89 #define ROTARYR2_SET_LED_POS_13 13
90 #define ROTARYR2_SET_LED_POS_14 14
91 #define ROTARYR2_SET_LED_POS_15 15
92 #define ROTARYR2_SET_LED_POS_16 16
93 
102 #define ROTARYR2_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
103 #define ROTARYR2_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
104  // rotaryr2_set
106 
121 #define ROTARYR2_MAP_MIKROBUS( cfg, mikrobus ) \
122  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
123  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
124  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
125  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
126  cfg.enb = MIKROBUS( mikrobus, MIKROBUS_AN ); \
127  cfg.ena = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
128  cfg.sw = MIKROBUS( mikrobus, MIKROBUS_INT )
129  // rotaryr2_map // rotaryr2
132 
137 typedef struct
138 {
139  // Input pins
140  digital_in_t enb;
141  digital_in_t ena;
142  digital_in_t sw;
144  // Modules
145  spi_master_t spi;
147  pin_name_t chip_select;
149 } rotaryr2_t;
150 
155 typedef struct
156 {
157  // Communication gpio pins
158  pin_name_t miso;
159  pin_name_t mosi;
160  pin_name_t sck;
161  pin_name_t cs;
163  // Additional gpio pins
164  pin_name_t enb;
165  //pin_name_t rst; /**< Description. */
166  pin_name_t ena;
167  pin_name_t sw;
169  // static variable
170  uint32_t spi_speed;
171  spi_master_mode_t spi_mode;
172  spi_master_chip_select_polarity_t cs_polarity;
175 
180 typedef enum
181 {
183  ROTARYR2_ERROR = -1
184 
186 
203 
218 
232 
246 err_t rotaryr2_set_led_data ( rotaryr2_t *ctx, uint16_t data_in );
247 
261 err_t rotaryr2_get_led_data ( rotaryr2_t *ctx, uint16_t *data_out );
262 
276 err_t rotaryr2_set_led_pos ( rotaryr2_t *ctx, uint8_t led_pos );
277 
289 
301 
313 
314 #ifdef __cplusplus
315 }
316 #endif
317 #endif // ROTARYR2_H
318  // rotaryr2
320 
321 // ------------------------------------------------------------------------ END
rotaryr2_t::sw
digital_in_t sw
Definition: rotaryr2.h:142
rotaryr2_cfg_t::ena
pin_name_t ena
Definition: rotaryr2.h:166
rotaryr2_get_state_ena
uint8_t rotaryr2_get_state_ena(rotaryr2_t *ctx)
Rotary R 2 get ena state function.
rotaryr2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: rotaryr2.h:172
rotaryr2_cfg_t::sw
pin_name_t sw
Definition: rotaryr2.h:167
rotaryr2_cfg_t::mosi
pin_name_t mosi
Definition: rotaryr2.h:159
rotaryr2_t::enb
digital_in_t enb
Definition: rotaryr2.h:140
rotaryr2_default_cfg
err_t rotaryr2_default_cfg(rotaryr2_t *ctx)
Rotary R 2 default configuration function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
rotaryr2_get_led_data
err_t rotaryr2_get_led_data(rotaryr2_t *ctx, uint16_t *data_out)
Rotary R 2 get LED data function.
rotaryr2_cfg_setup
void rotaryr2_cfg_setup(rotaryr2_cfg_t *cfg)
Rotary R 2 configuration object setup function.
rotaryr2_get_state_enb
uint8_t rotaryr2_get_state_enb(rotaryr2_t *ctx)
Rotary R 2 get enb state function.
rotaryr2_t
Rotary R 2 Click context object.
Definition: rotaryr2.h:138
rotaryr2_t::spi
spi_master_t spi
Definition: rotaryr2.h:145
rotaryr2_set_led_pos
err_t rotaryr2_set_led_pos(rotaryr2_t *ctx, uint8_t led_pos)
Rotary R 2 set LED position function.
rotaryr2_t::ena
digital_in_t ena
Definition: rotaryr2.h:141
rotaryr2_return_value_t
rotaryr2_return_value_t
Rotary R 2 Click return value data.
Definition: rotaryr2.h:181
rotaryr2_get_state_switch
uint8_t rotaryr2_get_state_switch(rotaryr2_t *ctx)
Rotary R 2 get switch state function.
rotaryr2_cfg_t::enb
pin_name_t enb
Definition: rotaryr2.h:164
rotaryr2_init
err_t rotaryr2_init(rotaryr2_t *ctx, rotaryr2_cfg_t *cfg)
Rotary R 2 initialization function.
rotaryr2_cfg_t::spi_speed
uint32_t spi_speed
Definition: rotaryr2.h:170
ROTARYR2_OK
@ ROTARYR2_OK
Definition: rotaryr2.h:182
rotaryr2_t::chip_select
pin_name_t chip_select
Definition: rotaryr2.h:147
rotaryr2_cfg_t::sck
pin_name_t sck
Definition: rotaryr2.h:160
rotaryr2_cfg_t::miso
pin_name_t miso
Definition: rotaryr2.h:158
rotaryr2_cfg_t
Rotary R 2 Click configuration object.
Definition: rotaryr2.h:156
rotaryr2_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: rotaryr2.h:171
ROTARYR2_ERROR
@ ROTARYR2_ERROR
Definition: rotaryr2.h:183
rotaryr2_set_led_data
err_t rotaryr2_set_led_data(rotaryr2_t *ctx, uint16_t data_in)
Rotary R 2 set LED data function.
rotaryr2_cfg_t::cs
pin_name_t cs
Definition: rotaryr2.h:161