jeena/telldus
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Add documentation for tdSensor(), see #110

Browse source
This commit is contained in:
Micke Prag 2011-10-28 15:10:03 +02:00
parent f285c9099e
commit 5ca9d3a7b8
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
telldus-core/client/telldus-core.cpp
View file

@ -534,6 +534,17 @@ void WINAPI tdDisconnectTellStickController(int vid, int pid, const char *serial
Client::getWStringFromService(msg);
}
/**
* Use this function to iterate over all sensors. Iterate until
* TELLSTICK_SUCCESS is not returned
* @param protocol A byref string where the protocol of the sensor will be placed
* @param protocolLen The length of the \c protocol parameter
* @param model A byref string where the model of the sensor will be placed
* @param modelLen The length of the \c model parameter
* @param id A byref int where the id of the sensor will be placed
* @param dataTypes A byref int with flags for the supported sensor values
* @returns TELLSTICK_SUCCESS if there is more sensors to be fetched
*/
int WINAPI tdSensor(char *protocol, int protocolLen, char *model, int modelLen, int *id, int *dataTypes) {
Client *client = Client::getInstance();
return client->getSensor(protocol, protocolLen, model, modelLen, id, dataTypes);