Skip to content

Commit 73c86f3

Browse files
muki01muki01
committed
Refactor pointer and reference types for consistency
1 parent 26e4a8c commit 73c86f3

File tree

2 files changed

+36
-36
lines changed

2 files changed

+36
-36
lines changed

‎src/OBD2_KLine.cpp‎

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#include "OBD2_KLine.h"
22

3-
OBD2_KLine::OBD2_KLine(SerialType &serialPort, uint32_t baudRate, uint8_t rxPin, uint8_t txPin)
3+
OBD2_KLine::OBD2_KLine(SerialType& serialPort, uint32_t baudRate, uint8_t rxPin, uint8_t txPin)
44
: _serial(&serialPort), _rxPin(rxPin), _txPin(txPin), _baudRate(baudRate) {
55
// Start serial
66
setSerial(true);
@@ -80,8 +80,9 @@ bool OBD2_KLine::trySlowInit() {
8080
}
8181
}
8282

83-
// 83 F1 11 C1 EF 8F C4
8483
bool OBD2_KLine::tryFastInit() {
84+
// example Request: C1 33 F1 81 66
85+
// example Response: 83 F1 11 C1 EF 8F C4
8586
debugPrintln(F("🔁 Trying ISO14230_Fast"));
8687

8788
setSerial(false);
@@ -110,7 +111,7 @@ bool OBD2_KLine::tryFastInit() {
110111

111112
// ----------------------------------- Basic Read/Write functions -----------------------------------
112113

113-
void OBD2_KLine::writeRawData(const uint8_t *dataArray, uint8_t length, uint8_t checksumType) {
114+
void OBD2_KLine::writeRawData(const uint8_t* dataArray, uint8_t length, uint8_t checksumType) {
114115
uint8_t totalLength = length; // default no checksum
115116
uint8_t checksum = 0;
116117

@@ -270,7 +271,7 @@ void OBD2_KLine::clearEcho(uint8_t length) {
270271
debugPrintln(F(""));
271272
}
272273

273-
bool OBD2_KLine::compareData(const uint8_t *dataArray, uint8_t length) {
274+
bool OBD2_KLine::compareData(const uint8_t* dataArray, uint8_t length) {
274275
for (size_t i = 0; i < length; i++) {
275276
if (dataArray[i] != resultBuffer[i]) {
276277
return false;
@@ -485,7 +486,7 @@ uint8_t OBD2_KLine::readDTCs(uint8_t mode) {
485486
// example Response: 87 F1 11 43 01 70 01 34 00 00 72
486487
// example Response: 87 F1 11 43 00 00 CC
487488
int dtcCount = 0;
488-
String *targetArray = nullptr;
489+
String* targetArray = nullptr;
489490

490491
if (mode == read_storedDTCs) {
491492
targetArray = storedDTCBuffer;
@@ -620,7 +621,7 @@ uint8_t OBD2_KLine::readSupportedData(uint8_t mode) {
620621
int pidIndex = 0;
621622
int startByte = 0;
622623
int arraySize = 32; // Size of supported data arrays
623-
uint8_t *targetArray = nullptr;
624+
uint8_t* targetArray = nullptr;
624625

625626
if (mode == read_LiveData) { // Mode 01
626627
startByte = 5;
@@ -717,7 +718,7 @@ void OBD2_KLine::setReadTimeout(uint16_t timeoutMs) {
717718
_readTimeout = timeoutMs;
718719
}
719720

720-
void OBD2_KLine::setProtocol(const String &protocolName) {
721+
void OBD2_KLine::setProtocol(const String& protocolName) {
721722
selectedProtocol = protocolName;
722723
connectionStatus = false; // Reset connection status
723724
connectedProtocol = ""; // Reset connected protocol
@@ -816,23 +817,23 @@ void OBD2_KLine::send5baud(uint8_t data) {
816817
debugPrintln(F(""));
817818
}
818819

819-
uint8_t OBD2_KLine::checksum8_XOR(const uint8_t *dataArray, int length) {
820+
uint8_t OBD2_KLine::checksum8_XOR(const uint8_t* dataArray, int length) {
820821
uint8_t checksum = 0;
821822
for (int i = 0; i < length; i++) {
822823
checksum ^= dataArray[i]; // XOR operation
823824
}
824825
return checksum;
825826
}
826827

827-
uint8_t OBD2_KLine::checksum8_Modulo256(const uint8_t *dataArray, int length) {
828+
uint8_t OBD2_KLine::checksum8_Modulo256(const uint8_t* dataArray, int length) {
828829
unsigned int sum = 0;
829830
for (int i = 0; i < length; i++) {
830831
sum += dataArray[i];
831832
}
832833
return (byte)(sum % 256); // or (byte)sum; because uint8_t overflow also gives a mod 256 effect.
833834
}
834835

835-
uint8_t OBD2_KLine::checksum8_TwosComplement(const uint8_t *dataArray, int length) {
836+
uint8_t OBD2_KLine::checksum8_TwosComplement(const uint8_t* dataArray, int length) {
836837
unsigned int sum = 0;
837838
for (int i = 0; i < length; i++) {
838839
sum += dataArray[i];
@@ -855,7 +856,7 @@ String OBD2_KLine::decodeDTC(uint8_t input_byte1, uint8_t input_byte2) {
855856
return ErrorCode;
856857
}
857858

858-
bool OBD2_KLine::isInArray(const uint8_t *dataArray, uint8_t length, uint8_t value) {
859+
bool OBD2_KLine::isInArray(const uint8_t* dataArray, uint8_t length, uint8_t value) {
859860
for (int i = 0; i < length; i++) {
860861
if (dataArray[i] == value) {
861862
return true;
@@ -864,7 +865,7 @@ bool OBD2_KLine::isInArray(const uint8_t *dataArray, uint8_t length, uint8_t val
864865
return false;
865866
}
866867

867-
String OBD2_KLine::convertHexToAscii(const uint8_t *dataArray, uint8_t length) {
868+
String OBD2_KLine::convertHexToAscii(const uint8_t* dataArray, uint8_t length) {
868869
String asciiString = "";
869870
for (int i = 0; i < length; i++) {
870871
uint8_t b = dataArray[i];
@@ -875,7 +876,7 @@ String OBD2_KLine::convertHexToAscii(const uint8_t *dataArray, uint8_t length) {
875876
return asciiString;
876877
}
877878

878-
String OBD2_KLine::convertBytesToHexString(const uint8_t *dataArray, uint8_t length) {
879+
String OBD2_KLine::convertBytesToHexString(const uint8_t* dataArray, uint8_t length) {
879880
String hexString = "";
880881
for (int i = 0; i < length; i++) {
881882
if (dataArray[i] < 0x10) hexString += "0"; // Pad leading zero
@@ -887,23 +888,23 @@ String OBD2_KLine::convertBytesToHexString(const uint8_t *dataArray, uint8_t len
887888

888889
// ----------------------------------- Debug Functions -----------------------------------
889890

890-
void OBD2_KLine::setDebug(Stream &serial) {
891+
void OBD2_KLine::setDebug(Stream& serial) {
891892
_debugSerial = &serial;
892893
}
893894

894-
void OBD2_KLine::debugPrint(const char *msg) {
895+
void OBD2_KLine::debugPrint(const char* msg) {
895896
if (_debugSerial) _debugSerial->print(msg);
896897
}
897898

898-
void OBD2_KLine::debugPrint(const __FlashStringHelper *msg) {
899+
void OBD2_KLine::debugPrint(const __FlashStringHelper* msg) {
899900
if (_debugSerial) _debugSerial->print(msg);
900901
}
901902

902-
void OBD2_KLine::debugPrintln(const char *msg) {
903+
void OBD2_KLine::debugPrintln(const char* msg) {
903904
if (_debugSerial) _debugSerial->println(msg);
904905
}
905906

906-
void OBD2_KLine::debugPrintln(const __FlashStringHelper *msg) {
907+
void OBD2_KLine::debugPrintln(const __FlashStringHelper* msg) {
907908
if (_debugSerial) _debugSerial->println(msg);
908909
}
909910

‎src/OBD2_KLine.h‎

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ const uint8_t read_ID_Num = 0x06; // Read Calibration ID Number
3737

3838
class OBD2_KLine {
3939
public:
40-
OBD2_KLine(SerialType &serialStream, uint32_t baudRate, uint8_t rxPin, uint8_t txPin);
40+
OBD2_KLine(SerialType& serialStream, uint32_t baudRate, uint8_t rxPin, uint8_t txPin);
4141

42-
void setDebug(Stream &serial);
42+
void setDebug(Stream& serial);
4343
void setSerial(bool enabled);
44-
void writeRawData(const uint8_t *dataArray, uint8_t length, uint8_t checksumType);
4544
bool initOBD2();
4645
bool trySlowInit();
4746
bool tryFastInit();
47+
void writeRawData(const uint8_t* dataArray, uint8_t length, uint8_t checksumType);
4848
void writeData(const uint8_t* data, uint8_t length);
4949

5050
template <size_t N>
@@ -53,7 +53,7 @@ class OBD2_KLine {
5353
}
5454

5555
uint8_t readData();
56-
bool compareData(const uint8_t *dataArray, uint8_t length);
56+
bool compareData(const uint8_t* dataArray, uint8_t length);
5757
void send5baud(uint8_t data);
5858
int read5baud();
5959

@@ -83,21 +83,20 @@ class OBD2_KLine {
8383
void setByteWriteInterval(uint16_t interval);
8484
void setInterByteTimeout(uint16_t interval);
8585
void setReadTimeout(uint16_t timeoutMs);
86-
void setProtocol(const String &protocolName);
86+
void setProtocol(const String& protocolName);
8787
void updateConnectionStatus(bool messageReceived);
8888

89-
uint8_t initMsg[4] = {0xC1, defaultInitAddress, 0xF1, 0x81}; // ISO14230-Fast init message
9089
void setInitAddress(uint8_t address);
9190
void setISO9141Header(uint8_t h1, uint8_t h2, uint8_t h3);
9291
void setISO14230Header(uint8_t h1, uint8_t h2, uint8_t h3);
9392
void setLengthMode(bool inHeader);
9493

9594
private:
96-
SerialType *_serial;
95+
SerialType* _serial;
9796
uint32_t _baudRate;
9897
uint8_t _rxPin;
9998
uint8_t _txPin;
100-
Stream *_debugSerial = nullptr; // Debug serial port
99+
Stream* _debugSerial = nullptr; // Debug serial port
101100

102101
uint8_t defaultInitAddress = 0x33;
103102
uint8_t header_ISO9141[3] = {0x68, 0x6A, 0xF1};
@@ -123,19 +122,19 @@ class OBD2_KLine {
123122
uint8_t supportedControlComponents[32];
124123
uint8_t supportedVehicleInfo[32];
125124

126-
uint8_t checksum8_XOR(const uint8_t *dataArray, int length);
127-
uint8_t checksum8_Modulo256(const uint8_t *dataArray, int length);
128-
uint8_t checksum8_TwosComplement(const uint8_t *dataArray, int length);
125+
uint8_t checksum8_XOR(const uint8_t* dataArray, int length);
126+
uint8_t checksum8_Modulo256(const uint8_t* dataArray, int length);
127+
uint8_t checksum8_TwosComplement(const uint8_t* dataArray, int length);
129128

130129
String decodeDTC(uint8_t input_byte1, uint8_t input_byte2);
131-
bool isInArray(const uint8_t *dataArray, uint8_t length, uint8_t value);
132-
String convertBytesToHexString(const uint8_t *dataArray, uint8_t length);
133-
String convertHexToAscii(const uint8_t *dataArray, uint8_t length);
134-
void debugPrint(const char *msg);
135-
void debugPrint(const __FlashStringHelper *msg);
136-
void debugPrintln(const char *msg);
137-
void debugPrintln(const __FlashStringHelper *msg);
130+
bool isInArray(const uint8_t* dataArray, uint8_t length, uint8_t value);
131+
String convertBytesToHexString(const uint8_t* dataArray, uint8_t length);
132+
String convertHexToAscii(const uint8_t* dataArray, uint8_t length);
138133
void clearEcho(uint8_t length);
134+
void debugPrint(const char* msg);
135+
void debugPrint(const __FlashStringHelper* msg);
136+
void debugPrintln(const char* msg);
137+
void debugPrintln(const __FlashStringHelper* msg);
139138
void debugPrintHex(uint8_t val); // Hexadecimal output
140139
void debugPrintHexln(uint8_t val); // Hexadecimal + newline
141140
};

0 commit comments

Comments
 (0)