rfswitch  2.0.0.0
rfswitch.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 RFSWITCH_H
29 #define RFSWITCH_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 
68 #define RFSWITCH_ON_PIN_STATE_HIGH 0x01
69 #define RFSWITCH_ON_PIN_STATE_LOW 0x00
70 #define RFSWITCH_SEL_PIN_STATE_HIGH 0x01
71 #define RFSWITCH_SEL_PIN_STATE_LOW 0x00
72 #define RFSWITCH_SELECT_CHANNEL_1 0x01
73 #define RFSWITCH_SELECT_CHANNEL_2 0x02
74  // rfswitch_set
76 
91 #define RFSWITCH_MAP_MIKROBUS( cfg, mikrobus ) \
92  cfg.on = MIKROBUS( mikrobus, MIKROBUS_CS ); \
93  cfg.sel = MIKROBUS( mikrobus, MIKROBUS_PWM )
94  // rfswitch_map // rfswitch
97 
102 typedef struct
103 {
104  digital_out_t on;
105  digital_out_t sel;
107 } rfswitch_t;
108 
113 typedef struct
114 {
115  pin_name_t on;
116  pin_name_t sel;
119 
124 typedef enum
125 {
127  RFSWITCH_ERROR = -1
128 
130 
147 
163 
173 
184 void rfswitch_on_pin_set ( rfswitch_t *ctx, uint8_t enable );
185 
196 void rfswitch_sel_pin_set ( rfswitch_t *ctx, uint8_t enable );
197 
208 
219 void rfswitch_select_channel ( rfswitch_t *ctx, uint8_t select_channel );
220 
221 #ifdef __cplusplus
222 }
223 #endif
224 #endif // RFSWITCH_H
225  // rfswitch
227 
228 // ------------------------------------------------------------------------ END
RFSWITCH_ERROR
@ RFSWITCH_ERROR
Definition: rfswitch.h:127
rfswitch_sel_pin_set
void rfswitch_sel_pin_set(rfswitch_t *ctx, uint8_t enable)
RF Switch SEL pin setting function.
rfswitch_return_value_t
rfswitch_return_value_t
RF Switch Click return value data.
Definition: rfswitch.h:125
rfswitch_init
err_t rfswitch_init(rfswitch_t *ctx, rfswitch_cfg_t *cfg)
RF Switch initialization function.
rfswitch_select_channel
void rfswitch_select_channel(rfswitch_t *ctx, uint8_t select_channel)
RF Switch select channel function.
rfswitch_cfg_t
RF Switch Click configuration object.
Definition: rfswitch.h:114
rfswitch_cfg_setup
void rfswitch_cfg_setup(rfswitch_cfg_t *cfg)
RF Switch configuration object setup function.
rfswitch_t::on
digital_out_t on
Definition: rfswitch.h:104
rfswitch_t::sel
digital_out_t sel
Definition: rfswitch.h:105
RFSWITCH_OK
@ RFSWITCH_OK
Definition: rfswitch.h:126
rfswitch_power_on
void rfswitch_power_on(rfswitch_t *ctx)
RF Switch power on function.
rfswitch_on_pin_set
void rfswitch_on_pin_set(rfswitch_t *ctx, uint8_t enable)
RF Switch ON pin setting function.
rfswitch_t
RF Switch Click context object.
Definition: rfswitch.h:103
rfswitch_switch_channel
void rfswitch_switch_channel(rfswitch_t *ctx)
RF Switch switch channel function.
rfswitch_cfg_t::sel
pin_name_t sel
Definition: rfswitch.h:116
rfswitch_cfg_t::on
pin_name_t on
Definition: rfswitch.h:115