BM innovations GmbH BM-USBRTX4 Manual De Usuario

Descargar
Página de 17
 
3DJHRI
4.2.4 Stop to detect if a BlueRobin device has been unplugged 
 
This function stops any previously started check for an unplug event. 
 
bool rtxInterface_UnplugDetectionStop(void); 
 
Return Value: 
Returns true if detection could have been stopped, otherwise returns false 
 
Remarks:  
This function is in experimental state! 
 
 
4.2.5 Signal an unplugged BlueRobin device 
 
This function should be periodically checked to see if an unplug event happened. 
 
bool rtxInterface_UnplugDetected(void); 
 
Return Value: 
Returns true if an unplug event has been detected, otherwise returns false 
 
Remarks:  
This function is in experimental state!  
 
 
 
4.3 Device Functions 
 
 
4.3.1 Open port 
 
Opens the port the BlueRobin transceiver hardware is connected to. The BM-USBRX3 hardware is powered up when 
opening the port. Some parts of the hardware require a start up time of up to 2 seconds so it could take up to that time to 
open the port. No start up time and therefore no delay can be seen for BM-USBD1 transceiver dongles. 
 
bool rtxDevice_Open(const char *PortName); 
 
Parameters: 
PortName  
String specifying the port name; will be returned as a part of the device information when calling 
function rtxInterface_GetDeviceInfo() 
 
Return Value: 
Returns true if port could be opened and transceiver hardware could be found, otherwise returns false 
 
Remarks:  
Do not try to open more than one port for a BM-USBRTX3 transceiver unit at a time. Always close the port first before 
trying to open the port again!  
 
 
4.3.2 Close port 
 
A successfully opened port has to be closed at the end of the application runtime to release all allocated memory and the 
port itself. 
 
bool rtxDevice_Close(void); 
 
Return Value: 
Returns true if port could be found and closed, otherwise returns false 
 
 
4.3.3 Check if port has been opened 
 
This function checks if a port to a BlueRobin device has already been opened. 
 
bool rtxDevice_IsOpen(void); 
 
Return Value: 
Returns true if port is open, otherwise returns false