doc/mesh-api: Add "options" dictionary to Send/Publish
authorInga Stotland <inga.stotland@intel.com>
Tue, 25 Aug 2020 00:54:32 +0000 (17:54 -0700)
committerAbhay Agarwal <ay.agarwal@samsung.com>
Mon, 28 Dec 2020 06:20:04 +0000 (11:50 +0530)
commit9d3f3ca3fc8ec24c499cb19ad10b21a0ebc3c155
tree0ee6e036b39507ba08383508adb1cb8a5f1f9af9
parentbbc5d93702eec1c5e2c1f67fff6b1b3d36db1eaf
doc/mesh-api: Add "options" dictionary to Send/Publish

This modifies Send, DevKeySend and Publish methods
on mesh.Node interface to include additional argument "options".
This new argument is a dictionary that currently has only one
new key word defined for Send() and DevKeySend():
    "ForceSegmented" - to force small payloads to be sent as
           one-segment messages

In case of Publish(), and additional keyword is defined
     "Vendor" -  16-bit Company ID as defined by the Bluetooth SIG

Other key words may be defined in future to accommodate evolving
requirements of Mesh Profile specification.

Also, the addition of "options" dictionary to Publish allows to
eliminate VendorPublish() method (taken care by "Vendor" keyword).

Change-Id: I5fa1ed0e03875cc4c16723aa6005b38fcf031255
Signed-off-by: anuj.bhumiya <anuj.bhumiya@samsung.com>
doc/mesh-api.txt