DSheirer#1507 Updates Cap+ Site Status and adds RAS bit handling.

src/main/java/io/github/dsheirer/edac/BPTC_196_96.java

@@ -1,9 +1,27 @@
+/*
+ * *****************************************************************************
+ * Copyright (C) 2014-2023 Dennis Sheirer
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ * ****************************************************************************
+ */
+
 package io.github.dsheirer.edac;
 
 import io.github.dsheirer.bits.BinaryMessage;
 import io.github.dsheirer.bits.BitSetFullException;
 import io.github.dsheirer.bits.CorrectedBinaryMessage;
-
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
@@ -14,7 +32,7 @@
 public class BPTC_196_96
 {
     public static final int BPTC_LENGTH = 196;
-    public static final int EXTRACTED_LENGTH = 96;
+    public static final int EXTRACTED_LENGTH = 96; //However, we set the 3x reserved bits in 96, 97, and 98 making the length 99
     public static final int MAX_ORIGINAL_INDEX = 136;
     public static final int COLUMN_COUNT = 15;
     public static final int MESSAGE_COLUMN_COUNT = 12; //Should be 11, but adjusted for the first pad bit
@@ -99,6 +117,11 @@ public static CorrectedBinaryMessage extract(CorrectedBinaryMessage original)
             }
         }
 
+        //Transfer bits R2, R1, and R0 to the end - RAS bits
+        extracted.set(96, message.get(0));
+        extracted.set(97, message.get(1));
+        extracted.set(98, message.get(2));
+
         return extracted;
     }
 

src/main/java/io/github/dsheirer/module/decode/dmr/DMRDecoderState.java

@@ -44,7 +44,7 @@
 import io.github.dsheirer.module.decode.dmr.message.data.csbk.CSBKMessage;
 import io.github.dsheirer.module.decode.dmr.message.data.csbk.motorola.CapacityMaxAloha;
 import io.github.dsheirer.module.decode.dmr.message.data.csbk.motorola.CapacityPlusNeighbors;
-import io.github.dsheirer.module.decode.dmr.message.data.csbk.motorola.CapacityPlusSystemStatus;
+import io.github.dsheirer.module.decode.dmr.message.data.csbk.motorola.CapacityPlusSiteStatus;
 import io.github.dsheirer.module.decode.dmr.message.data.csbk.motorola.ConnectPlusDataChannelGrant;
 import io.github.dsheirer.module.decode.dmr.message.data.csbk.motorola.ConnectPlusVoiceChannelUser;
 import io.github.dsheirer.module.decode.dmr.message.data.csbk.standard.Aloha;
@@ -674,9 +674,9 @@ private void processCSBK(CSBKMessage csbk)
                 }
                 break;
             case MOTOROLA_CAPPLUS_SYSTEM_STATUS:
-                if(csbk instanceof CapacityPlusSystemStatus)
+                if(csbk instanceof CapacityPlusSiteStatus)
                 {
-                    CapacityPlusSystemStatus cpss = (CapacityPlusSystemStatus)csbk;
+                    CapacityPlusSiteStatus cpss = (CapacityPlusSiteStatus)csbk;
 
                     //Channel rotation monitor normally uses only CONTROL state, so when we detect that we're a
                     //Capacity plus system, add ACTIVE as an active state to the monitor.  This can be requested repeatedly.

src/main/java/io/github/dsheirer/module/decode/dmr/DMRMessageFramer.java

@@ -377,15 +377,15 @@ private static Identity getIdentity(LRRPPacket packet)
 
     public static void main(String[] args)
     {
-        String path = "/media/denny/Lexar/Recordings/DMR/";
+        String path = "/media/denny/T7 Shield/Recordings/DMR/";
 
         //Con+ Traffic + Voice
 //        String file = path + "20200513_143340_9600BPS_DMR_SaiaNet_Onondaga_Control.bits"; //Enh GPS Revert Window Annce
 //        String file = path + "20200514_062135_9600BPS_DMR_SaiaNet_Onondaga_LCN_3_Control.bits"; //Neighbor only
 //        String file = path + "20200514_063507_9600BPS_DMR_SaiaNet_Onondaga_LCN_3_Control.bits"; //GPS Window Grant 2579
 //        String file = path + "20200514_064224_9600BPS_DMR_SaiaNet_Onondaga_LCN_3_Control.bits"; //GPS Window Grant 5056035
 //        String file = path + "20200514_131623_9600BPS_DMR_SaiaNet_Onondaga_LCN_3_Control.bits"; //GPS Grant: 5074193
-        String file = path + "20200514_133947_9600BPS_DMR_SaiaNet_Onondaga_LCN_4.bits"; //<<<<<<<------ Basic Encryption
+//        String file = path + "SaiaNet/20200514_133947_9600BPS_DMR_SaiaNet_Onondaga_LCN_4.bits"; //<<<<<<<------ Basic Encryption
 //        String file = path + "20200514_142249_9600BPS_DMR_SaiaNet_Onondaga_LCN_4.bits";
 //        String file = path + "20200514_144534_9600BPS_DMR_SaiaNet_Onondaga_LCN_3_Control.bits"; //Con+ Control w/GPS Window Announce
 
@@ -395,12 +395,16 @@ public static void main(String[] args)
         //Cap-Max Tier III CC
 //        String file = path + "20200710_053632_9600BPS_DMR_Niles_Radio_Coconino_Control.bits";
 
-        //Cap+ Multi-Site 1 - Traffic LCN 2
-//        String file = path + "20200716_210133_9600BPS_DMR_Aerowave_Technologies_Dallas_LCN_2.bits";
-//        String file = path + "20200716_212309_9600BPS_DMR_Aerowave_Technologies_Dallas_LCN_2.bits";
+        //Cap+ Multi-Site 1 - Data Revert LSN1/2 with CSBKO 62 Site status
+//        String file = path + "Texas_Dallas_Aerowave_Capacity_Plus_Multi_Site/20200716_210133_9600BPS_DMR_Aerowave_Technologies_Dallas_LCN_2.bits";
+//        String file = path + "Texas_Dallas_Aerowave_Capacity_Plus_Multi_Site/20200716_210845_9600BPS_DMR_Aerowave_Technologies_Dallas_LCN_2.bits";
+//        String file = path + "Texas_Dallas_Aerowave_Capacity_Plus_Multi_Site/20200716_212309_9600BPS_DMR_Aerowave_Technologies_Dallas_LCN_2.bits";
 
-        //Cap+ Multi-Site Enhanced GPS Channel
-//        String file = path + "20200714_224018_9600BPS_DMR_Farmers_Electric_Cooperative_Hunt_LCN_3.bits"; //This may have PLL mis-align issues
+        //Cap+ Multi-Site Enhanced Data Revert Channel  (no CSBKO 62)
+//        String file = path + "Texas_Hunt_Farmers_Electric_Capacity_Plus_Multi_Site/20200714_224018_9600BPS_DMR_Farmers_Electric_Cooperative_Hunt_LCN_3.bits"; //This may have PLL mis-align issues
+
+        //Cap+ Multi-Site - Dallas Unknown
+        String file = path + "Texas_Dallas_Unknown_1_Capacity_Plus_Multi_Site/20200716_211233_9600BPS_DMR_Dallas_Unk_Dallas_Unk.bits";
 
         //Hytera Short Data = Proprietary (encrypted)
 //        String file = path + "20200716_222839_9600BPS_DMR_SystemUnk_SiteUnk_Unk.bits"; //Hytera short data packets

src/main/java/io/github/dsheirer/module/decode/dmr/DMRMessageProcessor.java

@@ -111,6 +111,9 @@ public void receive(IMessage message)
             }
         }
 
+        //Now that the message has been (potentially) enriched, dispatch it to the modules
+        dispatch(message);
+
         //Extract the Full Link Control message fragment from the Voice with embedded signalling message
         if(message instanceof VoiceEMBMessage)
         {
@@ -202,9 +205,6 @@ else if((message instanceof IDLEMessage || message instanceof Aloha || message i
         {
             dispatch(mTalkerAliasAssembler.process(flc));
         }
-
-        //Now that the message has been (potentially) enriched, dispatch it to the modules
-        dispatch(message);
     }
 
     /**

src/main/java/io/github/dsheirer/module/decode/dmr/channel/DMRLogicalChannel.java

@@ -1,23 +1,20 @@
 /*
+ * *****************************************************************************
+ * Copyright (C) 2014-2023 Dennis Sheirer
  *
- *  * ******************************************************************************
- *  * Copyright (C) 2014-2019 Dennis Sheirer
- *  *
- *  * This program is free software: you can redistribute it and/or modify
- *  * it under the terms of the GNU General Public License as published by
- *  * the Free Software Foundation, either version 3 of the License, or
- *  * (at your option) any later version.
- *  *
- *  * This program is distributed in the hope that it will be useful,
- *  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  * GNU General Public License for more details.
- *  *
- *  * You should have received a copy of the GNU General Public License
- *  * along with this program.  If not, see <http://www.gnu.org/licenses/>
- *  * *****************************************************************************
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
  *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
  *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ * ****************************************************************************
  */
 
 package io.github.dsheirer.module.decode.dmr.channel;
@@ -87,7 +84,7 @@ public String toString()
     {
         StringBuilder sb = new StringBuilder();
         sb.append("LSN:").append(getLogicalSlotNumber());
-        sb.append(" LCN:").append(getValue());
+//        sb.append(" LCN:").append(getValue());
         return sb.toString();
     }
 }

src/main/java/io/github/dsheirer/module/decode/dmr/message/data/DataMessage.java

@@ -1,6 +1,6 @@
 /*
  * *****************************************************************************
- * Copyright (C) 2014-2022 Dennis Sheirer
+ * Copyright (C) 2014-2023 Dennis Sheirer
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -28,6 +28,9 @@
  */
 public abstract class DataMessage extends DMRBurst
 {
+    //R2, R1, R0 extracted from the BPTC extraction process. Note: message length remains at 96, even though these 3x bits
+    //are set at the end of the message.
+    private static final int[] BPTC_RESERVED_BITS = new int[]{96, 97, 98};
     private SlotType mSlotType;
 
     /**
@@ -54,4 +57,24 @@ public SlotType getSlotType()
     {
         return mSlotType;
     }
+
+    /**
+     * 3x reserved bits that are left-over from the BPTC encode/decode process that can be used to hold values like
+     * Moto RAS indicator.  These message length from the BPTC decoder is set to 96 and these 3x bits are appended to
+     * the end.  However, to keep the message.toString() correct, we specify the length as 96.
+     * @return reserved value.
+     */
+    public int getBPTCReservedBits()
+    {
+        return getMessage().getInt(BPTC_RESERVED_BITS);
+    }
+
+    /**
+     * Indicates if the BPTC reserved bits value is anything other than 0.
+     * @return true if non-zero.
+     */
+    public boolean hasRAS()
+    {
+        return getBPTCReservedBits() != 0;
+    }
 }

src/main/java/io/github/dsheirer/module/decode/dmr/message/data/DataMessageWithLinkControl.java

@@ -1,6 +1,6 @@
 /*
  * *****************************************************************************
- *  Copyright (C) 2014-2020 Dennis Sheirer
+ * Copyright (C) 2014-2023 Dennis Sheirer
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -26,7 +26,6 @@
 import io.github.dsheirer.module.decode.dmr.message.data.lc.LCMessage;
 import io.github.dsheirer.module.decode.dmr.message.data.lc.LCMessageFactory;
 import io.github.dsheirer.module.decode.dmr.message.type.DataType;
-
 import java.util.Collections;
 import java.util.List;
 
@@ -71,6 +70,10 @@ public LCMessage getLCMessage()
     public String toString()
     {
         StringBuilder sb = new StringBuilder();
+        if(hasRAS())
+        {
+            sb.append(" RAS:").append(getBPTCReservedBits());
+        }
         sb.append(getSlotType());
         sb.append(" ").append(getLCMessage());
         return sb.toString();

src/main/java/io/github/dsheirer/module/decode/dmr/message/data/IDLEMessage.java

@@ -1,7 +1,6 @@
 /*
- * ******************************************************************************
- * sdrtrunk
- * Copyright (C) 2014-2020 Zhenyu Mao
+ * *****************************************************************************
+ * Copyright (C) 2014-2023 Dennis Sheirer
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -15,15 +14,14 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>
- * *****************************************************************************
+ * ****************************************************************************
  */
 package io.github.dsheirer.module.decode.dmr.message.data;
 
 import io.github.dsheirer.bits.CorrectedBinaryMessage;
 import io.github.dsheirer.identifier.Identifier;
 import io.github.dsheirer.module.decode.dmr.DMRSyncPattern;
 import io.github.dsheirer.module.decode.dmr.message.CACH;
-
 import java.util.Collections;
 import java.util.List;
 
@@ -50,6 +48,12 @@ public String toString()
     {
         StringBuilder sb = new StringBuilder();
         sb.append("CC:").append(getSlotType().getColorCode());
+
+        if(hasRAS())
+        {
+            sb.append(" RAS:").append(getBPTCReservedBits());
+        }
+
         sb.append(" IDLE");
         return sb.toString();
     }

src/main/java/io/github/dsheirer/module/decode/dmr/message/data/UnknownDataMessage.java

@@ -1,6 +1,6 @@
 /*
  * *****************************************************************************
- *  Copyright (C) 2014-2020 Dennis Sheirer
+ * Copyright (C) 2014-2023 Dennis Sheirer
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -23,7 +23,6 @@
 import io.github.dsheirer.identifier.Identifier;
 import io.github.dsheirer.module.decode.dmr.DMRSyncPattern;
 import io.github.dsheirer.module.decode.dmr.message.CACH;
-
 import java.util.Collections;
 import java.util.List;
 
@@ -61,6 +60,11 @@ public String toString()
             sb.append("TS").append(getTimeslot());
         }
 
+        if(hasRAS())
+        {
+            sb.append(" RAS:").append(getBPTCReservedBits());
+        }
+
         sb.append(" ").append(getSlotType());
         sb.append(" ").append(getMessage().toHexString());
 

src/main/java/io/github/dsheirer/module/decode/dmr/message/data/block/DataBlock.java

@@ -75,6 +75,11 @@ public String toString()
     {
         StringBuilder sb = new StringBuilder();
 
+        if(hasRAS())
+        {
+            sb.append(" RAS:").append(getBPTCReservedBits());
+        }
+
         sb.append(" ").append(getSlotType());
         sb.append(" ").append(getMessage().toHexString());
 

src/main/java/io/github/dsheirer/module/decode/dmr/message/data/csbk/CSBKMessageFactory.java

@@ -39,7 +39,7 @@
 import io.github.dsheirer.module.decode.dmr.message.data.csbk.motorola.CapacityPlusDataRevertWindowGrant;
 import io.github.dsheirer.module.decode.dmr.message.data.csbk.motorola.CapacityPlusNeighbors;
 import io.github.dsheirer.module.decode.dmr.message.data.csbk.motorola.CapacityPlusPreamble;
-import io.github.dsheirer.module.decode.dmr.message.data.csbk.motorola.CapacityPlusSystemStatus;
+import io.github.dsheirer.module.decode.dmr.message.data.csbk.motorola.CapacityPlusSiteStatus;
 import io.github.dsheirer.module.decode.dmr.message.data.csbk.motorola.ConnectPlusCSBKO_16;
 import io.github.dsheirer.module.decode.dmr.message.data.csbk.motorola.ConnectPlusDataChannelGrant;
 import io.github.dsheirer.module.decode.dmr.message.data.csbk.motorola.ConnectPlusDataRevertWindowAnnouncement;
@@ -269,7 +269,7 @@ public static CSBKMessage create(DMRSyncPattern pattern, CorrectedBinaryMessage
                     csbk = new CapacityPlusPreamble(pattern, message, cach, slotType, timestamp, timeslot);
                     break;
                 case MOTOROLA_CAPPLUS_SYSTEM_STATUS:
-                    csbk = new CapacityPlusSystemStatus(pattern, message, cach, slotType, timestamp, timeslot);
+                    csbk = new CapacityPlusSiteStatus(pattern, message, cach, slotType, timestamp, timeslot);
                     break;
                 case MOTOROLA_CAPPLUS_DATA_WINDOW_ANNOUNCEMENT:
                     csbk = new CapacityPlusDataRevertWindowAnnouncement(pattern, message, cach, slotType, timestamp, timeslot);

src/main/java/io/github/dsheirer/module/decode/dmr/message/data/csbk/UnknownCSBKMessage.java

@@ -1,6 +1,6 @@
 /*
  * *****************************************************************************
- *  Copyright (C) 2014-2020 Dennis Sheirer
+ * Copyright (C) 2014-2023 Dennis Sheirer
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -25,7 +25,6 @@
 import io.github.dsheirer.module.decode.dmr.message.CACH;
 import io.github.dsheirer.module.decode.dmr.message.data.SlotType;
 import io.github.dsheirer.module.decode.dmr.message.type.Vendor;
-
 import java.util.Collections;
 import java.util.List;
 
@@ -60,6 +59,10 @@ public String toString()
         }
 
         sb.append("CC:").append(getSlotType().getColorCode());
+        if(hasRAS())
+        {
+            sb.append(" RAS:").append(getBPTCReservedBits());
+        }
         sb.append(" CSBK *UNKNOWN*");
 
         Vendor vendor = getVendor();

src/main/java/io/github/dsheirer/module/decode/dmr/message/data/csbk/hytera/Hytera08Acknowledge.java

@@ -83,6 +83,10 @@ public String toString()
         }
 
         sb.append("CC:").append(getSlotType().getColorCode());
+        if(hasRAS())
+        {
+            sb.append(" RAS:").append(getBPTCReservedBits());
+        }
         sb.append(" HYTERA 08 ").append(getAcknowledgeType());
         sb.append(" REASON:");
 

src/main/java/io/github/dsheirer/module/decode/dmr/message/data/csbk/hytera/Hytera68Acknowledge.java

@@ -82,6 +82,10 @@ public String toString()
         }
 
         sb.append("CC:").append(getSlotType().getColorCode());
+        if(hasRAS())
+        {
+            sb.append(" RAS:").append(getBPTCReservedBits());
+        }
         sb.append(" HYTERA 68 ").append(getAcknowledgeType());
         sb.append(" REASON:");