micrfrx  2.1.0.0
micrfrx.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 MICRFRX_H
29 #define MICRFRX_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_analog_in.h"
52 
73 #define MICRFRX_RSSI_VREF_3V3 3.3f
74 #define MICRFRX_RSSI_MIN_DBM ( -110 )
75 #define MICRFRX_RSSI_MAX_DBM ( -50 )
76 #define MICRFRX_RSSI_RANGE_DBM ( MICRFRX_RSSI_MAX_DBM - MICRFRX_RSSI_MIN_DBM )
77 #define MICRFRX_RSSI_MIN_V 0.5f
78 #define MICRFRX_RSSI_MAX_V 2.0f
79 #define MICRFRX_RSSI_RANGE_V ( MICRFRX_RSSI_MAX_V - MICRFRX_RSSI_MIN_V )
80 #define MICRFRX_RSSI_DBM_PER_V ( MICRFRX_RSSI_RANGE_DBM / MICRFRX_RSSI_MAX_V )
81 #define MICRFRX_RSSI_V_TO_DBM(x) ( MICRFRX_RSSI_MIN_DBM + ( ( x - MICRFRX_RSSI_MIN_V ) * MICRFRX_RSSI_DBM_PER_V ) )
82 #define MICRFRX_MAN_BIT_LEN_US 2000
83 #define MICRFRX_MAX_DATA_LEN 255
84  // micrfrx_cfg
86 
101 #define MICRFRX_MAP_MIKROBUS( cfg, mikrobus ) \
102  cfg.rssi = MIKROBUS( mikrobus, MIKROBUS_AN ); \
103  cfg.shd = MIKROBUS( mikrobus, MIKROBUS_RST ); \
104  cfg.sqc = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
105  cfg.dout = MIKROBUS( mikrobus, MIKROBUS_INT )
106  // micrfrx_map // micrfrx
109 
114 typedef struct
115 {
116  digital_out_t shd;
117  digital_out_t sqc;
119  digital_in_t dout;
121  analog_in_t adc;
123 } micrfrx_t;
124 
129 typedef struct
130 {
131  pin_name_t rssi;
132  pin_name_t shd;
133  pin_name_t sqc;
134  pin_name_t dout;
136  analog_in_resolution_t resolution;
137  float vref;
139 } micrfrx_cfg_t;
140 
145 typedef enum
146 {
148  MICRFRX_ERROR = -1
149 
151 
168 
182 err_t micrfrx_init ( micrfrx_t *ctx, micrfrx_cfg_t *cfg );
183 
193 
203 
213 
223 
233 
247 err_t micrfrx_read_rssi_voltage ( micrfrx_t *ctx, float *data_out );
248 
249 #ifdef __cplusplus
250 }
251 #endif
252 #endif // MICRFRX_H
253  // micrfrx
255 
256 // ------------------------------------------------------------------------ END
micrfrx_read_rssi_voltage
err_t micrfrx_read_rssi_voltage(micrfrx_t *ctx, float *data_out)
MICRF RX read RSSI pin voltage level function.
micrfrx_t
MICRF RX Click context object.
Definition: micrfrx.h:115
micrfrx_cfg_t::sqc
pin_name_t sqc
Definition: micrfrx.h:133
micrfrx_cfg_setup
void micrfrx_cfg_setup(micrfrx_cfg_t *cfg)
MICRF RX configuration object setup function.
micrfrx_disable_squelch
void micrfrx_disable_squelch(micrfrx_t *ctx)
MICRF RX disable squelch function.
micrfrx_init
err_t micrfrx_init(micrfrx_t *ctx, micrfrx_cfg_t *cfg)
MICRF RX initialization function.
micrfrx_get_data_pin
uint8_t micrfrx_get_data_pin(micrfrx_t *ctx)
MICRF RX get data pin function.
micrfrx_enable_device
void micrfrx_enable_device(micrfrx_t *ctx)
MICRF RX enable device function.
MICRFRX_ERROR
@ MICRFRX_ERROR
Definition: micrfrx.h:148
MICRFRX_OK
@ MICRFRX_OK
Definition: micrfrx.h:147
micrfrx_return_value_t
micrfrx_return_value_t
MICRF RX Click return value data.
Definition: micrfrx.h:146
micrfrx_t::sqc
digital_out_t sqc
Definition: micrfrx.h:117
micrfrx_cfg_t::rssi
pin_name_t rssi
Definition: micrfrx.h:131
micrfrx_cfg_t::resolution
analog_in_resolution_t resolution
Definition: micrfrx.h:136
micrfrx_t::adc
analog_in_t adc
Definition: micrfrx.h:121
micrfrx_disable_device
void micrfrx_disable_device(micrfrx_t *ctx)
MICRF RX disable device function.
micrfrx_cfg_t::shd
pin_name_t shd
Definition: micrfrx.h:132
micrfrx_cfg_t::dout
pin_name_t dout
Definition: micrfrx.h:134
micrfrx_enable_squelch
void micrfrx_enable_squelch(micrfrx_t *ctx)
MICRF RX enable squelch function.
micrfrx_cfg_t::vref
float vref
Definition: micrfrx.h:137
micrfrx_cfg_t
MICRF RX Click configuration object.
Definition: micrfrx.h:130
micrfrx_t::dout
digital_in_t dout
Definition: micrfrx.h:119
micrfrx_t::shd
digital_out_t shd
Definition: micrfrx.h:116