#include <HidController.h>
◆ HidController()
HidController::HidController |
( |
| ) |
|
Constructor. Creates an object that represents a HID port.
◆ ~HidController()
HidController::~HidController |
( |
| ) |
|
|
virtual |
Destructor. Destroys the HID port object.
◆ Close()
bool HidController::Close |
( |
| ) |
|
|
virtual |
Close a HID port. Closes the HID port.
- Returns
- True if the port was closed successfully, or false if the port was already closed, or an error occurred.
- See also
- Open
Implements OpenZWave::Controller.
◆ Open()
bool HidController::Open |
( |
string const & |
_hidControllerName | ) |
|
|
virtual |
Open a HID port. Attempts to open a HID port and initialize it with the specified paramters.
- Parameters
-
_HidControllerName | The name of the port to open. For example, ttyS1 on Linux, or \.\COM2 in Windows. |
- Returns
- True if the port was opened and configured successfully.
- See also
- Close, Read, Write
Implements OpenZWave::Controller.
◆ SetProductId()
bool HidController::SetProductId |
( |
uint32 const |
_productId | ) |
|
Set the USB product ID search value. The HID port must be closed for the setting to be accepted.
- Parameters
-
_parity | Product ID value to match when enumerating USB HID devices. |
- Returns
- True if the product ID value was accepted.
- See also
- Open, Close
◆ SetSerialNumber()
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.
- Parameters
-
_parity | Serial number string to match when enumerating USB HID devices. If empty, any serial number will be accepted. |
- Returns
- True if the serial number value was accepted.
- See also
- Open, Close
◆ SetVendorId()
bool HidController::SetVendorId |
( |
uint32 const |
_vendorId | ) |
|
Set the USB vendor ID search value. The HID port must be closed for the setting to be accepted.
- Parameters
-
_baud | Vendor ID value to match when enumerating USB HID devices. |
- Returns
- True if the vendor ID value was accepted.
- See also
- Open, Close
◆ Write()
Write to a HID port. Attempts to write data to an open HID port.
- Parameters
-
_buffer | Pointer to a block of memory containing the data to be written. |
_length | Length in bytes of the data. |
- Returns
- The number of bytes written.
- See also
- Read, Open, Close
Implements OpenZWave::Controller.
The documentation for this class was generated from the following files: