mesh

package
v0.0.0-...-04c4f09 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 1, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

BlueZ D-Bus Mesh API description [mesh-api.txt]

Index

Constants

This section is empty.

Variables

View Source 
var Application1Interface = "org.bluez.mesh.Application1"
View Source 
var Attention1Interface = "org.bluez.mesh.Attention1"
View Source 
var Element1Interface = "org.bluez.mesh.Element1"
View Source 
var Management1Interface = "org.bluez.mesh.Management1"
View Source 
var Network1Interface = "org.bluez.mesh.Network1"
View Source 
var Node1Interface = "org.bluez.mesh.Node1"
View Source 
var ProvisionAgent1Interface = "org.bluez.mesh.ProvisionAgent1"
View Source 
var Provisioner1Interface = "org.bluez.mesh.Provisioner1"

Functions

This section is empty.

Types

type Application1 

type Application1 struct {
	Properties *Application1Properties
	// contains filtered or unexported fields
}

Application1 Mesh Application Hierarchy

func NewApplication1 

func NewApplication1(servicePath string, objectPath dbus.ObjectPath) (*Application1, error)

NewApplication1 create a new instance of Application1

Args: - servicePath: unique name - objectPath: <app_root>

func (*Application1) Client 

func (a *Application1) Client() *bluez.Client

Client return Application1 dbus client

func (*Application1) Close 

func (a *Application1) Close()

Close the connection

func (*Application1) GetCRPL 

func (a *Application1) GetCRPL() (uint16, error)

GetCRPL get CRPL value

func (*Application1) GetCompanyID 

func (a *Application1) GetCompanyID() (uint16, error)

GetCompanyID get CompanyID value

func (*Application1) GetObjectManagerSignal 

func (a *Application1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)

GetObjectManagerSignal return a channel for receiving updates from the ObjectManager

func (*Application1) GetProductID 

func (a *Application1) GetProductID() (uint16, error)

GetProductID get ProductID value

func (*Application1) GetProperties 

func (a *Application1) GetProperties() (*Application1Properties, error)

GetProperties load all available properties

func (*Application1) GetPropertiesSignal 

func (a *Application1) GetPropertiesSignal() (chan *dbus.Signal, error)

GetPropertiesSignal return a channel for receiving udpdates on property changes

func (*Application1) GetProperty 

func (a *Application1) GetProperty(name string) (dbus.Variant, error)

GetProperty get a property

func (*Application1) GetVersionID 

func (a *Application1) GetVersionID() (uint16, error)

GetVersionID get VersionID value

func (*Application1) GetWatchPropertiesChannel 

func (a *Application1) GetWatchPropertiesChannel() chan *dbus.Signal

GetWatchPropertiesChannel return the dbus channel to receive properties interface

func (*Application1) Interface 

func (a *Application1) Interface() string

Interface return Application1 interface

func (*Application1) JoinComplete 

func (a *Application1) JoinComplete(token uint64) error

JoinComplete This method is called when the node provisioning initiated 

by a Join() method call successfully completed.
The token parameter serves as a unique identifier of the
particular node. The token must be preserved by the application
in order to authenticate itself to the mesh daemon and attach to
the network as a mesh node by calling Attach() method or
permanently remove the identity of the mesh node by calling
Leave() method.
If this method returns an error, the daemon will assume that the
application failed to preserve the token, and will remove the
freshly created node.

func (*Application1) JoinFailed 

func (a *Application1) JoinFailed(reason string) error

JoinFailed This method is called when the node provisioning initiated by 

Join() has failed.
The reason parameter identifies the reason for provisioning
failure. The defined values are: "timeout", "bad-pdu",
"confirmation-failed", "out-of-resources", "decryption-error",
"unexpected-error", "cannot-assign-addresses".

func (*Application1) Path 

func (a *Application1) Path() dbus.ObjectPath

Path return Application1 object path

func (*Application1) SetProperty 

func (a *Application1) SetProperty(name string, value interface{}) error

SetProperty set a property

func (*Application1) SetWatchPropertiesChannel 

func (a *Application1) SetWatchPropertiesChannel(c chan *dbus.Signal)

SetWatchPropertiesChannel set the dbus channel to receive properties interface

func (*Application1) ToProps 

func (a *Application1) ToProps() bluez.Properties

ToProps return the properties interface

func (*Application1) UnwatchProperties 

func (a *Application1) UnwatchProperties(ch chan *bluez.PropertyChanged) error

func (*Application1) WatchProperties 

func (a *Application1) WatchProperties() (chan *bluez.PropertyChanged, error)

WatchProperties updates on property changes

type Application1Properties 

type Application1Properties struct {

	/*
		CRPL A 16-bit minimum number of replay protection list entries
	*/
	CRPL uint16

	/*
		CompanyID A 16-bit Bluetooth-assigned Company Identifier of the vendor as
			defined by Bluetooth SIG
	*/
	CompanyID uint16

	/*
		ProductID A 16-bit vendor-assigned product identifier
	*/
	ProductID uint16

	/*
		VersionID A 16-bit vendor-assigned product version identifier
	*/
	VersionID uint16
	// contains filtered or unexported fields
}

Application1Properties contains the exposed properties of an interface

func (*Application1Properties) FromDBusMap 

func (a *Application1Properties) FromDBusMap(props map[string]dbus.Variant) (*Application1Properties, error)

FromDBusMap convert a map to an Application1Properties

func (*Application1Properties) FromMap 

func (a *Application1Properties) FromMap(props map[string]interface{}) (*Application1Properties, error)

FromMap convert a map to an Application1Properties

func (*Application1Properties) Lock 

func (p *Application1Properties) Lock()

Lock access to properties

func (*Application1Properties) ToMap 

func (a *Application1Properties) ToMap() (map[string]interface{}, error)

ToMap convert a Application1Properties to map

func (*Application1Properties) Unlock 

func (p *Application1Properties) Unlock()

Unlock access to properties

type Attention1 

type Attention1 struct {
	Properties *Attention1Properties
	// contains filtered or unexported fields
}

Attention1 Mesh Attention Hierarchy

func NewAttention1 

func NewAttention1(servicePath string, objectPath dbus.ObjectPath) (*Attention1, error)

NewAttention1 create a new instance of Attention1

Args: - servicePath: unique name - objectPath: freely definable

func (*Attention1) Client 

func (a *Attention1) Client() *bluez.Client

Client return Attention1 dbus client

func (*Attention1) Close 

func (a *Attention1) Close()

Close the connection

func (*Attention1) GetObjectManagerSignal 

func (a *Attention1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)

GetObjectManagerSignal return a channel for receiving updates from the ObjectManager

func (*Attention1) GetProperties 

func (a *Attention1) GetProperties() (*Attention1Properties, error)

GetProperties load all available properties

func (*Attention1) GetPropertiesSignal 

func (a *Attention1) GetPropertiesSignal() (chan *dbus.Signal, error)

GetPropertiesSignal return a channel for receiving udpdates on property changes

func (*Attention1) GetProperty 

func (a *Attention1) GetProperty(name string) (dbus.Variant, error)

GetProperty get a property

func (*Attention1) GetTimer 

func (a *Attention1) GetTimer(element uint16) (uint16, error)

GetTimer The element parameter is the unicast address within the node 

where the health server model is hosted.
Returns the number of seconds for how long the attention action
remains staying on.
PossibleErrors:
	org.bluez.mesh.Error.NotSupported

func (*Attention1) GetWatchPropertiesChannel 

func (a *Attention1) GetWatchPropertiesChannel() chan *dbus.Signal

GetWatchPropertiesChannel return the dbus channel to receive properties interface

func (*Attention1) Interface 

func (a *Attention1) Interface() string

Interface return Attention1 interface

func (*Attention1) Path 

func (a *Attention1) Path() dbus.ObjectPath

Path return Attention1 object path

func (*Attention1) SetProperty 

func (a *Attention1) SetProperty(name string, value interface{}) error

SetProperty set a property

func (*Attention1) SetTimer 

func (a *Attention1) SetTimer(element_index uint8, time uint16) error

SetTimer The element_index parameter is the element's index within the 

node where the health server model is hosted.
The time parameter indicates how many seconds the attention
state shall be on.
PossibleErrors:
	org.bluez.mesh.Error.NotSupported

func (*Attention1) SetWatchPropertiesChannel 

func (a *Attention1) SetWatchPropertiesChannel(c chan *dbus.Signal)

SetWatchPropertiesChannel set the dbus channel to receive properties interface

func (*Attention1) ToProps 

func (a *Attention1) ToProps() bluez.Properties

ToProps return the properties interface

func (*Attention1) UnwatchProperties 

func (a *Attention1) UnwatchProperties(ch chan *bluez.PropertyChanged) error

func (*Attention1) WatchProperties 

func (a *Attention1) WatchProperties() (chan *bluez.PropertyChanged, error)

WatchProperties updates on property changes

type Attention1Properties 

type Attention1Properties struct {
	// contains filtered or unexported fields
}

Attention1Properties contains the exposed properties of an interface

func (*Attention1Properties) FromDBusMap 

func (a *Attention1Properties) FromDBusMap(props map[string]dbus.Variant) (*Attention1Properties, error)

FromDBusMap convert a map to an Attention1Properties

func (*Attention1Properties) FromMap 

func (a *Attention1Properties) FromMap(props map[string]interface{}) (*Attention1Properties, error)

FromMap convert a map to an Attention1Properties

func (*Attention1Properties) Lock 

func (p *Attention1Properties) Lock()

Lock access to properties

func (*Attention1Properties) ToMap 

func (a *Attention1Properties) ToMap() (map[string]interface{}, error)

ToMap convert a Attention1Properties to map

func (*Attention1Properties) Unlock 

func (p *Attention1Properties) Unlock()

Unlock access to properties

type ConfigurationItem 

type ConfigurationItem struct {
	Index  byte
	Models []Model
}

ConfigurationItem array{byte, array{(uint16, dict)}}

type Element1 

type Element1 struct {
	Properties *Element1Properties
	// contains filtered or unexported fields
}

Element1 Mesh Element Hierarchy

func NewElement1 

func NewElement1(servicePath string, objectPath dbus.ObjectPath) (*Element1, error)

NewElement1 create a new instance of Element1

Args: - servicePath: unique name - objectPath: <app_defined_element_path>

func (*Element1) Client 

func (a *Element1) Client() *bluez.Client

Client return Element1 dbus client

func (*Element1) Close 

func (a *Element1) Close()

Close the connection

func (*Element1) DevKeyMessageReceived 

func (a *Element1) DevKeyMessageReceived(source uint16, remote bool, net_index uint16, data []byte) error

DevKeyMessageReceived This method is called by meshd daemon when a message arrives 

addressed to the application, which was sent with the remote
node's device key.
The source parameter is unicast address of the remote
node-element that sent the message.
The remote parameter if true indicates that the device key
used to decrypt the message was from the sender. False
indicates that the local nodes device key was used, and the
message has permissions to modify local states.
The net_index parameter indicates what subnet the message was
received on, and if a response is required, the same subnet
must be used to send the response.
The data parameter is the incoming message.

func (*Element1) GetLocation 

func (a *Element1) GetLocation() (uint16, error)

GetLocation get Location value

func (*Element1) GetModels 

func (a *Element1) GetModels() ([]ConfigurationItem, error)

GetModels get Models value

func (*Element1) GetObjectManagerSignal 

func (a *Element1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)

GetObjectManagerSignal return a channel for receiving updates from the ObjectManager

func (*Element1) GetProperties 

func (a *Element1) GetProperties() (*Element1Properties, error)

GetProperties load all available properties

func (*Element1) GetPropertiesSignal 

func (a *Element1) GetPropertiesSignal() (chan *dbus.Signal, error)

GetPropertiesSignal return a channel for receiving udpdates on property changes

func (*Element1) GetProperty 

func (a *Element1) GetProperty(name string) (dbus.Variant, error)

GetProperty get a property

func (*Element1) GetPublish 

func (a *Element1) GetPublish() (bool, error)

GetPublish get Publish value

func (*Element1) GetSubscribe 

func (a *Element1) GetSubscribe() (bool, error)

GetSubscribe get Subscribe value

func (*Element1) GetVendorModels 

func (a *Element1) GetVendorModels() ([]VendorOptionsItem, error)

GetVendorModels get VendorModels value

func (*Element1) GetWatchPropertiesChannel 

func (a *Element1) GetWatchPropertiesChannel() chan *dbus.Signal

GetWatchPropertiesChannel return the dbus channel to receive properties interface

func (*Element1) Interface 

func (a *Element1) Interface() string

Interface return Element1 interface

func (*Element1) MessageReceived 

func (a *Element1) MessageReceived(source uint16, key_index uint16, destination dbus.Variant, data []byte) error

MessageReceived This method is called by bluetooth-meshd daemon when a message 

arrives addressed to the application.
The source parameter is unicast address of the remote
node-element that sent the message.
The key_index parameter indicates which application key has been
used to decode the incoming message. The same key_index should
be used by the application when sending a response to this
message (in case a response is expected).
The destination parameter contains the destination address of
received message. Underlying variant types are:
uint16
	Destination is an unicast address, or a well known
	group address
array{byte}
	Destination is a virtual address label
The data parameter is the incoming message.

func (*Element1) Path 

func (a *Element1) Path() dbus.ObjectPath

Path return Element1 object path

func (*Element1) SetProperty 

func (a *Element1) SetProperty(name string, value interface{}) error

SetProperty set a property

func (*Element1) SetPublish 

func (a *Element1) SetPublish(v bool) error

SetPublish set Publish value

func (*Element1) SetSubscribe 

func (a *Element1) SetSubscribe(v bool) error

SetSubscribe set Subscribe value

func (*Element1) SetWatchPropertiesChannel 

func (a *Element1) SetWatchPropertiesChannel(c chan *dbus.Signal)

SetWatchPropertiesChannel set the dbus channel to receive properties interface

func (*Element1) ToProps 

func (a *Element1) ToProps() bluez.Properties

ToProps return the properties interface

func (*Element1) UnwatchProperties 

func (a *Element1) UnwatchProperties(ch chan *bluez.PropertyChanged) error

func (*Element1) UpdateModelConfiguration 

func (a *Element1) UpdateModelConfiguration(model_id uint16, config map[string]interface{}) error

UpdateModelConfiguration This method is called by bluetooth-meshd daemon when a model's 

configuration is updated.
The model_id parameter contains BT SIG Model Identifier or, if
Vendor key is present in config dictionary, a 16-bit
vendor-assigned Model Identifier.
The config parameter is a dictionary with the following keys
defined:
array{uint16} Bindings
	Indices of application keys bound to the model
uint32 PublicationPeriod
	Model publication period in milliseconds
uint16 Vendor
	A 16-bit Bluetooth-assigned Company Identifier of the
	vendor as defined by Bluetooth SIG
array{variant} Subscriptions
	Addresses the model is subscribed to.
	Each address is provided either as uint16 for group
	addresses, or as array{byte} for virtual labels.

func (*Element1) WatchProperties 

func (a *Element1) WatchProperties() (chan *bluez.PropertyChanged, error)

WatchProperties updates on property changes

type Element1Properties 

type Element1Properties struct {

	/*
		Location Location descriptor as defined in the GATT Bluetooth Namespace
			Descriptors section of the Bluetooth SIG Assigned Numbers
	*/
	Location uint16

	/*
		Models An array of SIG Models:

				id - SIG Model Identifier

				options - a dictionary that may contain additional model
				info. The following keys are defined:
	*/
	Models []ConfigurationItem

	/*
		Publish supports publication mechanism
	*/
	Publish bool

	/*
		Subscribe supports subscription mechanism

			The array may be empty.
	*/
	Subscribe bool

	/*
		VendorModels An array of Vendor Models:

				vendor - a 16-bit Bluetooth-assigned Company ID as
				defined by Bluetooth SIG.

				id - a 16-bit vendor-assigned Model Identifier

				options - a dictionary that may contain additional model
				info. The following keys are defined:
	*/
	VendorModels []VendorOptionsItem
	// contains filtered or unexported fields
}

Element1Properties contains the exposed properties of an interface

func (*Element1Properties) FromDBusMap 

func (a *Element1Properties) FromDBusMap(props map[string]dbus.Variant) (*Element1Properties, error)

FromDBusMap convert a map to an Element1Properties

func (*Element1Properties) FromMap 

func (a *Element1Properties) FromMap(props map[string]interface{}) (*Element1Properties, error)

FromMap convert a map to an Element1Properties

func (*Element1Properties) Lock 

func (p *Element1Properties) Lock()

Lock access to properties

func (*Element1Properties) ToMap 

func (a *Element1Properties) ToMap() (map[string]interface{}, error)

ToMap convert a Element1Properties to map

func (*Element1Properties) Unlock 

func (p *Element1Properties) Unlock()

Unlock access to properties

type Management1 

type Management1 struct {
	Properties *Management1Properties
	// contains filtered or unexported fields
}

Management1 Mesh Provisioning Hierarchy

func NewManagement1 

func NewManagement1(objectPath dbus.ObjectPath) (*Management1, error)

func (*Management1) AddNode 

func (a *Management1) AddNode(uuid []byte, options map[string]interface{}) error

AddNode This method is used by the application that supports 

org.bluez.mesh.Provisioner1 interface to add the
unprovisioned device specified by uuid, to the Network.
The uuid parameter is a 16-byte array that contains Device UUID
of the unprovisioned device to be added to the network.
The options parameter is a dictionary that may contain
additional configuration info (currently an empty placeholder
for forward compatibility).
PossibleErrors:
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.NotAuthorized

func (*Management1) Client 

func (a *Management1) Client() *bluez.Client

Client return Management1 dbus client

func (*Management1) Close 

func (a *Management1) Close()

Close the connection

func (*Management1) CreateAppKey 

func (a *Management1) CreateAppKey(net_index uint16, app_index uint16) error

CreateAppKey This method is used by the application to generate and add a new 

application key.
The net_index parameter is a 12-bit value (0x000-0xFFF)
specifying which net key to bind the application key to.
The app_index parameter is a 12-bit value (0x000-0xFFF)
specifying which app key to add.
This call affects the local bluetooth-meshd key database only.
PossibleErrors:
	org.bluez.mesh.Error.Failed
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.AlreadyExists
	org.bluez.mesh.Error.DoesNotExist

func (*Management1) CreateSubnet 

func (a *Management1) CreateSubnet(net_index uint16) error

CreateSubnet This method is used by the application to generate and add a new 

network subnet key.
The net_index parameter is a 12-bit value (0x001-0xFFF)
specifying which net key to add.
This call affects the local bluetooth-meshd key database only.
PossibleErrors:
	org.bluez.mesh.Error.Failed
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.AlreadyExists

func (*Management1) DeleteAppKey 

func (a *Management1) DeleteAppKey(app_index uint16) error

DeleteAppKey This method is used by the application to delete an application 

key.
The app_index parameter is a 12-bit value (0x000-0xFFF)
specifying which app key to delete.
This call affects the local bluetooth-meshd key database only.
PossibleErrors:
	org.bluez.mesh.Error.InvalidArguments

func (*Management1) DeleteRemoteNode 

func (a *Management1) DeleteRemoteNode(primary uint16, count uint8) error

DeleteRemoteNode This method is used by the application to delete a remote node 

from the local device key database.
The primary parameter specifies the unicast address of the
the node being deleted.
The count parameter specifies the number of elements that were
assigned to the remote node.
This call affects the local bluetooth-meshd key database only.
It is an error to call this with address range overlapping
with local element addresses.
PossibleErrors:
	org.bluez.mesh.Error.InvalidArguments

func (*Management1) DeleteSubnet 

func (a *Management1) DeleteSubnet(net_index uint16) error

DeleteSubnet This method is used by the application that to delete a subnet. 

The net_index parameter is a 12-bit value (0x001-0xFFF)
specifying which net key to delete. The primary net key (0x000)
may not be deleted.
This call affects the local bluetooth-meshd key database only.
PossibleErrors:
	org.bluez.mesh.Error.InvalidArguments

func (*Management1) ExportKeys 

func (a *Management1) ExportKeys() (map[string]interface{}, error)

ExportKeys

func (*Management1) GetObjectManagerSignal 

func (a *Management1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)

GetObjectManagerSignal return a channel for receiving updates from the ObjectManager

func (*Management1) GetProperties 

func (a *Management1) GetProperties() (*Management1Properties, error)

GetProperties load all available properties

func (*Management1) GetPropertiesSignal 

func (a *Management1) GetPropertiesSignal() (chan *dbus.Signal, error)

GetPropertiesSignal return a channel for receiving udpdates on property changes

func (*Management1) GetProperty 

func (a *Management1) GetProperty(name string) (dbus.Variant, error)

GetProperty get a property

func (*Management1) GetWatchPropertiesChannel 

func (a *Management1) GetWatchPropertiesChannel() chan *dbus.Signal

GetWatchPropertiesChannel return the dbus channel to receive properties interface

func (*Management1) ImportAppKey 

func (a *Management1) ImportAppKey(net_index uint16, app_index uint16, app_key []byte) error

ImportAppKey This method is used by the application to add an application 

key, that was originally generated by a remote Config Client.
The net_index parameter is a 12-bit value (0x000-0xFFF)
specifying which net key to bind the application key to.
The app_index parameter is a 12-bit value (0x000-0xFFF)
specifying which app key to import.
The app_key parameter is the 16-byte value of the key being
imported.
This call affects the local bluetooth-meshd key database only.
PossibleErrors:
	org.bluez.mesh.Error.Failed
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.AlreadyExists
	org.bluez.mesh.Error.DoesNotExist

func (*Management1) ImportRemoteNode 

func (a *Management1) ImportRemoteNode(primary uint16, count uint8, device_key []byte) error

ImportRemoteNode This method is used by the application to import a remote node 

that has been provisioned by an external process.
The primary parameter specifies the unicast address of the
the node being imported.
The count parameter specifies the number of elements that are
assigned to this remote node.
The device_key parameter is the access layer key that will be
will used to decrypt privledged messages from this remote node.
This call affects the local bluetooth-meshd key database only.
It is an error to call this with address range overlapping
with local element addresses.
PossibleErrors:
	org.bluez.mesh.Error.Failed
	org.bluez.mesh.Error.InvalidArguments

func (*Management1) ImportSubnet 

func (a *Management1) ImportSubnet(net_index uint16, net_key []byte) error

ImportSubnet This method is used by the application to add a network subnet 

key, that was originally generated by a remote Config Client.
The net_index parameter is a 12-bit value (0x000-0xFFF)
specifying which net key to add.
The net_key parameter is the 16-byte value of the net key being
imported.
This call affects the local bluetooth-meshd key database only.
PossibleErrors:
	org.bluez.mesh.Error.Failed
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.AlreadyExists

func (*Management1) Interface 

func (a *Management1) Interface() string

Interface return Management1 interface

func (*Management1) Path 

func (a *Management1) Path() dbus.ObjectPath

Path return Management1 object path

func (*Management1) SetKeyPhase 

func (a *Management1) SetKeyPhase(net_index uint16, phase uint8) error

SetKeyPhase This method is used to set the flooding key update phase of the 

given subnet. When finalizing the procedure, it is important
to CompleteAppKeyUpdate() on all app keys that have been
updated during the procedure prior to setting phase 3.
The net_index parameter is a 12-bit value (0x000-0xFFF)
specifying which subnet phase to set.
The phase parameter is used to cycle the local key database
through the phases as defined by the Mesh Profile Specification.
Allowed values:
	0 - Cancel Key Refresh (May only be called from Phase 1,
		and should never be called once the new key has
		started propagating)
	1 - Invalid Argument (see NetKeyUpdate method)
	2 - Go to Phase 2 (May only be called from Phase 1)
	3 - Complete Key Refresh procedure (May only be called
		from Phase 2)
This call affects the local bluetooth-meshd key database only.
It is the responsibility of the application to maintain the key
refresh phases per the Mesh Profile Specification.
PossibleErrors:
	org.bluez.mesh.Error.Failed
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.DoesNotExist

func (*Management1) SetProperty 

func (a *Management1) SetProperty(name string, value interface{}) error

SetProperty set a property

func (*Management1) SetWatchPropertiesChannel 

func (a *Management1) SetWatchPropertiesChannel(c chan *dbus.Signal)

SetWatchPropertiesChannel set the dbus channel to receive properties interface

func (*Management1) ToProps 

func (a *Management1) ToProps() bluez.Properties

ToProps return the properties interface

func (*Management1) UnprovisionedScan 

func (a *Management1) UnprovisionedScan(options map[string]interface{}) error

UnprovisionedScan This method is used by the application that supports 

org.bluez.mesh.Provisioner1 interface to start listening
(scanning) for unprovisioned devices in the area.
The options parameter is a dictionary with the following keys
defined:
uint16 Seconds
	Specifies number of seconds for scanning to be active.
	If set to 0 or if this key is not present, then the
	scanning will continue until UnprovisionedScanCancel()
	or AddNode() methods are called.
Each time a unique unprovisioned beacon is heard, the
ScanResult() method on the app will be called with the result.
PossibleErrors:
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.NotAuthorized
	org.bluez.mesh.Error.Busy

func (*Management1) UnprovisionedScanCancel 

func (a *Management1) UnprovisionedScanCancel() error

UnprovisionedScanCancel

func (*Management1) UnwatchProperties 

func (a *Management1) UnwatchProperties(ch chan *bluez.PropertyChanged) error

func (*Management1) UpdateAppKey 

func (a *Management1) UpdateAppKey(app_index uint16) error

UpdateAppKey This method is used by the application to generate a new 

application key.
The app_index parameter is a 12-bit value (0x000-0xFFF)
specifying which app key to update. Note that the subnet that
the key is bound to must exist and be in Phase 1.
This call affects the local bluetooth-meshd key database only.
PossibleErrors:
	org.bluez.mesh.Error.Failed
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.DoesNotExist
	org.bluez.mesh.Error.InProgress

func (*Management1) UpdateSubnet 

func (a *Management1) UpdateSubnet(net_index uint16) error

UpdateSubnet This method is used by the application to generate a new network 

subnet key, and set it's key refresh state to Phase 1.
The net_index parameter is a 12-bit value (0x000-0xFFF)
specifying which net key to update. Note that the subnet must
exist prior to updating.
This call affects the local bluetooth-meshd key database only.
PossibleErrors:
	org.bluez.mesh.Error.Failed
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.DoesNotExist
	org.bluez.mesh.Error.Busy

func (*Management1) WatchProperties 

func (a *Management1) WatchProperties() (chan *bluez.PropertyChanged, error)

WatchProperties updates on property changes

type Management1Properties 

type Management1Properties struct {
	// contains filtered or unexported fields
}

Management1Properties contains the exposed properties of an interface

func (*Management1Properties) FromDBusMap 

func (a *Management1Properties) FromDBusMap(props map[string]dbus.Variant) (*Management1Properties, error)

FromDBusMap convert a map to an Management1Properties

func (*Management1Properties) FromMap 

func (a *Management1Properties) FromMap(props map[string]interface{}) (*Management1Properties, error)

FromMap convert a map to an Management1Properties

func (*Management1Properties) Lock 

func (p *Management1Properties) Lock()

Lock access to properties

func (*Management1Properties) ToMap 

func (a *Management1Properties) ToMap() (map[string]interface{}, error)

ToMap convert a Management1Properties to map

func (*Management1Properties) Unlock 

func (p *Management1Properties) Unlock()

Unlock access to properties

type Model 

type Model struct {
	Identifier uint16
	Config     ModelConfig
}

Model

type ModelConfig 

type ModelConfig struct {
	Bindings          []uint16
	PublicationPeriod uint32
	Vendor            uint16
	Subscriptions     []dbus.Variant
}

ModelConfig

type Network1 

type Network1 struct {
	Properties *Network1Properties
	// contains filtered or unexported fields
}

Network1 Mesh Network Hierarchy

func NewNetwork1 

func NewNetwork1() (*Network1, error)

func (*Network1) Attach 

func (a *Network1) Attach(app_root dbus.ObjectPath, token uint64) (dbus.ObjectPath, []ConfigurationItem, error)

Attach This is the first method that an application must call to get 

access to mesh node functionalities.
The app_root parameter is a D-Bus object root path of
the application that implements org.bluez.mesh.Application1
interface. The application represents a node where child mesh
elements have their own objects that implement
org.bluez.mesh.Element1 interface. The standard
DBus.ObjectManager interface must be available on the
app_root path.
The token parameter is a 64-bit number that has been assigned to
the application when it first got provisioned/joined mesh
network, i.e. upon receiving JoinComplete() method. The daemon
uses the token to verify whether the application is authorized
to assume the mesh node identity.
In case of success, the method call returns mesh node object
(see Mesh Node Hierarchy section) and current configuration
settings. The return value of configuration parameter is an
array, where each entry is a structure that contains element
configuration. The element configuration structure is organized
as follows:
byte
	Element index, identifies the element to which this
	configuration entry pertains.
array{struct}
	Models array where each entry is a structure with the
	following members:
	uint16
		Either a SIG Model Identifier or, if Vendor key
		is present in model configuration dictionary, a
		16-bit vendor-assigned Model Identifier
	dict
		A dictionary that contains model configuration
		with the following keys defined:
		array{uint16} Bindings
			Indices of application keys bound to the
			model
		uint32 PublicationPeriod
			Model publication period in milliseconds
		uint16 Vendor
			A 16-bit Company ID as defined by the
			Bluetooth SIG
		array{variant} Subscriptions
			Addresses the model is subscribed to.
			Each address is provided either as
			uint16 for group addresses, or
			as array{byte} for virtual labels.
PossibleErrors:
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.NotFound,
	org.bluez.mesh.Error.AlreadyExists,
	org.bluez.mesh.Error.Busy,
	org.bluez.mesh.Error.Failed

func (*Network1) Cancel 

func (a *Network1) Cancel() error

Cancel

func (*Network1) Client 

func (a *Network1) Client() *bluez.Client

Client return Network1 dbus client

func (*Network1) Close 

func (a *Network1) Close()

Close the connection

func (*Network1) CreateNetwork 

func (a *Network1) CreateNetwork(app_root dbus.ObjectPath, uuid []byte) error

CreateNetwork This is the first method that an application calls to become 

a Provisioner node, and a Configuration Client on a newly
created Mesh Network.
The app_root parameter is a D-Bus object root path of the
application that implements org.bluez.mesh.Application1
interface, and a org.bluez.mesh.Provisioner1 interface. The
application represents a node where child mesh elements have
their own objects that implement org.bluez.mesh.Element1
interface. The application hierarchy also contains a provision
agent object that implements org.bluez.mesh.ProvisionAgent1
interface. The standard DBus.ObjectManager interface must be
available on the app_root path.
The uuid parameter is a 16-byte array that contains Device UUID.
This UUID must be unique (at least from the daemon perspective),
therefore attempting to call this function using already
registered UUID results in an error. The composition of the UUID
octets must be in compliance with RFC 4122.
The other information the bluetooth-meshd daemon will preserve
about the initial node, is to give it the initial primary
unicast address (0x0001), and create and assign a net_key as the
primary network net_index (0x000).
Upon successful processing of Create() method, the daemon
will call JoinComplete method on object implementing
org.bluez.mesh.Application1.
PossibleErrors:
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.AlreadyExists,

func (*Network1) GetObjectManagerSignal 

func (a *Network1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)

GetObjectManagerSignal return a channel for receiving updates from the ObjectManager

func (*Network1) GetProperties 

func (a *Network1) GetProperties() (*Network1Properties, error)

GetProperties load all available properties

func (*Network1) GetPropertiesSignal 

func (a *Network1) GetPropertiesSignal() (chan *dbus.Signal, error)

GetPropertiesSignal return a channel for receiving udpdates on property changes

func (*Network1) GetProperty 

func (a *Network1) GetProperty(name string) (dbus.Variant, error)

GetProperty get a property

func (*Network1) GetWatchPropertiesChannel 

func (a *Network1) GetWatchPropertiesChannel() chan *dbus.Signal

GetWatchPropertiesChannel return the dbus channel to receive properties interface

func (*Network1) Import 

func (a *Network1) Import(app_root dbus.ObjectPath, uuid []byte, dev_key []byte, net_key []byte, net_index uint16, flags map[string]interface{}, iv_index uint32, unicast uint16) error

Import This method creates a local mesh node based on node 

configuration that has been generated outside bluetooth-meshd.
The app_root parameter is a D-Bus object root path of the
application that implements org.bluez.mesh.Application1
interface.
The uuid parameter is a 16-byte array that contains Device UUID.
This UUID must be unique (at least from the daemon perspective),
therefore attempting to call this function using already
registered UUID results in an error. The composition of the UUID
octets must be in compliance with RFC 4122.
The dev_key parameter is the 16-byte value of the dev key of
the imported mesh node.
Remaining parameters correspond to provisioning data:
The net_key and net_index parameters describe the network (or a
subnet, if net_index is not 0) the imported mesh node belongs
to.
The flags parameter is a dictionary containing provisioning
flags. Supported values are:
	boolean IvUpdate
		When true, indicates that the network is in the
		middle of IV Index Update procedure.
	boolean KeyRefresh
		When true, indicates that the specified net key
		is in the middle of a key refresh procedure.
The iv_index parameter is the current IV Index value used by
the network. This value is known by the provisioner.
The unicast parameter is the primary unicast address of the
imported node.
Upon successful processing of Import() method, the daemon will
call JoinComplete method on object implementing
org.bluez.mesh.Application1 interface.
PossibleErrors:
	org.bluez.mesh.Error.InvalidArguments,
	org.bluez.mesh.Error.AlreadyExists,
	org.bluez.mesh.Error.NotSupported,
	org.bluez.mesh.Error.Failed

func (*Network1) Interface 

func (a *Network1) Interface() string

Interface return Network1 interface

func (*Network1) Join 

func (a *Network1) Join(app_root dbus.ObjectPath, uuid []byte) error

Join This is the first method that an application has to call to 

become a provisioned node on a mesh network. The call will
initiate broadcasting of Unprovisioned Device Beacon.
The app_root parameter is a D-Bus object root path of
the application that implements org.bluez.mesh.Application1
interface. The application represents a node where child mesh
elements have their own objects that implement
org.bluez.mesh.Element1 interface. The application hierarchy
also contains a provision agent object that implements
org.bluez.mesh.ProvisionAgent1 interface. The standard
DBus.ObjectManager interface must be available on the
app_root path.
The uuid parameter is a 16-byte array that contains Device UUID.
This UUID must be unique (at least from the daemon perspective),
therefore attempting to call this function using already
registered UUID results in an error. The composition of the UUID
octets must be in compliance with RFC 4122.
When provisioning finishes, the daemon will call either
JoinComplete or JoinFailed method on object implementing
org.bluez.mesh.Application1 interface.
PossibleErrors:
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.AlreadyExists,

func (*Network1) Leave 

func (a *Network1) Leave(token uint64) error

Leave This removes the configuration information about the mesh node 

identified by the 64-bit token parameter. The token parameter
has been obtained as a result of successful Join() method call.
PossibleErrors:
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.NotFound
	org.bluez.mesh.Error.Busy

func (*Network1) Path 

func (a *Network1) Path() dbus.ObjectPath

Path return Network1 object path

func (*Network1) SetProperty 

func (a *Network1) SetProperty(name string, value interface{}) error

SetProperty set a property

func (*Network1) SetWatchPropertiesChannel 

func (a *Network1) SetWatchPropertiesChannel(c chan *dbus.Signal)

SetWatchPropertiesChannel set the dbus channel to receive properties interface

func (*Network1) ToProps 

func (a *Network1) ToProps() bluez.Properties

ToProps return the properties interface

func (*Network1) UnwatchProperties 

func (a *Network1) UnwatchProperties(ch chan *bluez.PropertyChanged) error

func (*Network1) WatchProperties 

func (a *Network1) WatchProperties() (chan *bluez.PropertyChanged, error)

WatchProperties updates on property changes

type Network1Properties 

type Network1Properties struct {
	// contains filtered or unexported fields
}

Network1Properties contains the exposed properties of an interface

func (*Network1Properties) FromDBusMap 

func (a *Network1Properties) FromDBusMap(props map[string]dbus.Variant) (*Network1Properties, error)

FromDBusMap convert a map to an Network1Properties

func (*Network1Properties) FromMap 

func (a *Network1Properties) FromMap(props map[string]interface{}) (*Network1Properties, error)

FromMap convert a map to an Network1Properties

func (*Network1Properties) Lock 

func (p *Network1Properties) Lock()

Lock access to properties

func (*Network1Properties) ToMap 

func (a *Network1Properties) ToMap() (map[string]interface{}, error)

ToMap convert a Network1Properties to map

func (*Network1Properties) Unlock 

func (p *Network1Properties) Unlock()

Unlock access to properties

type Node1 

type Node1 struct {
	Properties *Node1Properties
	// contains filtered or unexported fields
}

Node1 Mesh Node Hierarchy

func NewNode1 

func NewNode1(objectPath dbus.ObjectPath) (*Node1, error)

func (*Node1) AddAppKey 

func (a *Node1) AddAppKey(element_path dbus.ObjectPath, destination uint16, app_index uint16, net_index uint16, update bool) error

AddAppKey This method is used to send add or update network key originated 

by the local configuration client to a remote configuration
server.
The element_path parameter is the object path of an element from
a collection of the application elements (see Mesh Application
Hierarchy section).
The destination parameter contains the destination address. This
destination must be a uint16 to a nodes primary unicast address.
The app_index parameter refers to the application key which is
being added or updated. This key must exist in the local key
database.
The net_index parameter is the subnet index of the network on
which the message is to be sent.
The update parameter indicates if this is an addition or an
update. If true, the subnet key must be in the phase 1 state of
the key update procedure.
Possible errors:
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.NotFound

func (*Node1) AddNetKey 

func (a *Node1) AddNetKey(element_path dbus.ObjectPath, destination uint16, subnet_index uint16, net_index uint16, update bool) error

AddNetKey This method is used to send add or update network key originated 

by the local configuration client to a remote configuration
server.
The element_path parameter is the object path of an element from
a collection of the application elements (see Mesh Application
Hierarchy section).
The destination parameter contains the destination address. This
destination must be a uint16 to a nodes primary unicast address.
The subnet_index parameter refers to the subnet index of the
network that is being added or updated. This key must exist in
the local key database.
The net_index parameter is the subnet index of the network on
which the message is to be sent.
The update parameter indicates if this is an addition or an
update. If true, the subnet key must be in the phase 1 state of
the key update procedure.
Possible errors:
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.NotFound

func (*Node1) Client 

func (a *Node1) Client() *bluez.Client

Client return Node1 dbus client

func (*Node1) Close 

func (a *Node1) Close()

Close the connection

func (*Node1) DevKeySend 

func (a *Node1) DevKeySend(element_path dbus.ObjectPath, destination uint16, remote bool, net_index uint16, options map[string]interface{}, data []byte) error

DevKeySend This method is used to send a message originated by a local 

model encoded with the device key of the remote node.
The element_path parameter is the object path of an element from
a collection of the application elements (see Mesh Application
Hierarchy section).
The destination parameter contains the destination address. This
destination must be a uint16 to a unicast address, or a well
known group address.
The remote parameter, if true, looks up the device key by the
destination address in the key database to encrypt the message.
If remote is true, but requested key does not exist, a NotFound
error will be returned. If set to false, the local node's
device key is used.
The net_index parameter is the subnet index of the network on
which the message is to be sent.
The options parameter is a dictionary with the following keys
defined:
	bool ForceSegmented
		Specifies whether to force sending of a short
		message as one-segment payload. If not present,
		the default setting is "false".
The data parameter is an outgoing message to be encypted by the
meshd daemon and sent on.
Possible errors:
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.NotFound

func (*Node1) GetAddresses 

func (a *Node1) GetAddresses() ([]uint16, error)

GetAddresses get Addresses value

func (*Node1) GetBeacon 

func (a *Node1) GetBeacon() (bool, error)

GetBeacon get Beacon value

func (*Node1) GetFeatures 

func (a *Node1) GetFeatures() (map[string]interface{}, error)

GetFeatures get Features value

func (*Node1) GetFriend 

func (a *Node1) GetFriend() (bool, error)

GetFriend get Friend value

func (*Node1) GetIvIndex 

func (a *Node1) GetIvIndex() (uint32, error)

GetIvIndex get IvIndex value

func (*Node1) GetIvUpdate 

func (a *Node1) GetIvUpdate() (bool, error)

GetIvUpdate get IvUpdate value

func (*Node1) GetLowPower 

func (a *Node1) GetLowPower() (bool, error)

GetLowPower get LowPower value

func (*Node1) GetObjectManagerSignal 

func (a *Node1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)

GetObjectManagerSignal return a channel for receiving updates from the ObjectManager

func (*Node1) GetProperties 

func (a *Node1) GetProperties() (*Node1Properties, error)

GetProperties load all available properties

func (*Node1) GetPropertiesSignal 

func (a *Node1) GetPropertiesSignal() (chan *dbus.Signal, error)

GetPropertiesSignal return a channel for receiving udpdates on property changes

func (*Node1) GetProperty 

func (a *Node1) GetProperty(name string) (dbus.Variant, error)

GetProperty get a property

func (*Node1) GetProxy 

func (a *Node1) GetProxy() (bool, error)

GetProxy get Proxy value

func (*Node1) GetRelay 

func (a *Node1) GetRelay() (bool, error)

GetRelay get Relay value

func (*Node1) GetSecondsSinceLastHeard 

func (a *Node1) GetSecondsSinceLastHeard() (uint32, error)

GetSecondsSinceLastHeard get SecondsSinceLastHeard value

func (*Node1) GetSequenceNumber 

func (a *Node1) GetSequenceNumber() (uint32, error)

GetSequenceNumber get SequenceNumber value

func (*Node1) GetWatchPropertiesChannel 

func (a *Node1) GetWatchPropertiesChannel() chan *dbus.Signal

GetWatchPropertiesChannel return the dbus channel to receive properties interface

func (*Node1) Interface 

func (a *Node1) Interface() string

Interface return Node1 interface

func (*Node1) Path 

func (a *Node1) Path() dbus.ObjectPath

Path return Node1 object path

func (*Node1) Publish 

func (a *Node1) Publish(element_path dbus.ObjectPath, model uint16, options map[string]interface{}, data []byte) error

Publish This method is used to send a publication originated by a local 

model. If the model does not exist, or it has no publication
record, the method returns org.bluez.mesh.Error.DoesNotExist
error.
The element_path parameter is the object path of an element from
a collection of the application elements (see Mesh Application
Hierarchy section).
The model parameter contains a model ID, as defined by the
Bluetooth SIG. If the options dictionary contains a "Vendor"
key, then this ID is defined by the specified vendor.
The options parameter is a dictionary with the following keys
defined:
	bool ForceSegmented
		Specifies whether to force sending of a short
		message as one-segment payload. If not present,
		the default setting is "false".
	uint16 Vendor
		A 16-bit Company ID as defined by the
		Bluetooth SIG. This key should only exist when
		publishing on a Vendor defined model.
The data parameter is an outgoing message to be encypted by the
meshd daemon and sent on.
Since only one Publish record may exist per element-model, the
destination and key_index are obtained from the Publication
record cached by the daemon.
Possible errors:
	org.bluez.mesh.Error.DoesNotExist
	org.bluez.mesh.Error.InvalidArguments

func (*Node1) Send 

func (a *Node1) Send(element_path dbus.ObjectPath, destination uint16, key_index uint16, options map[string]interface{}, data []byte) error

Send This method is used to send a message originated by a local 

model.
The element_path parameter is the object path of an element from
a collection of the application elements (see Mesh Application
Hierarchy section).
The destination parameter contains the destination address. This
destination must be a uint16 to a unicast address, or a well
known group address.
The key_index parameter determines which application key to use
for encrypting the message. The key_index must be valid for that
element, i.e., the application key must be bound to a model on
this element. Otherwise, org.bluez.mesh.Error.NotAuthorized will
be returned.
The options parameter is a dictionary with the following keys
defined:
	bool ForceSegmented
		Specifies whether to force sending of a short
		message as one-segment payload. If not present,
		the default setting is "false".
The data parameter is an outgoing message to be encypted by the
bluetooth-meshd daemon and sent on.
Possible errors:
	org.bluez.mesh.Error.NotAuthorized
	org.bluez.mesh.Error.InvalidArguments
	org.bluez.mesh.Error.NotFound

func (*Node1) SetFriend 

func (a *Node1) SetFriend(v bool) error

SetFriend set Friend value

func (*Node1) SetLowPower 

func (a *Node1) SetLowPower(v bool) error

SetLowPower set LowPower value

func (*Node1) SetProperty 

func (a *Node1) SetProperty(name string, value interface{}) error

SetProperty set a property

func (*Node1) SetProxy 

func (a *Node1) SetProxy(v bool) error

SetProxy set Proxy value

func (*Node1) SetRelay 

func (a *Node1) SetRelay(v bool) error

SetRelay set Relay value

func (*Node1) SetWatchPropertiesChannel 

func (a *Node1) SetWatchPropertiesChannel(c chan *dbus.Signal)

SetWatchPropertiesChannel set the dbus channel to receive properties interface

func (*Node1) ToProps 

func (a *Node1) ToProps() bluez.Properties

ToProps return the properties interface

func (*Node1) UnwatchProperties 

func (a *Node1) UnwatchProperties(ch chan *bluez.PropertyChanged) error

func (*Node1) WatchProperties 

func (a *Node1) WatchProperties() (chan *bluez.PropertyChanged, error)

WatchProperties updates on property changes

type Node1Properties 

type Node1Properties struct {

	/*
		Addresses This property contains unicast addresses of node's elements.
	*/
	Addresses []uint16

	/*
		Beacon This property indicates whether the periodic beaconing is
			enabled (true) or disabled (false).
	*/
	Beacon bool

	/*
		Features The dictionary that contains information about feature support.
			The following keys are defined:
	*/
	Features map[string]interface{}

	/*
		Friend Indicates the ability to establish a friendship with a
				Low Power node
	*/
	Friend bool

	/*
		IvIndex This property may be read at any time to determine the IV_Index
			that the current network is on. This information is only useful
			for provisioning.
	*/
	IvIndex uint32

	/*
		IvUpdate When true, indicates that the network is in the middle of IV
			Index Update procedure. This information is only useful for
			provisioning.
	*/
	IvUpdate bool

	/*
		LowPower Indicates support for operating in Low Power node mode
	*/
	LowPower bool

	/*
		Proxy Indicates support for GATT proxy
	*/
	Proxy bool

	/*
		Relay Indicates support for relaying messages

		If a key is absent from the dictionary, the feature is not supported.
		Otherwise, true means that the feature is enabled and false means that
		the feature is disabled.
	*/
	Relay bool

	/*
		SecondsSinceLastHeard This property may be read at any time to determine the number of
			seconds since mesh network layer traffic was last detected on
			this node's network.
	*/
	SecondsSinceLastHeard uint32

	/*
		SequenceNumber This property may be read at any time to determine the
			sequence number.
	*/
	SequenceNumber uint32
	// contains filtered or unexported fields
}

Node1Properties contains the exposed properties of an interface

func (*Node1Properties) FromDBusMap 

func (a *Node1Properties) FromDBusMap(props map[string]dbus.Variant) (*Node1Properties, error)

FromDBusMap convert a map to an Node1Properties

func (*Node1Properties) FromMap 

func (a *Node1Properties) FromMap(props map[string]interface{}) (*Node1Properties, error)

FromMap convert a map to an Node1Properties

func (*Node1Properties) Lock 

func (p *Node1Properties) Lock()

Lock access to properties

func (*Node1Properties) ToMap 

func (a *Node1Properties) ToMap() (map[string]interface{}, error)

ToMap convert a Node1Properties to map

func (*Node1Properties) Unlock 

func (p *Node1Properties) Unlock()

Unlock access to properties

type ProvisionAgent1 

type ProvisionAgent1 struct {
	Properties *ProvisionAgent1Properties
	// contains filtered or unexported fields
}

ProvisionAgent1 Provisioning Agent Hierarchy

func NewProvisionAgent1 

func NewProvisionAgent1(servicePath string, objectPath dbus.ObjectPath) (*ProvisionAgent1, error)

NewProvisionAgent1 create a new instance of ProvisionAgent1

Args: - servicePath: unique name - objectPath: freely definable

func (*ProvisionAgent1) Cancel 

func (a *ProvisionAgent1) Cancel() error

Cancel This method gets called by the daemon to cancel any existing 

Agent Requests. When called, any pending user input should be
canceled, and any display requests removed.

func (*ProvisionAgent1) Client 

func (a *ProvisionAgent1) Client() *bluez.Client

Client return ProvisionAgent1 dbus client

func (*ProvisionAgent1) Close 

func (a *ProvisionAgent1) Close()

Close the connection

func (*ProvisionAgent1) DisplayNumeric 

func (a *ProvisionAgent1) DisplayNumeric(type1 string, number uint32) error

DisplayNumeric This method is called when the Daemon has something important 

for the Agent to Display, but does not require any additional
input locally. For instance: "Enter 14939264 on remote device".
The type parameter indicates the display method. Allowed values
are:
	"blink" - Locally blink LED
	"beep" - Locally make a noise
	"vibrate" - Locally vibrate
	"out-numeric" - Display value to enter remotely
	"push" - Request pushes on remote button
	"twist" - Request twists on remote knob
The number parameter is the specific value represented by the
Prompt.

func (*ProvisionAgent1) DisplayString 

func (a *ProvisionAgent1) DisplayString(value string) error

DisplayString This method is called when the Daemon has something important 

for the Agent to Display, but does not require any additional
input locally. For instance: "Enter "ABCDE" on remote device".

func (*ProvisionAgent1) GetCapabilities 

func (a *ProvisionAgent1) GetCapabilities() ([]string, error)

GetCapabilities get Capabilities value

func (*ProvisionAgent1) GetObjectManagerSignal 

func (a *ProvisionAgent1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)

GetObjectManagerSignal return a channel for receiving updates from the ObjectManager

func (*ProvisionAgent1) GetOutOfBandInfo 

func (a *ProvisionAgent1) GetOutOfBandInfo() ([]string, error)

GetOutOfBandInfo get OutOfBandInfo value

func (*ProvisionAgent1) GetProperties 

func (a *ProvisionAgent1) GetProperties() (*ProvisionAgent1Properties, error)

GetProperties load all available properties

func (*ProvisionAgent1) GetPropertiesSignal 

func (a *ProvisionAgent1) GetPropertiesSignal() (chan *dbus.Signal, error)

GetPropertiesSignal return a channel for receiving udpdates on property changes

func (*ProvisionAgent1) GetProperty 

func (a *ProvisionAgent1) GetProperty(name string) (dbus.Variant, error)

GetProperty get a property

func (*ProvisionAgent1) GetURI 

func (a *ProvisionAgent1) GetURI() (string, error)

GetURI get URI value

func (*ProvisionAgent1) GetWatchPropertiesChannel 

func (a *ProvisionAgent1) GetWatchPropertiesChannel() chan *dbus.Signal

GetWatchPropertiesChannel return the dbus channel to receive properties interface

func (*ProvisionAgent1) Interface 

func (a *ProvisionAgent1) Interface() string

Interface return ProvisionAgent1 interface

func (*ProvisionAgent1) Path 

func (a *ProvisionAgent1) Path() dbus.ObjectPath

Path return ProvisionAgent1 object path

func (*ProvisionAgent1) PrivateKey 

func (a *ProvisionAgent1) PrivateKey() ([]byte, error)

PrivateKey This method is called during provisioning if the Provisioner 

has requested Out-Of-Band ECC key exchange. The Private key is
returned to the Daemon, and the Public Key is delivered to the
remote Provisioner using a method that does not involve the
Bluetooth Mesh system. The Private Key returned must be 32
octets in size, or the Provisioning procedure will fail and be
canceled.
This function will only be called if the Provisioner has
requested pre-determined keys to be exchanged Out-of-Band, and
the local role is Unprovisioned device.

func (*ProvisionAgent1) PromptNumeric 

func (a *ProvisionAgent1) PromptNumeric(type1 string) (uint32, error)

PromptNumeric This method is called when the Daemon requests the user to 

enter a decimal value between 1-99999999.
The type parameter indicates the input method. Allowed values
are:
	"blink" - Enter times remote LED blinked
	"beep" - Enter times remote device beeped
	"vibrate" - Enter times remote device vibrated
	"in-numeric" - Enter remotely displayed value
	"push" - Push local button remotely requested times
	"twist" - Twist local knob remotely requested times
This agent should prompt the user for specific input. For
instance: "Enter value being displayed by remote device".

func (*ProvisionAgent1) PromptStatic 

func (a *ProvisionAgent1) PromptStatic(type1 string) ([]byte, error)

PromptStatic This method is called when the Daemon requires a 16 octet byte 

array, as an Out-of-Band authentication.
The type parameter indicates the input method. Allowed values
are:
	"static-oob" - return 16 octet array
	"in-alpha" - return 16 octet alpha array
The Static data returned must be 16 octets in size, or the
Provisioning procedure will fail and be canceled. If input type
is "in-alpha", the printable characters should be
left-justified, with trailing 0x00 octets filling the remaining
bytes.

func (*ProvisionAgent1) PublicKey 

func (a *ProvisionAgent1) PublicKey() ([]byte, error)

PublicKey This method is called during provisioning if the local device is 

the Provisioner, and is requestng Out-Of-Band ECC key exchange.
The Public key is returned to the Daemon that is the matched
pair of the Private key of the remote device. The Public Key
returned must be 64 octets in size, or the Provisioning
procedure will fail and be canceled.
This function will only be called if the Provisioner has
requested pre-determined keys to be exchanged Out-of-Band, and
the local role is Provisioner.

func (*ProvisionAgent1) SetProperty 

func (a *ProvisionAgent1) SetProperty(name string, value interface{}) error

SetProperty set a property

func (*ProvisionAgent1) SetWatchPropertiesChannel 

func (a *ProvisionAgent1) SetWatchPropertiesChannel(c chan *dbus.Signal)

SetWatchPropertiesChannel set the dbus channel to receive properties interface

func (*ProvisionAgent1) ToProps 

func (a *ProvisionAgent1) ToProps() bluez.Properties

ToProps return the properties interface

func (*ProvisionAgent1) UnwatchProperties 

func (a *ProvisionAgent1) UnwatchProperties(ch chan *bluez.PropertyChanged) error

func (*ProvisionAgent1) WatchProperties 

func (a *ProvisionAgent1) WatchProperties() (chan *bluez.PropertyChanged, error)

WatchProperties updates on property changes

type ProvisionAgent1Properties 

type ProvisionAgent1Properties struct {

	/*
		Capabilities An array of strings with the following allowed values:
				"blink"
				"beep"
				"vibrate"
				"out-numeric"
				"out-alpha"
				"push"
				"twist"
				"in-numeric"
				"in-alpha"
				"static-oob"
				"public-oob"
	*/
	Capabilities []string

	/*
		OutOfBandInfo Indicates availability of OOB data. An array of strings with the
			following allowed values:
				"other"
				"uri"
				"machine-code-2d"
				"bar-code"
				"nfc"
				"number"
				"string"
				"on-box"
				"in-box"
				"on-paper",
				"in-manual"
				"on-device"
	*/
	OutOfBandInfo []string

	/*
		URI Uniform Resource Identifier points to out-of-band (OOB)
			information (e.g., a public key)
	*/
	URI string
	// contains filtered or unexported fields
}

ProvisionAgent1Properties contains the exposed properties of an interface

func (*ProvisionAgent1Properties) FromDBusMap 

func (a *ProvisionAgent1Properties) FromDBusMap(props map[string]dbus.Variant) (*ProvisionAgent1Properties, error)

FromDBusMap convert a map to an ProvisionAgent1Properties

func (*ProvisionAgent1Properties) FromMap 

func (a *ProvisionAgent1Properties) FromMap(props map[string]interface{}) (*ProvisionAgent1Properties, error)

FromMap convert a map to an ProvisionAgent1Properties

func (*ProvisionAgent1Properties) Lock 

func (p *ProvisionAgent1Properties) Lock()

Lock access to properties

func (*ProvisionAgent1Properties) ToMap 

func (a *ProvisionAgent1Properties) ToMap() (map[string]interface{}, error)

ToMap convert a ProvisionAgent1Properties to map

func (*ProvisionAgent1Properties) Unlock 

func (p *ProvisionAgent1Properties) Unlock()

Unlock access to properties

type Provisioner1 

type Provisioner1 struct {
	Properties *Provisioner1Properties
	// contains filtered or unexported fields
}

Provisioner1 Mesh Provisioner Hierarchy

func NewProvisioner1 

func NewProvisioner1(servicePath string, objectPath dbus.ObjectPath) (*Provisioner1, error)

NewProvisioner1 create a new instance of Provisioner1

Args: - servicePath: unique name - objectPath: freely definable

func (*Provisioner1) AddNodeComplete 

func (a *Provisioner1) AddNodeComplete(uuid []byte, unicast uint16, count uint8) error

AddNodeComplete This method is called when the node provisioning initiated 

by an AddNode() method call successfully completed.
The unicast parameter is the primary address that has been
assigned to the new node, and the address of it's config server.
The count parameter is the number of unicast addresses assigned
to the new node.
The new node may now be sent messages using the credentials
supplied by the RequestProvData method.

func (*Provisioner1) AddNodeFailed 

func (a *Provisioner1) AddNodeFailed(uuid []byte, reason string) error

AddNodeFailed This method is called when the node provisioning initiated by 

AddNode() has failed. Depending on how far Provisioning
proceeded before failing, some cleanup of cached data may be
required.
The reason parameter identifies the reason for provisioning
failure. The defined values are: "aborted", "timeout",
"bad-pdu", "confirmation-failed", "out-of-resources",
"decryption-error", "unexpected-error",
"cannot-assign-addresses".

func (*Provisioner1) Client 

func (a *Provisioner1) Client() *bluez.Client

Client return Provisioner1 dbus client

func (*Provisioner1) Close 

func (a *Provisioner1) Close()

Close the connection

func (*Provisioner1) GetObjectManagerSignal 

func (a *Provisioner1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)

GetObjectManagerSignal return a channel for receiving updates from the ObjectManager

func (*Provisioner1) GetProperties 

func (a *Provisioner1) GetProperties() (*Provisioner1Properties, error)

GetProperties load all available properties

func (*Provisioner1) GetPropertiesSignal 

func (a *Provisioner1) GetPropertiesSignal() (chan *dbus.Signal, error)

GetPropertiesSignal return a channel for receiving udpdates on property changes

func (*Provisioner1) GetProperty 

func (a *Provisioner1) GetProperty(name string) (dbus.Variant, error)

GetProperty get a property

func (*Provisioner1) GetWatchPropertiesChannel 

func (a *Provisioner1) GetWatchPropertiesChannel() chan *dbus.Signal

GetWatchPropertiesChannel return the dbus channel to receive properties interface

func (*Provisioner1) Interface 

func (a *Provisioner1) Interface() string

Interface return Provisioner1 interface

func (*Provisioner1) Path 

func (a *Provisioner1) Path() dbus.ObjectPath

Path return Provisioner1 object path

func (*Provisioner1) RequestProvData 

func (a *Provisioner1) RequestProvData(count uint8) (uint16, error)

RequestProvData This method is implemented by a Provisioner capable application 

and is called when the remote device has been fully
authenticated and confirmed.
The count parameter is the number of consecutive unicast
addresses the remote device is requesting.
Return Parameters are from the Mesh Profile Spec:
net_index - Subnet index of the net_key
unicast - Primary Unicast address of the new node
PossibleErrors:
	org.bluez.mesh.Error.Abort

func (*Provisioner1) ScanResult 

func (a *Provisioner1) ScanResult(rssi int16, data []byte, options map[string]interface{}) error

ScanResult The method is called from the bluetooth-meshd daemon when a 

unique UUID has been seen during UnprovisionedScan() for
unprovsioned devices.
The rssi parameter is a signed, normalized measurement of the
signal strength of the recieved unprovisioned beacon.
The data parameter is a variable length byte array, that may
have 1, 2 or 3 distinct fields contained in it including the 16
byte remote device UUID (always), a 16 bit mask of OOB
authentication flags (optional), and a 32 bit URI hash (if URI
bit set in OOB mask). Whether these fields exist or not is a
decision of the remote device.
The options parameter is a dictionary that may contain
additional scan result info (currently an empty placeholder for
forward compatibility).
If a beacon with a UUID that has already been reported is
recieved by the daemon, it will be silently discarded unless it
was recieved at a higher rssi power level.

func (*Provisioner1) SetProperty 

func (a *Provisioner1) SetProperty(name string, value interface{}) error

SetProperty set a property

func (*Provisioner1) SetWatchPropertiesChannel 

func (a *Provisioner1) SetWatchPropertiesChannel(c chan *dbus.Signal)

SetWatchPropertiesChannel set the dbus channel to receive properties interface

func (*Provisioner1) ToProps 

func (a *Provisioner1) ToProps() bluez.Properties

ToProps return the properties interface

func (*Provisioner1) UnwatchProperties 

func (a *Provisioner1) UnwatchProperties(ch chan *bluez.PropertyChanged) error

func (*Provisioner1) WatchProperties 

func (a *Provisioner1) WatchProperties() (chan *bluez.PropertyChanged, error)

WatchProperties updates on property changes

type Provisioner1Properties 

type Provisioner1Properties struct {
	// contains filtered or unexported fields
}

Provisioner1Properties contains the exposed properties of an interface

func (*Provisioner1Properties) FromDBusMap 

func (a *Provisioner1Properties) FromDBusMap(props map[string]dbus.Variant) (*Provisioner1Properties, error)

FromDBusMap convert a map to an Provisioner1Properties

func (*Provisioner1Properties) FromMap 

func (a *Provisioner1Properties) FromMap(props map[string]interface{}) (*Provisioner1Properties, error)

FromMap convert a map to an Provisioner1Properties

func (*Provisioner1Properties) Lock 

func (p *Provisioner1Properties) Lock()

Lock access to properties

func (*Provisioner1Properties) ToMap 

func (a *Provisioner1Properties) ToMap() (map[string]interface{}, error)

ToMap convert a Provisioner1Properties to map

func (*Provisioner1Properties) Unlock 

func (p *Provisioner1Properties) Unlock()

Unlock access to properties

type VendorItem 

type VendorItem struct {
	Vendor  uint16
	ModelID uint16
}

VendorItem array{(uint16, uint16)}

type VendorOptionsItem 

type VendorOptionsItem struct {
	VendorItem
	Options map[string]interface{}
}

VendorItem array{(uint16, uint16, dict)}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.