Honoring Asian Pacific American Heritage Month. See how.

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.

Functionally equivalent to ot-br-posix's AttachAllNodesTo4.

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.

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.

Request

NameType
dataset OperationalDatasetTlvs

Response

<EMPTY>

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

NameType
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

NameType
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

NameType
name fuchsia.lowpan/InterfaceName
server_end request<Dataset>

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 UpdateVendorMeshCopTxtEntries1.

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

NameType
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

NameType
name fuchsia.lowpan/InterfaceName
server_end request<Meshcop>

STRUCTS

TxtEntries

Defined in fuchsia.lowpan.thread/meshcop.fidl

FieldTypeDescriptionDefault
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

CONSTANTS

NameValueTypeDescription
MAX_DATASET_TLV_LEN 254 uint8

TYPE ALIASES

NameValueDescription
OperationalDatasetTlvs vector[MAX_DATASET_TLV_LEN]

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

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