IMeshNetwork class abstract
The class defining the API to manage a bluetooth mesh network.
Constructors
Properties
-
groups
→ Future<
List< GroupData> > -
The currently defined group(s)
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
-
highestAllocatableAddress
→ Future<
int> -
The max address that the current selected provisioner can allocate
no setter
- id → String
-
The id of the network
no setter
-
name
→ Future<
String> -
The name of the network
no setter
-
nodes
→ Future<
List< ProvisionedMeshNode> > -
The current list of nodes (provisioners + provisioned mesh devices)
no setter
-
provisioners
→ Future<
List< Provisioner> > -
The current list of provisioners
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addGroupWithName(
String name) → Future< GroupData?> -
Will try to add a new group in the network with the given
name -
addProvisioner(
int unicastAddressRange, int groupAddressRange, int sceneAddressRange, int globalTtl, {String name}) → Future< bool> - Will add a provisioner in the current network using the given ranges and ttl.
-
assignUnicastAddress(
int unicastAddress) → Future< void> -
Will check if the given
unicastAddressis free of use -
deleteNode(
String uid) → Future< bool> - Will manually remove a node from the network.
-
distributeNetKey(
int netKeyIndex) → Future< NetworkKey?> - Will distribute the Network Key at the given index
-
elementsForGroup(
int groupAddress) → Future< List< ElementData> > -
Will return the data of elements subscribed to the given
groupAddress -
generateNetKey(
) → Future< NetworkKey> - Will return a newly generated Network Key
-
getGroupElementIds(
int groupAddress) → Future< Map> -
Will return the elements that have subscribed either Generic Level models or Generic ON/OFF models to the given
groupAddress -
getMeshModelSubscriptions(
int elementAddress, int modelIdentifier) → Future< Map> - Will return the subscribed addresses of the given element and model
-
getNetKey(
int netKeyIndex) → Future< NetworkKey?> - Will return the Network Key at the given index
-
getNode(
int address) → Future< ProvisionedMeshNode?> -
Will return the node corresponding to the given
address -
getNodeUsingUUID(
String uuid) → Future< ProvisionedMeshNode?> -
Will return the node corresponding to the given
uuid -
nextAvailableUnicastAddress(
int elementSize) → Future< int> - Will return the next free unicast address based on the number of elements of a node
-
nextAvailableUnicastAddressWithMin(
int minAddress, int elementSize) → Future< int> -
Will return the next free unicast address based on the number of elements of a node. The address shall be greater than the given
minAddress -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeGroup(
int groupAddress) → Future< bool> -
Will remove the group with the given
groupAddress -
removeNetKey(
int netKeyIndex) → Future< bool?> - Will remove the Network Key at the given index
-
removeProvisioner(
String provisionerUUID) → Future< bool> - Will remove the provisioner with the given uuid
-
selectedProvisionerUuid(
) → Future< String> - Will return the UUID of the current selected provisioner
-
selectProvisioner(
int provisionerIndex) → Future< void> - Will select the provisioner at the given index of the provisioners list
-
toString(
) → String -
A string representation of this object.
inherited
-
updateProvisioner(
Provisioner provisioner) → Future< bool> -
Will update the given
provisioner
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited