Skip to content

Not all CurieBLE library functions are documented #6739

Open
@per1234

Description

@per1234

Not all of the functions used in the CurieBLE library examples are documented in the library reference page on arduino.cc (https://www.arduino.cc/en/Reference/CurieBLE). These should be easy enough to do since they are already documented to some extent in the source code. What is likely an incomplete list follows:


BLE.scan():
https://github.com/01org/corelibs-arduino101/blob/2.0.2/libraries/CurieBLE/src/BLEDevice.h#L367-L381

    /**
     * @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():
https://github.com/01org/corelibs-arduino101/blob/2.0.2/libraries/CurieBLE/src/BLEDevice.h#L477

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

BLE.stopScan():
https://github.com/01org/corelibs-arduino101/blob/2.0.2/libraries/CurieBLE/src/BLEDevice.h#L440-L449

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

BLE.scanForUuid():
https://github.com/01org/corelibs-arduino101/blob/2.0.2/libraries/CurieBLE/src/BLEDevice.h#L402-L419

     /**
     * @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);

Originally reported at http://forum.arduino.cc/index.php?topic=500757

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions