Changes for v1.0.0 release

Author: sorek

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Maciej sorek Loboda
+
+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.

library.json

@@ -0,0 +1,27 @@
+{
+    "name": "DS2",
+    "keywords": "ds2, kwp, kwp2000, esp32, esp32-s3, esp32-s2, arduino",
+    "description": "DS2 and KWP library to handle messages in those automotive protocols",
+    "version": "1.0.0",
+    "repository":
+    {
+        "type": "git",
+        "url": "https://github.com/handmade0octopus/ds2.git"
+    },
+    "frameworks": "*",
+    "platforms": "*",
+    "build": {
+        "srcFilter": [
+            "+<DS2.cpp>"
+        ]
+    },
+    "authors":
+    [
+      {
+         "name": "sorek",
+         "email": "contact@sorek.uk",
+         "url": "http://sorek.uk",
+         "maintainer": true
+      }
+    ]
+}

library.properties

@@ -0,0 +1,9 @@
+name=DS2
+version=1.0.0
+author=sorek.uk
+maintainer=sorek <contact@sorek.uk>
+sentence=DS2 and KWP library to handle messages in those automotive protocols.
+paragraph=Supporting any Arduino based device
+category=Communication
+url=https://github.com/handmade0octopus/ds2
+architectures=*

DS2.cpp renamed to src/DS2.cpp

@@ -17,8 +17,7 @@ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 #include <Arduino.h>
 #include <DS2.h>
 
-DS2::DS2(Stream &stream):serial(stream) {
-}
+
 
 
 bool DS2::obtainValues(uint8_t command[], uint8_t data[], uint8_t respLen) {
@@ -29,7 +28,6 @@ bool DS2::obtainValues(uint8_t command[], uint8_t data[], uint8_t respLen) {
 	blocking = true;
 	writeData(command);
 	bool result = readData(data);
-//	log_e("Data: %d2, %d2, %d2 ,%d2 ,%d2 ,%d2, %d2", data[0], data[1], data[2], data[3], data[4], data[5], data[6]);
 	blocking = block;
 	if(!result) clearRX();
 	return (result && checkDataOk(data));
@@ -51,7 +49,6 @@ uint8_t DS2::sendCommand(uint8_t command[], uint8_t respLen) {
 
 ReceiveType DS2::receiveData(uint8_t data[]) {
 	uint32_t time;
-//	log_e("Time: %d", millis() - timeStamp);
 	if(messageSend) {
 		if(readData(data)) {
 			messageSend = false;
@@ -118,7 +115,7 @@ uint8_t DS2::writeData(uint8_t data[], uint8_t length) {
 }
 
 uint8_t DS2::writeToSerial(uint8_t data[], uint8_t length) {
-	if(!slow) {
+	if(!slowSend) {
 		length = serial.write(data, length);
 	//	serial.flush();
 		return length;
@@ -215,29 +212,23 @@ void DS2::clearData(uint8_t data[]) {
 }
 
 
-bool DS2::checkData(uint8_t data[]) {
+bool DS2::checkData(uint8_t data[], bool fix) {
 	uint8_t echo = 0;
-	if(echoLength != 0) echo += (kwp ? data[3] + 5 : data[1]);
+	if(echoLength != 0 && !fix) echo += (kwp ? data[3] + 5 : data[1]);
 	uint8_t checksum = data[echo];
 	uint8_t checkLen = (kwp ? data[echo+3]+echo + 5 : data[echo+1]+echo);
 	for(uint8_t i = echo+1; i < checkLen; i++) {
 		checksum ^= data[i];
 	}
 
 	if(checksum == 0) {
-		/*
-		if(echo != 0 && echo < maxDataLength/2 && data[echo+1] == echo) {
-			bool sameData = true;
-			for(uint8_t i = 0; i < echo; i++) {
-				if(data[i] != data[echo + i]) sameData = false;
-			}
-			if(sameData) return false;
-		} */
-		
 		commandsPerSecond = 1000.0/(millis() - timeStamp);
 		timeStamp = millis();
 		return true;
-	} else return false;
+	} else {
+		if(fix) data[checkLen-1] = checksum;
+		return false;
+	}
 }
 
 bool DS2::checkDataOk(uint8_t data[]) {

DS2.h renamed to src/DS2.h

@@ -78,7 +78,7 @@ enum ReceiveType : uint8_t {
 class DS2 {
 	public:
 		// Constructor, you can pass any Serial, SoftwareSerial or BluetoothSerial - anything that extends 'stream'
-		DS2(Stream &stream);
+		DS2(Stream &stream):serial(stream) {}
 
 		// You san use library in blocking mode (default is false) and it waits ISO 112ms time for response.
 		void setBlocking(bool mode);
@@ -95,7 +95,8 @@ class DS2 {
 		uint8_t writeData(uint8_t data[], uint8_t length = 0); // sets device to first byte value; sets echo to second byte value
 		bool readCommand(uint8_t data[]); // sets echo to 0 so you can use readData and it will read data without echo after calling this command
 		bool readData(uint8_t data[]); // reads command and checks data
-		bool checkData(uint8_t data[]); // just use setEcho to 0 if want to check only response or command otherwise it will check whole data (echo + response) for checksum
+		// just use setEcho to 0 if want to check only response or command otherwise it will check whole data (echo + response) for checksum
+		bool checkData(uint8_t data[], bool fix = false); // fix = true allows you to fix checksum of the data you want to send
 		uint8_t available();
 		void flush();
 
@@ -129,11 +130,8 @@ class DS2 {
 		bool getKwp() { return kwp; };
 
 		// Some ECUs like DDE4 need delay between bytes sent
-		bool setSlowSend(bool setS, uint8_t delay = 3) { 
-			slowSend = delay;
-			return (slow = setS);
-		};
-		
+		void setSlowSend(uint8_t delay = 0) { slowSend = delay; };
+		uint8_t getSlowSend() { return slowSend; }
 
 		// Get commands per second calculated from write command followed by readData
 		float getRespondsPerSecond();
@@ -142,14 +140,13 @@ class DS2 {
 		void clearRX();
 		void clearRX(uint8_t available, uint8_t length);
 
-		Stream &serial;
 	private:
+		Stream &serial;
 		bool kwp = false;
-		bool slow = false;
 		bool blocking = false;
 		bool messageSend = false;
 
-		uint8_t slowSend = 4;
+		uint8_t slowSend = 0;
 		uint8_t device = 0;
 		uint8_t echoLength = 0, responseLength, maxDataLength = MAX_DATA_LENGTH;