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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 
58 #define RFSWITCH_ON_PIN_STATE_HIGH 0x01
59 #define RFSWITCH_ON_PIN_STATE_LOW 0x00
60 #define RFSWITCH_SEL_PIN_STATE_HIGH 0x01
61 #define RFSWITCH_SEL_PIN_STATE_LOW 0x00
62 #define RFSWITCH_SELECT_CHANNEL_1 0x01
63 #define RFSWITCH_SELECT_CHANNEL_2 0x02
64  // rfswitch_set
66 
81 #define RFSWITCH_MAP_MIKROBUS( cfg, mikrobus ) \
82  cfg.on = MIKROBUS( mikrobus, MIKROBUS_CS ); \
83  cfg.sel = MIKROBUS( mikrobus, MIKROBUS_PWM )
84  // rfswitch_map // rfswitch
87 
92 typedef struct
93 {
94  digital_out_t on;
95  digital_out_t sel;
97 } rfswitch_t;
98 
103 typedef struct
104 {
105  pin_name_t on;
106  pin_name_t sel;
109 
114 typedef enum
115 {
117  RFSWITCH_ERROR = -1
118 
120 
137 
153 
163 
174 void rfswitch_on_pin_set ( rfswitch_t *ctx, uint8_t enable );
175 
186 void rfswitch_sel_pin_set ( rfswitch_t *ctx, uint8_t enable );
187 
198 
209 void rfswitch_select_channel ( rfswitch_t *ctx, uint8_t select_channel );
210 
211 #ifdef __cplusplus
212 }
213 #endif
214 #endif // RFSWITCH_H
215  // rfswitch
217 
218 // ------------------------------------------------------------------------ END
RFSWITCH_ERROR
@ RFSWITCH_ERROR
Definition: rfswitch.h:117
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:115
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:104
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:94
rfswitch_t::sel
digital_out_t sel
Definition: rfswitch.h:95
RFSWITCH_OK
@ RFSWITCH_OK
Definition: rfswitch.h:116
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:93
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:106
rfswitch_cfg_t::on
pin_name_t on
Definition: rfswitch.h:105