Skip to content

Commit 54a8455

Browse files
committed
Define some more headers regardin slave search
1 parent 255e18c commit 54a8455

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

src/BaseClasses/ANTPLUS_BaseSlaveProfile.h

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,41 @@ class BaseSlaveProfile : public BaseProfile {
1111

1212
/**
1313
* Pass in a pointer to an array uint16_t[ANTPLUS_MAX_CHANNELS_POSSIBLE]
14+
* Starts a search for all devices configured with this profle
15+
* This will disrupt all other channels to do the search, therefore you will have to
16+
* call start() on all registered profiles.
17+
* This is a blocking method, see backgroundDeviceSearch for a non-blocking variation.
1418
*
15-
* Any non-0 entry after the function returned is a nearby device
19+
* returns the number of the ids filled.
1620
*/
1721
uint8_t searchForDevices(uint16_t* buffer);
22+
23+
/**
24+
* Pass in a pointer to an array uint16_t[ANTPLUS_MAX_CHANNELS_POSSIBLE]
25+
* Start a non-blocking search for the following device profile.
26+
* This will disrupt all other channels to do the search, therefore you will have to
27+
* call start() on all registered profiles.
28+
*/
29+
void backgroundDeviceSearch(uint16_t* buffer);
30+
31+
/**
32+
* Check the status of the backgroundDeviceSearch.
33+
*/
34+
uint8_t backgroundDeviceSearchStatus();
35+
36+
/**
37+
* Call this to determine the number of devices found using backgroundDeviceSearch.
38+
* This can be called before the search is completed.
39+
*/
40+
uint8_t backgroundDeviceSearchNumberDevices();
41+
42+
/**
43+
* TODO
44+
*
45+
* Register a callback method for when backgroundDeviceSearch completes.
46+
*/
47+
void backgroundDeviceSearchCallback();
48+
1849
/**
1950
* Will return once the device either pairs or timesout its search
2051
*/

0 commit comments

Comments
 (0)