OceanDirectLighthouseC++  3.1.1
OceanDirect Lighthouse C++/C API
SerialPortAPI.h
1 /*****************************************************
2  * @file SerialPortAPI.h
3  * @date April 2021
4  * @author Ocean Insight, Inc.
5  *
6  * This is an interface to OceanDirect that allows
7  * the user to read and write serial port baud rate to device.
8  * This is intended as a usable and extensible API.
9  */
10  /************************************************************************
11  *
12  * OCEAN INSIGHT CONFIDENTIAL
13  * __________________
14  *
15  * [2018] - [2021] Ocean Insight Incorporated
16  * All Rights Reserved.
17  *
18  * NOTICE: All information contained herein is, and remains
19  * the property of Ocean Insight Incorporated and its suppliers,
20  * if any. The intellectual and technical concepts contained
21  * herein are proprietary to Ocean Insight Incorporated
22  * and its suppliers and may be covered by U.S. and Foreign Patents,
23  * patents in process, and are protected by trade secret or copyright law.
24  * Dissemination of this information or reproduction of this material
25  * is strictly forbidden unless prior written permission is obtained
26  * from Ocean Insight Incorporated.
27  *
28  **************************************************************************/
29 
30 #ifndef SERIAL_PORT_API_H
31 #define SERIAL_PORT_API_H
32 
33 #include "api/DllDecl.h"
34 #include <cstdint>
35 
42 namespace oceandirect {
43  namespace api {
44 
45  class DLL_DECL SerialPortAPI {
46  public:
47  SerialPortAPI();
48  virtual ~SerialPortAPI();
49  static SerialPortAPI *getInstance();
50 
51  static void shutdown();
52 
64  virtual int getBaudRate(long deviceID, int *errorCode);
65 
77  virtual void setBaudRate(long deviceID, int *errorCode, int baudRate);
78 
89  virtual void saveSettingsToFlash(long deviceID, int *errorCode);
90 
102  virtual std::uint8_t getSerialCommThresholdMode(long deviceID, int* errorCode);
103 
115  virtual void setSerialCommThresholdMode(long deviceID, int* errorCode, std::uint8_t thresholdMode);
116  protected:
117  static SerialPortAPI *instance;
118  };
119  }
120 }
121 #endif /* SERIAL_PORT_API_H */
Definition: SerialPortAPI.h:45
virtual void saveSettingsToFlash(long deviceID, int *errorCode)
virtual void setBaudRate(long deviceID, int *errorCode, int baudRate)
virtual int getBaudRate(long deviceID, int *errorCode)
virtual std::uint8_t getSerialCommThresholdMode(long deviceID, int *errorCode)
virtual void setSerialCommThresholdMode(long deviceID, int *errorCode, std::uint8_t thresholdMode)
This is an interface to OceanDirect that allows the user to connect to devices over USB and other bus...
Definition: OceanDirectAPI.h:147