Skip to content

Add missing OpenThread meshcop tlv types #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lboue wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add missing OpenThread meshcop tlv types #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
37ae86d
Add THREAD_DOMAIN_NAME constant to tlv_parser
lboue Dec 26, 2025
41be1f3
Replace APPLE_TAG_UNKNOWN with WAKEUP_CHANNEL
lboue Dec 26, 2025
ebe11f0
Add DURATION constant to tlv_parser.py
lboue Dec 26, 2025
4c2ceff
Replace APPLE_TAG_UNKNOWN with WAKEUP_CHANNEL
lboue Dec 26, 2025
031094e
Rename test_parse_tlv_apple to test_parse_tlv_with_wakeup_channel for…
lboue Jan 8, 2026
f8a2d80
Add new Meshcop TLV types and corresponding test cases
lboue Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions python_otbr_api/tlv_parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ class MeshcopTLVType(IntEnum):
JOINER_IID = 19
JOINER_RLOC = 20
JOINER_ROUTER_KEK = 21
DURATION = 23
PROVISIONING_URL = 32
VENDOR_NAME_TLV = 33
VENDOR_MODEL_TLV = 34
Expand All @@ -51,8 +52,8 @@ class MeshcopTLVType(IntEnum):
PERIOD = 55
SCAN_DURATION = 56
ENERGY_LIST = 57
# Seen in a dataset imported through iOS companion app
APPLE_TAG_UNKNOWN = 74
THREAD_DOMAIN_NAME = 59
WAKEUP_CHANNEL = 74
DISCOVERYREQUEST = 128
DISCOVERYRESPONSE = 129
JOINERADVERTISEMENT = 241
Expand Down
70 changes: 67 additions & 3 deletions tests/test_tlv_parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,64 @@
)


# Shared dataset covering the newly added Meshcop TLV types.
NEW_MESHCOP_DATASET = {
MeshcopTLVType.DURATION: MeshcopTLVItem(
MeshcopTLVType.DURATION, bytes.fromhex("05")
),
MeshcopTLVType.PROVISIONING_URL: MeshcopTLVItem(
MeshcopTLVType.PROVISIONING_URL, "test".encode()
),
MeshcopTLVType.VENDOR_NAME_TLV: MeshcopTLVItem(
MeshcopTLVType.VENDOR_NAME_TLV, "ACME".encode()
),
MeshcopTLVType.UDP_ENCAPSULATION_TLV: MeshcopTLVItem(
MeshcopTLVType.UDP_ENCAPSULATION_TLV, bytes.fromhex("beef")
),
MeshcopTLVType.IPV6_ADDRESS_TLV: MeshcopTLVItem(
MeshcopTLVType.IPV6_ADDRESS_TLV,
bytes.fromhex("20010db8000000000000000000000001"),
),
MeshcopTLVType.PENDINGTIMESTAMP: MeshcopTLVItem(
MeshcopTLVType.PENDINGTIMESTAMP, bytes.fromhex("0000000000010000")
),
MeshcopTLVType.DELAYTIMER: MeshcopTLVItem(
MeshcopTLVType.DELAYTIMER, bytes.fromhex("00001388")
),
MeshcopTLVType.COUNT: MeshcopTLVItem(
MeshcopTLVType.COUNT, bytes.fromhex("03")
),
MeshcopTLVType.PERIOD: MeshcopTLVItem(
MeshcopTLVType.PERIOD, bytes.fromhex("0032")
),
MeshcopTLVType.SCAN_DURATION: MeshcopTLVItem(
MeshcopTLVType.SCAN_DURATION, bytes.fromhex("04")
),
MeshcopTLVType.ENERGY_LIST: MeshcopTLVItem(
MeshcopTLVType.ENERGY_LIST, bytes.fromhex("010203")
),
MeshcopTLVType.THREAD_DOMAIN_NAME: MeshcopTLVItem(
MeshcopTLVType.THREAD_DOMAIN_NAME, "home".encode()
),
MeshcopTLVType.DISCOVERYREQUEST: MeshcopTLVItem(
MeshcopTLVType.DISCOVERYREQUEST, bytes.fromhex("00")
),
MeshcopTLVType.DISCOVERYRESPONSE: MeshcopTLVItem(
MeshcopTLVType.DISCOVERYRESPONSE, bytes.fromhex("01")
),
MeshcopTLVType.JOINERADVERTISEMENT: MeshcopTLVItem(
MeshcopTLVType.JOINERADVERTISEMENT, bytes.fromhex("02")
),
}

# Expected TLV hex for NEW_MESHCOP_DATASET; order follows the dict insertion order.
NEW_MESHCOP_DATASET_HEX = (
"170105200474657374210441434d453002beef311020010db8000000000000000000000001"
"330800000000000100003404000013883601033702003238010439030102033b04686f6d65"
"800100810101f10102"
)


def test_encode_tlv() -> None:
"""Test the TLV parser."""
dataset = {
Expand Down Expand Up @@ -58,6 +116,9 @@ def test_encode_tlv() -> None:
).lower()
)

encoded_new_types = encode_tlv(NEW_MESHCOP_DATASET)
assert encoded_new_types == NEW_MESHCOP_DATASET_HEX


def test_parse_tlv() -> None:
"""Test the TLV parser."""
Expand Down Expand Up @@ -100,8 +161,11 @@ def test_parse_tlv() -> None:
),
}

parsed_new_types = parse_tlv(NEW_MESHCOP_DATASET_HEX)
assert parsed_new_types == NEW_MESHCOP_DATASET


def test_parse_tlv_apple() -> None:
def test_parse_tlv_with_wakeup_channel() -> None:
"""Test the TLV parser from a (truncated) dataset from an Apple BR."""
dataset_tlv = (
"0e08000065901a07000000030000194a0300000f35060004001fffc003104d79486f6d65313233"
Expand All @@ -115,8 +179,8 @@ def test_parse_tlv_apple() -> None:
MeshcopTLVType.CHANNEL: Channel(
MeshcopTLVType.CHANNEL, bytes.fromhex("000019")
),
MeshcopTLVType.APPLE_TAG_UNKNOWN: MeshcopTLVItem(
MeshcopTLVType.APPLE_TAG_UNKNOWN, bytes.fromhex("00000f")
MeshcopTLVType.WAKEUP_CHANNEL : MeshcopTLVItem(
MeshcopTLVType.WAKEUP_CHANNEL , bytes.fromhex("00000f")
),
MeshcopTLVType.CHANNELMASK: MeshcopTLVItem(
MeshcopTLVType.CHANNELMASK, bytes.fromhex("0004001fffc0")
Expand Down