@aeroswarm/codec 0.0.0-stage → 0.1.8

package/src/config/eurocontroll_version/asterix_cat094.xml

@@ -0,0 +1,457 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ===========================================================================
+  ASTERIX Category 094 - System Track Data
+  ===========================================================================
+
+  STATUS: WORKING DRAFT. Infrastructure only.
+
+  EUROCONTROL has allocated CAT094 ("System Track Data", SDPS source, Part 9,
+  blocking NOT allowed) and lists it as the next version of Category 062,
+  still under development. No edition has been published, and EUROCONTROL
+  publishes no machine-readable schema for ASTERIX at all - Categories are
+  free-text PDFs. Everything below that is not marked "defined" is therefore
+  a placeholder awaiting a real CAT094 ICD.
+
+  WHAT IS FILLED IN
+    - Category metadata
+    - Edition metadata
+    - FSPEC mechanism
+    - UAP slot layout (PROVISIONAL - see TODO on the UAP element)
+    - Data items I094/010, I094/015, I094/040, I094/070
+
+  WHAT IS NOT
+    - Every other data item is <Undefined/> with a TODO. No CAT062 structure
+      has been copied in.
+
+  HOW TO EXTEND
+    1. Get the FRN <-> item allocation from the ICD, fix the UAP block.
+    2. For each item, replace <Undefined/> with <Fixed>/<Extended>/
+       <Repetitive>/<Compound>/<Explicit> and set status="defined".
+    3. Re-validate against asterix-spec.xsd (command is in a Note element
+       under CategoryMetadata, since XML comments cannot contain a double hyphen).
+
+  DECODER CONTRACT
+    An item with <Undefined/> has unknown length. ASTERIX data fields are not
+    self-describing, so a decoder that meets an FSPEC bit for an Undefined
+    item MUST abort the record rather than guess - continuing will
+    desynchronise every subsequent field.
+  ===========================================================================
+-->
+<AsterixCategory xmlns="urn:local:asterix:spec:1.0"
+                 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                 xsi:schemaLocation="urn:local:asterix:spec:1.0 asterix-spec.xsd">
+
+  <!-- ===================== Category metadata ===================== -->
+  <CategoryMetadata>
+    <CategoryNumber>94</CategoryNumber>
+    <Name>System Track Data</Name>
+    <Part>9</Part>
+    <DataSource>Surveillance Data Processing System (SDPS)</DataSource>
+    <Purpose>Transmission of system track data from an SDPS to one or more users.</Purpose>
+    <BlockingAllowed>false</BlockingAllowed>
+    <Status>working-draft</Status>
+    <Note>CAT094 is allocated by the ASTERIX Maintenance Group as the next version of Category 062. As of this writing no edition has been published.</Note>
+    <Note>Blocking is not allowed: exactly one Record per Data Block.</Note>
+    <Note>Validate with: xmllint --noout --schema asterix-spec.xsd asterix_cat094.xml</Note>
+  </CategoryMetadata>
+
+  <!-- ===================== Edition metadata ===================== -->
+  <EditionMetadata>
+    <Edition>0.1-draft</Edition>
+    <Date>2026-07-30</Date>
+    <ReferenceDocument id="SPEC-149-Part1">
+      EUROCONTROL Specification for Surveillance Data Exchange, Part 1 - ASTERIX structure and conventions.
+    </ReferenceDocument>
+    <ReferenceDocument id="ASTERIX-CATEGORY-STATUS">
+      EUROCONTROL, "About the status of the Categories" - lists CAT094 as System Track Data, under development.
+    </ReferenceDocument>
+    <ChangeRecord>
+      <Change edition="0.1-draft" date="2026-07-30">
+        Initial skeleton. Infrastructure and items 010/015/040/070 only.
+        TODO: replace with the real edition number and date once the CAT094
+        ICD or the published EUROCONTROL edition is available.
+      </Change>
+    </ChangeRecord>
+  </EditionMetadata>
+
+  <!-- ===================== FSPEC ===================== -->
+  <!--
+    Per Part 1: bits 8..2 of each FSPEC octet address seven consecutive FRNs;
+    bit 1 is the Field Extension Indicator. FX=1 means another octet follows.
+    Spare FRNs are transmitted as 0.
+
+    TODO: maxOctets is provisional. Confirm the final FRN count from the ICD;
+          if CAT094 defines more than 35 FRNs this must grow to 6 octets.
+  -->
+  <Fspec maxOctets="5" frnsPerOctet="7" extensionBit="1">
+    <Note>FRN n maps to FSPEC octet ceil(n/7), bit 8-((n-1) mod 7).</Note>
+    <Note>An FSPEC octet of all zeros with FX=0 is not a valid record.</Note>
+  </Fspec>
+
+  <!-- ===================== UAP ===================== -->
+  <!--
+    TODO - THE ENTIRE FRN ALLOCATION BELOW IS PROVISIONAL.
+
+    Only FRN 1 is safe: Part 1 requires the Data Source Identifier in every
+    record. The remaining slots are reserved so the FSPEC geometry is stable
+    while the file is being filled in; the item numbers attached to them are
+    guesses and MUST be replaced from the CAT094 ICD. Do not ship a decoder
+    that relies on this layout.
+  -->
+  <UAP name="default">
+    <!-- ==== FSPEC octet 1 ==== -->
+    <UapItem frn="1"  fspecOctet="1" fspecBit="8" itemRef="I094/010" status="defined"     presence="mandatory" octets="2"/>
+    <UapItem frn="2"  fspecOctet="1" fspecBit="7" status="spare"/>
+    <UapItem frn="3"  fspecOctet="1" fspecBit="6" itemRef="I094/015" status="defined"     presence="optional"  octets="1"/>
+    <UapItem frn="4"  fspecOctet="1" fspecBit="5" itemRef="I094/070" status="defined"     presence="optional"  octets="3"/>
+    <UapItem frn="5"  fspecOctet="1" fspecBit="4" itemRef="I094/105" status="placeholder">
+      <Comment>TODO: position in WGS-84 co-ordinates. Confirm item number, length and LSB.</Comment>
+    </UapItem>
+    <UapItem frn="6"  fspecOctet="1" fspecBit="3" itemRef="I094/100" status="placeholder">
+      <Comment>TODO: calculated track position, Cartesian. Confirm.</Comment>
+    </UapItem>
+    <UapItem frn="7"  fspecOctet="1" fspecBit="2" itemRef="I094/185" status="placeholder">
+      <Comment>TODO: calculated track velocity, Cartesian. Confirm.</Comment>
+    </UapItem>
+
+    <!-- ==== FSPEC octet 2 ==== -->
+    <UapItem frn="8"  fspecOctet="2" fspecBit="8" itemRef="I094/210" status="placeholder"/>
+    <UapItem frn="9"  fspecOctet="2" fspecBit="7" itemRef="I094/060" status="placeholder"/>
+    <UapItem frn="10" fspecOctet="2" fspecBit="6" itemRef="I094/245" status="placeholder"/>
+    <UapItem frn="11" fspecOctet="2" fspecBit="5" itemRef="I094/380" status="placeholder">
+      <Comment>TODO: aircraft derived data. Expected to be a large Compound item.</Comment>
+    </UapItem>
+    <UapItem frn="12" fspecOctet="2" fspecBit="4" itemRef="I094/040" status="defined"     presence="optional"  octets="2"/>
+    <UapItem frn="13" fspecOctet="2" fspecBit="3" itemRef="I094/080" status="placeholder">
+      <Comment>TODO: track status. Expected Extended (FX-terminated).</Comment>
+    </UapItem>
+    <UapItem frn="14" fspecOctet="2" fspecBit="2" itemRef="I094/290" status="placeholder"/>
+
+    <!-- ==== FSPEC octet 3 ==== -->
+    <UapItem frn="15" fspecOctet="3" fspecBit="8" itemRef="I094/200" status="placeholder"/>
+    <UapItem frn="16" fspecOctet="3" fspecBit="7" itemRef="I094/295" status="placeholder"/>
+    <UapItem frn="17" fspecOctet="3" fspecBit="6" itemRef="I094/136" status="placeholder"/>
+    <UapItem frn="18" fspecOctet="3" fspecBit="5" itemRef="I094/130" status="placeholder"/>
+    <UapItem frn="19" fspecOctet="3" fspecBit="4" itemRef="I094/135" status="placeholder"/>
+    <UapItem frn="20" fspecOctet="3" fspecBit="3" itemRef="I094/220" status="placeholder"/>
+    <UapItem frn="21" fspecOctet="3" fspecBit="2" itemRef="I094/390" status="placeholder"/>
+
+    <!-- ==== FSPEC octet 4 ==== -->
+    <UapItem frn="22" fspecOctet="4" fspecBit="8" itemRef="I094/270" status="placeholder"/>
+    <UapItem frn="23" fspecOctet="4" fspecBit="7" itemRef="I094/300" status="placeholder"/>
+    <UapItem frn="24" fspecOctet="4" fspecBit="6" itemRef="I094/110" status="placeholder"/>
+    <UapItem frn="25" fspecOctet="4" fspecBit="5" itemRef="I094/120" status="placeholder"/>
+    <UapItem frn="26" fspecOctet="4" fspecBit="4" itemRef="I094/510" status="placeholder"/>
+    <UapItem frn="27" fspecOctet="4" fspecBit="3" itemRef="I094/500" status="placeholder"/>
+    <UapItem frn="28" fspecOctet="4" fspecBit="2" itemRef="I094/340" status="placeholder"/>
+
+    <!-- ==== FSPEC octet 5 ==== -->
+    <UapItem frn="29" fspecOctet="5" fspecBit="8" status="spare">
+      <Comment>TODO: reserved for new CAT094 items not present in CAT062.</Comment>
+    </UapItem>
+    <UapItem frn="30" fspecOctet="5" fspecBit="7" status="spare"/>
+    <UapItem frn="31" fspecOctet="5" fspecBit="6" status="spare"/>
+    <UapItem frn="32" fspecOctet="5" fspecBit="5" status="spare"/>
+    <UapItem frn="33" fspecOctet="5" fspecBit="4" status="spare"/>
+    <UapItem frn="34" fspecOctet="5" fspecBit="3" itemRef="RE" status="special"/>
+    <UapItem frn="35" fspecOctet="5" fspecBit="2" itemRef="SP" status="special"/>
+  </UAP>
+
+  <!-- ===================== Data items ===================== -->
+  <DataItems>
+
+    <!-- ============ DEFINED ============ -->
+
+    <DataItem ref="I094/010" presence="mandatory" status="defined">
+      <Name>Data Source Identifier</Name>
+      <Definition>Identification of the system sending the data.</Definition>
+      <Format>Two-octet fixed length Data Item.</Format>
+      <Structure>
+        <Fixed octets="2">
+          <Field name="SAC" longName="System Area Code"           from="16" to="9" encoding="unsigned"/>
+          <Field name="SIC" longName="System Identification Code"  from="8"  to="1" encoding="unsigned"/>
+        </Fixed>
+      </Structure>
+      <EncodingRule>This Item shall be present in every ASTERIX record (Part 1).</EncodingRule>
+      <Note>The current list of allocated SACs is maintained by EUROCONTROL.</Note>
+    </DataItem>
+
+    <DataItem ref="I094/015" presence="optional" status="defined">
+      <Name>Service Identification</Name>
+      <Definition>Identification of the service provided to one or more users.</Definition>
+      <Format>One-octet fixed length Data Item.</Format>
+      <Structure>
+        <Fixed octets="1">
+          <Field name="SI" longName="Service Identification" from="8" to="1" encoding="unsigned"/>
+        </Fixed>
+      </Structure>
+      <EncodingRule>The service identification is allocated by the SDPS.</EncodingRule>
+    </DataItem>
+
+    <DataItem ref="I094/040" presence="optional" status="defined">
+      <Name>Track Number</Name>
+      <Definition>Identification of a track.</Definition>
+      <Format>Two-octet fixed length Data Item.</Format>
+      <Structure>
+        <Fixed octets="2">
+          <Field name="TRK" longName="Track Number" from="16" to="1" encoding="unsigned"/>
+        </Fixed>
+      </Structure>
+      <Note>TODO: confirm width. If CAT094 widens the track number beyond 16 bits this item becomes 3 or 4 octets and the UAP length attribute must follow.</Note>
+    </DataItem>
+
+    <DataItem ref="I094/070" presence="optional" status="defined">
+      <Name>Time Of Track Information</Name>
+      <Definition>Absolute time stamping of the track information, expressed as UTC time.</Definition>
+      <Format>Three-octet fixed length Data Item.</Format>
+      <Structure>
+        <Fixed octets="3">
+          <Field name="TOT" longName="Time Of Track Information"
+                 from="24" to="1" encoding="unsigned" lsb="0.0078125" unit="s"/>
+        </Fixed>
+      </Structure>
+      <EncodingRule>The time is reset to zero at midnight UTC; the counter wraps after 24 hours.</EncodingRule>
+      <Note>TODO: confirm resolution. LSB is 1/128 s in the predecessor category; a successor category may adopt a finer LSB or a wider field.</Note>
+    </DataItem>
+
+    <!-- ============ PLACEHOLDERS ============
+         Each entry below reserves an item number and nothing else.
+         Replace <Undefined/> with a real structure and flip status to
+         "defined" as the ICD becomes available.
+    -->
+
+    <DataItem ref="I094/060" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Define name, definition, format and bit layout from the CAT094 ICD.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/080" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Expected to be an Extended (FX-terminated) item. Number of extents unknown.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/100" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Define bit layout and LSB.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/105" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Define bit layout and LSB. Check whether CAT094 increases coordinate resolution.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/110" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Expected Compound. Define primary subfield bitmap and subfield list.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/120" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Define bit layout.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/130" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Define bit layout, sign convention and LSB.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/135" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Define bit layout, sign convention and LSB.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/136" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Define bit layout, sign convention and LSB.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/185" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Define bit layout and LSB.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/200" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Define bit layout and enumerations.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/210" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Define bit layout and LSB.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/220" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Define bit layout and LSB.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/245" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Define bit layout. Check character encoding (ICAO 6-bit vs ASCII).</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/270" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Define bit layout and LSB.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/290" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Expected Compound. Define primary subfield bitmap and subfield list.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/295" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Expected Compound. Define primary subfield bitmap and subfield list.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/300" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Define enumeration.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/340" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Expected Compound. Define primary subfield bitmap and subfield list.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/380" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Expected Compound with a multi-octet primary subfield. Define the full subfield list; this is the largest single item in the category and the most likely to change between editions.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/390" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Expected Compound. Define primary subfield bitmap and subfield list.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/500" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Expected Compound. Define primary subfield bitmap and subfield list.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <DataItem ref="I094/510" status="placeholder">
+      <Name>TODO</Name>
+      <Structure>
+        <Undefined reason="No published CAT094 specification">
+          <Todo>Expected Extended with multi-octet extents. Define extent width and fields.</Todo>
+        </Undefined>
+      </Structure>
+    </DataItem>
+
+    <!-- ============ SPECIAL FIELDS ============ -->
+
+    <DataItem ref="RE" presence="optional" status="special">
+      <Name>Reserved Expansion Field</Name>
+      <Definition>Expansion field carrying data items not present in the standard UAP.</Definition>
+      <Format>Explicit length Data Item: one length octet (inclusive) followed by the field contents.</Format>
+      <Structure>
+        <Explicit lengthOctets="1">
+          <Note>Contents are opaque to this specification.</Note>
+        </Explicit>
+      </Structure>
+      <Note>TODO: no Reserved Expansion Field has been defined for CAT094. Add a sub-UAP here when one exists.</Note>
+    </DataItem>
+
+    <DataItem ref="SP" presence="optional" status="special">
+      <Name>Special Purpose Field</Name>
+      <Definition>Field reserved for bilaterally agreed, non-standard data.</Definition>
+      <Format>Explicit length Data Item: one length octet (inclusive) followed by the field contents.</Format>
+      <Structure>
+        <Explicit lengthOctets="1">
+          <Note>Contents are subject to bilateral agreement and are opaque to this specification.</Note>
+        </Explicit>
+      </Structure>
+    </DataItem>
+
+  </DataItems>
+</AsterixCategory>