Hamlib  3.0.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
serial.h
1 /*
2  * Hamlib Interface - serial communication header
3  * Copyright (c) 2000-2005 by Stephane Fillod and Frank Singleton
4  *
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  *
20  */
21 
22 #ifndef _SERIAL_H
23 #define _SERIAL_H 1
24 
25 #include <hamlib/rig.h>
26 #include "iofunc.h"
27 
28 __BEGIN_DECLS
29 
30 extern HAMLIB_EXPORT(int) serial_open(hamlib_port_t *rs);
31 extern HAMLIB_EXPORT(int) serial_setup(hamlib_port_t *rs);
32 extern HAMLIB_EXPORT(int) serial_flush(hamlib_port_t *p);
33 
34 /* Hamlib internal use, see rig.c */
35 int ser_open(hamlib_port_t *p);
36 int ser_close(hamlib_port_t *p);
37 extern HAMLIB_EXPORT(int) ser_set_rts(hamlib_port_t *p, int state);
38 extern HAMLIB_EXPORT(int) ser_get_rts(hamlib_port_t *p, int *state);
39 extern HAMLIB_EXPORT(int) ser_set_brk(hamlib_port_t *p, int state);
40 extern HAMLIB_EXPORT(int) ser_set_dtr(hamlib_port_t *p, int state);
41 extern HAMLIB_EXPORT(int) ser_get_dtr(hamlib_port_t *p, int *state);
42 extern HAMLIB_EXPORT(int) ser_get_cts(hamlib_port_t *p, int *state);
43 extern HAMLIB_EXPORT(int) ser_get_dsr(hamlib_port_t *p, int *state);
44 extern HAMLIB_EXPORT(int) ser_get_car(hamlib_port_t *p, int *state);
45 
46 __END_DECLS
47 
48 #endif /* _SERIAL_H */
int serial_setup(hamlib_port_t *rs)
Set up Serial port according to requests in port.
Definition: serial.c:128
int ser_get_rts(hamlib_port_t *p, int *state)
Get RTS bit.
Definition: serial.c:463
int ser_set_rts(hamlib_port_t *p, int state)
Set Request to Send (RTS) bit.
Definition: serial.c:430
int serial_open(hamlib_port_t *rs)
Open serial port using rig.state data.
Definition: serial.c:90
int ser_open(hamlib_port_t *p)
Open serial port.
Definition: serial.c:409
int serial_flush(hamlib_port_t *p)
Flush all characters waiting in RX buffer.
Definition: serial.c:397
int ser_get_dsr(hamlib_port_t *p, int *state)
Get Data Set Ready (DSR) bit.
Definition: serial.c:577
Hamlib rig data structures.
int ser_get_cts(hamlib_port_t *p, int *state)
Get Clear to Send (CTS) bit.
Definition: serial.c:561
int ser_set_brk(hamlib_port_t *p, int state)
Set Break.
Definition: serial.c:530
int ser_get_dtr(hamlib_port_t *p, int *state)
Get DTR bit.
Definition: serial.c:513
int ser_get_car(hamlib_port_t *p, int *state)
Get Carrier (CI?) bit.
Definition: serial.c:545
Port definition.
Definition: rig.h:1338
int ser_set_dtr(hamlib_port_t *p, int state)
Set Data Terminal Ready (DTR) bit.
Definition: serial.c:480
int ser_close(hamlib_port_t *p)
Close serial port.
Definition: serial.c:419

Generated by doxygen 1.8.8

Hamlib documentation for version 3.0.1 -- Wed Jan 13 2016 15:05:23
Project page: http://www.hamlib.org