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 #ifndef CONFIG_CHANNEL_MONITOR_H_ 35 #define CONFIG_CHANNEL_MONITOR_H_ 36 37 /** 38 * @addtogroup config-channel-monitor 39 * 40 * @brief 41 * This module includes configuration variables for Channel Monitor. 42 * 43 * @{ 44 */ 45 46 /** 47 * @def OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE 48 * 49 * Define to 1 to enable Channel Monitor support. 50 */ 51 #ifndef OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE 52 #define OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE 0 53 #endif 54 55 /** 56 * @def OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_INTERVAL 57 * 58 * The sample interval in milliseconds used by Channel Monitoring feature. 59 60 * When enabled, a zero-duration Energy Scan is performed, collecting a single RSSI sample per channel during each 61 * interval. 62 * 63 * Applicable only if Channel Monitoring feature is enabled (i.e., `OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE` is set). 64 */ 65 #ifndef OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_INTERVAL 66 #define OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_INTERVAL 41000 67 #endif 68 69 /** 70 * @def OPENTHREAD_CONFIG_CHANNEL_MONITOR_RSSI_THRESHOLD 71 * 72 * The RSSI threshold in dBm used by Channel Monitoring feature. 73 * 74 * The RSSI samples are compared with the given threshold. Channel monitoring reports the average rate of RSSI samples 75 * that are above this threshold within an observation window (per channel). 76 * 77 * It is recommended that this value is set to same value as the CCA threshold used by radio. 78 * 79 * Applicable only if Channel Monitoring feature is enabled (i.e., `OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE` is set). 80 */ 81 #ifndef OPENTHREAD_CONFIG_CHANNEL_MONITOR_RSSI_THRESHOLD 82 #define OPENTHREAD_CONFIG_CHANNEL_MONITOR_RSSI_THRESHOLD -75 83 #endif 84 85 /** 86 * @def OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_WINDOW 87 * 88 * The averaging sample window length (in units of channel sample interval) used by Channel Monitoring feature. 89 * 90 * Channel monitoring will sample all channels every sample interval. It maintains the average rate of RSSI samples 91 * that are above the RSSI threshold within (approximately) this sample window. 92 * 93 * Applicable only if Channel Monitoring feature is enabled (i.e., `OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE` is set). 94 */ 95 #ifndef OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_WINDOW 96 #define OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_WINDOW 960 97 #endif 98 99 /** 100 * @} 101 */ 102 103 #endif // CONFIG_CHANNEL_MONITOR_H_ 104
