Added new classes to support two way communications and extended messages and software reset

Author: j54n1n

avr/libraries/IntegerEasyTransfer/README.txt

@@ -1,5 +1,5 @@
 /*******************************************************************************
-*  IntegerEasyTransfer 1.0.0 library modified by Julian Sanin, sourced from:
+*  IntegerEasyTransfer 1.1.0 library modified by Julian Sanin, sourced from:
 *
 *  EasyTransfer Arduino Library v2.1
 *       details and example sketch: 
@@ -44,6 +44,9 @@
 *        The library supports a maximum of 20 uint8_t or 10 int16_t values.
 *        Mixed uint8_t and int16_t are allowed but care should be taken that the
 *        values do not overflow the data buffer.
+*   1.1.0
+*        Added new classes to support two way communications and extended
+*        messages and software reset.
 *
 *
 *  Limits of the Library

avr/libraries/IntegerEasyTransfer/examples/IntegerEasyTransfer_Interop_Example/IntegerEasyTransfer_Interop_Example.ino

@@ -0,0 +1,67 @@
+#include <TwoWayIntegerEasyTransfer.h>
+#include <IntegerEasyTransferFeatureManager.h>
+
+// New custom feature.
+struct MyFeature : public IntegerEasyTransferFeature {
+
+  enum {
+    MY_COMMAND = 0x0F,
+    // Add further commands if needed.
+  };
+
+  uint8_t data = 0x00;
+  
+  bool handleMessage(uint8_t command, IntegerEasyTransfer & request) {
+    // Filter commands that you are interested in.
+    switch(command) {
+    case MY_COMMAND:
+      data = request.readByte();
+      return true;
+    default:
+      // Got a message that is not handled by this feature.
+      return false;
+    }
+  }
+ 
+  void reset() {
+    data = 0x00;
+  }
+
+  void sendNewData() {
+    // Extended feature messages uses following format for sending data:
+    TwoWayIntegerEasyTransfer.writeByte(
+        TwoWayIntegerEasyTransfer.MESSAGE_FEATURE
+    );
+    TwoWayIntegerEasyTransfer.writeByte(MY_COMMAND);
+    TwoWayIntegerEasyTransfer.writeByte(++data);
+    TwoWayIntegerEasyTransfer.sendData();
+  } 
+};
+
+// Instance of the feature.
+MyFeature myFeature;
+
+// Create a instance of the feature manager.
+IntegerEasyTransferFeatureManager featureManager;
+
+void setup() {
+  // Begin communication channel.
+  Serial.begin(9600);
+  TwoWayIntegerEasyTransfer.begin(&Serial);
+  // Attach callbacks and add features.
+  TwoWayIntegerEasyTransfer.attach([]() { doSystemReset(); });
+  featureManager.addFeature(myFeature);
+  // Perform software reset manually.
+  doSystemReset();
+}
+
+void loop() {
+  // Keep message pumping up and running.
+  if (TwoWayIntegerEasyTransfer.hasReceivedData()) {
+    TwoWayIntegerEasyTransfer.processInput();
+  }
+}
+
+void doSystemReset() {
+  featureManager.reset();
+}

avr/libraries/IntegerEasyTransfer/keywords.txt

@@ -8,6 +8,12 @@
 #######################################
 
 IntegerEasyTransfer	KEYWORD1
+IntegerEasyTransferFeature	KEYWORD1
+IntegerEasyTransferFeatureManager	KEYWORD1
+TwoWayIntegerEasyTransfer	KEYWORD1
+DefaultMessageCallbackFunction	KEYWORD1
+FeatureMessageCallbackFunction	KEYWORD1
+SystemResetCallbackFunction	KEYWORD1
 
 #######################################
 # Methods and Functions (KEYWORD2)
@@ -20,7 +26,17 @@ writeByte	KEYWORD2
 writeInt	KEYWORD2
 readByte	KEYWORD2
 readInt	KEYWORD2
+sendSystemReset	KEYWORD2
+hasReceivedData	KEYWORD2
+processInput	KEYWORD2
+attach	KEYWORD2
+addFeature	KEYWORD2
+handleMessage	KEYWORD2
+reset	KEYWORD2
 
 #######################################
 # Constants (LITERAL1)
 #######################################
+
+MESSAGE_FEATURE LITERAL1
+MESSAGE_SYSTEM_RESET	LITERAL1

avr/libraries/IntegerEasyTransfer/library.properties

@@ -1,5 +1,5 @@
 name=IntegerEasyTransfer
-version=1.0.0
+version=1.1.0
 author=Bill Porter <bill@billporter.info>, Julian Sanin <sanin89julian@gmail.com>
 maintainer=Julian Sanin <sanin89julian@gmail.com>
 sentence=A library to interface Arduino boards.

avr/libraries/IntegerEasyTransfer/src/IntegerEasyTransferFeature.h

@@ -0,0 +1,63 @@
+/*
+ * Library for configurable and easy transfers.
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 Julian Sanin
+ *
+ * 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.
+ */
+
+#ifndef INTEGER_EASY_TRANSFER_FEATURE_H
+#define INTEGER_EASY_TRANSFER_FEATURE_H
+
+#include <stdint.h>
+
+class IntegerEasyTransfer;
+
+class IntegerEasyTransferFeature {
+
+	// Link to next feature item, used by FeatureManager.
+	IntegerEasyTransferFeature * _nextFeature = nullptr;
+	friend class IntegerEasyTransferFeatureManager;
+
+public:
+	/// <summary>
+	/// Handle the incoming request message.
+	/// </summary>
+	/// <param name="command">
+	/// The first command byte of the incoming request message.
+	/// </param>
+	/// <param name="request">
+	/// Further data messages of the incoming request.
+	/// </param>
+	/// <returns>
+	/// True if the message has been handled otherwise false.
+	/// </returns>
+	virtual bool handleMessage(
+		uint8_t command, IntegerEasyTransfer & request
+	) = 0;
+
+	/// <summary>
+	/// System reset command.
+	/// </summary>
+	virtual void reset() = 0;
+};
+
+#endif // INTEGER_EASY_TRANSFER_FEATURE_H

avr/libraries/IntegerEasyTransfer/src/IntegerEasyTransferFeatureManager.cpp

@@ -0,0 +1,81 @@
+/*
+ * Library for configurable and easy transfers.
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 Julian Sanin
+ *
+ * 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.
+ */
+
+#include "IntegerEasyTransferFeatureManager.h"
+#include "TwoWayIntegerEasyTransfer.h"
+
+static IntegerEasyTransferFeatureManager * _featureManager = nullptr;
+
+IntegerEasyTransferFeatureManager::IntegerEasyTransferFeatureManager()
+	: _features{ nullptr } {
+	_featureManager = this;
+	// Handle extended messages on connected features.
+	TwoWayIntegerEasyTransfer.attach(
+		[](IntegerEasyTransfer & request) {
+		if (_featureManager != nullptr) {
+			uint8_t extendedCommand = request.readByte();
+			if (!_featureManager->handleMessage(extendedCommand, request)) {
+				// TODO: Report unhandled message.
+			}
+		}
+	});
+}
+
+bool IntegerEasyTransferFeatureManager::handleMessage(
+	uint8_t command, IntegerEasyTransfer & request
+) {
+	IntegerEasyTransferFeature * selectedFeature = _features;
+	while (selectedFeature != nullptr) {
+		if (selectedFeature->handleMessage(command, request)) {
+			return true;
+		}
+		selectedFeature = selectedFeature->_nextFeature;
+	}
+	return false;
+}
+
+void IntegerEasyTransferFeatureManager::reset() {
+	IntegerEasyTransferFeature * selectedFeature = _features;
+	while (selectedFeature != nullptr) {
+		selectedFeature->reset();
+		selectedFeature = selectedFeature->_nextFeature;
+	}
+}
+
+void IntegerEasyTransferFeatureManager::addFeature(
+	IntegerEasyTransferFeature & feature) {
+	if (_features != nullptr) {
+		IntegerEasyTransferFeature * selectedFeature = _features;
+		while (selectedFeature->_nextFeature != nullptr) {
+			selectedFeature = selectedFeature->_nextFeature;
+		}
+		selectedFeature->_nextFeature = &feature;
+		selectedFeature->_nextFeature = nullptr;
+	} else {
+		_features = &feature;
+		_features->_nextFeature = nullptr;
+	}
+}

avr/libraries/IntegerEasyTransfer/src/IntegerEasyTransferFeatureManager.h

@@ -0,0 +1,53 @@
+/*
+ * Library for configurable and easy transfers.
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 Julian Sanin
+ *
+ * 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.
+ */
+
+#ifndef INTEGER_EASY_TRANSFER_FEATURE_MANAGER_H
+#define INTEGER_EASY_TRANSFER_FEATURE_MANAGER_H
+
+#include "IntegerEasyTransferFeature.h"
+
+class IntegerEasyTransferFeatureManager : public IntegerEasyTransferFeature {
+
+	// List of managed features.
+	IntegerEasyTransferFeature * _features;
+
+public:
+	IntegerEasyTransferFeatureManager();
+
+	bool handleMessage(uint8_t command, IntegerEasyTransfer & request);
+	void reset();
+
+	/// <summary>
+	/// Adds the feature to the manager. See also:
+	/// <seealso cref="IntegerEasyTransferFeature" />
+	/// </summary>
+	/// <param name="feature">
+	/// The feature to be added.
+	/// </param>
+	void addFeature(IntegerEasyTransferFeature & feature);
+};
+
+#endif // INTEGER_EASY_TRANSFER_FEATURE_MANAGER_H