-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathserialib.cpp
1134 lines (976 loc) · 33.2 KB
/
serialib.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*!
\file serialib.cpp
\brief Source file of the class serialib. This class is used for communication over a serial device.
\author Philippe Lucidarme (University of Angers)
\version 2.0
\date december the 27th of 2019
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
This is a licence-free software, it can be used by anyone who try to build a better world.
*/
#include "serialib.h"
//_____________________________________
// ::: Constructors and destructors :::
/*!
\brief Constructor of the class serialib.
*/
serialib::serialib()
{
#if defined (_WIN32) || defined( _WIN64)
// Set default value for RTS and DTR (Windows only)
currentStateRTS=true;
currentStateDTR=true;
hSerial = INVALID_HANDLE_VALUE;
#endif
#if defined (__linux__) || defined(__APPLE__)
fd = -1;
#endif
}
/*!
\brief Destructor of the class serialib. It close the connection
*/
// Class desctructor
serialib::~serialib()
{
closeDevice();
}
//_________________________________________
// ::: Configuration and initialization :::
/*!
\brief Open the serial port
\param Device : Port name (COM1, COM2, ... for Windows ) or (/dev/ttyS0, /dev/ttyACM0, /dev/ttyUSB0 ... for linux)
\param Bauds : Baud rate of the serial port.
\n Supported baud rate for Windows :
- 110
- 300
- 600
- 1200
- 2400
- 4800
- 9600
- 14400
- 19200
- 38400
- 56000
- 57600
- 115200
- 128000
- 256000
\n Supported baud rate for Linux :\n
- 110
- 300
- 600
- 1200
- 2400
- 4800
- 9600
- 19200
- 38400
- 57600
- 115200
\n Optionally supported baud rates, depending on Linux kernel:\n
- 230400
- 460800
- 500000
- 576000
- 921600
- 1000000
- 1152000
- 1500000
- 2000000
- 2500000
- 3000000
- 3500000
- 4000000
\param Databits : Number of data bits in one UART transmission.
\n Supported values: \n
- SERIAL_DATABITS_5 (5)
- SERIAL_DATABITS_6 (6)
- SERIAL_DATABITS_7 (7)
- SERIAL_DATABITS_8 (8)
- SERIAL_DATABITS_16 (16) (not supported on Unix)
\param Parity: Parity type
\n Supported values: \n
- SERIAL_PARITY_NONE (N)
- SERIAL_PARITY_EVEN (E)
- SERIAL_PARITY_ODD (O)
- SERIAL_PARITY_MARK (MARK) (not supported on Unix)
- SERIAL_PARITY_SPACE (SPACE) (not supported on Unix)
\param Stopbit: Number of stop bits
\n Supported values:
- SERIAL_STOPBITS_1 (1)
- SERIAL_STOPBITS_1_5 (1.5) (not supported on Unix)
- SERIAL_STOPBITS_2 (2)
\return 1 success
\return -1 device not found
\return -2 error while opening the device
\return -3 error while getting port parameters
\return -4 Speed (Bauds) not recognized
\return -5 error while writing port parameters
\return -6 error while writing timeout parameters
\return -7 Databits not recognized
\return -8 Stopbits not recognized
\return -9 Parity not recognized
*/
char serialib::openDevice(const char *Device, const unsigned int Bauds,
SerialDataBits Databits,
SerialParity Parity,
SerialStopBits Stopbits) {
#if defined (_WIN32) || defined( _WIN64)
// Open serial port
hSerial = CreateFileA(Device,GENERIC_READ | GENERIC_WRITE,0,0,OPEN_EXISTING,/*FILE_ATTRIBUTE_NORMAL*/0,0);
if(hSerial==INVALID_HANDLE_VALUE) {
if(GetLastError()==ERROR_FILE_NOT_FOUND)
return -1; // Device not found
// Error while opening the device
return -2;
}
// Set parameters
// Structure for the port parameters
DCB dcbSerialParams;
dcbSerialParams.DCBlength=sizeof(dcbSerialParams);
// Get the port parameters
if (!GetCommState(hSerial, &dcbSerialParams)) return -3;
// Set the speed (Bauds)
switch (Bauds)
{
case 110 : dcbSerialParams.BaudRate=CBR_110; break;
case 300 : dcbSerialParams.BaudRate=CBR_300; break;
case 600 : dcbSerialParams.BaudRate=CBR_600; break;
case 1200 : dcbSerialParams.BaudRate=CBR_1200; break;
case 2400 : dcbSerialParams.BaudRate=CBR_2400; break;
case 4800 : dcbSerialParams.BaudRate=CBR_4800; break;
case 9600 : dcbSerialParams.BaudRate=CBR_9600; break;
case 14400 : dcbSerialParams.BaudRate=CBR_14400; break;
case 19200 : dcbSerialParams.BaudRate=CBR_19200; break;
case 38400 : dcbSerialParams.BaudRate=CBR_38400; break;
case 56000 : dcbSerialParams.BaudRate=CBR_56000; break;
case 57600 : dcbSerialParams.BaudRate=CBR_57600; break;
case 115200 : dcbSerialParams.BaudRate=CBR_115200; break;
case 128000 : dcbSerialParams.BaudRate=CBR_128000; break;
case 256000 : dcbSerialParams.BaudRate=CBR_256000; break;
default : return -4;
}
//select data size
BYTE bytesize = 0;
switch(Databits) {
case SERIAL_DATABITS_5: bytesize = 5; break;
case SERIAL_DATABITS_6: bytesize = 6; break;
case SERIAL_DATABITS_7: bytesize = 7; break;
case SERIAL_DATABITS_8: bytesize = 8; break;
case SERIAL_DATABITS_16: bytesize = 16; break;
default: return -7;
}
BYTE stopBits = 0;
switch(Stopbits) {
case SERIAL_STOPBITS_1: stopBits = ONESTOPBIT; break;
case SERIAL_STOPBITS_1_5: stopBits = ONE5STOPBITS; break;
case SERIAL_STOPBITS_2: stopBits = TWOSTOPBITS; break;
default: return -8;
}
BYTE parity = 0;
switch(Parity) {
case SERIAL_PARITY_NONE: parity = NOPARITY; break;
case SERIAL_PARITY_EVEN: parity = EVENPARITY; break;
case SERIAL_PARITY_ODD: parity = ODDPARITY; break;
case SERIAL_PARITY_MARK: parity = MARKPARITY; break;
case SERIAL_PARITY_SPACE: parity = SPACEPARITY; break;
default: return -9;
}
// configure byte size
dcbSerialParams.ByteSize = bytesize;
// configure stop bits
dcbSerialParams.StopBits = stopBits;
// configure parity
dcbSerialParams.Parity = parity;
// Write the parameters
if(!SetCommState(hSerial, &dcbSerialParams)) return -5;
// Set TimeOut
// Set the Timeout parameters
timeouts.ReadIntervalTimeout=0;
// No TimeOut
timeouts.ReadTotalTimeoutConstant=MAXDWORD;
timeouts.ReadTotalTimeoutMultiplier=0;
timeouts.WriteTotalTimeoutConstant=MAXDWORD;
timeouts.WriteTotalTimeoutMultiplier=0;
// Write the parameters
if(!SetCommTimeouts(hSerial, &timeouts)) return -6;
// Opening successfull
return 1;
#endif
#if defined (__linux__) || defined(__APPLE__)
// Structure with the device's options
struct termios options;
// Open device
fd = open(Device, O_RDWR | O_NOCTTY | O_NDELAY);
// If the device is not open, return -1
if (fd == -1) return -2;
// Open the device in nonblocking mode
fcntl(fd, F_SETFL, FNDELAY);
// Get the current options of the port
tcgetattr(fd, &options);
// Clear all the options
bzero(&options, sizeof(options));
// Prepare speed (Bauds)
speed_t Speed;
switch (Bauds)
{
case 110 : Speed=B110; break;
case 300 : Speed=B300; break;
case 600 : Speed=B600; break;
case 1200 : Speed=B1200; break;
case 2400 : Speed=B2400; break;
case 4800 : Speed=B4800; break;
case 9600 : Speed=B9600; break;
case 19200 : Speed=B19200; break;
case 38400 : Speed=B38400; break;
case 57600 : Speed=B57600; break;
case 115200 : Speed=B115200; break;
#if defined (B230400)
case 230400 : Speed=B230400; break;
#endif
#if defined (B460800)
case 460800 : Speed=B460800; break;
#endif
#if defined (B500000)
case 500000 : Speed=B500000; break;
#endif
#if defined (B576000)
case 576000 : Speed=B576000; break;
#endif
#if defined (B921600)
case 921600 : Speed=B921600; break;
#endif
#if defined (B1000000)
case 1000000 : Speed=B1000000; break;
#endif
#if defined (B1152000)
case 1152000 : Speed=B1152000; break;
#endif
#if defined (B1500000)
case 1500000 : Speed=B1500000; break;
#endif
#if defined (B2000000)
case 2000000 : Speed=B2000000; break;
#endif
#if defined (B2500000)
case 2500000 : Speed=B2500000; break;
#endif
#if defined (B3000000)
case 3000000 : Speed=B3000000; break;
#endif
#if defined (B3500000)
case 3500000 : Speed=B3500000; break;
#endif
#if defined (B4000000)
case 4000000 : Speed=B4000000; break;
#endif
default : return -4;
}
int databits_flag = 0;
switch(Databits) {
case SERIAL_DATABITS_5: databits_flag = CS5; break;
case SERIAL_DATABITS_6: databits_flag = CS6; break;
case SERIAL_DATABITS_7: databits_flag = CS7; break;
case SERIAL_DATABITS_8: databits_flag = CS8; break;
//16 bits and everything else not supported
default: return -7;
}
int stopbits_flag = 0;
switch(Stopbits) {
case SERIAL_STOPBITS_1: stopbits_flag = 0; break;
case SERIAL_STOPBITS_2: stopbits_flag = CSTOPB; break;
//1.5 stopbits and everything else not supported
default: return -8;
}
int parity_flag = 0;
switch(Parity) {
case SERIAL_PARITY_NONE: parity_flag = 0; break;
case SERIAL_PARITY_EVEN: parity_flag = PARENB; break;
case SERIAL_PARITY_ODD: parity_flag = (PARENB | PARODD); break;
//mark and space parity not supported
default: return -9;
}
// Set the baud rate
cfsetispeed(&options, Speed);
cfsetospeed(&options, Speed);
// Configure the device : data bits, stop bits, parity, no control flow
// Ignore modem control lines (CLOCAL) and Enable receiver (CREAD)
options.c_cflag |= ( CLOCAL | CREAD | databits_flag | parity_flag | stopbits_flag);
options.c_iflag |= ( IGNPAR | IGNBRK );
// Timer unused
options.c_cc[VTIME]=0;
// At least on character before satisfy reading
options.c_cc[VMIN]=0;
// Activate the settings
tcsetattr(fd, TCSANOW, &options);
// Success
return (1);
#endif
}
bool serialib::isDeviceOpen()
{
#if defined (_WIN32) || defined( _WIN64)
return hSerial != INVALID_HANDLE_VALUE;
#endif
#if defined (__linux__) || defined(__APPLE__)
return fd >= 0;
#endif
}
/*!
\brief Close the connection with the current device
*/
void serialib::closeDevice()
{
#if defined (_WIN32) || defined( _WIN64)
CloseHandle(hSerial);
hSerial = INVALID_HANDLE_VALUE;
#endif
#if defined (__linux__) || defined(__APPLE__)
close (fd);
fd = -1;
#endif
}
//___________________________________________
// ::: Read/Write operation on characters :::
/*!
\brief Write a char on the current serial port
\param Byte : char to send on the port (must be terminated by '\0')
\return 1 success
\return -1 error while writting data
*/
int serialib::writeChar(const char Byte)
{
#if defined (_WIN32) || defined( _WIN64)
// Number of bytes written
DWORD dwBytesWritten;
// Write the char to the serial device
// Return -1 if an error occured
if(!WriteFile(hSerial,&Byte,1,&dwBytesWritten,NULL)) return -1;
// Write operation successfull
return 1;
#endif
#if defined (__linux__) || defined(__APPLE__)
// Write the char
if (write(fd,&Byte,1)!=1) return -1;
// Write operation successfull
return 1;
#endif
}
//________________________________________
// ::: Read/Write operation on strings :::
/*!
\brief Write a string on the current serial port
\param receivedString : string to send on the port (must be terminated by '\0')
\return 1 success
\return -1 error while writting data
*/
int serialib::writeString(const char *receivedString)
{
#if defined (_WIN32) || defined( _WIN64)
// Number of bytes written
DWORD dwBytesWritten;
// Write the string
if(!WriteFile(hSerial,receivedString,strlen(receivedString),&dwBytesWritten,NULL))
// Error while writing, return -1
return -1;
// Write operation successfull
return 1;
#endif
#if defined (__linux__) || defined(__APPLE__)
// Lenght of the string
int Lenght=strlen(receivedString);
// Write the string
if (write(fd,receivedString,Lenght)!=Lenght) return -1;
// Write operation successfull
return 1;
#endif
}
// _____________________________________
// ::: Read/Write operation on bytes :::
/*!
\brief Write an array of data on the current serial port
\param Buffer : array of bytes to send on the port
\param NbBytes : number of byte to send
\return 1 success
\return -1 error while writting data
*/
int serialib::writeBytes(const void *Buffer, const unsigned int NbBytes)
{
#if defined (_WIN32) || defined( _WIN64)
// Number of bytes written
DWORD dwBytesWritten;
// Write data
if(!WriteFile(hSerial, Buffer, NbBytes, &dwBytesWritten, NULL))
// Error while writing, return -1
return -1;
// Write operation successfull
return 1;
#endif
#if defined (__linux__) || defined(__APPLE__)
// Write data
if (write (fd,Buffer,NbBytes)!=(ssize_t)NbBytes) return -1;
// Write operation successfull
return 1;
#endif
}
/*!
\brief Wait for a byte from the serial device and return the data read
\param pByte : data read on the serial device
\param timeOut_ms : delay of timeout before giving up the reading
If set to zero, timeout is disable (Optional)
\return 1 success
\return 0 Timeout reached
\return -1 error while setting the Timeout
\return -2 error while reading the byte
*/
int serialib::readChar(char *pByte,unsigned int timeOut_ms)
{
#if defined (_WIN32) || defined(_WIN64)
// Number of bytes read
DWORD dwBytesRead = 0;
// Set the TimeOut
timeouts.ReadTotalTimeoutConstant=timeOut_ms;
// Write the parameters, return -1 if an error occured
if(!SetCommTimeouts(hSerial, &timeouts)) return -1;
// Read the byte, return -2 if an error occured
if(!ReadFile(hSerial,pByte, 1, &dwBytesRead, NULL)) return -2;
// Return 0 if the timeout is reached
if (dwBytesRead==0) return 0;
// The byte is read
return 1;
#endif
#if defined (__linux__) || defined(__APPLE__)
// Timer used for timeout
timeOut timer;
// Initialise the timer
timer.initTimer();
// While Timeout is not reached
while (timer.elapsedTime_ms()<timeOut_ms || timeOut_ms==0)
{
// Try to read a byte on the device
switch (read(fd,pByte,1)) {
case 1 : return 1; // Read successfull
case -1 : return -2; // Error while reading
}
}
return 0;
#endif
}
/*!
\brief Read a string from the serial device (without TimeOut)
\param receivedString : string read on the serial device
\param FinalChar : final char of the string
\param MaxNbBytes : maximum allowed number of bytes read
\return >0 success, return the number of bytes read
\return -1 error while setting the Timeout
\return -2 error while reading the byte
\return -3 MaxNbBytes is reached
*/
int serialib::readStringNoTimeOut(char *receivedString,char finalChar,unsigned int maxNbBytes)
{
// Number of characters read
unsigned int NbBytes=0;
// Returned value from Read
char charRead;
// While the buffer is not full
while (NbBytes<maxNbBytes)
{
// Read a character with the restant time
charRead=readChar(&receivedString[NbBytes]);
// Check a character has been read
if (charRead==1)
{
// Check if this is the final char
if (receivedString[NbBytes]==finalChar)
{
// This is the final char, add zero (end of string)
receivedString [++NbBytes]=0;
// Return the number of bytes read
return NbBytes;
}
// The character is not the final char, increase the number of bytes read
NbBytes++;
}
// An error occured while reading, return the error number
if (charRead<0) return charRead;
}
// Buffer is full : return -3
return -3;
}
/*!
\brief Read a string from the serial device (with timeout)
\param receivedString : string read on the serial device
\param finalChar : final char of the string
\param maxNbBytes : maximum allowed number of characters read
\param timeOut_ms : delay of timeout before giving up the reading (optional)
\return >0 success, return the number of bytes read (including the null character)
\return 0 timeout is reached
\return -1 error while setting the Timeout
\return -2 error while reading the character
\return -3 MaxNbBytes is reached
*/
int serialib::readString(char *receivedString,char finalChar,unsigned int maxNbBytes,unsigned int timeOut_ms)
{
// Check if timeout is requested
if (timeOut_ms==0) return readStringNoTimeOut(receivedString,finalChar,maxNbBytes);
// Number of bytes read
unsigned int nbBytes=0;
// Character read on serial device
char charRead;
// Timer used for timeout
timeOut timer;
long int timeOutParam;
// Initialize the timer (for timeout)
timer.initTimer();
// While the buffer is not full
while (nbBytes<maxNbBytes)
{
// Compute the TimeOut for the next call of ReadChar
timeOutParam = timeOut_ms-timer.elapsedTime_ms();
// If there is time remaining
if (timeOutParam>0)
{
// Wait for a byte on the serial link with the remaining time as timeout
charRead=readChar(&receivedString[nbBytes],timeOutParam);
// If a byte has been received
if (charRead==1)
{
// Check if the character received is the final one
if (receivedString[nbBytes]==finalChar)
{
// Final character: add the end character 0
receivedString [++nbBytes]=0;
// Return the number of bytes read
return nbBytes;
}
// This is not the final character, just increase the number of bytes read
nbBytes++;
}
// Check if an error occured during reading char
// If an error occurend, return the error number
if (charRead<0) return charRead;
}
// Check if timeout is reached
if (timer.elapsedTime_ms()>timeOut_ms)
{
// Add the end caracter
receivedString[nbBytes]=0;
// Return 0 (timeout reached)
return 0;
}
}
// Buffer is full : return -3
return -3;
}
/*!
\brief Read an array of bytes from the serial device (with timeout)
\param buffer : array of bytes read from the serial device
\param maxNbBytes : maximum allowed number of bytes read
\param timeOut_ms : delay of timeout before giving up the reading
\param sleepDuration_us : delay of CPU relaxing in microseconds (Linux only)
In the reading loop, a sleep can be performed after each reading
This allows CPU to perform other tasks
\return >=0 return the number of bytes read before timeout or
requested data is completed
\return -1 error while setting the Timeout
\return -2 error while reading the byte
*/
int serialib::readBytes (void *buffer,unsigned int maxNbBytes,unsigned int timeOut_ms, unsigned int sleepDuration_us)
{
#if defined (_WIN32) || defined(_WIN64)
// Avoid warning while compiling
UNUSED(sleepDuration_us);
// Number of bytes read
DWORD dwBytesRead = 0;
// Set the TimeOut
timeouts.ReadTotalTimeoutConstant=(DWORD)timeOut_ms;
// Write the parameters and return -1 if an error occrured
if(!SetCommTimeouts(hSerial, &timeouts)) return -1;
// Read the bytes from the serial device, return -2 if an error occured
if(!ReadFile(hSerial,buffer,(DWORD)maxNbBytes,&dwBytesRead, NULL)) return -2;
// Return the byte read
return dwBytesRead;
#endif
#if defined (__linux__) || defined(__APPLE__)
// Timer used for timeout
timeOut timer;
// Initialise the timer
timer.initTimer();
unsigned int NbByteRead=0;
// While Timeout is not reached
while (timer.elapsedTime_ms()<timeOut_ms || timeOut_ms==0)
{
// Compute the position of the current byte
unsigned char* Ptr=(unsigned char*)buffer+NbByteRead;
// Try to read a byte on the device
int Ret=read(fd,(void*)Ptr,maxNbBytes-NbByteRead);
// Error while reading
if (Ret==-1) return -2;
// One or several byte(s) has been read on the device
if (Ret>0)
{
// Increase the number of read bytes
NbByteRead+=Ret;
// Success : bytes has been read
if (NbByteRead>=maxNbBytes)
return NbByteRead;
}
// Suspend the loop to avoid charging the CPU
usleep (sleepDuration_us);
}
// Timeout reached, return the number of bytes read
return NbByteRead;
#endif
}
// _________________________
// ::: Special operation :::
/*!
\brief Empty receiver buffer
Note that when using serial over USB on Unix systems, a delay of 20ms may be necessary before calling the flushReceiver function
\return If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero.
*/
char serialib::flushReceiver()
{
#if defined (_WIN32) || defined(_WIN64)
// Purge receiver
return PurgeComm (hSerial, PURGE_RXCLEAR);
#endif
#if defined (__linux__) || defined(__APPLE__)
// Purge receiver
tcflush(fd,TCIFLUSH);
return true;
#endif
}
/*!
\brief Return the number of bytes in the received buffer (UNIX only)
\return The number of bytes received by the serial provider but not yet read.
*/
int serialib::available()
{
#if defined (_WIN32) || defined(_WIN64)
// Device errors
DWORD commErrors;
// Device status
COMSTAT commStatus;
// Read status
ClearCommError(hSerial, &commErrors, &commStatus);
// Return the number of pending bytes
return commStatus.cbInQue;
#endif
#if defined (__linux__) || defined(__APPLE__)
int nBytes=0;
// Return number of pending bytes in the receiver
ioctl(fd, FIONREAD, &nBytes);
return nBytes;
#endif
}
// __________________
// ::: I/O Access :::
/*!
\brief Set or unset the bit DTR (pin 4)
DTR stands for Data Terminal Ready
Convenience method :This method calls setDTR and clearDTR
\param status = true set DTR
status = false unset DTR
\return If the function fails, the return value is false
If the function succeeds, the return value is true.
*/
bool serialib::DTR(bool status)
{
if (status)
// Set DTR
return this->setDTR();
else
// Unset DTR
return this->clearDTR();
}
/*!
\brief Set the bit DTR (pin 4)
DTR stands for Data Terminal Ready
\return If the function fails, the return value is false
If the function succeeds, the return value is true.
*/
bool serialib::setDTR()
{
#if defined (_WIN32) || defined(_WIN64)
// Set DTR
currentStateDTR=true;
return EscapeCommFunction(hSerial,SETDTR);
#endif
#if defined (__linux__) || defined(__APPLE__)
// Set DTR
int status_DTR=0;
ioctl(fd, TIOCMGET, &status_DTR);
status_DTR |= TIOCM_DTR;
ioctl(fd, TIOCMSET, &status_DTR);
return true;
#endif
}
/*!
\brief Clear the bit DTR (pin 4)
DTR stands for Data Terminal Ready
\return If the function fails, the return value is false
If the function succeeds, the return value is true.
*/
bool serialib::clearDTR()
{
#if defined (_WIN32) || defined(_WIN64)
// Clear DTR
currentStateDTR=true;
return EscapeCommFunction(hSerial,CLRDTR);
#endif
#if defined (__linux__) || defined(__APPLE__)
// Clear DTR
int status_DTR=0;
ioctl(fd, TIOCMGET, &status_DTR);
status_DTR &= ~TIOCM_DTR;
ioctl(fd, TIOCMSET, &status_DTR);
return true;
#endif
}
/*!
\brief Set or unset the bit RTS (pin 7)
RTS stands for Data Termina Ready
Convenience method :This method calls setDTR and clearDTR
\param status = true set DTR
status = false unset DTR
\return false if the function fails
\return true if the function succeeds
*/
bool serialib::RTS(bool status)
{
if (status)
// Set RTS
return this->setRTS();
else
// Unset RTS
return this->clearRTS();
}
/*!
\brief Set the bit RTS (pin 7)
RTS stands for Data Terminal Ready
\return If the function fails, the return value is false
If the function succeeds, the return value is true.
*/
bool serialib::setRTS()
{
#if defined (_WIN32) || defined(_WIN64)
// Set RTS
currentStateRTS=false;
return EscapeCommFunction(hSerial,SETRTS);
#endif
#if defined (__linux__) || defined(__APPLE__)
// Set RTS
int status_RTS=0;
ioctl(fd, TIOCMGET, &status_RTS);
status_RTS |= TIOCM_RTS;
ioctl(fd, TIOCMSET, &status_RTS);
return true;
#endif
}
/*!
\brief Clear the bit RTS (pin 7)
RTS stands for Data Terminal Ready
\return If the function fails, the return value is false
If the function succeeds, the return value is true.
*/
bool serialib::clearRTS()
{
#if defined (_WIN32) || defined(_WIN64)
// Clear RTS
currentStateRTS=false;
return EscapeCommFunction(hSerial,CLRRTS);
#endif
#if defined (__linux__) || defined(__APPLE__)
// Clear RTS
int status_RTS=0;
ioctl(fd, TIOCMGET, &status_RTS);
status_RTS &= ~TIOCM_RTS;
ioctl(fd, TIOCMSET, &status_RTS);
return true;
#endif
}
/*!
\brief Get the CTS's status (pin 8)
CTS stands for Clear To Send
\return Return true if CTS is set otherwise false
*/
bool serialib::isCTS()
{
#if defined (_WIN32) || defined(_WIN64)
DWORD modemStat;
GetCommModemStatus(hSerial, &modemStat);
return modemStat & MS_CTS_ON;
#endif
#if defined (__linux__) || defined(__APPLE__)
int status=0;
//Get the current status of the CTS bit
ioctl(fd, TIOCMGET, &status);
return status & TIOCM_CTS;
#endif
}
/*!
\brief Get the DSR's status (pin 6)
DSR stands for Data Set Ready
\return Return true if DTR is set otherwise false
*/
bool serialib::isDSR()
{
#if defined (_WIN32) || defined(_WIN64)
DWORD modemStat;
GetCommModemStatus(hSerial, &modemStat);
return modemStat & MS_DSR_ON;
#endif
#if defined (__linux__) || defined(__APPLE__)
int status=0;
//Get the current status of the DSR bit
ioctl(fd, TIOCMGET, &status);
return status & TIOCM_DSR;
#endif
}
/*!
\brief Get the DCD's status (pin 1)
CDC stands for Data Carrier Detect
\return true if DCD is set
\return false otherwise
*/
bool serialib::isDCD()
{
#if defined (_WIN32) || defined(_WIN64)
DWORD modemStat;
GetCommModemStatus(hSerial, &modemStat);
return modemStat & MS_RLSD_ON;
#endif
#if defined (__linux__) || defined(__APPLE__)
int status=0;
//Get the current status of the DCD bit
ioctl(fd, TIOCMGET, &status);
return status & TIOCM_CAR;
#endif
}
/*!
\brief Get the RING's status (pin 9)
Ring Indicator
\return Return true if RING is set otherwise false
*/
bool serialib::isRI()
{
#if defined (_WIN32) || defined(_WIN64)
DWORD modemStat;
GetCommModemStatus(hSerial, &modemStat);