cot-kmp
0.1.0-alpha05indexedLightweight parser, generator and transformer for Cursor on Target messages; preserves custom detail elements, converts COT types to/from SIDC standards, and serializes XML.
2
Stars
—
Used by
dependents
—
Health
/ 100
cot-kmp
cot-kmp is a lightweight Kotlin Multiplatform library for parsing, generating, and transforming Cursor on Target (COT) messages. It targets Android, JVM/Desktop, and JavaScript.
Targets
- Android API 21+
- JVM 17+
- JavaScript Browser (IR)
Kotlin version requirement: This library requires Kotlin 2.1.x or higher in your project. It will not load correctly with Kotlin 2.0.x or earlier.
Quick Start
Parse a COT message
import cot.parser.CotParser
val result = CotParser.parse(
"""
<event version="2.0" uid="UNIT-001" type="a-f-G-U-C"
time="2024-01-01T00:00:00.000Z" start="2024-01-01T00:00:00.000Z"
stale="2024-01-01T01:00:00.000Z" how="m-g">
<point lat="34.0522" lon="-118.2437" hae="71.0" ce="10.0" le="5.0"/>
</event>
""".trimIndent(),
)
Build and serialize a COT message
import cot.model.CotEvent
import cot.model.CotPoint
import cot.serializer.CotSerializer
val event = CotEvent(
uid = "UNIT-001",
type = "a-f-G-U-C",
time = "2024-01-01T00:00:00.000Z",
start = "2024-01-01T00:00:00.000Z",
stale = "2024-01-01T01:00:00.000Z",
how = "m-g",
point = CotPoint(lat = 34.0522, lon = -118.2437),
)
val xml = CotSerializer.serialize(event)
Convert COT type to SIDC
import cot.sidc.SidcStandard
import cot.sidc.cotTypeToSidc
val sidc2525C = cotTypeToSidc("a-f-G-U-C", SidcStandard.MIL_STD_2525C)
val sidc2525D = cotTypeToSidc("a-f-G-U-C", SidcStandard.MIL_STD_2525D)
Supported SIDC standards in this library:
- MIL-STD-2525B
- MIL-STD-2525C
- MIL-STD-2525D
Convert SIDC back to COT type
import cot.sidc.sidcToCotType
val cotType = sidcToCotType("SFGPUC---------")
JavaScript quick start
npm install cot-kmp
See README.npm.md for the full JavaScript/TypeScript API reference and usage examples.
Java quick start
import cot.CotJvmApi;
import cot.model.CotEvent;
import cot.sidc.SidcStandard;
String xml = "<event version=\"2.0\" uid=\"UNIT-001\" type=\"a-f-G-U-C\" "
+
+
+
+ ;
CotJvmApi.parse(xml);
CotJvmApi.cotTypeToSidc(event.getType(), SidcStandard.MIL_STD_2525C);
CotJvmApi.serialize(event);
All methods throw IllegalArgumentException on failure. CotJvmApi is available on JVM and Android targets.
Detail Extensibility
CotDetail gives you simple access to common detail values like contact info and remarks, while still keeping custom detail elements available when you need them.
If your messages include ATAK or vendor-specific detail tags, they are preserved in a structured form instead of being discarded.
val event = CotParser.parse(xml).getOrThrow()
val group = event.detail?.children?.firstOrNull { it.tag == "__group" }
val role = group?.attributes?.get("role") // e.g. "Team Member"
To add a custom child when building a message:
import cot.model.DetailElement
val detail = CotDetail(
callsign = "ALPHA-1",
children = listOf(
DetailElement(
tag = "status",
attributes = mapOf("battery" to "87"),
),
),
)
For more detail about what is preserved and how it round-trips, see DETAIL_PRESERVATION.md.
Error Handling
Parsing and transformation APIs return Result<T> for normal failures. Invalid XML, malformed COT type strings, and unsupported SIDC values produce descriptive error messages.
COT Type Format Reference
scheme-affiliation-dimension[-function[-modifier]]
Examples:
a-f-G-U-Ca-h-Aa-n-S
For more detail about SIDC support, legacy 2525B interoperability, and known ambiguities, see SIDC_INTEROP.md.
Installation
Via Maven Central (stable releases - recommended)
No extra repository configuration needed.
Android projects must use the
-androidartifact to avoid an AGP dependency analysis bug with KMP module metadata. JVM/Desktop projects use the root artifact.
Android (Kotlin DSL):
dependencies {
implementation("io.github.rosaleskevin:cot-kmp-android:0.1.0-alpha05")
}
JVM / Desktop (Kotlin DSL):
dependencies {
implementation("io.github.rosaleskevin:cot-kmp:0.1.0-alpha05")
}
Gradle (Groovy) — Android:
dependencies {
implementation 'io.github.rosaleskevin:cot-kmp-android:0.1.0-alpha05'
}
Maven — Android:
<dependency>
<groupId>io.github.rosaleskevin</groupId>
<artifactId>cot-kmp-android</artifactId>
<version>0.1.0-alpha05</version>
</dependency>
Maven — JVM:
<dependency>
<groupId>io.github.rosaleskevin</groupId>
<artifactId>cot-kmp</artifactId>
<version>0.1.0-alpha05</version>
</dependency>
Via npm (JavaScript / TypeScript)
npm install cot-kmp
See README.npm.md for usage details.
License
This project is licensed under the MIT License - see the LICENSE file for details. You are free to use, modify, and distribute this library in both open source and commercial/proprietary projects with no restrictions beyond attribution.
Acknowledgements
Inspired by kotcot by cyberpython.