rotaryr 2.0.0.0
rotaryr.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 ROTARYR_H
29#define ROTARYR_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_spi_master.h"
38
54#define ROTARYR_ONE_LED 0x0001
55#define ROTARYR_TWO_LED 0x0101
56#define ROTARYR_FOUR_LED 0x1111
57#define ROTARYR_EIGHT_LED 0x5555
58#define ROTARYR_RESET_LED 0x0000
59 // rotaryr_led
61
76#define ROTARYR_MAP_MIKROBUS( cfg, mikrobus ) \
77 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
78 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
79 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
80 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
81 cfg.ecb = MIKROBUS( mikrobus, MIKROBUS_AN ); \
82 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
83 cfg.eca = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
84 cfg.sw = MIKROBUS( mikrobus, MIKROBUS_INT )
85 // rotaryr_map // rotaryr
88
93typedef struct
94{
95 // Output pins
96
97 digital_out_t rst;
98 digital_out_t cs;
99
100 // Input pins
101
102 digital_in_t ecb;
103 digital_in_t eca;
104 digital_in_t sw;
105
106 // Modules
107
108 spi_master_t spi;
110 pin_name_t chip_select;
112} rotaryr_t;
113
118typedef struct
119{
120 // Communication gpio pins
121
122 pin_name_t miso;
123 pin_name_t mosi;
124 pin_name_t sck;
125 pin_name_t cs;
127 // Additional gpio pins
128
129 pin_name_t ecb;
130 pin_name_t rst;
131 pin_name_t eca;
132 pin_name_t sw;
133
134 // static variable
135
136 uint32_t spi_speed;
137 spi_master_mode_t spi_mode;
138 spi_master_chip_select_polarity_t cs_polarity;
141
146typedef enum
147{
149 ROTARYR_ERROR = -1
150
152
169
185
200void rotaryr_generic_transfer ( rotaryr_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
201
212void rotaryr_turn_on_led_by_data ( rotaryr_t *ctx, uint16_t write_data );
213
224void rotaryr_turn_on_led_by_position ( rotaryr_t *ctx, uint8_t led_position );
225
237
246uint16_t rotaryr_get_led_data ( uint8_t current_led_state );
247
258
269
280
281#ifdef __cplusplus
282}
283#endif
284#endif // ROTARYR_H
285 // rotaryr
287
288// ------------------------------------------------------------------------ END
uint8_t rotaryr_button_push(rotaryr_t *ctx)
Button push state.
uint8_t rotaryr_get_ecb_state(rotaryr_t *ctx)
State ecb pin.
void rotaryr_generic_transfer(rotaryr_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
ROTARY R data transfer function.
uint8_t rotaryr_get_eca_state(rotaryr_t *ctx)
State eca pin.
void rotaryr_cfg_setup(rotaryr_cfg_t *cfg)
ROTARY R configuration object setup function.
uint16_t rotaryr_get_led_data(uint8_t current_led_state)
Get led data state.
void rotaryr_turn_on_led_by_data(rotaryr_t *ctx, uint16_t write_data)
ROTARY R generic data write function.
void rotaryr_reset_led(rotaryr_t *ctx)
Reset led.
err_t rotaryr_init(rotaryr_t *ctx, rotaryr_cfg_t *cfg)
ROTARY R initialization function.
void rotaryr_turn_on_led_by_position(rotaryr_t *ctx, uint8_t led_position)
ROTARY R turn on led by position function.
rotaryr_return_value_t
ROTARY R Click return value data.
Definition: rotaryr.h:147
@ ROTARYR_ERROR
Definition: rotaryr.h:149
@ ROTARYR_OK
Definition: rotaryr.h:148
ROTARY R Click configuration object.
Definition: rotaryr.h:119
spi_master_chip_select_polarity_t cs_polarity
Definition: rotaryr.h:138
pin_name_t eca
Definition: rotaryr.h:131
pin_name_t sck
Definition: rotaryr.h:124
spi_master_mode_t spi_mode
Definition: rotaryr.h:137
pin_name_t mosi
Definition: rotaryr.h:123
uint32_t spi_speed
Definition: rotaryr.h:136
pin_name_t sw
Definition: rotaryr.h:132
pin_name_t miso
Definition: rotaryr.h:122
pin_name_t rst
Definition: rotaryr.h:130
pin_name_t cs
Definition: rotaryr.h:125
pin_name_t ecb
Definition: rotaryr.h:129
ROTARY R Click context object.
Definition: rotaryr.h:94
digital_out_t cs
Definition: rotaryr.h:98
digital_in_t eca
Definition: rotaryr.h:103
spi_master_t spi
Definition: rotaryr.h:108
digital_in_t ecb
Definition: rotaryr.h:102
digital_in_t sw
Definition: rotaryr.h:104
digital_out_t rst
Definition: rotaryr.h:97
pin_name_t chip_select
Definition: rotaryr.h:110