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 Child Supervision. 32 */ 33 34 #ifndef CONFIG_CHILD_SUPERVISION_H_ 35 #define CONFIG_CHILD_SUPERVISION_H_ 36 37 /** 38 * @addtogroup config-child-supervision 39 * 40 * @brief 41 * This module includes configuration variables for Child Supervision. 42 * 43 * @{ 44 */ 45 46 /** 47 * @def OPENTHREAD_CONFIG_CHILD_SUPERVISION_INTERVAL 48 * 49 * The default supervision interval in seconds to use when in child state. Zero indicates no supervision needed. 50 * 51 * The current supervision interval can be changed using `otChildSupervisionSetInterval()`. 52 * 53 * Child supervision feature provides a mechanism for parent to ensure that a message is sent to each sleepy child 54 * within the supervision interval. If there is no transmission to the child within the supervision interval, child 55 * supervisor will enqueue and send a supervision message (a data message with empty payload) to the child. 56 */ 57 #ifndef OPENTHREAD_CONFIG_CHILD_SUPERVISION_INTERVAL 58 #define OPENTHREAD_CONFIG_CHILD_SUPERVISION_INTERVAL 129 59 #endif 60 61 /** 62 * @def OPENTHREAD_CONFIG_CHILD_SUPERVISION_CHECK_TIMEOUT 63 * 64 * The default supervision check timeout interval (in seconds) used by a device in child state. Set to zero to disable 65 * the supervision check process on the child. 66 * 67 * The check timeout interval can be changed using `otChildSupervisionSetCheckTimeout()`. 68 * 69 * If the sleepy child does not hear from its parent within the specified timeout interval, it initiates the re-attach 70 * process (MLE Child Update Request/Response exchange with its parent). 71 */ 72 #ifndef OPENTHREAD_CONFIG_CHILD_SUPERVISION_CHECK_TIMEOUT 73 #define OPENTHREAD_CONFIG_CHILD_SUPERVISION_CHECK_TIMEOUT 190 74 #endif 75 76 /** 77 * @def OPENTHREAD_CONFIG_CHILD_SUPERVISION_OLDER_VERSION_CHILD_DEFAULT_INTERVAL 78 * 79 * Specifies the default supervision interval to use on parent for children that do not explicitly indicate their 80 * desired supervision internal (do not include a "Supervision Interval TLV") and are running older Thread versions 81 * (version <= 1.3.0). 82 * 83 * This config is added to allow backward compatibility on parent with SED children that used Child Supervision 84 * feature in OT stack before adoption of it by Thread specification and addition of the "Supervision Interval TLV" as 85 * the mechanism for child to inform the parent of its desired supervision interval. 86 * 87 * The config can be set to zero to effectively disable it, i.e., if a child does not provide "Supervision Interval TLV" 88 * it indicates that it does not want to be supervised and then parent will use zero interval for the child. 89 */ 90 #ifndef OPENTHREAD_CONFIG_CHILD_SUPERVISION_OLDER_VERSION_CHILD_DEFAULT_INTERVAL 91 #define OPENTHREAD_CONFIG_CHILD_SUPERVISION_OLDER_VERSION_CHILD_DEFAULT_INTERVAL 129 92 #endif 93 94 /** 95 * @} 96 */ 97 98 #endif // CONFIG_CHILD_SUPERVISION_H_ 99