Files
Tom Rebbert 023d2e0762 [neighbor-table] add otThreadGetNeighborInfoByRloc16() API (#13715)
This commit adds `otThreadGetNeighborInfoByRloc16()`, which returns
the `otNeighborInfo` for a single neighbor given its RLOC16, along with
a matching `neighbor <rloc16>` CLI command.

Previously, the only way to get average/last RSSI and frame/message
error rates for a neighboring router was to iterate the whole table
with `otThreadGetNextNeighborInfo()`, since `otThreadGetRouterInfo()`
does not provide these fields. The new API is a direct lookup that
works for any neighbor type (child, router, or parent).

`NeighborTable::GetNeighborInfo()` rejects broadcast and invalid
RLOC16s, then checks the parent directly on a child. On a router or
leader, it looks up a child RLOC16 in the child table. On a router,
leader, or FTD child, it looks up a router RLOC16 in the router table,
requiring the full RLOC16 to match since the table is indexed by Router
ID only. On an FTD child, this covers routers with which the child has
established a link. Unlike the FTD build of
`otThreadGetNextNeighborInfo()`, the new API reports the parent when
the device is a child.

The CLI `neighbor <rloc16>` command prints role (`C`/`R`), RLOC16,
extended address, age, connection time, RSSI, link quality, error
rates, mode, and version.

This commit also adds the Nexus test `test_neighbor_info_by_rloc16`,
included in `DEFAULT_TESTS`, which covers routers, children, the
parent, an FED's link with a non-parent router, and not-found cases,
and cross-checks every field against the iterator. It also extends
`cli-neighbor.exp` with the new command.
2026-10-21 22:44:41 -07:00

68 lines
2.6 KiB
Plaintext
Executable File

#!/usr/bin/expect -f
#
# Copyright (c) 2020, 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.
#
source "tests/scripts/expect/_common.exp"
source "tests/scripts/expect/_multinode.exp"
setup_two_nodes
switch_node 2
set rloc [get_rloc16]
set extaddr [get_extaddr]
switch_node 1
send "neighbor table\n"
expect "| Role | RLOC16 | Age | Avg RSSI | Last RSSI | LQ In |R|D|N| Extended MAC | Version |"
expect "+------+--------+-----+----------+-----------+-------+-+-+-+------------------+---------+"
expect -re "\\| +C +\\| 0x$rloc \\| +\\d+ \\| +-?\\d+ \\| +-?\\d+ \\| +\\d+ \\|1\\|0\\|0\\| $extaddr \\| +\\d+ \\|"
expect_line "Done"
send "neighbor list\n"
expect "0x$rloc"
expect_line "Done"
send "neighbor 0x$rloc\n"
expect "Role: C"
expect "Rloc16: 0x$rloc"
expect "Ext Addr: $extaddr"
expect -re "Connection Time: \\d+"
expect_line "Mode: r"
expect_line "Done"
send "neighbor 0xfffe\n"
expect "Error 23: NotFound"
set leader_rloc [get_rloc16]
switch_node 2
send "neighbor 0x$leader_rloc\n"
expect "Role: R"
expect "Rloc16: 0x$leader_rloc"
expect_line "Done"
switch_node 1
send "neighbor something_invalid\n"
expect "Error 7: InvalidArgs"
dispose_all