[Bluetooth] Specifying documentation about BluetoothLEManufacturerData 02/138702/1
authorSzymon Jastrzebski <s.jastrzebsk@partner.samsung.com>
Thu, 13 Jul 2017 08:49:30 +0000 (10:49 +0200)
committerSzymon Jastrzebski <s.jastrzebsk@partner.samsung.com>
Thu, 13 Jul 2017 08:49:30 +0000 (10:49 +0200)
Change-Id: I313de7ad29a4b847905d2fdf771eb06eb183b899
Signed-off-by: Szymon Jastrzebski <s.jastrzebsk@partner.samsung.com>
org.tizen.web.apireference/html/device_api/mobile/tizen/bluetooth.html
org.tizen.web.apireference/html/device_api/wearable/tizen/bluetooth.html

index 91f06ac..4685962 100755 (executable)
@@ -639,6 +639,21 @@ manufacturer.id = "129";
 <span class="attrName"><span class="type">DOMString </span><span class="name">data</span></span><div class="brief">
  The manufacturer data content
             </div>
+<div class="description">
+            <p>
+The string should consist of hexadecimal characters only (A-F, a-f, 0-9). If the string's length is odd, the last character will be omitted.
+The string may start without or with one of below prefixes:
+            </p>
+            <ul>
+              <li>
+'0x',              </li>
+              <li>
+'0X'.              </li>
+            </ul>
+            <p>
+See also, <a href="#BluetoothLEDevice::manufacturerData">usage of BluetoothLEManufacturerData</a>.
+            </p>
+           </div>
 <p><span class="version">
             Since: </span>
  2.3.1
@@ -4198,15 +4213,38 @@ adapter.startScan(function onsuccess(device)
  2.3.1
             </p>
 <div class="example">
-<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint">
-var adapter = tizen.bluetooth.getLEAdapter();
-adapter.startScan(function onsuccess(device)
-{
-  var manufacturerData = device.manufacturerData;
-  console.log("Manufacture id: " + manufacturerData.id);
-  console.log("Manufacture data: " + manufacturerData.data);
-});
-</pre>
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var adapter = tizen.bluetooth.getLEAdapter();
+
+ /* On an advertising device: */
+ var advertiseOptions = {
+   manufacturerData: new tizen.BluetoothLEManufacturerData("127", "0xDeadc0dE")
+ };
+ var advertiseData = new tizen.BluetoothLEAdvertiseData(advertiseOptions);
+
+ adapter.startAdvertise(advertiseData,
+   "ADVERTISE",
+   function onstate(state) {
+     console.log("Advertiser state: " + state);
+   },
+   function(e) {
+     console.log("Failed to startAdvertise : " + e.message);
+   },
+   "LOW_LATENCY");
+
+ /* On scanning device: */
+ adapter.startScan(
+     function onsuccess(device) {
+         var manufacturerData = device.manufacturerData;
+         console.log("Found device, manufacturerData: " + JSON.stringify(device.manufacturerData));
+     }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre> Advertiser state: STARTED
+
+ Found device, manufacturerData: {"id":"127","data":"DEADC0DE"}
+ </pre>
 </div>
 </li>
 <li class="attribute" id="BluetoothLEDevice::rssi">
index 0570707..11c4df2 100755 (executable)
@@ -639,6 +639,21 @@ manufacturer.id = "129";
 <span class="attrName"><span class="type">DOMString </span><span class="name">data</span></span><div class="brief">
  The manufacturer data content
             </div>
+<div class="description">
+            <p>
+The string should consist of hexadecimal characters only (A-F, a-f, 0-9). If the string's length is odd, the last character will be omitted.
+The string may start without or with one of below prefixes:
+            </p>
+            <ul>
+              <li>
+'0x',              </li>
+              <li>
+'0X'.              </li>
+            </ul>
+            <p>
+See also, <a href="#BluetoothLEDevice::manufacturerData">usage of BluetoothLEManufacturerData</a>.
+            </p>
+           </div>
 <p><span class="version">
             Since: </span>
  2.3.1
@@ -4198,15 +4213,38 @@ adapter.startScan(function onsuccess(device)
  2.3.1
             </p>
 <div class="example">
-<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint">
-var adapter = tizen.bluetooth.getLEAdapter();
-adapter.startScan(function onsuccess(device)
-{
-  var manufacturerData = device.manufacturerData;
-  console.log("Manufacture id: " + manufacturerData.id);
-  console.log("Manufacture data: " + manufacturerData.data);
-});
-</pre>
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var adapter = tizen.bluetooth.getLEAdapter();
+
+ /* On an advertising device: */
+ var advertiseOptions = {
+   manufacturerData: new tizen.BluetoothLEManufacturerData("127", "0xDeadc0dE")
+ };
+ var advertiseData = new tizen.BluetoothLEAdvertiseData(advertiseOptions);
+
+ adapter.startAdvertise(advertiseData,
+   "ADVERTISE",
+   function onstate(state) {
+     console.log("Advertiser state: " + state);
+   },
+   function(e) {
+     console.log("Failed to startAdvertise : " + e.message);
+   },
+   "LOW_LATENCY");
+
+ /* On scanning device: */
+ adapter.startScan(
+     function onsuccess(device) {
+         var manufacturerData = device.manufacturerData;
+         console.log("Found device, manufacturerData: " + JSON.stringify(device.manufacturerData));
+     }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre> Advertiser state: STARTED
+
+ Found device, manufacturerData: {"id":"127","data":"DEADC0DE"}
+ </pre>
 </div>
 </li>
 <li class="attribute" id="BluetoothLEDevice::rssi">