-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathmain_cad.h
131 lines (115 loc) · 4.38 KB
/
main_cad.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/*!
* @file main_cad.h
*
* @brief Channel Activity Detection (CAD) example for SX126x chip
*
* The Clear BSD License
* Copyright Semtech Corporation 2021. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted (subject to the limitations in the disclaimer
* below) provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the Semtech corporation nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
* THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SEMTECH CORPORATION BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef MAIN_CAD_H
#define MAIN_CAD_H
#ifdef __cplusplus
extern "C" {
#endif
/*
* -----------------------------------------------------------------------------
* --- DEPENDENCIES ------------------------------------------------------------
*/
/*
* -----------------------------------------------------------------------------
* --- PUBLIC MACROS -----------------------------------------------------------
*/
/*!
* @brief Defines the number of symbols used for the CAD detection
*
* @warning A minimum of 2 symbols is recommended to perform a CAD
*/
#ifndef CAD_SYMBOL_NUM
#define CAD_SYMBOL_NUM 2
#endif
/*!
* @brief Define the sensitivity of the LoRa® modem when trying to correlate to actual LoRa® preamble
symbols. Threshold used to decide if there is a LoRa activity.
*/
#ifndef CAD_DETECT_PEAK
#define CAD_DETECT_PEAK 22
#endif
/*!
* @brief Minimum peak value, meant to filter out case with almost no signal or noise.
*/
#ifndef CAD_DETECT_MIN
#define CAD_DETECT_MIN 10
#endif
/*!
* @brief Defines the action to be performed after a CAD operation
*/
#ifndef CAD_EXIT_MODE
#define CAD_EXIT_MODE SX126X_CAD_LBT
#endif
/*!
* @brief Timeout is only used when the CAD is performed with CAD_EXIT_MODE = SX126X_CAD_RX or SX126X_CAD_LBT
* If CAD_EXIT_MODE = SX126X_CAD_RX, check SetRx for Timeout definition.
* If CAD_EXIT_MODE = SX126X_CAD_LBT, check SetTx for Timeout definition.
*/
#ifndef CAD_TIMEOUT_MS
#define CAD_TIMEOUT_MS 1000
#endif
/*!
* @brief Force user parameters for CAD
* Set to true to keep the value set above for CAD parameters
* Otherwise they will be overwritten according to Spreading Factor
* to optimize detection.
*/
#ifndef USER_PROVIDED_CAD_PARAMETERS
#define USER_PROVIDED_CAD_PARAMETERS false
#endif
/*!
* @brief Delay between CAD detection
* In milliseconds, how long to wait after last action before
* starting a new CAD
*/
#ifndef DELAY_MS_BEFORE_CAD
#define DELAY_MS_BEFORE_CAD 900
#endif
/*
* -----------------------------------------------------------------------------
* --- PUBLIC CONSTANTS --------------------------------------------------------
*/
/*
* -----------------------------------------------------------------------------
* --- PUBLIC TYPES ------------------------------------------------------------
*/
/*
* -----------------------------------------------------------------------------
* --- PUBLIC FUNCTIONS PROTOTYPES ---------------------------------------------
*/
#ifdef __cplusplus
}
#endif
#endif // MAIN_CAD_H
/* --- EOF ------------------------------------------------------------------ */