typedefs in seperate file

Author: bertmelis

src/ModbusMessage.h

@@ -27,32 +27,9 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #include <stdint.h>  // for uint*_t
 #include <stddef.h>  // for size_t
 
-enum MBFunctionCode : uint8_t {
-  READ_COIL            = 0x01,
-  READ_DISC_INPUT      = 0x02,
-  READ_HOLD_REGISTER   = 0x03,
-  READ_INPUT_REGISTER  = 0x04,
-  WRITE_COIL           = 0x05,
-  WRITE_HOLD_REGISTER  = 0x06,
-  WRITE_MULT_COILS     = 0x0F,
-  WRITE_MULT_REGISTERS = 0x10
-};
+#include "esp32ModbusTypeDefs.h"
 
-enum MBError : uint8_t {
-  SUCCES                = 0x00,
-  ILLEGAL_FUNCTION      = 0x01,
-  ILLEGAL_DATA_ADDRESS  = 0x02,
-  ILLEGAL_DATA_VALUE    = 0x03,
-  SERVER_DEVICE_FAILURE = 0x04,
-  ACKNOWLEDGE           = 0x05,
-  SERVER_DEVICE_BUSY    = 0x06,
-  NEGATIVE_ACKNOWLEDGE  = 0x07,
-  MEMORY_PARITY_ERROR   = 0x08,
-  TIMEOUT               = 0xE0,
-  INVALID_SLAVE         = 0xE1,
-  INVALID_FUNCTION      = 0xE2,
-  CRC_ERROR             = 0xE3
-};
+using namespace esp32Modbus;  // NOLINT
 
 class ModbusMessage {
  public:

src/esp32ModbusRTU.h

@@ -41,10 +41,10 @@ extern "C" {
 #include <HardwareSerial.h>
 #include <esp32-hal-gpio.h>
 
+#include "esp32ModbusTypeDefs.h"
 #include "ModbusMessage.h"
 
-typedef std::function<void(uint8_t, MBFunctionCode, uint8_t*, uint16_t)> MBOnData;
-typedef std::function<void(MBError)> MBOnError;
+using namespace esp32Modbus;  // NOLINT
 
 class esp32ModbusRTU {
  public:

src/esp32ModbusTypeDefs.h

@@ -0,0 +1,63 @@
+/* esp32ModbusTypedefs
+
+Copyright 2018 Bert Melis
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+#pragma once
+
+#include <stdint.h>  // for uint*_t
+#include <functional>  // for std::function
+
+namespace esp32Modbus {
+
+enum MBFunctionCode : uint8_t {
+  READ_COIL            = 0x01,
+  READ_DISC_INPUT      = 0x02,
+  READ_HOLD_REGISTER   = 0x03,
+  READ_INPUT_REGISTER  = 0x04,
+  WRITE_COIL           = 0x05,
+  WRITE_HOLD_REGISTER  = 0x06,
+  WRITE_MULT_COILS     = 0x0F,
+  WRITE_MULT_REGISTERS = 0x10
+};
+
+enum MBError : uint8_t {
+  SUCCES                = 0x00,
+  ILLEGAL_FUNCTION      = 0x01,
+  ILLEGAL_DATA_ADDRESS  = 0x02,
+  ILLEGAL_DATA_VALUE    = 0x03,
+  SERVER_DEVICE_FAILURE = 0x04,
+  ACKNOWLEDGE           = 0x05,
+  SERVER_DEVICE_BUSY    = 0x06,
+  NEGATIVE_ACKNOWLEDGE  = 0x07,
+  MEMORY_PARITY_ERROR   = 0x08,
+  TIMEOUT               = 0xE0,
+  INVALID_SLAVE         = 0xE1,
+  INVALID_FUNCTION      = 0xE2,
+  CRC_ERROR             = 0xE3,  // only for Modbus-RTU
+  COMM_ERROR            = 0xE4  // general communication error
+};
+
+typedef std::function<void(uint8_t, MBFunctionCode, uint8_t*, uint16_t)> MBOnData;
+typedef std::function<void(MBError)> MBOnError;
+
+}  // namespace esp32Modbus