OpenZWave Library 1.6.1914
Loading...
Searching...
No Matches
SerialController.h
Go to the documentation of this file.
1//-----------------------------------------------------------------------------
2//
3// SerialController.h
4//
5// Cross-platform serial port handler
6//
7// Copyright (c) 2010 Jason Frazier <frazierjason@gmail.com>
8//
9// SOFTWARE NOTICE AND LICENSE
10//
11// This file is part of OpenZWave.
12//
13// OpenZWave is free software: you can redistribute it and/or modify
14// it under the terms of the GNU Lesser General Public License as published
15// by the Free Software Foundation, either version 3 of the License,
16// or (at your option) any later version.
17//
18// OpenZWave is distributed in the hope that it will be useful,
19// but WITHOUT ANY WARRANTY; without even the implied warranty of
20// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21// GNU Lesser General Public License for more details.
22//
23// You should have received a copy of the GNU Lesser General Public License
24// along with OpenZWave. If not, see <http://www.gnu.org/licenses/>.
25//
26//-----------------------------------------------------------------------------
27
28#ifndef _SerialController_H
29#define _SerialController_H
30
31#include <string>
32#include "Defs.h"
33#include "platform/Controller.h"
34
35namespace OpenZWave
36{
37 namespace Internal
38 {
39 namespace Platform
40 {
41
42// class Driver;
43// class Msg;
44 class SerialControllerImpl;
45
50 {
52
53 public:
54 enum Parity
55 {
61 };
62
64 {
67 StopBits_Two = 2
68 };
69
75
80 virtual ~SerialController();
81
88 bool SetBaud(uint32 const _baud);
89
96 bool SetParity(Parity const _parity);
97
104 bool SetStopBits(StopBits const _stopBits);
105
113 bool Open(string const& _SerialControllerName);
114
121 bool Close();
122
131 uint32 Write(uint8* _buffer, uint32 _length);
132
133 private:
134 uint32 m_baud;
137 string m_serialControllerName;
138
139 OpenZWave::Internal::Platform::SerialControllerImpl* m_pImpl; // Pointer to an object that encapsulates the platform-specific implementation of the serial port.
140 bool m_bOpen;
141 };
142 } // namespace Platform
143 } // namespace Internal
144} // namespace OpenZWave
145
146#endif //_SerialController_H
147
unsigned int uint32
Definition Defs.h:91
unsigned char uint8
Definition Defs.h:85
Represents a USB Controller.
Definition Controller.h:59
Interface for controllers that implement a Serial Interface (USB Serial Port Emulation)
Definition SerialController.h:50
bool SetBaud(uint32 const _baud)
Definition SerialController.cpp:73
virtual ~SerialController()
Definition SerialController.cpp:63
uint32 Write(uint8 *_buffer, uint32 _length)
Definition SerialController.cpp:152
friend class SerialControllerImpl
Definition SerialController.h:51
bool SetStopBits(StopBits const _stopBits)
Definition SerialController.cpp:105
bool Close()
Definition SerialController.cpp:136
Parity
Definition SerialController.h:55
@ Parity_Space
Definition SerialController.h:60
@ Parity_None
Definition SerialController.h:56
@ Parity_Odd
Definition SerialController.h:57
@ Parity_Mark
Definition SerialController.h:59
@ Parity_Even
Definition SerialController.h:58
SerialController()
Definition SerialController.cpp:53
bool SetParity(Parity const _parity)
Definition SerialController.cpp:89
bool Open(string const &_SerialControllerName)
Definition SerialController.cpp:120
StopBits
Definition SerialController.h:64
@ StopBits_OneAndAHalf
Definition SerialController.h:66
@ StopBits_One
Definition SerialController.h:65
@ StopBits_Two
Definition SerialController.h:67
Definition Bitfield.cpp:31