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

Document TDDeviceEvent

Browse source
This commit is contained in:
Erik Johansson 2012-03-17 18:46:25 +01:00
parent d715e4ad41
commit 296be6a068
1 changed files with 15 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -192,8 +192,22 @@ using namespace TelldusCore;
* *
* @typedef TDDeviceEvent * @typedef TDDeviceEvent
* The callback type for device events. * The callback type for device events.
*
* @attention The callback will be called by another thread than the thread
* used by the application and some measures must be taken to synchronize it
* with the main thread.
*
* @param deviceId The id of the device that changed.
* @param method The new device state. Can be @ref TELLSTICK_TURNON, @ref
* TELLSTICK_TURNOFF, etc.
* @param data If @a method is @ref TELLSTICK_DIM this holds the current value
* as a human readable string, example "128" for 50%.
* @param callbackId The id of the callback.
* @param context The pointer passed when registering for the event.
*
* @sa tdRegisterDeviceEvent * @sa tdRegisterDeviceEvent
* *
*
* @typedef TDDeviceChangeEvent * @typedef TDDeviceChangeEvent
* The callback type for device change events. * The callback type for device change events.
* *
@ -201,7 +215,7 @@ using namespace TelldusCore;
* used by the application and some measures must be taken to synchronize it * used by the application and some measures must be taken to synchronize it
* with the main thread. * with the main thread.
* *
* @param deviceId The id for the device that was added, changed or removed. * @param deviceId The id of the device that was added, changed or removed.
* @param changeEvent One of the constants @ref TELLSTICK_DEVICE_ADDED, @ref * @param changeEvent One of the constants @ref TELLSTICK_DEVICE_ADDED, @ref
* TELLSTICK_DEVICE_CHANGED or @ref TELLSTICK_DEVICE_REMOVED. * TELLSTICK_DEVICE_CHANGED or @ref TELLSTICK_DEVICE_REMOVED.
* @param changeType If @a changeEvent was @ref TELLSTICK_DEVICE_CHANGED, this * @param changeType If @a changeEvent was @ref TELLSTICK_DEVICE_CHANGED, this