fuchsia.lowpan.thread

Added: 7

PROTOCOLS

Dataset

Defined in fuchsia.lowpan.thread/dataset.fidl

Thread Operational Dataset Protocol.

This protocol can expose PII.

This protocol provides methods related to the management of the Thread operational dataset in raw TLV form.

AttachAllNodesTo

Requests that all nodes on the current network attach to the thread network described by given dataset. Returns the number of milliseconds until the change takes effect.

Functionally equivalent to ot-br-posix's AttachAllNodesTo 4.

If this device is not currently provisioned, then calling this method is equivalent to calling SetActiveTlvs().

The transition of all nodes to the new network may take as long as five minutes. The exact amount of time until the network is transitioned is returned by this method.

This method returns once the transition has been scheduled successfully. Any error that prevents the scheduling of this operation from completing successfully (such as being provided with an incomplete dataset) will result in the protocol being closed.

Added: 8

Request

Name	Type
`dataset`	`OperationalDatasetTlvs`

Response

Name	Type
`delay_ms`	`int64`

GetActiveTlvs

Fetches and returns the active Thread operational dataset in raw TLV form. Functionally equivalent to otDatasetGetActiveTlvs()2.

This method returns the active dataset, or nothing in the case that there is no active operational dataset.

Any error that prevents the operation from completing successfully will result in the protocol being closed.

Request

<EMPTY>

Response

Name	Type
`dataset`	`OperationalDatasetTlvs`

SetActiveTlvs

Sets the active Thread Operational Dataset in raw TLV form. Functionally equivalent to otDatasetSetActiveTlvs()3.

This method returns once the operation has completed successfully.

Any error that prevents the operation from completing successfully will result in the protocol being closed.

Request

Name	Type
`dataset`	`OperationalDatasetTlvs`

Response

<EMPTY>

DatasetConnector

Defined in fuchsia.lowpan.thread/dataset.fidl

Protocol for connecting to Dataset on a LoWPAN device.

Connect

Connects to the Dataset protocol on the named LoWPAN device.

The name of the interface can be learned by calling fuchsia.lowpan/Lookup.GetDevices.

If there is an error in processing this request the given channel is closed and an epitaph code used to describe the reason for the failure:

ZX_ERR_INVALID_ARGUMENT: The given interface name was not formatted correctly or otherwise invalid.
ZX_ERR_NOT_FOUND: No interface was found with the given name.
ZX_ERR_NOT_SUPPORTED: The interface exists but does not support this protocol.

Request

Name	Type
`name`	`fuchsia.lowpan/InterfaceName`
`server_end`	`server_end<Dataset>`

Feature

Defined in fuchsia.lowpan.thread/feature.fidl

Protocol for fetching and updating the OpenThread feature configuration for a specific LoWPAN interface.

Added: 12

GetFeatureConfig

Returns the current OpenThread feature configuration for this interface.

A unset field in the returned value means that feature is not supported.

Request

<EMPTY>

Response

Name	Type
`config`	`FeatureConfig`

UpdateFeatureConfig

Updates the current OpenThread feature configuration for this interface.

Any unset field in config will leave that field unchanged.

Request

Name	Type
`config`	`FeatureConfig`

Response

<EMPTY>

FeatureConnector

Defined in fuchsia.lowpan.thread/feature.fidl

Protocol for connecting to Feature on a LoWPAN device.

Added: 12

Connect

Connects to the Feature protocol on the named LoWPAN device.

The name of the interface can be learned by calling fuchsia.lowpan/Lookup.GetDevices.

If there is an error in processing this request the given channel is closed and an epitaph code used to describe the reason for the failure:

ZX_ERR_INVALID_ARGUMENT: The given interface name was not formatted correctly or otherwise invalid.
ZX_ERR_NOT_FOUND: No interface was found with the given name.
ZX_ERR_NOT_SUPPORTED: The interface exists but does not support this protocol.

Request

Name	Type
`name`	`fuchsia.lowpan/InterfaceName`
`server_end`	`server_end<Feature>`

Meshcop

Defined in fuchsia.lowpan.thread/meshcop.fidl

Methods associated with the Mesh Commissioning Protocol (Meshcop).

UpdateTxtEntries

Updates the TXT record information associated with the Meshcop border agent DNS-SD entry. This allows additional information about the device to be discoverable on the local network when acting as a border agent.

Functionally equivalent to ot-br-posix's UpdateVendorMeshCopTxtEntries 1.

Typically, the following keys are updated:

vn: Vendor Name
mn: Model Name
vo: Vendor OUI
vd/vcd: Vendor-specific Data

See table 8-4 in section 8.4.1.1.2 of the Thread 1.2 specification for a detailed explanation of all the keys and their values.

Any error that prevents the operation from completing successfully (such as being provided with invalid keys) will result in the protocol being closed.

Request

Name	Type
`txt_entries`	`vector<TxtEntries>[32]`

Response

<EMPTY>

MeshcopConnector

Defined in fuchsia.lowpan.thread/meshcop.fidl

Protocol for connecting to Meshcop on a LoWPAN device.

Connect

Connects to the Meshcop protocol on the named LoWPAN interface.

The name of the interface can be learned by calling fuchsia.lowpan/Lookup.GetDevices.

If there is an error in processing this request the given channel is closed and an epitaph code used to describe the reason for the failure:

ZX_ERR_INVALID_ARGUMENT: The given interface name was not formatted correctly or otherwise invalid.
ZX_ERR_NOT_FOUND: No interface was found with the given name.
ZX_ERR_NOT_SUPPORTED: The interface exists but does not support this protocol.

Request

Name	Type
`name`	`fuchsia.lowpan/InterfaceName`
`server_end`	`server_end<Meshcop>`

STRUCTS

TxtEntries

Defined in fuchsia.lowpan.thread/meshcop.fidl

Field Type Description Default

Field	Type	Description	Default
`key`	`string[254]`	The key string for this TXT entry. Must not contain the character `=`. Maximum theoretical length is 254 bytes.	No default
`value`	`vector<uint8>[253]`	The binary value associated with this key. Maximum theoretical length is 253 bytes, which is two bytes less than the TXT record maximum length to account for a single-byte key and key/value separator byte.	No default

key

string[254]

The key string for this TXT entry.

Must not contain the character =. Maximum theoretical length is 254 bytes.

No default

value

vector<uint8>[253]

The binary value associated with this key.

Maximum theoretical length is 253 bytes, which is two bytes less than the TXT record maximum length to account for a single-byte key and key/value separator byte.

No default

TABLES

FeatureConfig

Defined in fuchsia.lowpan.thread/feature.fidl

OpenThread feature configuration.

This table describes what OpenThread features are enabled or disabled for a given interface. See the Feature protocol for more information.

Added: 12

Ordinal	Field	Type	Description
1	`trel_enabled`	`bool`	Determines if TREL is enabled or disabled.
2	`nat64_enabled`	`bool`	Determines if NAT64 is enabled or disabled.
3	`srp_replication_enabled`	`bool`	Determines if SRP replication is enabled or disabled.

CONSTANTS

Name	Value	Type	Description
MAX_DATASET_TLV_LEN	`254`	`uint8`

ALIASES

Name Value Description

Name	Value	Description
OperationalDatasetTlvs	`vector`[`MAX_DATASET_TLV_LEN`]	Datatype for containing a Thread dataset in raw TLV form. Functionally equivalent to type otOperationalDatasetTlvs 1. The details of the Thread TLV format are documented in the Thread Specification.

OperationalDatasetTlvs

vector[MAX_DATASET_TLV_LEN]

Datatype for containing a Thread dataset in raw TLV form. Functionally equivalent to type otOperationalDatasetTlvs 1.

The details of the Thread TLV format are documented in the Thread Specification.