Added .clang-format for consistent formatting (#36)

See https://zed0.co.uk/clang-format-configurator/ for available options

Author: Yannick Schinko

.clang-format

@@ -0,0 +1,19 @@
+---
+BasedOnStyle: LLVM
+Language: Cpp
+AlignConsecutiveAssignments: true
+AlignConsecutiveDeclarations: true
+AlignConsecutiveMacros: true
+AlignEscapedNewlines: Left
+AlignOperands: true
+AlignTrailingComments: true
+AllowShortBlocksOnASingleLine: false
+AllowShortFunctionsOnASingleLine: false
+AlwaysBreakTemplateDeclarations: true
+BreakBeforeBraces: Allman
+ColumnLimit: 160
+IndentWidth: 4
+MaxEmptyLinesToKeep: 2
+PointerAlignment: Left
+TabWidth: 4
+UseTab: ForIndentation

src/I2CTransfer.cpp

@@ -1,8 +1,6 @@
 #include "I2CTransfer.h"
 
 
-
-
 /*
  void I2CTransfer::begin(TwoWire &_port, configST configs)
  Description:
@@ -17,16 +15,14 @@
  -------
   * void
 */
-void I2CTransfer::begin(TwoWire &_port, const configST configs)
+void I2CTransfer::begin(TwoWire& _port, const configST configs)
 {
 	port = &_port;
 	port->onReceive(processData);
 	packet.begin(configs);
 }
 
 
-
-
 /*
  void I2CTransfer::begin(TwoWire &_port, const bool _debug, Stream &_debugPort)
  Description:
@@ -41,15 +37,13 @@ void I2CTransfer::begin(TwoWire &_port, const configST configs)
  -------
   * void
 */
-void I2CTransfer::begin(TwoWire &_port, const bool _debug, Stream &_debugPort)
+void I2CTransfer::begin(TwoWire& _port, const bool _debug, Stream& _debugPort)
 {
 	port = &_port;
 	packet.begin(_debug, _debugPort);
 }
 
 
-
-
 /*
  uint8_t I2CTransfer::sendData(const uint16_t &messageLen, const uint8_t &packetID, const uint8_t &targetAddress=0)
  Description:
@@ -61,12 +55,12 @@ void I2CTransfer::begin(TwoWire &_port, const bool _debug, Stream &_debugPort)
   to send as the payload in the next packet
   * const uint8_t &packetID - The packet 8-bit identifier
   * const uint8_t &targetAddress - I2C address to the device the packet
-	  will be transmitted to
+      will be transmitted to
  Return:
  -------
   * uint8_t numBytesIncl - Number of payload bytes included in packet
 */
-uint8_t I2CTransfer::sendData(const uint16_t &messageLen, const uint8_t &packetID, const uint8_t &targetAddress)
+uint8_t I2CTransfer::sendData(const uint16_t& messageLen, const uint8_t& packetID, const uint8_t& targetAddress)
 {
 	uint8_t numBytesIncl;
 
@@ -82,8 +76,6 @@ uint8_t I2CTransfer::sendData(const uint16_t &messageLen, const uint8_t &packetI
 }
 
 
-
-
 /*
  void I2CTransfer::processData(int numBytes)
  Description:
@@ -101,18 +93,16 @@ void I2CTransfer::processData(int numBytes)
 {
 	uint8_t recChar;
 	classToUse->bytesRead = 0;
-	
+
 	while (classToUse->port->available())
 	{
-		recChar = classToUse->port->read();
+		recChar               = classToUse->port->read();
 		classToUse->bytesRead = classToUse->packet.parse(recChar);
-		classToUse->status = classToUse->packet.status;
+		classToUse->status    = classToUse->packet.status;
 	}
 }
 
 
-
-
 /*
  uint8_t I2CTransfer::currentPacketID()
  Description:
@@ -131,6 +121,4 @@ uint8_t I2CTransfer::currentPacketID()
 }
 
 
-
-
 I2CTransfer* I2CTransfer::classToUse = NULL;

src/I2CTransfer.h

@@ -1,31 +1,28 @@
 #pragma once
 #include "Arduino.h"
-#include "Wire.h"
 #include "Packet.h"
-
-
+#include "Wire.h"
 
 
 class I2CTransfer
 {
-public: // <<---------------------------------------//public
-	Packet packet;
+  public: // <<---------------------------------------//public
+	Packet              packet;
 	static I2CTransfer* classToUse;
-	uint8_t bytesRead = 0;
-	int8_t status = 0;
-
+	uint8_t             bytesRead = 0;
+	int8_t              status    = 0;
 
 
-
-	I2CTransfer() { classToUse = this; };
-	void begin(TwoWire &_port, const configST configs);
-	void begin(TwoWire &_port, const bool _debug=true, Stream &_debugPort=Serial);
-	uint8_t sendData(const uint16_t &messageLen, const uint8_t &packetID=0, const uint8_t &targetAddress=0);
+	I2CTransfer()
+	{
+		classToUse = this;
+	};
+	void    begin(TwoWire& _port, const configST configs);
+	void    begin(TwoWire& _port, const bool _debug = true, Stream& _debugPort = Serial);
+	uint8_t sendData(const uint16_t& messageLen, const uint8_t& packetID = 0, const uint8_t& targetAddress = 0);
 	uint8_t currentPacketID();
 
 
-
-
 	/*
 	 uint16_t I2CTransfer::txObj(const T &val, const uint16_t &index=0, const uint16_t &len=sizeof(T))
 	 Description:
@@ -46,14 +43,12 @@ class I2CTransfer
 	  by the calling of this member function
 	*/
 	template <typename T>
-	uint16_t txObj(const T &val, const uint16_t &index=0, const uint16_t &len=sizeof(T))
+	uint16_t txObj(const T& val, const uint16_t& index = 0, const uint16_t& len = sizeof(T))
 	{
 		return packet.txObj(val, index, len);
 	}
 
 
-
-
 	/*
 	 uint16_t I2CTransfer::rxObj(const T &val, const uint16_t &index=0, const uint16_t &len=sizeof(T))
 	 Description:
@@ -74,14 +69,12 @@ class I2CTransfer
 	  by the calling of this member function
 	*/
 	template <typename T>
-	uint16_t rxObj(const T &val, const uint16_t &index=0, const uint16_t &len=sizeof(T))
+	uint16_t rxObj(const T& val, const uint16_t& index = 0, const uint16_t& len = sizeof(T))
 	{
 		return packet.rxObj(val, index, len);
 	}
 
 
-
-
 	/*
 	 uint8_t I2CTransfer::sendDatum(const T &val, const uint8_t &packetID=0, const uint8_t &targetAddress=0, const uint16_t &len=sizeof(T))
 	 Description:
@@ -103,20 +96,15 @@ class I2CTransfer
 	  * uint8_t - Number of payload bytes included in packet
 	*/
 	template <typename T>
-	uint8_t sendDatum(const T &val, const uint8_t &packetID=0, const uint8_t &targetAddress=0, const uint16_t &len=sizeof(T))
+	uint8_t sendDatum(const T& val, const uint8_t& packetID = 0, const uint8_t& targetAddress = 0, const uint16_t& len = sizeof(T))
 	{
 		return sendData(packet.txObj(val, packetID, len), packetID, targetAddress);
 	}
 
 
-
-
-
-private: // <<---------------------------------------//private
+  private: // <<---------------------------------------//private
 	TwoWire* port;
 
 
-
-
 	static void processData(int numBytes);
 };