[docs] create config variables list (#9721)

This commit is contained in:
jrhodie
2023-12-20 12:51:50 -08:00
committed by GitHub
parent 1d126effb9
commit 16596a38c3
45 changed files with 751 additions and 1 deletions
+89
View File
@@ -0,0 +1,89 @@
/*
* Copyright (c) 2023, The OpenThread Authors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
* 3. Neither the name of the copyright holder nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* 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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.
*/
/**
* @file
* @brief
* This file defines the Doxygen group structure for OpenThread documentation.
*/
/**
* @defgroup config Config Variables
* @brief
* This module lists all OpenThread configuration variables.
*
* @{
*
* @defgroup config-announce-sender Announce Sender
* @defgroup config-backbone-router Backbone Router Services
* @defgroup config-border-agent Border Agent
* @defgroup config-border-router Border Router
* @defgroup config-border-routing Border Routing Manager
* @defgroup config-channel-manager Channel Manager
* @defgroup config-channel-monitor Channel Monitor
* @defgroup config-child-supervision Child Supervision
* @defgroup config-coap CoAP
* @defgroup config-commissioner Commissioner
* @defgroup config-crypto Crypto Backend Library
* @defgroup config-dataset-updater Dataset Updater
* @defgroup config-dhcpv6-client DHCPv6 Client
* @defgroup config-dhcpv6-server DHCPv6 Server
* @defgroup config-diag DIAG Service
* @defgroup config-dns-client DNS Client
* @defgroup config-dns-dso DNS Stateful Operations
* @defgroup config-dnssd-server DNS-SD Server
* @defgroup config-history-tracker History Tracker
* @defgroup config-ip6 IP6 Service
* @defgroup config-joiner Joiner
* @defgroup config-link-metrics-manager Link Metrics Manager
* @defgroup config-link-quality Link Quality
* @defgroup config-link-raw Link Raw Service
* @defgroup config-logging Logging Service
* @defgroup config-mac MAC
* @defgroup config-mesh-diag Mesh Diagnostic
* @defgroup config-mesh-forwarder Mesh Forwarder
* @defgroup config-misc Miscellaneous Constants
* @defgroup config-mle MLE Service
* @defgroup config-nat64 NAT64
* @defgroup config-netdata-publisher Network Data Publisher
* @defgroup config-network-diagnostic Network Diagnostics
* @defgroup config-parent-search Parent Search
* @defgroup config-ping-sender Ping Sender
* @defgroup config-platform Platform Specific Services
* @defgroup config-power-calibration Power Calibration
* @defgroup config-radio-link Radio Links
* @defgroup config-secure-transport Secure Transport
* @defgroup config-sntp-client SNTP Client
* @defgroup config-srp-client SRP Client
* @defgroup config-srp-server SRP Server
* @defgroup config-time-sync Time Sync Service
* @defgroup config-tmf Thread Management Framework Service
*
* @}
*
*/
+16 -1
View File
@@ -28,13 +28,23 @@
/**
* @file
* This file includes compile-time configurations for the DNS Client.
* This file includes compile-time configurations for the Announce Sender.
*
*/
#ifndef CONFIG_ANNOUNCE_SENDER_H_
#define CONFIG_ANNOUNCE_SENDER_H_
/**
* @addtogroup config-announce-sender
*
* @brief
* This module includes configuration variables for the Announce Sender.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_ANNOUNCE_SENDER_ENABLE
*
@@ -90,4 +100,9 @@
#define OPENTHREAD_CONFIG_ANNOUNCE_SENDER_JITTER_INTERVAL 500
#endif
/**
* @}
*
*/
#endif // CONFIG_ANNOUNCE_SENDER_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_BACKBONE_ROUTER_H_
#define CONFIG_BACKBONE_ROUTER_H_
/**
* @addtogroup config-backbone-router
*
* @brief
* This module includes configuration variables for Backbone Router services.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
*
@@ -113,4 +123,9 @@
#define OPENTHREAD_CONFIG_NDPROXY_TABLE_ENTRY_NUM 250
#endif
/**
* @}
*
*/
#endif // CONFIG_BACKBONE_ROUTER_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_BORDER_AGENT_H_
#define CONFIG_BORDER_AGENT_H_
/**
* @addtogroup config-border-agent
*
* @brief
* This module includes configuration variables for Border Agent.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_BORDER_AGENT_ENABLE
*
@@ -65,4 +75,9 @@
#define OPENTHREAD_CONFIG_BORDER_AGENT_ID_ENABLE 0
#endif
/**
* @}
*
*/
#endif // CONFIG_BORDER_AGENT_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_BORDER_ROUTER_H_
#define CONFIG_BORDER_ROUTER_H_
/**
* @addtogroup config-border-router
*
* @brief
* This module includes configuration variables for Border Router services.
*
* @{
*
*/
#include <config/border_routing.h>
/**
@@ -83,4 +93,9 @@
#define OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE
#endif
/**
* @}
*
*/
#endif // CONFIG_BORDER_ROUTER_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_BORDER_ROUTING_H_
#define CONFIG_BORDER_ROUTING_H_
/**
* @addtogroup config-border-routing
*
* @brief
* This module includes configuration variables for Border Routing Manager.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE
*
@@ -162,4 +172,9 @@
#define OPENTHREAD_CONFIG_BORDER_ROUTING_MOCK_PLAT_APIS_ENABLE 0
#endif
/**
* @}
*
*/
#endif // CONFIG_BORDER_ROUTING_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_CHANNEL_MANAGER_H_
#define CONFIG_CHANNEL_MANAGER_H_
/**
* @addtogroup config-channel-manager
*
* @brief
* This module includes configuration variables for Channel Manager.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE
*
@@ -136,4 +146,9 @@
#define OPENTHREAD_CONFIG_CHANNEL_MANAGER_CCA_FAILURE_THRESHOLD (0xffff * 14 / 100)
#endif
/**
* @}
*
*/
#endif // CONFIG_CHANNEL_MANAGER_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_CHANNEL_MONITOR_H_
#define CONFIG_CHANNEL_MONITOR_H_
/**
* @addtogroup config-channel-monitor
*
* @brief
* This module includes configuration variables for Channel Monitor.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE
*
@@ -92,4 +102,9 @@
#define OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_WINDOW 960
#endif
/**
* @}
*
*/
#endif // CONFIG_CHANNEL_MONITOR_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_CHILD_SUPERVISION_H_
#define CONFIG_CHILD_SUPERVISION_H_
/**
* @addtogroup config-child-supervision
*
* @brief
* This module includes configuration variables for Child Supervision.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_CHILD_SUPERVISION_INTERVAL
*
@@ -86,4 +96,9 @@
#define OPENTHREAD_CONFIG_CHILD_SUPERVISION_OLDER_VERSION_CHILD_DEFAULT_INTERVAL 129
#endif
/**
* @}
*
*/
#endif // CONFIG_CHILD_SUPERVISION_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_COAP_H_
#define CONFIG_COAP_H_
/**
* @addtogroup config-coap
*
* @brief
* This module includes configuration variables for CoAP.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_COAP_SERVER_MAX_CACHED_RESPONSES
*
@@ -97,4 +107,9 @@
#define OPENTHREAD_CONFIG_COAP_SECURE_API_ENABLE 0
#endif
/**
* @}
*
*/
#endif // CONFIG_COAP_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_COMMISSIONER_H_
#define CONFIG_COMMISSIONER_H_
/**
* @addtogroup config-commissioner
*
* @brief
* This module includes configuration variables for the Commissioner.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_COMMISSIONER_ENABLE
*
@@ -66,4 +76,9 @@
#define OPENTHREAD_CONFIG_COMMISSIONER_JOINER_SESSION_TIMEOUT 30
#endif
/**
* @}
*
*/
#endif // CONFIG_COMMISSIONER_H_
+15
View File
@@ -29,6 +29,16 @@
#ifndef CONFIG_CRYPTO_H_
#define CONFIG_CRYPTO_H_
/**
* @addtogroup config-crypto
*
* @brief
* This module includes configuration variables for the Crypto Backend Library.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_CRYPTO_LIB
*
@@ -95,4 +105,9 @@
#endif // OPENTHREAD_CONFIG_CRYPTO_LIB == OPENTHREAD_CONFIG_CRYPTO_LIB_PLATFORM
/**
* @}
*
*/
#endif // CONFIG_CRYPTO_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_DATASET_UPDATER_H_
#define CONFIG_DATASET_UPDATER_H_
/**
* @addtogroup config-dataset-updater
*
* @brief
* This module includes configuration variables for Dataset Updater.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE
*
@@ -67,4 +77,9 @@
#define OPENTHREAD_CONFIG_DATASET_UPDATER_DEFAULT_RETRY_WAIT_INTERVAL 1500
#endif
/**
* @}
*
*/
#endif // CONFIG_DATASET_UPDATER_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_DHCP6_CLIENT_H_
#define CONFIG_DHCP6_CLIENT_H_
/**
* @addtogroup config-dhcpv6-client
*
* @brief
* This module includes configuration variables for the DHCPv6 client.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_DHCP6_CLIENT_ENABLE
*
@@ -65,4 +75,9 @@
#define OPENTHREAD_CONFIG_DHCP6_CLIENT_NUM_PREFIXES 4
#endif
/**
* @}
*
*/
#endif // CONFIG_DHCP6_CLIENT_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_DHCP6_SERVER_H_
#define CONFIG_DHCP6_SERVER_H_
/**
* @addtogroup config-dhcpv6-server
*
* @brief
* This module includes configuration variables for the DHCPv6 server.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_DHCP6_SERVER_ENABLE
*
@@ -55,4 +65,9 @@
#define OPENTHREAD_CONFIG_DHCP6_SERVER_NUM_PREFIXES 4
#endif
/**
* @}
*
*/
#endif // CONFIG_DHCP6_SERVER_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_DIAG_H_
#define CONFIG_DIAG_H_
/**
* @addtogroup config-diag
*
* @brief
* This module includes configuration variables for the DIAG service.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_DIAG_ENABLE
*
@@ -75,4 +85,9 @@
#define OPENTHREAD_CONFIG_DIAG_CMD_LINE_BUFFER_SIZE 256
#endif
/**
* @}
*
*/
#endif // CONFIG_DIAG_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_DNS_CLIENT_H_
#define CONFIG_DNS_CLIENT_H_
/**
* @addtogroup config-dns-client
*
* @brief
* This module includes configuration variables for the DNS client.
*
* @{
*
*/
#include "config/ip6.h"
#include "config/srp_client.h"
@@ -181,4 +191,9 @@
#define OPENTHREAD_CONFIG_DNS_CLIENT_OVER_TCP_QUERY_MAX_SIZE 1024
#endif
/**
* @}
*
*/
#endif // CONFIG_DNS_CLIENT_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_DNS_DSO_H_
#define CONFIG_DNS_DSO_H_
/**
* @addtogroup config-dns-dso
*
* @brief
* This module includes configuration variables for DNS Stateful Operations.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_DNS_DSO_ENABLE
*
@@ -87,4 +97,9 @@
#define OPENTHREAD_CONFIG_DNS_DSO_MOCK_PLAT_APIS_ENABLE 0
#endif
/**
* @}
*
*/
#endif // CONFIG_DNS_DSO_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_DNSSD_SERVER_H_
#define CONFIG_DNSSD_SERVER_H_
/**
* @addtogroup config-dnssd-server
*
* @brief
* This module includes configuration variables for the DNS-SD server.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_DNSSD_SERVER_ENABLE
*
@@ -98,4 +108,9 @@
#define OPENTHREAD_CONFIG_DNS_UPSTREAM_QUERY_MOCK_PLAT_APIS_ENABLE 0
#endif
/**
* @}
*
*/
#endif // CONFIG_DNSSD_SERVER_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_HISTORY_TRACKER_H_
#define CONFIG_HISTORY_TRACKER_H_
/**
* @addtogroup config-history-tracker
*
* @brief
* This module includes configuration variables for History Tracker.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE
*
@@ -163,4 +173,9 @@
#define OPENTHREAD_CONFIG_HISTORY_TRACKER_EXTERNAL_ROUTE_LIST_SIZE 32
#endif
/**
* @}
*
*/
#endif // CONFIG_HISTORY_TRACKER_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_IP6_H_
#define CONFIG_IP6_H_
/**
* @addtogroup config-ip6
*
* @brief
* This module includes configuration variables for the IP6 service.
*
* @{
*
*/
#include "config/border_routing.h"
/**
@@ -202,4 +212,9 @@
#define OPENTHREAD_CONFIG_IP6_BR_COUNTERS_ENABLE OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE
#endif
/**
* @}
*
*/
#endif // CONFIG_IP6_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_JOINER_H_
#define CONFIG_JOINER_H_
/**
* @addtogroup config-joiner
*
* @brief
* This module includes configuration variables for the Joiner.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_JOINER_ENABLE
*
@@ -55,4 +65,9 @@
#define OPENTHREAD_CONFIG_JOINER_MAX_CANDIDATES 2
#endif
/**
* @}
*
*/
#endif // CONFIG_JOINER_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_LINK_METRICS_MANAGER_H_
#define CONFIG_LINK_METRICS_MANAGER_H_
/**
* @addtogroup config-link-metrics-manager
*
* @brief
* This module includes configuration variables for Link Metrics Manager.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_LINK_METRICS_MANAGER_ENABLE
*
@@ -55,4 +65,9 @@
#define OPENTHREAD_CONFIG_LINK_METRICS_MANAGER_ON_BY_DEFAULT 0
#endif
/**
* @}
*
*/
#endif // CONFIG_LINK_METRICS_MANAGER_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_LINK_QUALITY_H_
#define CONFIG_LINK_QUALITY_H_
/**
* @addtogroup config-link-quality
*
* @brief
* This module includes configuration variables for the Link Quality service.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_CCA_FAILURE_RATE_AVERAGING_WINDOW
*
@@ -74,4 +84,9 @@
#define OPENTHREAD_CONFIG_IPV6_TX_ERR_RATE_AVERAGING_WINDOW 128
#endif
/**
* @}
*
*/
#endif // CONFIG_LINK_QUALITY_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_LINK_RAW_H_
#define CONFIG_LINK_RAW_H_
/**
* @addtogroup config-link-raw
*
* @brief
* This module includes configuration variables for the Link Raw service.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_LINK_RAW_ENABLE
*
@@ -45,4 +55,9 @@
#define OPENTHREAD_CONFIG_LINK_RAW_ENABLE 0
#endif
/**
* @}
*
*/
#endif // CONFIG_LINK_RAW_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_LOGGING_H_
#define CONFIG_LOGGING_H_
/**
* @addtogroup config-logging
*
* @brief
* This module includes configuration variables for the Logging service.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_LOG_OUTPUT
*
@@ -184,4 +194,9 @@
#define OPENTHREAD_CONFIG_LOG_MAX_SIZE 150
#endif
/**
* @}
*
*/
#endif // CONFIG_LOGGING_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_MAC_H_
#define CONFIG_MAC_H_
/**
* @addtogroup config-mac
*
* @brief
* This module includes configuration variables for MAC.
*
* @{
*
*/
#include "config/time_sync.h"
/**
@@ -587,4 +597,9 @@
#define OPENTHREAD_CONFIG_MAC_DATA_POLL_TIMEOUT 100
#endif
/**
* @}
*
*/
#endif // CONFIG_MAC_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_MESH_DIAG_H_
#define CONFIG_MESH_DIAG_H_
/**
* @addtogroup config-mesh-diag
*
* @brief
* This module includes configuration variables for Mesh Diagnostic.
*
* @{
*
*/
#include "config/border_routing.h"
/**
@@ -59,4 +69,9 @@
#define OPENTHREAD_CONFIG_MESH_DIAG_RESPONSE_TIMEOUT 5000
#endif
/**
* @}
*
*/
#endif // CONFIG_MESH_DIAG_H_
+15
View File
@@ -34,6 +34,16 @@
#ifndef CONFIG_MESH_FORWARDER_H_
#define CONFIG_MESH_FORWARDER_H_
/**
* @addtogroup config-mesh-forwarder
*
* @brief
* This module includes configuration variables for the Mesh Forwarder.
*
* @{
*
*/
#include "config/border_router.h"
/**
@@ -200,4 +210,9 @@
#define OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_HISTOGRAM_BIN_INTERVAL 10
#endif
/**
* @}
*
*/
#endif // CONFIG_MESH_FORWARDER_H_
+15
View File
@@ -34,6 +34,16 @@
#ifndef CONFIG_MISC_H_
#define CONFIG_MISC_H_
/**
* @addtogroup config-misc
*
* @brief
* This module includes configuration variables for Miscellaneous constants.
*
* @{
*
*/
#include "config/coap.h"
#include "config/srp_server.h"
@@ -572,4 +582,9 @@
#define OPENTHREAD_CONFIG_OPERATIONAL_DATASET_AUTO_INIT 0
#endif
/**
* @}
*
*/
#endif // CONFIG_MISC_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_MLE_H_
#define CONFIG_MLE_H_
/**
* @addtogroup config-mle
*
* @brief
* This module includes configuration variables for the MLE service.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_MLE_MAX_ROUTERS
*
@@ -338,4 +348,9 @@
#define OPENTHREAD_CONFIG_MLE_LINK_METRICS_SERIES_MTD 2
#endif
/**
* @}
*
*/
#endif // CONFIG_MLE_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_NAT64_H_
#define CONFIG_NAT64_H_
/**
* @addtogroup config-nat64
*
* @brief
* This module includes configuration variables for NAT64.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE
*
@@ -75,4 +85,9 @@
#define OPENTHREAD_CONFIG_NAT64_BORDER_ROUTING_ENABLE 0
#endif
/**
* @}
*
*/
#endif
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_NETDATA_PUBLISHER_H_
#define CONFIG_NETDATA_PUBLISHER_H_
/**
* @addtogroup config-netdata-publisher
*
* @brief
* This module includes configuration variables for Network Data Publisher.
*
* @{
*
*/
#include "config/border_router.h"
#include "config/border_routing.h"
#include "config/srp_server.h"
@@ -156,4 +166,9 @@
#define OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES 3
#endif
/**
* @}
*
*/
#endif // CONFIG_NETDATA_PUBLISHER_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_NETWORK_DIAGNOSTIC_H_
#define CONFIG_NETWORK_DIAGNOSTIC_H_
/**
* @addtogroup config-network-diagnostic
*
* @brief
* This module includes configuration variables for Network Diagnostics.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_NET_DIAG_VENDOR_NAME
*
@@ -82,4 +92,9 @@
#define OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE 0
#endif
/**
* @}
*
*/
#endif // CONFIG_NETWORK_DIAGNOSTIC_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_PARENT_SEARCH_H_
#define CONFIG_PARENT_SEARCH_H_
/**
* @addtogroup config-parent-search
*
* @brief
* This module includes configuration variables for Parent Search.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_PARENT_SEARCH_ENABLE
*
@@ -93,4 +103,9 @@
#define OPENTHREAD_CONFIG_PARENT_SEARCH_RSS_THRESHOLD -65
#endif
/**
* @}
*
*/
#endif // CONFIG_PARENT_SEARCH_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_PING_SENDER_H_
#define CONFIG_PING_SENDER_H_
/**
* @addtogroup config-ping-sender
*
* @brief
* This module includes configuration variables for Ping Sender.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_PING_SENDER_ENABLE
*
@@ -89,4 +99,9 @@
#define OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_COUNT 1
#endif
/**
* @}
*
*/
#endif // CONFIG_PING_SENDER_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_PLATFORM_H_
#define CONFIG_PLATFORM_H_
/**
* @addtogroup config-platform
*
* @brief
* This module includes configuration variables for platform-specific services.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_PLATFORM_INFO
*
@@ -186,4 +196,9 @@
#endif
#endif
/**
* @}
*
*/
#endif // CONFIG_PLATFORM_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_POWER_CALIBRATION_H_
#define CONFIG_POWER_CALIBRATION_H_
/**
* @addtogroup config-power-calibration
*
* @brief
* This module includes configuration variables for Power Calibration.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_POWER_CALIBRATION_ENABLE
*
@@ -65,4 +75,9 @@
#define OPENTHREAD_CONFIG_POWER_CALIBRATION_NUM_CALIBRATED_POWER_ENTRIES 6
#endif
/**
* @}
*
*/
#endif // CONFIG_POWER_CALIBRATION_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_RADIO_LINK_H_
#define CONFIG_RADIO_LINK_H_
/**
* @addtogroup config-radio-link
*
* @brief
* This module includes configuration variables for radio links.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_RADIO_LINK_IEEE_802_15_4_ENABLE
*
@@ -93,4 +103,9 @@
#define OPENTHREAD_CONFIG_MULTI_RADIO_FRAG_TAG_TIMEOUT (20 * 1000)
#endif
/**
* @}
*
*/
#endif // CONFIG_RADIO_LINK_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_SECURE_TRANSPORT_H_
#define CONFIG_SECURE_TRANSPORT_H_
/**
* @addtogroup config-secure-transport
*
* @brief
* This module includes configuration variables for Secure Transport.
*
* @{
*
*/
#include "config/border_agent.h"
#include "config/coap.h"
#include "config/commissioner.h"
@@ -66,4 +76,9 @@
#error "OPENTHREAD_CONFIG_DTLS_ENABLE is deprecated please use OPENTHREAD_CONFIG_SECURE_TRANSPORT_ENABLE instead"
#endif
/**
* @}
*
*/
#endif // CONFIG_SECURE_TRANSPORT_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_SNTP_CLIENT_H_
#define CONFIG_SNTP_CLIENT_H_
/**
* @addtogroup config-sntp-client
*
* @brief
* This module includes configuration variables for the SNTP Client.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_SNTP_CLIENT_ENABLE
*
@@ -65,4 +75,9 @@
#define OPENTHREAD_CONFIG_SNTP_CLIENT_MAX_RETRANSMIT 2
#endif
/**
* @}
*
*/
#endif // CONFIG_SNTP_CLIENT_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_SRP_CLIENT_H_
#define CONFIG_SRP_CLIENT_H_
/**
* @addtogroup config-srp-client
*
* @brief
* This module includes configuration variables for the SRP Client.
*
* @{
*
*/
#include "config/misc.h"
/**
@@ -402,4 +412,9 @@
#define OPENTHREAD_CONFIG_SRP_CLIENT_BUFFERS_TXT_BUFFER_SIZE 64
#endif
/**
* @}
*
*/
#endif // CONFIG_SRP_CLIENT_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_SRP_SERVER_H_
#define CONFIG_SRP_SERVER_H_
/**
* @addtogroup config-srp-server
*
* @brief
* This module includes configuration variables for the SRP Server.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_SRP_SERVER_ENABLE
*
@@ -109,4 +119,9 @@
#define OPENTHREAD_CONFIG_SRP_SERVER_SERVICE_UPDATE_TIMEOUT ((4 * 250u) + 250u)
#endif
/**
* @}
*
*/
#endif // CONFIG_SRP_SERVER_H_
+15
View File
@@ -35,6 +35,16 @@
#ifndef CONFIG_TIME_SYNC_H_
#define CONFIG_TIME_SYNC_H_
/**
* @addtogroup config-time-sync
*
* @brief
* This module includes configuration variables for the Time Sync service.
*
* @{
*
*/
/**
* @def OPENTHREAD_CONFIG_TIME_SYNC_ENABLE
*
@@ -94,4 +104,9 @@
#define OPENTHREAD_CONFIG_TIME_SYNC_JUMP_NOTIF_MIN_US 10000
#endif
/**
* @}
*
*/
#endif // CONFIG_TIME_SYNC_H_
+16
View File
@@ -35,6 +35,17 @@
#ifndef CONFIG_TMF_H_
#define CONFIG_TMF_H_
/**
* @addtogroup config-tmf
*
* @brief
* This module includes configuration variables for the Thread Management
* Framework service.
*
* @{
*
*/
#include "config/border_router.h"
/**
@@ -247,4 +258,9 @@
#error "Thread 1.2 or higher version is required for OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE"
#endif
/**
* @}
*
*/
#endif // CONFIG_TMF_H_