Files
esp-idf/components/openthread/Kconfig
T

398 lines
14 KiB
Plaintext
Raw Normal View History

2021-04-02 14:49:49 +08:00
menu "OpenThread"
config OPENTHREAD_ENABLED
bool "OpenThread"
default n
help
Select this option to enable OpenThread and show the submenu with OpenThread configuration choices.
config OPENTHREAD_LOG_LEVEL_DYNAMIC
bool "Enable dynamic log level control"
depends on OPENTHREAD_ENABLED
default y
help
Select this option to enable dynamic log level control for OpenThread
choice OPENTHREAD_CONSOLE_TYPE
prompt "OpenThread console type"
depends on OPENTHREAD_ENABLED
default OPENTHREAD_CONSOLE_TYPE_UART
help
Select OpenThread console type
config OPENTHREAD_CONSOLE_TYPE_UART
depends on ESP_CONSOLE_UART_DEFAULT || ESP_CONSOLE_UART_CUSTOM
bool "OpenThread console type UART"
config OPENTHREAD_CONSOLE_TYPE_USB_SERIAL_JTAG
depends on ESP_CONSOLE_USB_SERIAL_JTAG || ESP_CONSOLE_SECONDARY_USB_SERIAL_JTAG
bool "OpenThread console type USB Serial/JTAG Controller"
endchoice #OPENTHREAD_CONSOLE_TYPE
choice OPENTHREAD_LOG_LEVEL
prompt "OpenThread log verbosity"
depends on OPENTHREAD_ENABLED && !OPENTHREAD_LOG_LEVEL_DYNAMIC
default OPENTHREAD_LOG_LEVEL_INFO
help
Select OpenThread log level.
config OPENTHREAD_LOG_LEVEL_NONE
bool "No logs"
config OPENTHREAD_LOG_LEVEL_CRIT
bool "Error logs"
config OPENTHREAD_LOG_LEVEL_WARN
bool "Warning logs"
config OPENTHREAD_LOG_LEVEL_NOTE
bool "Notice logs"
config OPENTHREAD_LOG_LEVEL_INFO
bool "Info logs"
config OPENTHREAD_LOG_LEVEL_DEBG
bool "Debug logs"
endchoice #OPENTHREAD_LOG_LEVEL
2023-06-02 17:38:23 +08:00
menu "Thread Operational Dataset"
config OPENTHREAD_NETWORK_NAME
string "OpenThread network name"
default "OpenThread-ESP"
config OPENTHREAD_MESH_LOCAL_PREFIX
string "OpenThread mesh local prefix, format <address>/<plen>"
default "fd00:db8:a0:0::/64"
help
A string in the format "<address>/<plen>", where `<address>` is an IPv6
address and `<plen>` is a prefix length. For example "fd00:db8:a0:0::/64"
2023-06-02 17:38:23 +08:00
config OPENTHREAD_NETWORK_CHANNEL
int "OpenThread network channel"
range 11 26
default 15
config OPENTHREAD_NETWORK_PANID
hex "OpenThread network pan id"
range 0 0xFFFE
default 0x1234
config OPENTHREAD_NETWORK_EXTPANID
string "OpenThread extended pan id"
default "dead00beef00cafe"
help
The OpenThread network extended pan id in hex string format
config OPENTHREAD_NETWORK_MASTERKEY
string "OpenThread network key"
default "00112233445566778899aabbccddeeff"
help
The OpenThread network network key in hex string format
config OPENTHREAD_NETWORK_PSKC
string "OpenThread pre-shared commissioner key"
default "104810e2315100afd6bc9215a6bfac53"
help
The OpenThread pre-shared commissioner key in hex string format
endmenu
config OPENTHREAD_LOG_LEVEL
int
depends on OPENTHREAD_ENABLED && !OPENTHREAD_LOG_LEVEL_DYNAMIC
default 0 if OPENTHREAD_LOG_LEVEL_NONE
default 1 if OPENTHREAD_LOG_LEVEL_CRIT
default 2 if OPENTHREAD_LOG_LEVEL_WARN
default 3 if OPENTHREAD_LOG_LEVEL_NOTE
default 4 if OPENTHREAD_LOG_LEVEL_INFO
default 5 if OPENTHREAD_LOG_LEVEL_DEBG
2021-07-09 12:18:41 +08:00
choice OPENTHREAD_RADIO_TYPE
prompt "Config the Thread radio type"
depends on OPENTHREAD_ENABLED
default OPENTHREAD_RADIO_NATIVE if SOC_IEEE802154_SUPPORTED
2021-07-09 12:18:41 +08:00
default OPENTHREAD_RADIO_SPINEL_UART
help
Configure how OpenThread connects to the 15.4 radio
config OPENTHREAD_RADIO_NATIVE
bool "Native 15.4 radio"
help
Select this to use the native 15.4 radio.
config OPENTHREAD_RADIO_SPINEL_UART
bool "Connect via UART"
help
Select this to connect to a Radio Co-Processor via UART.
config OPENTHREAD_RADIO_SPINEL_SPI
bool "Connect via SPI"
help
Select this to connect to a Radio Co-Processor via SPI.
2021-07-09 12:18:41 +08:00
endchoice
2021-04-02 14:49:49 +08:00
choice OPENTHREAD_DEVICE_TYPE
prompt "Config the Thread device type"
depends on OPENTHREAD_ENABLED
default OPENTHREAD_FTD
help
OpenThread can be configured to different device types (FTD, MTD, Radio)
config OPENTHREAD_FTD
bool "Full Thread Device"
help
Select this to enable Full Thread Device which can act as router and leader in a Thread network.
config OPENTHREAD_MTD
bool "Minimal Thread Device"
help
Select this to enable Minimal Thread Device which can only act as end device in a Thread network.
This will reduce the code size of the OpenThread stack.
config OPENTHREAD_RADIO
bool "Radio Only Device"
help
2021-12-03 12:16:11 +08:00
Select this to enable Radio Only Device which can only forward 15.4 packets to the host.
2021-04-02 14:49:49 +08:00
The OpenThread stack will be run on the host and OpenThread will have minimal footprint on the
radio only device.
endchoice
choice OPENTHREAD_RCP_TRANSPORT
prompt "The RCP transport type"
depends on OPENTHREAD_RADIO
default OPENTHREAD_RCP_UART
config OPENTHREAD_RCP_UART
bool "UART RCP"
help
Select this to enable UART connection to host.
config OPENTHREAD_RCP_SPI
bool "SPI RCP"
select GPIO_CTRL_FUNC_IN_IRAM
help
Select this to enable SPI connection to host.
endchoice
config OPENTHREAD_NCP_VENDOR_HOOK
bool "Enable vendor command for RCP"
depends on OPENTHREAD_RADIO
default n
help
Select this to enable OpenThread NCP vendor commands.
config OPENTHREAD_CLI
bool "Enable Openthread Command-Line Interface"
depends on OPENTHREAD_ENABLED
default y
help
Select this option to enable Command-Line Interface in OpenThread.
2021-04-02 14:49:49 +08:00
config OPENTHREAD_DIAG
bool "Enable diag"
depends on OPENTHREAD_ENABLED
default y
help
Select this option to enable Diag in OpenThread. This will enable diag mode and a series of diag commands
in the OpenThread command line. These commands allow users to manipulate low-level features of the storage
and 15.4 radio.
config OPENTHREAD_COMMISSIONER
bool "Enable Commissioner"
depends on OPENTHREAD_ENABLED
default n
help
Select this option to enable commissioner in OpenThread. This will enable the device to act as a
commissioner in the Thread network. A commissioner checks the pre-shared key from a joining device with
the Thread commissioning protocol and shares the network parameter with the joining device upon success.
config OPENTHREAD_COMM_MAX_JOINER_ENTRIES
int "The size of max commissioning joiner entries"
depends on OPENTHREAD_COMMISSIONER
default 2
range 2 50
2021-04-02 14:49:49 +08:00
config OPENTHREAD_JOINER
bool "Enable Joiner"
depends on OPENTHREAD_ENABLED
default n
help
Select this option to enable Joiner in OpenThread. This allows a device to join the Thread network with a
pre-shared key using the Thread commissioning protocol.
2021-09-10 14:15:52 +08:00
config OPENTHREAD_SRP_CLIENT
bool "Enable SRP Client"
depends on OPENTHREAD_ENABLED
2022-12-26 19:05:19 +08:00
default y
2021-09-10 14:15:52 +08:00
help
Select this option to enable SRP Client in OpenThread. This allows a device to register SRP services to SRP
Server.
config OPENTHREAD_SRP_CLIENT_MAX_SERVICES
int "Specifies number of service entries in the SRP client service pool"
depends on OPENTHREAD_SRP_CLIENT
default 5
range 2 20
help
Set the max buffer size of service entries in the SRP client service pool.
2023-03-01 15:10:21 +08:00
config OPENTHREAD_DNS_CLIENT
bool "Enable DNS Client"
depends on OPENTHREAD_ENABLED
default y
help
Select this option to enable DNS Client in OpenThread.
config OPENTHREAD_BORDER_ROUTER
bool "Enable Border Router"
depends on OPENTHREAD_ENABLED
default n
help
Select this option to enable border router features in OpenThread.
config OPENTHREAD_PLATFORM_MSGPOOL_MANAGEMENT
bool 'Allocate message pool buffer from PSRAM'
depends on OPENTHREAD_ENABLED && (SPIRAM_USE_CAPS_ALLOC || SPIRAM_USE_MALLOC)
default n
help
If enabled, the message pool is managed by platform defined logic.
config OPENTHREAD_NUM_MESSAGE_BUFFERS
int "The number of openthread message buffers"
depends on OPENTHREAD_ENABLED
default 65
range 10 100 if !OPENTHREAD_PLATFORM_MSGPOOL_MANAGEMENT
range 10 8191 if OPENTHREAD_PLATFORM_MSGPOOL_MANAGEMENT
config OPENTHREAD_SPINEL_RX_FRAME_BUFFER_SIZE
int "The size of openthread spinel rx frame buffer"
depends on OPENTHREAD_ENABLED || OPENTHREAD_SPINEL_ONLY
default 1024
range 512 8192
config OPENTHREAD_MLE_MAX_CHILDREN
int "The size of max MLE children entries"
depends on OPENTHREAD_ENABLED
default 10
range 5 50
config OPENTHREAD_TMF_ADDR_CACHE_ENTRIES
int "The size of max TMF address cache entries"
depends on OPENTHREAD_ENABLED
default 20
range 5 50
2022-05-30 15:53:11 +08:00
config OPENTHREAD_DNS64_CLIENT
bool "Use dns64 client"
depends on OPENTHREAD_ENABLED && LWIP_IPV4
2022-05-30 15:53:11 +08:00
default n
help
Select this option to acquire NAT64 address from dns servers.
config OPENTHREAD_DNS_SERVER_ADDR
string "DNS server address (IPv4)"
depends on OPENTHREAD_DNS64_CLIENT
default "8.8.8.8"
help
Set the DNS server IPv4 address.
config OPENTHREAD_UART_BUFFER_SIZE
int "The uart received buffer size of openthread"
depends on OPENTHREAD_ENABLED
default 256
range 128 1024
help
Set the OpenThread UART buffer size.
2023-01-03 17:29:30 +08:00
config OPENTHREAD_LINK_METRICS
bool "Enable link metrics feature"
depends on OPENTHREAD_ENABLED
default n
help
Select this option to enable link metrics feature
config OPENTHREAD_MACFILTER_ENABLE
bool "Enable mac filter feature"
depends on OPENTHREAD_ENABLED
default n
help
Select this option to enable mac filter feature
2023-01-03 17:29:30 +08:00
config OPENTHREAD_CSL_ENABLE
bool "Enable CSL feature"
depends on OPENTHREAD_ENABLED
default n
help
Select this option to enable CSL feature
config OPENTHREAD_XTAL_ACCURACY
int "The accuracy of the XTAL"
default 130
help
The device's XTAL accuracy, in ppm.
config OPENTHREAD_CSL_ACCURACY
int "The current CSL rx/tx scheduling drift, in units of ± ppm"
depends on OPENTHREAD_CSL_ENABLE
default 1
help
The current accuracy of the clock used for scheduling CSL operations
config OPENTHREAD_CSL_UNCERTAIN
int "The CSL Uncertainty in units of 10 us."
depends on OPENTHREAD_CSL_ENABLE
default 1
help
The fixed uncertainty of the Device for scheduling CSL Transmissions in units of 10 microseconds.
2023-01-03 17:29:30 +08:00
config OPENTHREAD_CSL_DEBUG_ENABLE
bool "Enable CSL debug"
depends on OPENTHREAD_CSL_ENABLE
default n
help
Select this option to set rx on when sleep in CSL feature, only for debug
2023-05-24 18:01:17 +08:00
config OPENTHREAD_DUA_ENABLE
bool "Enable Domain Unicast Address feature"
depends on OPENTHREAD_ENABLED
default n
help
Only used for Thread1.2 certification
2023-09-21 20:31:38 +08:00
config OPENTHREAD_TIME_SYNC
bool "Enable the time synchronization service feature"
depends on OPENTHREAD_ENABLED
default n
help
Select this option to enable time synchronization feature, the devices in the same Thread network could
sync to the same network time.
config OPENTHREAD_RADIO_STATS_ENABLE
bool "Enable Radio Statistics feature"
depends on OPENTHREAD_FTD || OPENTHREAD_MTD
default n
help
Select this option to enable the radio statistics feature, you can use radio command to print some radio
Statistics informations.
config OPENTHREAD_SPINEL_ONLY
bool "Enable OpenThread External Radio Spinel feature"
default n
help
Select this option to enable the OpenThread Radio Spinel for external protocol stack, such as Zigbee.
menu "Thread Address Query Config"
config OPENTHREAD_ADDRESS_QUERY_TIMEOUT
int "Timeout value (in seconds) for a address notification response after sending an address query."
depends on OPENTHREAD_FTD || OPENTHREAD_MTD
default 3
range 1 10
config OPENTHREAD_ADDRESS_QUERY_RETRY_DELAY
int "Initial retry delay for address query (in seconds)."
depends on OPENTHREAD_FTD || OPENTHREAD_MTD
default 15
range 1 120
config OPENTHREAD_ADDRESS_QUERY_MAX_RETRY_DELAY
int "Maximum retry delay for address query (in seconds)."
depends on OPENTHREAD_FTD || OPENTHREAD_MTD
default 120
range OPENTHREAD_ADDRESS_QUERY_RETRY_DELAY 960
endmenu
2021-04-02 14:49:49 +08:00
endmenu