CurieBLE Reference

Hello,

I'm confused about something related to the CurieBLE library that I hope someone can help me clear up.

I am using some example code I found on the web to begin a project of my own, using the CurieBLE library. Some of the library calls in the sample code are referencing functions that I don't see in the CurieBLE reference page (https://www.arduino.cc/en/Reference/CurieBLE).

For example, these snippets from the sample code (which by the way, compiles and runs on my Arduino 101):

BLE.scan();
....
if (peripheral.localName()=="PowerLight") {
....
BLE.stopScan();
....
BLE.scanForUuid("19B10000-E8F2-537E-4F6C-D104768A1214");

The above calls do not exist in the CurieBLE reference on Arduino's website, at least not that I have been able to locate.

Can someone help?

Thanks...Doug

Yes, that's unfortunate that the documentation is incomplete. Luckily there is some documentation in the source code.

BLE.scan():

   /**
     * @brief   Start scanning for peripherals with the option of accepting all detectable
     *          Peripherals or just the newly detected.
     *
     * @param[in] withDuplicates        true - return all detectable Peripherals.
     *                                  false- return a detected Peripheral only once.
     *
     * @return  none
     *
     * @note  When, withDuplicates = true, accept all detectable Peripherals.
     *        No Peripheral filtering process applied to the scan result.
     *        By default, withDuplicates = false, a detected Peripheral is
     *        reported once.
     */
void scan(bool withDuplicates = false);

localName():

   String localName() const; // returns the advertised local name as a String

BLE.stopScan():

   /**
     * @brief   Stop scanning for peripherals
     *
     * @param   none
     *
     * @return  none
     *
     * @note  none
     */
    void stopScan();

BLE.scanForUuid():

    /**
     * @brief   Start scanning for peripherals and filter by service in ADV and
     *          the option of accepting all detectable Peripherals or just the
     *          newly detected.
     *
     * @param[in]   service    The service
     *
     * @param[in]   withDuplicates      true - return all detectable Peripherals.
     *                                  false- return a detected Peripheral only once.
     *
     * @return  none
     *
     * @note   When, withDuplicates = true, accept all detectable Peripherals.
     *         No Peripheral filtering process applied to the scan result.
     *         By default, withDuplicates = false, a detected Peripheral is
     *         reported once.
     *
     */
     void scanForUuid(String uuid, bool withDuplicates = false);

I have reported this issue to the Arduino developers at Not all CurieBLE library functions are documented · Issue #6739 · arduino/Arduino · GitHub

Thanks for reporting this rdprecure!

Thanks a bunch pert, that helps. I didn't think to look deeper into some of the other includes.