circuitmatter.clusters.device_management.network_commissioning

Classes

ThreadCapabilitiesBitmap

Support for integer-based Flags

NetworkCommissioningCluster

Module Contents

class circuitmatter.clusters.device_management.network_commissioning.ThreadCapabilitiesBitmap

Bases: circuitmatter.data_model.Map16

Support for integer-based Flags

IS_BORDER_ROUTER_CAPABLE
IS_ROUTER_CAPABLE
IS_SLEEPY_END_DEVICE_CAPABLE
IS_FULL_THREAD_DEVICE
IS_SYNCHRONIZED_SLEEPY_END_DEVICE_CAPABLE
class circuitmatter.clusters.device_management.network_commissioning.NetworkCommissioningCluster

Bases: circuitmatter.data_model.Cluster

CLUSTER_ID = 49
class FeatureBitmap

Bases: enum.IntFlag

Support for integer-based Flags

WIFI_NETWORK_INTERFACE = 1
THREAD_NETWORK_INTERFACE = 2
ETHERNET_NETWORK_INTERFACE = 4
class WifiBandEnum

Bases: circuitmatter.data_model.Enum8

Enum where members are also (and must be) ints

BAND_2G4 = 0
BAND_3G65 = 1
BAND_5G = 2
BAND_6G = 3
BAND_60G = 4
BAND_1G = 5
class NetworkCommissioningStatus

Bases: circuitmatter.data_model.Enum8

Enum where members are also (and must be) ints

SUCCESS = 0

Ok, no error

OUT_OF_RANGE = 1

Value Outside Range

BOUNDS_EXCEEDED = 2

A collection would exceed its size limit

NETWORK_ID_NOT_FOUND = 3

The NetworkID is not among the collection of added networks

DUPLICATE_NETWORK_ID = 4

The NetworkID is already among the collection of added networks

NETWORK_NOT_FOUND = 5

SSID Not found

Type:

Cannot find AP

REGULATORY_ERROR = 6

Mismatch on band/channels/regulatory domain / 2.4GHz vs 5GHz

Type:

Cannot find AP

AUTH_FAILURE = 7

Cannot associate due to authentication failure

UNSUPPORTED_SECURITY = 8

Cannot associate due to unsupported security mode

OTHER_CONNECTION_FAILURE = 9

Other association failure

IPV6_FAILED = 10

Failure to generate an IPv6 address

IP_BIND_FAILED = 11

Failure to bind Wi-Fi <-> IP interfaces

UNKNOWN_ERROR = 12

Unknown error

class NetworkInfoStruct

Bases: circuitmatter.tlv.Structure

NetworkID
Connected
__str__()
encode() → memoryview
encode_into(buffer: bytearray, offset: int = 0) → int
classmethod decode(buffer: memoryview, offset=0) → Structure
classmethod decode_member(control_octet, buffer, offset=0, depth=0) → tuple[dict, int]
construct_containers()
classmethod from_value(value)
values
classmethod max_length()
set_value(tag, value)
delete_value(tag)
max_networks
networks
scan_max_time_seconds
connect_max_time_seconds
interface_enabled
last_network_status
last_network_id
last_connect_error_value
supported_wifi_bands
supported_thread_features
thread_version
cluster_revision
feature_map
attribute_list
event_list
accepted_command_list
generated_command_list
data_version
__contains__(descriptor_id)
restore(nonvolatile)
get_attribute_data(session, path, subscription=None) → list[circuitmatter.interaction_model.AttributeDataIB]
set_attribute(context, attribute_data) → circuitmatter.interaction_model.AttributeStatusIB
invoke(session, path, fields) → circuitmatter.interaction_model.CommandDataIB | circuitmatter.interaction_model.StatusCode | None