API stubs for the BLE advertisement API.

extensions/common/api/bluetooth_low_energy.idl

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // The <code>chrome.bluetoothLowEnergy</code> API is used to communicate with
 // Bluetooth Smart (Low Energy) devices using the
 // <a href="https://developer.bluetooth.org/TechnologyOverview/Pages/GATT.aspx">
 // Generic Attribute Profile (GATT)</a>.
 namespace bluetoothLowEnergy {
   // Values representing the possible properties of a characteristic.
   enum CharacteristicProperty {broadcast, read, writeWithoutResponse, write,
                                notify, indicate, authenticatedSignedWrites,
                                extendedProperties, reliableWrite,
                                writableAuxiliaries};
 
+  // Type of advertisement. If 'broadcast' is chosen, the sent advertisement
+  // type will be ADV_NONCONN_IND. If set to 'peripheral', the advertisement
+  // type will be ADV_IND or ADV_SCAN_IND.
+  [nodoc] enum AdvertisementType {broadcast, peripheral};
+
   // Represents a peripheral's Bluetooth GATT Service, a collection of
   // characteristics and relationships to other services that encapsulate
   // the behavior of part of a device.
   dictionary Service {
     // The UUID of the service, e.g. 0000180d-0000-1000-8000-00805f9b34fb.
     DOMString uuid;
 
     // Indicates whether the type of this service is primary or secondary.
     boolean isPrimary;
 
@@ skipping 81 matching lines @@
   // Optional characteristic notification session properties specified during a
   // call to $(ref:startCharacteristicNotifications).
   dictionary NotificationProperties {
     // Flag indicating whether the app should receive notifications when the
     // event page of the application is unloaded (see <a
     // href="http://developer.chrome.com/apps/app_lifecycle.html">Manage App
     // Lifecycle</a>). The default value is <code>false</code>.
     boolean persistent;
   };
 
+  // Represents an entry of the "Manufacturer Specific Data" field of Bluetooth
+  // LE advertisement data.
+  [nodoc] dictionary ManufacturerData {
+    long id;
+    long[] data;
+  };
+
+  // Represents an entry of the "Service Data" field of Bluetooth LE advertisement
+  // data.
+  [nodoc] dictionary ServiceData {
+    DOMString uuid;
+    long[] data;
+  };
+
+  // Represents a Bluetooth LE advertisement instance.
+  [nodoc] dictionary Advertisement {
+    // Type of advertisement.
+    AdvertisementType type;
+
+    // List of UUIDs to include in the "Service UUIDs" field of the Advertising
+    // Data. These UUIDs can be of the 16bit, 32bit or 128 formats.
+    DOMString[]? serviceUuids;
+
+    // List of manufacturer specific data to be included in "Manufacturer Specific
+    // Data" fields of the advertising data.
+    ManufacturerData[]? manufacturerData;
+
+    // List of UUIDs to include in the "Solicit UUIDs" field of the Advertising
+    // Data. These UUIDs can be of the 16bit, 32bit or 128 formats.
+    DOMString[]? solicitUuids;
+
+    // List of service data to be included in "Service Data" fields of the advertising
+    // data.
+    ServiceData[]? serviceData;
+  };
+
   callback CharacteristicCallback = void(Characteristic result);
   callback CharacteristicsCallback = void(Characteristic[] result);
   callback DescriptorCallback = void(Descriptor result);
   callback DescriptorsCallback = void(Descriptor[] result);
   callback ResultCallback = void();
   callback ServiceCallback = void(Service result);
   callback ServicesCallback = void(Service[] result);
+  callback RegisterAdvertisementCallback = void (long advertisementId);
 
   // These functions all report failures via chrome.runtime.lastError.
   interface Functions {
     // Establishes a connection between the application and the device with the
     // given address. A device may be already connected and its GATT services
     // available without calling <code>connect</code>, however, an app that
     // wants to access GATT services of a device should call this function to
     // make sure that a connection to the device is maintained. If the device
     // is not connected, all GATT services of the device will be discovered
     // after a successful call to <code>connect</code>.
@@ skipping 121 matching lines @@
     // Write the value of a specified characteristic descriptor from a remote
     // peripheral.
     // |descriptorId| : The instance ID of the GATT characteristic descriptor
     // whose value should be written to.
     // |value| : The value that should be sent to the remote descriptor as part
     // of the write request.
     // |callback| : Called when the write request has completed.
     static void writeDescriptorValue(DOMString descriptorId,
                                      ArrayBuffer value,
                                      ResultCallback callback);
+
+    // Create an advertisement and register it for advertising. To call this
+    // function, the app must have the bluetooth:low_energy and

[scheib, 2015/05/06 23:17:41]

Mentioning the permissions is good. Can we link to the doc that explains how to
set these permissions https://developer.chrome.com/apps/manifest/bluetooth

[rkc, 2015/05/07 17:16:28]

Done.

+    // bluetooth:peripheral permissions set to true.
+    // Note: On some hardware central and peripheral modes at the same time is
+    // supported but on hardware that doesn't support this, making this call
+    // will switch the device to peripheral mode. In the case of hardware which
+    // does not support both central and peripheral mode, attempting to use the
+    // device in both modes will lead to undefined behavior or prevent other
+    // central-role applications from behaving correctly (including the
+    // discovery of Bluetooth Low Energy devices).
+    // |advertisement| : The advertisement to advertise.
+    // |callback| : Called once the registeration is done and we've started
+    // advertising. Returns the id of the created advertisement.
+    [nodoc] static void registerAdvertisement(
+        Advertisement advertisement, RegisterAdvertisementCallback callback);
+
+    // Unregisters an advertisement and stops its advertising.
+    // |advertisementId| : Id of the advertisement to unregister.
+    // |callback| : Called once the advertisement is unregistered and is no
+    // longer being advertised.
+    [nodoc] static void unregisterAdvertisement(long advertisementId,
+                                                ResultCallback callback);
   };
 
   interface Events {
     // Fired whan a new GATT service has been discovered on a remote device.
     // |service| : The GATT service that was added.
     static void onServiceAdded(Service service);
 
     // Fired when the state of a remote GATT service changes. This involves any
     // characteristics and/or descriptors that get added or removed from the
     // service, as well as "ServiceChanged" notifications from the remote
@@ skipping 15 matching lines @@
 
     // Fired when the value of a remote GATT characteristic descriptor changes,
     // usually as a result of a read request. This event exists
     // mostly for convenience and will always be sent after a successful
     // call to $(ref:readDescriptorValue).
     // |descriptor| : The GATT characteristic descriptor whose value has
     // changed.
     static void onDescriptorValueChanged(Descriptor descriptor);
   };
 };