1 /* 2 * Copyright (c) 2019, The OpenThread Authors. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the copyright holder nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /** 30 * @file 31 * This file includes compile-time configurations for Channel Monitor. 32 * 33 */ 34 35 #ifndef CONFIG_CHANNEL_MONITOR_H_ 36 #define CONFIG_CHANNEL_MONITOR_H_ 37 38 /** 39 * @addtogroup config-channel-monitor 40 * 41 * @brief 42 * This module includes configuration variables for Channel Monitor. 43 * 44 * @{ 45 * 46 */ 47 48 /** 49 * @def OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE 50 * 51 * Define to 1 to enable Channel Monitor support. 52 * 53 */ 54 #ifndef OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE 55 #define OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE 0 56 #endif 57 58 /** 59 * @def OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_INTERVAL 60 * 61 * The sample interval in milliseconds used by Channel Monitoring feature. 62 63 * When enabled, a zero-duration Energy Scan is performed, collecting a single RSSI sample per channel during each 64 * interval. 65 * 66 * Applicable only if Channel Monitoring feature is enabled (i.e., `OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE` is set). 67 * 68 */ 69 #ifndef OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_INTERVAL 70 #define OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_INTERVAL 41000 71 #endif 72 73 /** 74 * @def OPENTHREAD_CONFIG_CHANNEL_MONITOR_RSSI_THRESHOLD 75 * 76 * The RSSI threshold in dBm used by Channel Monitoring feature. 77 * 78 * The RSSI samples are compared with the given threshold. Channel monitoring reports the average rate of RSSI samples 79 * that are above this threshold within an observation window (per channel). 80 * 81 * It is recommended that this value is set to same value as the CCA threshold used by radio. 82 * 83 * Applicable only if Channel Monitoring feature is enabled (i.e., `OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE` is set). 84 * 85 */ 86 #ifndef OPENTHREAD_CONFIG_CHANNEL_MONITOR_RSSI_THRESHOLD 87 #define OPENTHREAD_CONFIG_CHANNEL_MONITOR_RSSI_THRESHOLD -75 88 #endif 89 90 /** 91 * @def OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_WINDOW 92 * 93 * The averaging sample window length (in units of channel sample interval) used by Channel Monitoring feature. 94 * 95 * Channel monitoring will sample all channels every sample interval. It maintains the average rate of RSSI samples 96 * that are above the RSSI threshold within (approximately) this sample window. 97 * 98 * Applicable only if Channel Monitoring feature is enabled (i.e., `OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE` is set). 99 * 100 */ 101 #ifndef OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_WINDOW 102 #define OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_WINDOW 960 103 #endif 104 105 /** 106 * @} 107 * 108 */ 109 110 #endif // CONFIG_CHANNEL_MONITOR_H_ 111
