forked from PlusToolkit/ndicapi
/
ndicapi_serial.h
258 lines (199 loc) · 9 KB
/
ndicapi_serial.h
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
/*=======================================================================
Program: NDI Combined API C Interface Library
Module: $RCSfile: ndicapi_serial.h,v $
Creator: David Gobbi <dgobbi@atamai.com>
Language: C
Author: $Author: kcharbon $
Date: $Date: 2008/06/18 15:33:20 $
Version: $Revision: 1.6 $
==========================================================================
Copyright (c) 2000-2005 Atamai, Inc.
Use, modification and redistribution of the software, in source or
binary forms, are permitted provided that the following terms and
conditions are met:
1) Redistribution of the source code, in verbatim or modified
form, must retain the above copyright notice, this license,
the following disclaimer, and any notices that refer to this
license and/or the following disclaimer.
2) Redistribution in binary form must include the above copyright
notice, a copy of this license and the following disclaimer
in the documentation or with other materials provided with the
distribution.
3) Modified copies of the source code must be clearly marked as such,
and must not be misrepresented as verbatim copies of the source code.
THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS"
WITHOUT EXPRESSED OR IMPLIED WARRANTY INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. IN NO EVENT SHALL ANY COPYRIGHT HOLDER OR OTHER PARTY WHO MAY
MODIFY AND/OR REDISTRIBUTE THE SOFTWARE UNDER THE TERMS OF THIS LICENSE
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, LOSS OF DATA OR DATA BECOMING INACCURATE
OR LOSS OF PROFIT OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF
THE USE OR INABILITY TO USE THE SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
=======================================================================*/
/*! \file ndicapi_serial.h
This file contains the platform-dependent portions of the
NDICAPI C API that talk to the serial port.
*/
#ifndef NDICAPI_SERIAL_H
#define NDICAPI_SERIAL_H
#include "ndicapiExport.h"
/*=====================================================================*/
/*! \defgroup NDISerial NDI Serial Methods
These are low-level methods that provide a platform-independent
interface to the serial port.
*/
#ifdef __cplusplus
extern "C" {
#endif
/*! \ingroup NDISerial
\typedef NDIFileHandle
The serial port handle is a platform-specific type, for which we use
the typedef NDIFileHandle. On UNIX it is an int.
*/
#ifdef _WIN32
#define _WINSOCKAPI_
#include <windows.h>
typedef HANDLE NDIFileHandle;
#define NDI_INVALID_HANDLE INVALID_HANDLE_VALUE
#elif defined(linux) || defined(__linux__)
typedef int NDIFileHandle;
#define NDI_INVALID_HANDLE -1
#define NDI_DEVICE0 "/dev/ttyS0"
#define NDI_DEVICE1 "/dev/ttyS1"
#define NDI_DEVICE2 "/dev/ttyUSB0"
#define NDI_DEVICE3 "/dev/ttyUSB1"
#define NDI_DEVICE4 "/dev/ttyUSB2"
#define NDI_DEVICE5 "/dev/ttyUSB3"
#define NDI_DEVICE6 "/dev/ttyUSB4"
#define NDI_DEVICE7 "/dev/ttyUSB5"
#elif defined(__APPLE__)
typedef int NDIFileHandle;
#define NDI_INVALID_HANDLE -1
#elif defined(sgi)
typedef int NDIFileHandle;
#define NDI_INVALID_HANDLE -1
#define NDI_DEVICE0 "/dev/ttyd1"
#define NDI_DEVICE1 "/dev/ttyd2"
#define NDI_DEVICE2 "/dev/ttyd3"
#define NDI_DEVICE3 "/dev/ttyd4"
#define NDI_DEVICE4 "/dev/ttyd5"
#define NDI_DEVICE5 "/dev/ttyd6"
#define NDI_DEVICE6 "/dev/ttyd7"
#define NDI_DEVICE7 "/dev/ttyd8"
#elif defined(macintosh)
typedef long NDIFileHandle;
#define NDI_INVALID_HANDLE -1
/* macros to extract input and output file handles */
#define output_file(serial_port) ((short)((serial_port & 0xff00) >> 16));
#define input_file(serial_port) ((short)((serial_port & 0x00ff) >> 0));
#define NDI_DEVICE0 "\p.A"
#define NDI_DEVICE1 "\p.B"
#endif
/*! \ingroup NDISerial
Open the specified serial port device.
A return value of NDI_INVALID_HANDLE means that an error occurred.
The serial port will be set to 9600 baud, 8N1, no handshake.
The macros NDI_DEVICE0 through NDI_DEVICE3 will expand to valid device
names for the first four serial ports, e.g. "/dev/ttyS0" on linux.
The type of the handle is platform-specific.
*/
ndicapiExport NDIFileHandle ndiSerialOpen(const char* device);
/*! \ingroup NDISerial
Close the serial port. It is wise to send a "COMM 00000\r" command
to the NDICAPI before you close the port, otherwise the next time the
serial port is opened you will have to reset the NDICAPI before you can
resume communication with it.
*/
ndicapiExport void ndiSerialClose(NDIFileHandle serial_port);
/*! \ingroup NDISerial
Check whether the DSR signel is set. If the return value is zero,
then the DSR is not set which means that either the device has been
unplugged from the serial port or has been turned off.
*/
ndicapiExport int ndiSerialCheckDSR(NDIFileHandle serial_port);
/*! \ingroup NDISerial
Send a 300ms break to the serial port to reset the NDICAPI.
After you call this function, you must also call
ndiSerialComm(file, 9600, "8N1", 0) to reset the
serial port back to the default NDICAPI communication parameters.
The NDICAPI will beep and send the text "RESETBE6F\r", which
must be read with ndiSerialRead().
The return value of this function will be if the call was successful.
A negative return value means that an IO error occurred.
*/
ndicapiExport int ndiSerialBreak(NDIFileHandle serial_port);
/*! \ingroup NDISerial
Flush out the serial I/O buffers. The following options are available:
- NDI_IFLUSH: discard the contents of the input buffer
- NDI_OFLUSH: discard the contents of the output buffer
- NDI_IOFLUSH: discard the contents of both buffers.
<p>The return value of this function will be if the call was successful.
A negative return value means that an IO error occurred.
*/
ndicapiExport int ndiSerialFlush(NDIFileHandle serial_port, int flushtype);
#define NDI_IFLUSH 0x1
#define NDI_OFLUSH 0x2
#define NDI_IOFLUSH 0x3
/*! \ingroup NDISerial
Change the baud rate and other comm parameters.
The baud rate should be one of 9600, 14400, 19200, 38400, 57600, 115200.
The mode string should be one of "8N1", "7O2" etc. The first character
is the number of data bits (7 or 8), the second character is the parity
(N, O or E for none, odd or even), and the the third character is the
number of stop bits (1 or 2).
The handshake value should be 0 or 1 depending on whether hardware
handshaking is desired.
The default setting for the NDICAPI (i.e. after a power-on or a reset)
is (9600, "8N1", 0). A commonly used setting is (115200, "8N1", 1).
Before this function is called you should send a COMM command to the
ndicapi and read the "OKAY" reply.
The return value will be 0 if the call was successful.
A negative return value means that an IO error occurred, or that
the specified parameters are not available for this serial port.
*/
ndicapiExport int ndiSerialComm(NDIFileHandle serial_port, int baud, const char* mode,
int handshake);
/*! \ingroup NDISerial
Change the timeout for the serial port in milliseconds.
The default is 5 seconds, but this might be too long for certain
applications.
The return value will be 0 if the call was successful.
A negative return value signals failure.
*/
ndicapiExport int ndiSerialTimeout(NDIFileHandle serial_port, int milliseconds);
/*! \ingroup NDISerial
Write a stream of 'n' characters from the string 'text' to the serial
port. The number of characters actually written is returned.
The NDICAPI expects all commands to end with a carriage return.
The serial port input buffers are flushed before the information is
written, because leftover bytes in the input buffer are likely due
to an error on a previous communication.
If the return value is negative, then an IO error occurred.
If the return value is less than 'n', then a timeout error occurred.
*/
ndicapiExport int ndiSerialWrite(NDIFileHandle serial_port, const char* text, int n);
/*! \ingroup NDISerial
Read characters from the serial port until a carriage return is
received. A maximum of 'n' characters will be read. The number
of characters actually read is returned. The resulting string will
not be null-terminated.
If the return value is negative, then an IO error occurred.
If the return value is zero, then a timeout error occurred.
If the return value is equal to 'n' and the final character
is not a carriage return (i.e. reply[n-1] != '\r'), then the
read was incomplete and there are more characters waiting to
be read.
*/
ndicapiExport int ndiSerialRead(NDIFileHandle serial_port, char* reply, int n, bool isBinary, int* errorCode);
/*! \ingroup NDISerial
Sleep for the specified number of milliseconds. The actual sleep time
is likely to last for 10ms longer than the specifed time due to
task scheduling overhead. The return value is always zero.
*/
ndicapiExport int ndiSerialSleep(NDIFileHandle serial_port, int milliseconds);
#ifdef __cplusplus
}
#endif
#endif