![]() |
OpenZWave Library
1.5.0
|
Interface for controllers that implement a HID emulation. More...
#include <HidController.h>
Public Member Functions | |
HidController () | |
virtual | ~HidController () |
bool | SetVendorId (uint32 const _vendorId) |
bool | SetProductId (uint32 const _productId) |
bool | SetSerialNumber (string const &_serialNumber) |
bool | Open (string const &_hidControllerName) |
bool | Close () |
uint32 | Write (uint8 *_buffer, uint32 _length) |
![]() | |
Controller () | |
virtual | ~Controller () |
void | PlayInitSequence (Driver *_driver) |
uint32 | Read (uint8 *_buffer, uint32 _length) |
![]() | |
Stream (uint32 _bufferSize) | |
void | SetSignalThreshold (uint32 _size) |
bool | Get (uint8 *_buffer, uint32 _size) |
bool | Put (uint8 *_buffer, uint32 _size) |
uint32 | GetDataSize () const |
void | Purge () |
![]() | |
void | AddWatcher (pfnWaitNotification_t _callback, void *_context) |
void | RemoveWatcher (pfnWaitNotification_t _callback, void *_context) |
![]() | |
Ref () | |
void | AddRef () |
int32 | Release () |
Additional Inherited Members | |
![]() | |
enum | { Timeout_Immediate = 0, Timeout_Infinite = -1 } |
typedef void(* | pfnWaitNotification_t) (void *_context) |
![]() | |
static int32 | Single (Wait *_object, int32 _timeout=-1) |
static int32 | Multiple (Wait **_objects, uint32 _numObjects, int32 _timeout=-1) |
![]() | |
void | LogData (uint8 *_buffer, uint32 _size, const string &_function) |
virtual bool | IsSignalled () |
~Stream () | |
![]() | |
Wait () | |
virtual | ~Wait () |
void | Notify () |
![]() | |
virtual | ~Ref () |
Interface for controllers that implement a HID emulation.
HidController::HidController | ( | ) |
Constructor. Creates an object that represents a HID port.
|
virtual |
Destructor. Destroys the HID port object.
|
virtual |
Close a HID port. Closes the HID port.
Implements OpenZWave::Controller.
|
virtual |
Open a HID port. Attempts to open a HID port and initialize it with the specified parameters.
_HidControllerName | The name of the port to open. For example, ttyS1 on Linux, or \.\COM2 in Windows. |
Implements OpenZWave::Controller.
bool HidController::SetProductId | ( | uint32 const | _productId | ) |
bool HidController::SetSerialNumber | ( | string const & | _serialNumber | ) |
Set the USB serial number search value. The HID port must be closed for the setting to be accepted.
_parity | Serial number string to match when enumerating USB HID devices. If empty, any serial number will be accepted. |
bool HidController::SetVendorId | ( | uint32 const | _vendorId | ) |
Write to a HID port. Attempts to write data to an open HID port.
_buffer | Pointer to a block of memory containing the data to be written. |
_length | Length in bytes of the data. |
Implements OpenZWave::Controller.