Diff: BGLib.h

Revision:

6:23d9a99dcde0

Parent:

5:7c7220a316ed

Child:

7:63daf39f20e1

diff -r 7c7220a316ed -r 23d9a99dcde0 BGLib.h
--- a/BGLib.h	Tue May 19 05:01:10 2015 +0000
+++ b/BGLib.h	Tue May 19 05:49:00 2015 +0000
@@ -10,10 +10,8 @@
 * 
 * BGLib ble112(p9, p10, p7, p8);
 * 
-* uint8_t hello_msg[] = {0x00, 0x00, 0x00, 0x01};
-* 
 * void helloCallback() {
-*    //executed when code compiles.
+*    printf("BLE112 said hello!\r\n");
 * }
 * 
 * int main() {
@@ -35,6 +33,13 @@
     */
     BGLib(PinName tx, PinName rx, PinName rts, PinName cts);
     
+    /** GAP Discoverable modes */
+    enum gap_discover_mode {
+        gap_discover_limited = 0, ///< Discover only limited discoverable devices, that is, Slaves which have the LE Limited Discoverable Mode bit set in the Flags AD type of their advertisement packets.
+        gap_discover_generic = 1, ///<  Discover limited and generic discoverable devices, that is, Slaves which have the LE Limited Discoverable Mode or the LE General Discoverable Mode bit set in the Flags AD type of their advertisement packets.
+        gap_discover_observation = 2 ///< Discover all devices regardless of the Flags AD type, so also devices in non-discoverable mode will be reported to host.
+    };
+    
     /** Send a Hello command to the device. */
     void ble_cmd_system_hello();
     
@@ -51,7 +56,9 @@
     */
     void set_ble_rsp_system_get_info(get_info_callback_t pCallback);
     
-    /** Send a Reset command to the device. */
+    /** Send a Reset command to the device.
+    * @param args A struct containing the DFU flag.  
+    */
     void ble_cmd_system_reset(ble_msg_system_reset_t args);
     
     /** Set the callback for a Boot event. Invoked when the BLE112 is powered on or reset. 
@@ -59,17 +66,31 @@
     */
     void set_ble_evt_system_boot(boot_callback_t pCallback);
     
-    /** Set a "timestamping" callback. This is invoked whenever the mbed receives data on the UART interface.
+    /** Set a "timestamping" callback. This is invoked whenever the mbed receives <em>any</em> data on the UART interface.
     * @param pCallback Function pointer to the desired callback.
     */
     void set_timestamp_callback(timestamp_callback_t pCallback);
     
+    /** Send a Discover command to the device. 
+    * @param mode The mode that the device should do discovery in.
+    */
+    void ble_cmd_gap_discover(gap_discover_mode mode);
+        
+    
 private:
+    /** Function that handles parsing responses on the UART port. */
     void parse();
+    
+    /** Function that sends a specific number of bytes via the UART port.
+    * @attention This function doesn't do any bounds checking. Be careful with what you put in!
+    */
     void send_bytes(uint8_t bytes[], int length);
     
+    /** Serial Port object. */
     Serial mSerial;
     
+    
+    // Callbacks
     hello_callback_t mHelloCallback;
     get_info_callback_t mGetInfoCallback;
     boot_callback_t mBootCallback;