ESP-THREAD-BR Release v1.3

The Espressif Thread Border Router SDK v1.3 release.

It's based on ESP-IDF v5.5.2, the corresponding OpenThread commit is 36b14d3.

This version has already obtained Thread v1.4 certification. You can find the certification details here.

Use the following commands to download the ESP-IDF and ESP-Thread-BR for this release:

git clone -b v5.5.2 --recursive https://github.com/espressif/esp-idf.git
git clone -b v1.3 https://github.com/espressif/esp-thread-br.git

The latest documentation is available at: https://docs.espressif.com/projects/esp-thread-br.

ChangeLog

This is the list of changes since release v1.2:

Added

• Added APIs to start or stop the OpenThread stack (espressif/esp-idf@31b8066)
• Added a function to exit openthread main loop safely (espressif/esp-idf@f704630)
• Supported Wi-Fi configuration in SoftAP mode (f360147)
• Supported multicast forwarding cache filter in Thread BR (espressif/esp-idf@0586744)
• Supported DHCPv6 PD feature (espressif/esp-idf@0586744)
• Added DHCPv6 PD codelab (4da9e5e)
• Supported the ephemeral key QR code for M5Stack Thread BR (32a2931)

Changed

• Supported custom netif config during initialization (espressif/esp-idf@6334043)
• Updated the OpenThread examples to use the new APIs, simplifying Thread initialization and deinitialization (espressif/esp-idf@31b8066)
• Updated OpenThread examples to use esp_console. The ot prefix is required when running OpenThread CLI commands (espressif/esp-idf@31b8066)
• Generated the dataset randomly (d188172)
• Updated openthread submodule (36b14d3ef) (espressif/esp-idf@0586744)
• Refactored openthread rcp update APIs to simplify RCP update flow (4c1b767)

Fixed

• Fixed a potential stack overflow issue in TREL browse (espressif/esp-idf@332c73b)
• Fixed an occasional multicast router initialization failure (espressif/esp-idf@332c73b)
• Fixed a deadlock issue in DNS resolver (espressif/esp-idf@332c73b)
• Fixed an issue where NVS was not opened from the configured partition (espressif/esp-idf@332c73b)
• Resolved the RCP data transmission issue over USB Serial JTAG (espressif/esp-idf@166e12c)
• Enlarged the spiffs writing size (e38ba1e)

ESP-THREAD-BR Release v1.2

The Espressif Thread Border Router SDK v1.2 release.

It's based on ESP-IDF v5.4.2, the corresponding OpenThread commit is ec2b0d4.

Use the following commands to download the ESP-IDF and ESP-Thread-BR for this release:

git clone -b v5.4.2 --recursive https://github.com/espressif/esp-idf.git
git clone -b v1.2 https://github.com/espressif/esp-thread-br.git

The latest documentation is available at: https://docs.espressif.com/projects/esp-thread-br.

ChangeLog

This is the list of changes since release v1.1:

Added

• Border Router Example Based on M5Stack

  • Added a border router example based on m5stack (6af15ad)
  • Added support for Unit Gateway H2 in the M5Stack example (8ecde3b)

• Thread Radio Encapsulation Link (TREL) Features

  • Supported TREL feature (espressif/esp-idf@a0ae573)

• DNS Related Features

  • Added check for IP address in DNS external resolve hook (espressif/esp-idf@1723b41)
  • Supported DNS resolver to forward IPv6 query and response (espressif/esp-idf@d6b6583)

• RCP Related Features

  • Added a callback to handle RCP reset failure (espressif/esp-idf@352ea8d)
  • Added an API to set RCP version string (espressif/esp-idf@77fb4e4)
  • Supported RCP update of ESP32-C6 (175715b)
  • Supported restoring vendor properties of RCP (espressif/esp-idf@09419b1)
  • Supported vendor hook for RCP SPI (espressif/esp-idf@1c75f46)
  • Supported RCP time sync and CSL options (espressif/esp-idf@c33c8a2)

• SRP Related Features

  • Handled subtype changed event (espressif/esp-idf@7564ff7)
  • Supported modifying port and txt of service (espressif/esp-idf@14bc7c0)

• Supported new SoCs

  • Supported ESP32-C5 based Thread border router (espressif/esp-idf@26d8350)
  • Supported ESP32-P4 based Thread border router (3512245)

• Other Features

  • Added dataset changed event and post it in state change callback (espressif/esp-idf@9677b9b)
  • Supported bus_latency for dual-chip BR solution (espressif/esp-idf@f59e0b6)
  • Supported changing OpenThread version information (espressif/esp-idf@fd166e8)
  • Supported preferred channel mask (espressif/esp-idf@86eed3f)
  • Supported time sync feature on border router (espressif/esp-idf@4025f1f)
  • Supported using custom header file (espressif/esp-idf@b813889)
  • Enabled Wi-Fi CLI extension for esp-hosted (a5244f1)
  • Supported alloc nat64 session from psram (espressif/esp-idf@d5d07b4)
  • Registered a compatibility error handler for border router (ccf5b28)

Changed

• Adjusted the OpenThread menuconfig structure (espressif/esp-idf@b813889)
• Enabled bbr when initialize border router (espressif/esp-idf@14bc7c0)
• Replaced netconn external resolve hook with dns external hook (espressif/esp-idf@f62628d)
• Unset default netif to ot (ce5ae6f)

Fixed

• DNS Related Fixes

  • Fixed external DNS resolve hook for DNS64 client (espressif/esp-idf@8af82e8)

• SRP Related Fixes

  • Checked the number of items before adding or updating subtypes (espressif/esp-idf@d6b6583)
  • Enlarged the default config for max services (3f18ebf)
  • Removed ML-EID address filter for srp client (espressif/esp-idf@26d8350)

• OpenThread Extension Command Fixes

  • Added lock for TCP socket extension commands (df53c24)
  • Fixed the ot Wi-Fi extension commands to resolve a deadlock issue (8d0580f)

• Other Fixes

  • Fixed endless loop when process invalid RA message (espressif/esp-idf@14bc7c0)
  • Fixed invalid host resolving for Thread end devices (espressif/esp-idf@7cf389d)
  • Fixed ping pong issue in multicast forwarding (espressif/esp-idf@d6b6583)
  • Handled SetTimeSyncState when ifconfig up or down (espressif/esp-idf@a53f89e)
  • Set channel for energy scan (espressif/esp-idf@7c03514)

ESP-THREAD-BR Release v1.1

The Espressif Thread Border Router SDK v1.1 release.

It's based on ESP-IDF v5.3.1, the corresponding OpenThread commit is f32c18b.

Use the following commands to download the ESP-IDF and ESP-Thread-BR for this release:

git clone -b v5.3.1 --recursive https://github.com/espressif/esp-idf.git
git clone -b v1.1 https://github.com/espressif/esp-thread-br.git

The latest documentation is available at: https://docs.espressif.com/projects/esp-thread-br.

ChangeLog

This is the list of changes since release v1.0:

Added

• Added the Thread 1.4 credential sharing feature
  • supported openthread ephemeral key feature (espressif/esp-idf@3efe49f)
  • Supported meshcop-e service publish and remove (espressif/esp-idf@3efe49f)
  • Added method to set instance name of meshcop-e mdns service (espressif/esp-idf@3860cc8)
• Supported Neighbor Solicit probe mechanism (espressif/esp-idf@1de232f)
• Supported NA router farwording flag set (espressif/esp-idf@da3107a)
• Added a task switching lock holder check (espressif/esp-idf@7e93518)
• Supported RX on when idle radio capability (espressif/esp-idf@e358506)
• Supported RCP re-initialization (espressif/esp-idf@58992e2)
• OpenThread CLI extenstion commands
  • Added the Non-volatile storage (NVS) diagnosis (ea09a22)
  • Added RCP update command (1e157a9)
• Added the RCP OTA feature to rcp_update component (3911aab)
• Supported using external PSRAM for br Web server data (6afa52b)

Changed

• Set raw pcb ttl value to 255 for icmpv6 message (espressif/esp-idf@93d68c2)
• Updated SRP server update response error code (espressif/esp-idf@58992e2)
• Optimized the PIO logic in multiple BRs scenario (espressif/esp-idf@6e2950d)
• Made ot task queue sending non-permanent blocking (espressif/esp-idf@73cdd20)
• Used the lwip on-link prefix table (espressif/esp-idf@1de232f)
• Updated CONFIG_LWIP_IPV6_NUM_ADDRESSES to 12 in Thread BR lib (espressif/esp-idf@be5feaf)
• Used wifi power save max modem as default (a94544b)
• Adjusted the BR initialization order (3b24084)
• Enlarged the ot task size (c666511)
• Start Web server after wifi/ethernet ipv4 address is got (14c2544)
• Supported Wi-Fi disconnect and optimized Wi-Fi connection flow (87c907e)

Fixed

• Fixed filter the zero-length prefix when adding router table (espressif/esp-idf@e88dc25)
• Moved router entry pointer in timeout handler (espressif/esp-idf@e88dc25)
• Fixed parsing when txt entry key pointer is NULL (espressif/esp-idf@e88dc25)
• Checked the lifetime value before calling sys_timeout (espressif/esp-idf@e88dc25)
• Fixed dead lock issue related to mdns (espressif/esp-idf@3efe49f)

ESP-THREAD-BR Release v1.0

The Espressif Thread Border Router SDK v1.0 official release. The documentation is available at: https://docs.espressif.com/projects/esp-thread-br

It's based on ESP-IDF v5.1.2, the corresponding OpenThread commit is af5938e.

ChangeLog

This is the list of changes since release v1.0-beta:

Added

• Added support for RF coexistence (568221c)
• Added support for border router deinit (espressif/esp-idf@649b8bc)
• Added more REST APIs
  • border agent id request (2f6cd9e)
  • delete node information (ddffc8a)
  • dataset configuration (0b08a3a)

Changed

• Moved USB console init to openthread platform layer (espressif/esp-idf@6cc6ece)
• Supported RCP size optimization configuration (espressif/esp-idf@ffc8da6)

Fixed

• Fixed removing client service failure in some cases (espressif/esp-idf@649b8bc)
• Fixed curl failure in NAT64 (espressif/esp-idf@649b8bc)
• Fixed multi connection issue in NAT64 (espressif/esp-idf@649b8bc)

ESP-THREAD-BR Release v1.0-beta

The Espressif Thread Border Router SDK v1.0-beta release. The documentation is available at: https://docs.espressif.com/projects/esp-thread-br

It's based on ESP-IDF v5.1.1, the corresponding OpenThread commit is 5beae14.

Supported Features

Networking Features

• Bi-directional IPv6 Connectivity: The devices on the backbone link (typically Wi-Fi) and the Thread network can reach each other.
• Service Discovery Delegate: The nodes on the Thread network can find the mDNS services on the backbone link.
• Service Registration Server: The nodes on the Thread network can register services to the border router for devices on the backbone link to discover.
• Multicast Forwarding: The devices joining the same multicast group on the backbone link and the Thread network can be reached with one single multicast.
• NAT64: The devices can access the IPv4 Internet via the border router.

Production Features

• RCP Update: The built border router image will contain an updatable RCP image and can automatically update the RCP on version mismatch or RCP failure.
• Web GUI: The border router will enable a web server and provide some practical functions including Thread network discovery, network formation and status query.