Extended Gator Protocol (M558FS) #5069

abish7643 · 2023-04-14T16:19:07Z

Functionalities Added

RFID Packet Decoding (Tested)
Alarm Packet Decoding (Power Off, SOS Tested)
Engine Start Encoding (Tested)
Engine Stop Decoding (Tested)

Attaching Logs for anyone to do Test Cases

24248000253c0d0733230414195650008307570765682900000000c0470100000c0f0000473000ff710d
2424210005718000d50d
24248000253c0d0733230414195720008307570765682900000000c0470100000c0f0000473600ff060d
2424210005068000a20d
24248000253c0d0733230414195750008307570765682900000000c0470100000c0f0000473a00ff7a0d
24242100057a8000de0d
24248000253c0d0733230414195820008307570765683000000000c0470100000c0f0000473d00ff1b0d
24242100051b8000bf0d
24248000253c0d0733230414195850008307570765682900000000c0470100000c0f0000474000ff0f0d
24242100050f8000ab0d
24248000253c0d0733230414195920008307580765682900000000c0470100000c0f0000474200ff730d
2424210005738000d70d
24248000253c0d0733230414195950008307580765683100000000c0470100000c0f0000474800ff110d
24248000253c0d0733230414200020008307590765683200000000c0470100000c0f0000474b00ff000d
2424210005008000a40d
24248000253c0d0733230414200050008307590765683200000000c0470100000c0f0000474d00ff760d
24248000253c0d0733230414200120008307590765683200000000c0470100000c0f0000475100ff1b0d
24242100051b8000bf0d
24248000253c0d0733230414200135008307590765683200000000c0470000000c0d0000475300ff0f0d
24242100050f8000ab0d
24248200273c0d0733230414200145008307590765683200000000c04700000000000000475300ff0008760d
2424210005768200d00d
24248000253c0d0733230414200149008307590765683200000000c04701000000000000475300ff730d
2424210005738000d70d
24247200203c0d07330242313631394143430d2a4123041420015600830758076568329f0d
24242100059f7200c90d
24247200203c0d07330231394143324630430d2a412304142002010083075807656831c90d
2424210005c972009f0d
24248000253c0d0733230414200219008307580765683200000000c0470100000c0d0000475500ff260d
2424210005268000820d
24248200273c0d0733230414200220008307580765683200000000c0470100000c0d0000475500ff00011e0d
24242100051e8200b80d
24248000253c0d0733230414200249008307580765683200000000c0470100000c0f0000475700ff760d
2424210005768000d20d

…wledgement

tananaev

Let's start with some big themes first:

Please add unit tests for both decoding and encoding
Fix formatting. For example, variable use our variable name convention. No underscores. Lower camel case names for functions and variables. No shortened words.
Run gradle check to make sure all checks pass.

abish7643 · 2023-04-14T16:29:06Z

Let's start with some big themes first:

1. Please add unit tests for both decoding and encoding

2. Fix formatting. For example, variable use our variable name convention. No underscores. Lower camel case names for functions and variables. No shortened words.

3. Run gradle check to make sure all checks pass.

I'll do all of this in the upcoming days.

abish7643 · 2023-04-15T08:06:48Z

Added new commit.

Gradle Build ran successfully without any StyleCode errors.

@abish7643
Formatting Fixed, Naming Patterns Fixed, Gradle Build Successful

tananaev · 2023-04-15T13:54:14Z

OK, can you please add unit tests and provide the protocol documentation.

abish7643 · 2023-04-17T08:54:08Z

OK, can you please add unit tests and provide the protocol documentation.

Attaching Protocol Document. The protocol is exactly same as the one found on Protocol page.
M508A_M508G_M528S_M508S_M558_M558T_M588F_M588FS_tracker_data_protocol.pdf

I'm running the development server locally and using localtonet to forward UDP packets to Gator's predefined port. All functionalities were tested and was working as intended.

…tor_Protocol_Improved

abish7643 · 2023-04-17T13:15:33Z

@tananaev

Added Single Location Reporting Encoder Function
Added Encoder and Decoder Tests

debug.xml

src/main/java/org/traccar/protocol/GatorProtocolEncoder.java

tananaev · 2023-04-17T14:15:00Z

src/main/java/org/traccar/protocol/GatorProtocolEncoder.java

+        return buf;
+    }
+
+    public int[] numToIp(String sim) {


This function doesn't look right. First of all, the naming of the function and variables is not per our standards. Also, it looks too complicated. It just doesn't make sense. What are you trying to do here?

It's an algorithm mentioned in the Protocol Document. Refer the Appendix section if required.

I have made the variable nomenclature understandable. I copied it from the document, initially even I didn't understand this nomenclature within the document, that's the reason why it ended like this. Now it made sense, so I have modified it.

There has to be a better way. This is what it looks like in the decoder:

https://github.com/traccar/traccar/blob/master/src/main/java/org/traccar/protocol/GatorProtocolDecoder.java#L51-L60

Yes. The protocol document also have a complicated decoder function. Somehow this is simplified quite extensively,.

I'll look into this.

@tananaev

I simplified the encoding function.
Tested it with actual devices.

https://github.com/abish7643/traccar/blob/Gator_Protocol_Improved/src/main/java/org/traccar/protocol/GatorProtocolEncoder.java#L82-L98

src/main/java/org/traccar/protocol/GatorProtocolEncoder.java

src/main/java/org/traccar/protocol/GatorProtocolDecoder.java

abish7643 · 2023-04-17T16:16:14Z

I have made the required changes as you mentioned, I need to test the device tomorrow since I have changed some parts which you suggested.

If there are any modification required, do mention.

abish7643 · 2023-04-17T19:14:56Z

@tananaev

I do need a suggestion. The final one, don't worry.

One of the returned data from the device doesn't contain position data, so the last position known data is used. (getLastLocation(position, null);)

Should I set the position valid or not, since technically it's the previous location.

tananaev · 2023-04-17T19:20:27Z

If you use getLastLocation, you shouldn't set any GPS related fields, including validity.

abish7643 · 2023-04-17T20:07:58Z

Removed That Line. I'll test all the functionalities tomorrow and will update.

abish7643 · 2023-04-18T05:34:37Z

@tananaev

Works perfect. Tested everything.
You could check, only a line was removed (setValid).

tananaev

I think we're almost there. I've added a few smaller comments, mostly around formatting.

src/main/java/org/traccar/protocol/GatorProtocolDecoder.java

src/main/java/org/traccar/protocol/GatorProtocolEncoder.java

tananaev · 2023-04-19T13:11:01Z

src/main/java/org/traccar/protocol/GatorProtocolEncoder.java

+    }
+
+    public int[] idToPseudoIPAddress(String deviceID) {
+        if (deviceID.length() != 11) {


What is this for?

I was about to mention that the gradle build was failing if I don't include that length check.

Definitely the test case failed but I'm not sure why that's the case. May be you could help.

So which message is correct?

@tananaev

I have tracked it down, the issue lies in the substring creation block. The device ID should be at least 11 to continue with that logic.

public int[] idToPseudoIPAddress(String deviceID) { if (deviceID.length() != 11) { return new int[4]; } int[] ipAddress = new int[4]; for (int i = 0; i < 4; i++) { ipAddress[i] = Integer.parseInt(deviceID.substring(3 + i * 2, 5 + i * 2)); } ipAddress[0] = ipAddress[0] % 0x7f; ipAddress[1] = ipAddress[1] % 0x7f; ipAddress[2] = ipAddress[2] % 0x7f; ipAddress[3] = ipAddress[3] % 0x7f; return ipAddress; }

According to the protocol document, the device id can be varied in length. The previous developer did assume that the device ID length was 11, that's the reason why the decoder function was simple while my initial encoder function was quite long since I have taken care of the length. Since the decoder creates an ID with a fixed length, there's no point in improving the capability of just the encoder. But to get past Gradle build, I may have to add a conditional check on length there.

So what's your take on this, should I extend the decoder function just like how I initially made the encoder function. Or should I keep it simple like this.

I did configure the tracker with an ID of length 10 rather than 11, and the decoded ID was wrong.

If it's incorrect, then yes, ideally we should fix it.

src/main/java/org/traccar/protocol/GatorProtocolEncoder.java

src/main/java/org/traccar/protocol/GatorProtocolDecoder.java

tananaev · 2023-04-19T16:47:48Z

src/main/java/org/traccar/protocol/GatorProtocolDecoder.java

+            String rfidData;
+            int rfidDataEndIndex = buf.indexOf(buf.readerIndex(), buf.writerIndex(), (byte) 0x0D);
+            if (rfidDataEndIndex == -1) {
+                return null;
+            }
+
+            int length = rfidDataEndIndex - buf.readerIndex();
+            rfidData = buf.readCharSequence(length, Charset.defaultCharset()).toString();
+            buf.readUnsignedByte();
+
+            position.set(Position.KEY_DRIVER_UNIQUE_ID, rfidData);


Why do you need so many variables? Just inline when possible.

Suggested change

String rfidData;

int rfidDataEndIndex = buf.indexOf(buf.readerIndex(), buf.writerIndex(), (byte) 0x0D);

if (rfidDataEndIndex == -1) {

return null;

}

int length = rfidDataEndIndex - buf.readerIndex();

rfidData = buf.readCharSequence(length, Charset.defaultCharset()).toString();

buf.readUnsignedByte();

position.set(Position.KEY_DRIVER_UNIQUE_ID, rfidData);

int rfidEndIndex = buf.indexOf(buf.readerIndex(), buf.writerIndex(), (byte) '\r');

if (rfidEndIndex == -1) {

return null;

}

position.set(

Position.KEY_DRIVER_UNIQUE_ID,

buf.readCharSequence(rfidEndIndex - buf.readerIndex(), ASCII).toString());

buf.readUnsignedByte();

abish7643 added 12 commits April 12, 2023 21:44

Added RFID support

1aa11e1

Merge remote-tracking branch 'origin/master'

e6270a2

Merge branch 'master' into M588FS_Support

f2926f6

Extended Protocol

e1b177c

Added Commands for Engine On / OFF (Relay)

7830242

CRC Computed by Already Existing Function

af7724c

Added Support for Decoding Relay Commands Acknowledgments

835d427

Using Previous Position Info for Server to Tracker Positionless Ackno…

45bd005

…wledgement

Alarm Key Modified For Better Computed Attributes Management

bf7f207

Refactored, Removed Events Class

4a83e57

Added Logs for Reference

2084957

Release Candidate

d620801

tananaev reviewed Apr 14, 2023

View reviewed changes

Formatting Fixed, Naming Patterns Fixed, Gradle Build Successful

c08d5bb

abish7643 changed the title ~~Extended Gator Protocol~~ Extended Gator Protocol (M558FS) Apr 15, 2023

abish7643 added 2 commits April 16, 2023 17:05

Merge remote-tracking branch 'TotalSecure/master'

2163415

Merge branch 'master' into Gator_Protocol_Improved

cb070a6

abish7643 added 8 commits April 17, 2023 15:43

Added Single Location Reporting Functionality

443c8d0

"key" modified to default Key Ignition

dc07976

Merge branch 'traccar:master' into Gator_Protocol_Improved

df5b1cb

Merge branch 'Gator_Protocol_Improved' into M588FS_Support

6342b45

Merge remote-tracking branch 'origin/Gator_Protocol_Improved' into Ga…

6e879da

…tor_Protocol_Improved

Merge branch 'M588FS_Support' into Gator_Protocol_Improved

c254989

Test Case Error Due to Usage of Ignition Key Fixed

eae9517

Added Encoder and Decoder Test

adff51f

tananaev reviewed Apr 17, 2023

View reviewed changes

Formatted as Suggested

bdd4c3e

Avoiding Valid on Packets without Position Data

1f03be4

Simplified Address Encoding Logic

6987505

tananaev reviewed Apr 19, 2023

View reviewed changes

abish7643 added 2 commits April 19, 2023 21:15

Suggested Changes & Improvements

2157b27

RFID Part Improved

86092df

tananaev reviewed Apr 19, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extended Gator Protocol (M558FS) #5069

Extended Gator Protocol (M558FS) #5069

abish7643 commented Apr 14, 2023 •

edited

tananaev left a comment

abish7643 commented Apr 14, 2023 •

edited

abish7643 commented Apr 15, 2023 •

edited

tananaev commented Apr 15, 2023

abish7643 commented Apr 17, 2023 •

edited

abish7643 commented Apr 17, 2023 •

edited

tananaev Apr 17, 2023

abish7643 Apr 17, 2023

tananaev Apr 18, 2023

abish7643 Apr 18, 2023

abish7643 Apr 19, 2023 •

edited

abish7643 commented Apr 17, 2023

abish7643 commented Apr 17, 2023 •

edited

tananaev commented Apr 17, 2023

abish7643 commented Apr 17, 2023

abish7643 commented Apr 18, 2023

tananaev left a comment

tananaev Apr 19, 2023

abish7643 Apr 19, 2023 •

edited

tananaev Apr 19, 2023

abish7643 Apr 19, 2023 •

edited

tananaev Apr 19, 2023

tananaev Apr 19, 2023

Extended Gator Protocol (M558FS) #5069

Are you sure you want to change the base?

Extended Gator Protocol (M558FS) #5069

Conversation

abish7643 commented Apr 14, 2023 • edited

Functionalities Added

tananaev left a comment

Choose a reason for hiding this comment

abish7643 commented Apr 14, 2023 • edited

abish7643 commented Apr 15, 2023 • edited

tananaev commented Apr 15, 2023

abish7643 commented Apr 17, 2023 • edited

abish7643 commented Apr 17, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abish7643 Apr 19, 2023 • edited

Choose a reason for hiding this comment

abish7643 commented Apr 17, 2023

abish7643 commented Apr 17, 2023 • edited

tananaev commented Apr 17, 2023

abish7643 commented Apr 17, 2023

abish7643 commented Apr 18, 2023

tananaev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abish7643 Apr 19, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abish7643 Apr 19, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abish7643 commented Apr 14, 2023 •

edited

abish7643 commented Apr 14, 2023 •

edited

abish7643 commented Apr 15, 2023 •

edited

abish7643 commented Apr 17, 2023 •

edited

abish7643 commented Apr 17, 2023 •

edited

abish7643 Apr 19, 2023 •

edited

abish7643 commented Apr 17, 2023 •

edited

abish7643 Apr 19, 2023 •

edited

abish7643 Apr 19, 2023 •

edited