diff options
| author | Brian Gix <brian.gix@intel.com> | 2019-07-11 15:59:44 -0700 |
|---|---|---|
| committer | Brian Gix <brian.gix@intel.com> | 2019-07-14 08:32:18 -0700 |
| commit | cfec54d37b626f65b56849d9ef2c2a5be637dde4 (patch) | |
| tree | 6a3a3ae1ae3fb915ee2ed7bbfee46e7075c0852f /doc/mesh-api.txt | |
| parent | 47a07dd39d4ee2d14cf2e6b9a5a7ee8c2525aa67 (diff) | |
| download | bluez-cfec54d37b626f65b56849d9ef2c2a5be637dde4.tar.gz | |
doc: Cleanup API Provisioner1 interface
Modified the RequestProvData In and Out param list to eliminate
parameters which can be provided by the Node which owns the
procedure, and clean-up the actual error list.
Diffstat (limited to 'doc/mesh-api.txt')
| -rw-r--r-- | doc/mesh-api.txt | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/mesh-api.txt b/doc/mesh-api.txt index 893a1a6c0..0ac2fdfd1 100644 --- a/doc/mesh-api.txt +++ b/doc/mesh-api.txt @@ -365,7 +365,9 @@ Methods: 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 void UnprovisionedScanCancel(void) @@ -374,6 +376,7 @@ Methods: (scanning) for unprovisioned devices in the area. PossibleErrors: + org.bluez.mesh.Error.InvalidArguments org.bluez.mesh.Error.NotAuthorized void AddNode(array{byte}[16] uuid) @@ -860,7 +863,7 @@ Service unique name Interface org.bluez.mesh.Provisioner1 Object path freely definable - ScanResult(int8 rssi, array{byte} data) + void ScanResult(int16 rssi, array{byte} data) The method is called from the bluetooth-meshd daemon when a unique UUID has been seen during UnprovisionedScan() for @@ -881,17 +884,17 @@ Object path freely definable was recieved at a higher rssi power level. - uint16 net_index, uint8 flags, uint32 iv_index, uint16 unicast - RequestProvData() + uint16 net_index, uint16 unicast RequestProvData(uint8 count) 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 - flags - Flags for IV_Update and Key Refresh - iv_index - Current IvIndex being used on the network unicast - Primary Unicast address of the new node PossibleErrors: |