ngscopeclient 0.1-dev+51fbda87c
UART.h
Go to the documentation of this file.
1/***********************************************************************************************************************
2* *
3* ANTIKERNEL v0.1 *
4* *
5* Copyright (c) 2012-2016 Andrew D. Zonenberg *
6* All rights reserved. *
7* *
8* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the *
9* following conditions are met: *
10* *
11* * Redistributions of source code must retain the above copyright notice, this list of conditions, and the *
12* following disclaimer. *
13* *
14* * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the *
15* following disclaimer in the documentation and/or other materials provided with the distribution. *
16* *
17* * Neither the name of the author nor the names of any contributors may be used to endorse or promote products *
18* derived from this software without specific prior written permission. *
19* *
20* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
21* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
22* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES *
23* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR *
24* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
25* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE *
26* POSSIBILITY OF SUCH DAMAGE. *
27* *
28***********************************************************************************************************************/
29
36#ifndef UART_h
37#define UART_h
38
39#include "../log/log.h"
40#include <string>
41#include "Socket.h"
42
43#ifdef _WIN32
44
45typedef HANDLE FILE_DESCRIPTOR;
46#define INVALID_FILE_DESCRIPTOR INVALID_HANDLE_VALUE
47
48#else
49
50typedef int FILE_DESCRIPTOR;
51#define INVALID_FILE_DESCRIPTOR -1
52
53#endif
54
58class UART
59{
60public:
61
62 UART();
63 UART(const std::string& devfile, int baud);
64 bool Connect(const std::string& devfile, int baud, bool dtrEnable = false);
65 void Close();
66 virtual ~UART();
67
68 bool Read(unsigned char* data, int len);
69 bool Write(const unsigned char* data, int len);
70
71 FILE_DESCRIPTOR GetHandle()
72 { return m_fd; }
73
74 bool IsValid() const
75 {
76 if (m_networked)
77 return m_socket.IsValid();
78
79 return (m_fd != INVALID_FILE_DESCRIPTOR);
80 }
81
82protected:
83 bool m_networked;
84 FILE_DESCRIPTOR m_fd;
85 Socket m_socket;
86};
87
88#endif
Declaration of Socket class.
Class representing a network socket.
Definition: Socket.h:63
Wrapper class for a serial port.
Definition: UART.h:59
void Close()
Disconnects from the serial port.
Definition: UART.cpp:257
UART()
Constructor.
Definition: UART.cpp:84
virtual ~UART()
Destructor.
Definition: UART.cpp:95
bool Connect(const std::string &devfile, int baud, bool dtrEnable=false)
Connects to a serial port.
Definition: UART.cpp:108