Implement BSTPL protocol

4 files changed, 202 insertions, 0 deletions

diff --git a/setup/default.xml b/setup/default.xml
index 0abc96431..607efc35f 100644
--- a/setup/default.xml
+++ b/setup/default.xml
@@ -283,5 +283,6 @@
     <entry key='armoli.port'>5238</entry>
     <entry key='teratrack.port'>5239</entry>
     <entry key='envotech.port'>5240</entry>
+    <entry key='bstpl.port'>5241</entry>
 
 </properties>
diff --git a/src/main/java/org/traccar/protocol/BstplProtocol.java b/src/main/java/org/traccar/protocol/BstplProtocol.java
new file mode 100644
index 000000000..dde14a2ca
--- /dev/null
+++ b/src/main/java/org/traccar/protocol/BstplProtocol.java
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2022 Anton Tananaev (anton@traccar.org)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.traccar.protocol;
+
+import io.netty.handler.codec.string.StringDecoder;
+import io.netty.handler.codec.string.StringEncoder;
+import org.traccar.BaseProtocol;
+import org.traccar.CharacterDelimiterFrameDecoder;
+import org.traccar.PipelineBuilder;
+import org.traccar.TrackerServer;
+import org.traccar.config.Config;
+
+import javax.inject.Inject;
+
+public class BstplProtocol extends BaseProtocol {
+
+    @Inject
+    public BstplProtocol(Config config) {
+        addServer(new TrackerServer(config, getName(), false) {
+            @Override
+            protected void addProtocolHandlers(PipelineBuilder pipeline, Config config) {
+                pipeline.addLast(new CharacterDelimiterFrameDecoder(1024, '#'));
+                pipeline.addLast(new StringEncoder());
+                pipeline.addLast(new StringDecoder());
+                pipeline.addLast(new BstplProtocolDecoder(BstplProtocol.this));
+            }
+        });
+    }
+
+}
diff --git a/src/main/java/org/traccar/protocol/BstplProtocolDecoder.java b/src/main/java/org/traccar/protocol/BstplProtocolDecoder.java
new file mode 100644
index 000000000..15c114642
--- /dev/null
+++ b/src/main/java/org/traccar/protocol/BstplProtocolDecoder.java
@@ -0,0 +1,137 @@
+/*
+ * Copyright 2022 Anton Tananaev (anton@traccar.org)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.traccar.protocol;
+
+import io.netty.channel.Channel;
+import org.traccar.BaseProtocolDecoder;
+import org.traccar.Protocol;
+import org.traccar.helper.Parser;
+import org.traccar.helper.PatternBuilder;
+import org.traccar.helper.UnitsConverter;
+import org.traccar.model.Position;
+import org.traccar.session.DeviceSession;
+
+import java.net.SocketAddress;
+import java.util.regex.Pattern;
+
+public class BstplProtocolDecoder extends BaseProtocolDecoder {
+
+    public BstplProtocolDecoder(Protocol protocol) {
+        super(protocol);
+    }
+
+    private static final Pattern PATTERN = new PatternBuilder()
+            .text("BSTPL$")                      // header
+            .number("(d),")                      // type
+            .expression("([^,]+),")              // device id
+            .expression("([AV]),")               // validity
+            .number("(dd)(dd)(dd),")             // date (ddmmyy)
+            .number("(dd)(dd)(dd),")             // time (hhmmss)
+            .number("(d+.d+),([0NS]),")          // latitude
+            .number("(d+.d+),([0EW]),")          // longitude
+            .number("(d+),")                     // speed
+            .number("(d+),")                     // odometer
+            .number("(d+),")                     // course
+            .number("(d+),")                     // satellites
+            .number("([01]),")                   // box open
+            .number("(d+),")                     // rssi
+            .number("([01]),")                   // charge
+            .number("([01]),")                   // ignition
+            .number("([01]),")                   // engine
+            .number("([01]),")                   // locked
+            .number("(d+.d+),")                  // adc
+            .number("d+,")                       // reserved
+            .number("(d+.d+),")                  // battery
+            .expression("([^,]+),")              // firmware
+            .number("([^,]+),")                  // iccid
+            .number("(d+.d+)")                   // power
+            .compile();
+
+    private String decodeAlarm(int value) {
+        switch (value) {
+            case 4:
+                return Position.ALARM_LOW_BATTERY;
+            case 5:
+                return Position.ALARM_ACCELERATION;
+            case 6:
+                return Position.ALARM_BRAKING;
+            case 7:
+                return Position.ALARM_OVERSPEED;
+            case 9:
+                return Position.ALARM_SOS;
+            default:
+                return null;
+        }
+    }
+    @Override
+    protected Object decode(
+            Channel channel, SocketAddress remoteAddress, Object msg) throws Exception {
+
+        Parser parser = new Parser(PATTERN, (String) msg);
+        if (!parser.matches()) {
+            return null;
+        }
+
+        int type = parser.nextInt();
+
+        DeviceSession deviceSession = getDeviceSession(channel, remoteAddress, parser.next());
+        if (deviceSession == null) {
+            return null;
+        }
+
+        Position position = new Position(getProtocolName());
+        position.setDeviceId(deviceSession.getDeviceId());
+
+        position.set(Position.KEY_ALARM, decodeAlarm(type));
+
+        position.setValid(parser.next().equals("A"));
+        position.setTime(parser.nextDateTime(Parser.DateTimeFormat.DMY_HMS));
+        position.setLatitude(parser.nextCoordinate(Parser.CoordinateFormat.DEG_HEM));
+        position.setLongitude(parser.nextCoordinate(Parser.CoordinateFormat.DEG_HEM));
+        position.setSpeed(UnitsConverter.knotsFromKph(parser.nextInt()));
+
+        position.set(Position.KEY_ODOMETER, parser.nextInt() * 1000L);
+
+        position.setCourse(parser.nextInt());
+
+        position.set(Position.KEY_SATELLITES, parser.nextInt());
+
+        boolean boxOpen = parser.nextInt() > 0;
+        if (type == 8 && boxOpen) {
+            position.set(Position.KEY_ALARM, Position.ALARM_TAMPERING);
+        }
+        position.set("boxOpen", boxOpen);
+
+        position.set(Position.KEY_RSSI, parser.nextInt());
+
+        boolean charge = parser.nextInt() > 0;
+        if (type == 3) {
+            position.set(Position.KEY_ALARM, charge ? Position.ALARM_POWER_RESTORED : Position.ALARM_POWER_CUT);
+        }
+        position.set(Position.KEY_CHARGE, charge);
+
+        position.set(Position.KEY_IGNITION, parser.nextInt() > 0);
+        position.set("engine", parser.nextInt() > 0);
+        position.set(Position.KEY_BLOCKED, parser.nextInt() > 0);
+        position.set(Position.PREFIX_ADC + 1, parser.nextDouble());
+        position.set(Position.KEY_BATTERY, parser.nextDouble());
+        position.set(Position.KEY_ICCID, parser.next());
+        position.set(Position.KEY_POWER, parser.nextDouble());
+
+        return position;
+    }
+
+}
diff --git a/src/test/java/org/traccar/protocol/BstplProtocolDecoderTest.java b/src/test/java/org/traccar/protocol/BstplProtocolDecoderTest.java
new file mode 100644
index 000000000..ae4c47229
--- /dev/null
+++ b/src/test/java/org/traccar/protocol/BstplProtocolDecoderTest.java
@@ -0,0 +1,21 @@
+package org.traccar.protocol;
+
+import org.junit.Test;
+import org.traccar.ProtocolTest;
+
+public class BstplProtocolDecoderTest extends ProtocolTest {
+
+    @Test
+    public void testDecode() throws Exception {
+
+        var decoder = inject(new BstplProtocolDecoder(null));
+
+        verifyPosition(decoder, text(
+                "BSTPL$1,869630054439504,V,200722,045113,00.000000,0,00.00000,0,0,0,000,00,0,17,1,1,0,0,00.01,0,04.19,15B_190821,8991000907387031196F,12.27"));
+
+        verifyPosition(decoder, text(
+                "BSTPL$1,AP12AP3456,A,130720,160552,27.244183,N,83.673973,E,20,156,183,17,0,11,1,0,0,0,00.00,00,04.16,15_V1_0_0,89917380578146790443,12.16"));
+
+    }
+
+}