Visioscan Set SDK Libraries 1.0.28
Visioscan Set SDK Help documentation file for C++ and C++/CLI
 
Loading...
Searching...
No Matches
UsbCommunication.h
1#pragma once
2
3#pragma comment(lib, "Ws2_32.lib")
4#include "BaseCommunication.h"
5#include "UsbSettings.h"
6
7#include <thread>
8#include "UsbInformation.h"
9#include "ClockUtilities.h"
10
11#ifdef STARFLEETTOOLBOX_EXPORTS
12#define USBCOMM __declspec(dllexport)
13#else
14#define USBCOMM __declspec(dllimport)
15#endif
16
20typedef struct UsbDevice {
21 struct libusb_transfer* transfer;
22 struct libusb_device_handle* device_handle;
23 unsigned char input_endpoint;
24 struct libusb_context* usbContext;
25
26 BaseDataExtractor* extractor; // a pointer to the communication extractor
27 HANDLE dataAvailableSemaphore; // semaphore to warn that Command ACK is available
28 HANDLE rawDataAvailableSemaphore; // semaphore to warn that RAW Data are available
29 HANDLE semReadyToConsume; // synchronisation for data consumed
30 string commandResult; // the command result
31 bool treat = false; // indicates if data treater is in treatment
32 vector<string> localVector; // temporary local vector
33 RawData extractedData; // the extracted raw data
34 bool interruptTransfer = true; // indicates a transfert interruption
35 CommunicationStatus commStatus; // the connection status
36 atomic<chrono::time_point<std::chrono::steady_clock>> lastUsbDataTime; // the last raw data sent
37};
38
42class USBCOMM UsbCommunication :
43 public BaseCommunication
44{
45public:
46 const int COMMAND_ACK_TIMEOUT = 20000;
47 const int MAX_SIZE_TO_READ = 40000;
48
53 UsbCommunication(MONITORING_MODE monitoring);
58 UsbCommunication(UsbSettings* settings, MONITORING_MODE monitoring);
63
67 CommunicationStatus Connect();
71 CommunicationStatus Connect(bool reconnecting);
72
76 void Disconnect();
77
78
84 string SendCommand(string commandToSend);
85
86
93 RawData WaitForRawData(int waitTimeout, unsigned long* semStatus);
94
100 static vector<UsbInformation> GetDeviceList();
101protected:
106 CommunicationStatus GetConnectionStatus();
107private:
108 atomic<chrono::time_point<std::chrono::steady_clock>> _lastUsbDataTime;
109
110 void Disconnect(bool reconnecting);
111 CommunicationStatus Reconnect();
112 std::atomic<bool> _stopHandle;
113 std::atomic<bool> _connected;
114
115 std::atomic<bool> _alreadydisconnected;
116 std::atomic<bool> _disconnectCalledByPeer;
117
118
119 std::atomic<int> _mainConnectionStatus; // useful for monitoring
120
121 UsbDevice usbDevice;
122 thread _usbReceiveData;
123
124 HANDLE _mutexSendAvailable; // prevent the socket to be used from another process to send data
125
130 void UsbEventDataReceiverBusiness(void* param);
131
137 static void __stdcall callbackUSBReadTransferComplete(struct libusb_transfer* xfr);
138};
139
Definition CommunicationStructures.h:24
The base class encapsulating sensor's RAW data.
Definition RawData.h:14
A structure definition to handle USB callback event.
Definition UsbCommunication.h:20
BaseDataExtractor * extractor
Definition UsbCommunication.h:26
string commandResult
Definition UsbCommunication.h:30
struct libusb_transfer * transfer
Definition UsbCommunication.h:21
RawData extractedData
Definition UsbCommunication.h:33
HANDLE dataAvailableSemaphore
Definition UsbCommunication.h:27
struct libusb_device_handle * device_handle
Definition UsbCommunication.h:22
bool treat
Definition UsbCommunication.h:31
bool interruptTransfer
Definition UsbCommunication.h:34
atomic< chrono::time_point< std::chrono::steady_clock > > lastUsbDataTime
Definition UsbCommunication.h:36
vector< string > localVector
Definition UsbCommunication.h:32
HANDLE semReadyToConsume
Definition UsbCommunication.h:29
unsigned char input_endpoint
Definition UsbCommunication.h:23
CommunicationStatus commStatus
Definition UsbCommunication.h:35
struct libusb_context * usbContext
Definition UsbCommunication.h:24
HANDLE rawDataAvailableSemaphore
Definition UsbCommunication.h:28
This class handles the USB communication.
Definition UsbCommunication.h:44
The USB settings encapsulation for USB communication.
Definition UsbSettings.h:18