1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![doc(html_logo_url = "https://raw.githubusercontent.com/rsadsb/adsb_deku/master/media/logo.png")]
/*!
`adsb_deku` provides decoding for the [`ADS-B`] Downlink protocol by using the [`deku`] crate.
See [`rsadsb.github.io`] for more details.
# Downlink Format Support
| [`DF`] | Name | Section |
| -------- | ----------------------------------- | ----------- |
| 0 | [`Short Air-Air Surveillance`] | 3.1.2.8.2 |
| 4 | [`Surveillance Altitude Reply`] | 3.1.2.6.5 |
| 5 | [`Surveillance Identity Reply`] | 3.1.2.6.7 |
| 11 | [`All Call Reply`] | 2.1.2.5.2.2 |
| 16 | [`Long Air-Air Surveillance`] | 3.1.2.8.3 |
| 17 | [`Extended Squitter(ADS-B)`] | 3.1.2.8.6 |
| 18 | [`Extended Squitter(TIS-B)`] | 3.1.2.8.7 |
| 19 | [`Extended Squitter(Military)`] | 3.1.2.8.8 |
| 20 | [`Comm-B Altitude Reply`] | 3.1.2.6.6 |
| 21 | [`Comm-B Identity Reply`] | 3.1.2.6.8 |
| 24 | [`Comm-D`] | 3.1.2.7.3 |
# [`Comm-B Altitude Reply`] and [`Comm-B Identity Reply`] Comm-B Support
| [`BDS`] | Name | Table |
| --------- | --------------------------------------- | ----------- |
| (0,0) | [`Empty`] | |
| (1,0) | [`Data Link Capability`] | A-2-16 |
| (2,0) | [`Aircraft Identification`] | A-2-32 |
# [`Extended Squitter(ADS-B)`] and [`Extended Squitter(TIS-B)`] Type Code Support
| [`ME`](Type Code) | Name |
| ------------------- | ----------------------------------- |
| 0 | [`ME::NoPosition`] |
| 1..=4 | [`ME::AircraftIdentification`] |
| 5..=8 | [`ME::SurfacePosition`] |
| 9..=18 | [`ME::AirbornePositionBaroAltitude`] |
| 19 | [`ME::AirborneVelocity`] |
| 20..=22 | [`ME::AirbornePositionGNSSAltitude`] |
| 23 | [`ME::Reserved0`] |
| 24 | [`ME::SurfaceSystemStatus`] |
| 25..=27 | [`ME::Reserved1`] |
| 28 | [`ME::AircraftStatus`] |
| 29 | [`ME::TargetStateAndStatusInformation`]|
| 30 | [`ME::AircraftOperationalCoordination`]|
| 31 | [`ME::AircraftOperationStatus`] |
# Example
To begin using `adsb_deku`, import the [`Frame`] struct as well as the trait [`deku::DekuContainerRead`].
This trait is re-exported for your convenience. [`Frame::from_bytes()`] provides the interface for decoding bytes
into adsb data.
```rust
use hexlit::hex;
use adsb_deku::Frame;
use adsb_deku::deku::DekuContainerRead;
let bytes = hex!("8da2c1bd587ba2adb31799cb802b");
let frame = Frame::from_bytes((&bytes, 0)).unwrap().1;
assert_eq!(
r#" Extended Squitter Airborne position (barometric altitude)
Address: a2c1bd (Mode S / ADS-B)
Air/Ground: airborne
Altitude: 23650 ft barometric
CPR type: Airborne
CPR odd flag: even
CPR latitude: (87769)
CPR longitude: (71577)
"#,
frame.to_string()
);
```
# Apps
The [`apps/`] directory of the project repository contains programs `radar` and `1090` for showcasing
different `adsb_deku` uses. See the [`README.md`] for examples of use.
[`DF`]: crate::DF
[`ME`]: crate::adsb::ME
[`BDS`]: crate::bds::BDS
[`Short Air-Air Surveillance`]: crate::DF::ShortAirAirSurveillance
[`Surveillance Altitude Reply`]: crate::DF::SurveillanceAltitudeReply
[`Surveillance Identity Reply`]: crate::DF::SurveillanceIdentityReply
[`All Call Reply`]: crate::DF::AllCallReply
[`Long Air-Air Surveillance`]: crate::DF::LongAirAir
[`Extended Squitter(ADS-B)`]: crate::DF::ADSB
[`Extended Squitter(TIS-B)`]: crate::DF::TisB
[`Extended Squitter(Military)`]: crate::DF::ExtendedQuitterMilitaryApplication
[`Comm-B Altitude Reply`]: crate::DF::CommBAltitudeReply
[`Comm-B Identity Reply`]: crate::DF::CommBIdentityReply
[`Comm-D`]: crate::DF::CommDExtendedLengthMessage
[`Empty`]: crate::bds::BDS::Empty
[`Data Link Capability`]: crate::bds::BDS::DataLinkCapability
[`Aircraft Identification`]: crate::bds::BDS::AircraftIdentification
[`ME::NoPosition`]: crate::adsb::ME::NoPosition
[`ME::AircraftIdentification`]: crate::adsb::ME::AircraftIdentification
[`ME::SurfacePosition`]: crate::adsb::ME::SurfacePosition
[`ME::AirbornePositionBaroAltitude`]: crate::adsb::ME::AirbornePositionBaroAltitude
[`ME::AirborneVelocity`]: crate::adsb::ME::AirborneVelocity
[`ME::AirbornePositionGNSSAltitude`]: crate::adsb::ME::AirbornePositionGNSSAltitude
[`ME::Reserved0`]: crate::adsb::ME::Reserved0
[`ME::SurfaceSystemStatus`]: crate::adsb::ME::SurfaceSystemStatus
[`ME::Reserved1`]: crate::adsb::ME::Reserved1
[`ME::AircraftStatus`]: crate::adsb::ME::AircraftStatus
[`ME::TargetStateAndStatusInformation`]: crate::adsb::ME::TargetStateAndStatusInformation
[`ME::AircraftOperationalCoordination`]: crate::adsb::ME::AircraftOperationalCoordination
[`ME::AircraftOperationStatus`]: crate::adsb::ME::AircraftOperationStatus
[`README.md`]: https://github.com/rsadsb/adsb_deku/blob/master/README.md
[`apps/`]: https://github.com/rsadsb/adsb_deku/tree/master/apps
[`ADS-B`]: https://en.wikipedia.org/wiki/Automatic_Dependent_Surveillance%E2%80%93Broadcast
[`deku`]: https://github.com/sharksforarms/deku
[`rsadsb.github.io`]: https://rsadsb.github.io/
*/
// good reference: http://www.anteni.net/adsb/Doc/1090-WP30-18-DRAFT_DO-260B-V42.pdf
//
// Maybe always reference this in the future?
/// re-export deku
pub use deku;
extern crate alloc;
#[cfg(feature = "alloc")]
use alloc::{fmt, format, string::String, string::ToString, vec, vec::Vec};
#[cfg(feature = "alloc")]
use core::{
clone::Clone,
cmp::Eq,
cmp::PartialEq,
default::Default,
fmt::Debug,
hash::Hash,
iter::IntoIterator,
marker::Copy,
prelude::rust_2021::derive,
result,
result::Result::{Err, Ok},
write, writeln,
};
pub mod adsb;
pub mod bds;
pub mod cpr;
mod crc;
mod mode_ac;
#[doc = include_str!("../README.md")]
mod readme_test {}
use adsb::{ControlField, ADSB};
use bds::BDS;
use deku::bitvec::{BitSlice, Msb0};
use deku::prelude::*;
/// Downlink ADS-B Packet
#[derive(Debug, PartialEq, DekuRead, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Frame {
/// Starting with 5 bit identifier, decode packet
pub df: DF,
/// Calculated from all bits, used as ICAO for Response packets
#[deku(reader = "Self::read_crc(df, deku::input_bits)")]
pub crc: u32,
}
impl Frame {
/// Read rest as CRC bits
fn read_crc<'b>(
df: &DF,
rest: &'b BitSlice<u8, Msb0>,
) -> result::Result<(&'b BitSlice<u8, Msb0>, u32), DekuError> {
const MODES_LONG_MSG_BYTES: usize = 14;
const MODES_SHORT_MSG_BYTES: usize = 7;
let bit_len = if let Ok(id) = df.deku_id() {
if id & 0x10 != 0 {
MODES_LONG_MSG_BYTES * 8
} else {
MODES_SHORT_MSG_BYTES * 8
}
} else {
// In this case, it's the DF::CommD, which has multiple ids
MODES_LONG_MSG_BYTES * 8
};
let (_, remaining_bytes, _) = rest.domain().region().unwrap();
let crc = crc::modes_checksum(remaining_bytes, bit_len)?;
Ok((rest, crc))
}
}
impl fmt::Display for Frame {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let crc = self.crc;
match &self.df {
DF::ShortAirAirSurveillance { altitude, .. } => {
writeln!(f, " Short Air-Air Surveillance")?;
writeln!(f, " ICAO Address: {crc:06x} (Mode S / ADS-B)")?;
if altitude.0 > 0 {
let altitude = altitude.0;
writeln!(f, " Air/Ground: airborne?")?;
writeln!(f, " Altitude: {altitude} ft barometric")?;
} else {
writeln!(f, " Air/Ground: ground")?;
}
}
DF::SurveillanceAltitudeReply { fs, ac, .. } => {
writeln!(f, " Surveillance, Altitude Reply")?;
writeln!(f, " ICAO Address: {crc:06x} (Mode S / ADS-B)")?;
writeln!(f, " Air/Ground: {fs}")?;
if ac.0 > 0 {
let altitude = ac.0;
writeln!(f, " Altitude: {altitude} ft barometric")?;
}
}
DF::SurveillanceIdentityReply { fs, id, .. } => {
let identity = id.0;
writeln!(f, " Surveillance, Identity Reply")?;
writeln!(f, " ICAO Address: {crc:06x} (Mode S / ADS-B)")?;
writeln!(f, " Air/Ground: {fs}")?;
writeln!(f, " Identity: {identity:04x}")?;
}
DF::AllCallReply { capability, icao, .. } => {
writeln!(f, " All Call Reply")?;
writeln!(f, " ICAO Address: {icao} (Mode S / ADS-B)")?;
writeln!(f, " Air/Ground: {capability}")?;
}
DF::LongAirAir { altitude, .. } => {
writeln!(f, " Long Air-Air ACAS")?;
writeln!(f, " ICAO Address: {crc:06x} (Mode S / ADS-B)")?;
// TODO the airborne? should't be static
if altitude.0 > 0 {
let altitude = altitude.0;
writeln!(f, " Air/Ground: airborne?")?;
writeln!(f, " Baro altitude: {altitude} ft")?;
} else {
writeln!(f, " Air/Ground: ground")?;
}
}
DF::ADSB(adsb) => {
write!(f, "{}", adsb.to_string("(Mode S / ADS-B)")?)?;
}
DF::TisB { cf, .. } => {
write!(f, "{cf}")?;
}
// TODO
DF::ExtendedQuitterMilitaryApplication { .. } => {}
DF::CommBAltitudeReply { bds, alt, .. } => {
writeln!(f, " Comm-B, Altitude Reply")?;
writeln!(f, " ICAO Address: {crc:x?} (Mode S / ADS-B)")?;
let altitude = alt.0;
writeln!(f, " Altitude: {altitude} ft")?;
write!(f, " {bds}")?;
}
DF::CommBIdentityReply { id, bds, .. } => {
writeln!(f, " Comm-B, Identity Reply")?;
writeln!(f, " ICAO Address: {crc:x?} (Mode S / ADS-B)")?;
writeln!(f, " Squawk: {id:x?}")?;
write!(f, " {bds}")?;
}
DF::CommDExtendedLengthMessage { .. } => {
writeln!(f, " Comm-D Extended Length Message")?;
writeln!(f, " ICAO Address: {crc:x?} (Mode S / ADS-B)")?;
}
}
Ok(())
}
}
/// Downlink Format (3.1.2.3.2.1.2)
///
/// Starting with 5 bits, decode the rest of the message as the correct data packets
#[derive(Debug, PartialEq, DekuRead, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[deku(type = "u8", bits = "5")]
pub enum DF {
/// 17: Extended Squitter, Downlink Format 17 (3.1.2.8.6)
///
/// Civil aircraft ADS-B message
#[deku(id = "17")]
ADSB(ADSB),
/// 11: (Mode S) All-call reply, Downlink format 11 (2.1.2.5.2.2)
#[deku(id = "11")]
AllCallReply {
/// CA: Capability
capability: Capability,
/// AA: Address Announced
icao: ICAO,
/// PI: Parity/Interrogator identifier
p_icao: ICAO,
},
/// 0: (Mode S) Short Air-Air Surveillance, Downlink Format 0 (3.1.2.8.2)
#[deku(id = "0")]
ShortAirAirSurveillance {
/// VS: Vertical Status
#[deku(bits = "1")]
vs: u8,
/// CC:
#[deku(bits = "1")]
cc: u8,
/// Spare
#[deku(bits = "1")]
unused: u8,
/// SL: Sensitivity level, ACAS
#[deku(bits = "3")]
sl: u8,
/// Spare
#[deku(bits = "2")]
unused1: u8,
/// RI: Reply Information
#[deku(bits = "4")]
ri: u8,
/// Spare
#[deku(bits = "2")]
unused2: u8,
/// AC: altitude code
altitude: AC13Field,
/// AP: address, parity
parity: ICAO,
},
/// 4: (Mode S) Surveillance Altitude Reply, Downlink Format 4 (3.1.2.6.5)
#[deku(id = "4")]
SurveillanceAltitudeReply {
/// FS: Flight Status
fs: FlightStatus,
/// DR: DownlinkRequest
dr: DownlinkRequest,
/// UM: Utility Message
um: UtilityMessage,
/// AC: AltitudeCode
ac: AC13Field,
/// AP: Address/Parity
ap: ICAO,
},
/// 5: (Mode S) Surveillance Identity Reply (3.1.2.6.7)
#[deku(id = "5")]
SurveillanceIdentityReply {
/// FS: Flight Status
fs: FlightStatus,
/// DR: Downlink Request
dr: DownlinkRequest,
/// UM: UtilityMessage
um: UtilityMessage,
/// ID: Identity
id: IdentityCode,
/// AP: Address/Parity
ap: ICAO,
},
/// 16: (Mode S) Long Air-Air Surveillance Downlink Format 16 (3.1.2.8.3)
#[deku(id = "16")]
LongAirAir {
#[deku(bits = "1")]
vs: u8,
#[deku(bits = "2")]
spare1: u8,
#[deku(bits = "3")]
sl: u8,
#[deku(bits = "2")]
spare2: u8,
#[deku(bits = "4")]
ri: u8,
#[deku(bits = "2")]
spare3: u8,
/// AC: altitude code
altitude: AC13Field,
/// MV: message, acas
#[deku(count = "7")]
mv: Vec<u8>,
/// AP: address, parity
parity: ICAO,
},
/// 18: Extended Squitter/Supplementary, Downlink Format 18 (3.1.2.8.7)
///
/// Non-Transponder-based ADS-B Transmitting Subsystems and TIS-B Transmitting equipment.
/// Equipment that cannot be interrogated.
#[deku(id = "18")]
TisB {
/// Enum containing message
cf: ControlField,
/// PI: parity/interrogator identifier
pi: ICAO,
},
/// 19: Extended Squitter Military Application, Downlink Format 19 (3.1.2.8.8)
#[deku(id = "19")]
ExtendedQuitterMilitaryApplication {
/// Reserved
#[deku(bits = "3")]
af: u8,
},
/// 20: COMM-B Altitude Reply (3.1.2.6.6)
#[deku(id = "20")]
CommBAltitudeReply {
/// FS: Flight Status
flight_status: FlightStatus,
/// DR: Downlink Request
dr: DownlinkRequest,
/// UM: Utility Message
um: UtilityMessage,
/// AC: Altitude Code
alt: AC13Field,
/// MB Message, Comm-B
bds: BDS,
/// AP: address/parity
parity: ICAO,
},
/// 21: COMM-B Reply, Downlink Format 21 (3.1.2.6.8)
#[deku(id = "21")]
CommBIdentityReply {
/// FS: Flight Status
fs: FlightStatus,
/// DR: Downlink Request
dr: DownlinkRequest,
/// UM: Utility Message
um: UtilityMessage,
/// ID: Identity
#[deku(
bits = "13",
endian = "big",
map = "|squawk: u32| -> Result<_, DekuError> {Ok(mode_ac::decode_id13_field(squawk))}"
)]
id: u32,
/// MB Message, Comm-B
bds: BDS,
/// AP address/parity
parity: ICAO,
},
/// 24..=31: Comm-D(ELM), Downlink Format 24 (3.1.2.7.3)
#[deku(id_pat = "24..=31")]
CommDExtendedLengthMessage {
/// Spare - 1 bit
#[deku(bits = "1")]
spare: u8,
/// KE: control, ELM
ke: KE,
/// ND: number of D-segment
#[deku(bits = "4")]
nd: u8,
/// MD: message, Comm-D, 80 bits
#[deku(count = "10")]
md: Vec<u8>,
/// AP: address/parity
parity: ICAO,
},
}
/// Latitude, Longitude and Altitude information
#[derive(Debug, PartialEq, Eq, DekuRead, Default, Copy, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Altitude {
#[deku(bits = "5")]
pub tc: u8,
pub ss: SurveillanceStatus,
#[deku(bits = "1")]
pub saf_or_imf: u8,
#[deku(reader = "Self::read(deku::rest)")]
pub alt: Option<u16>,
/// UTC sync or not
#[deku(bits = "1")]
pub t: bool,
/// Odd or even
pub odd_flag: CPRFormat,
#[deku(bits = "17", endian = "big")]
pub lat_cpr: u32,
#[deku(bits = "17", endian = "big")]
pub lon_cpr: u32,
}
impl fmt::Display for Altitude {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let altitude = self
.alt
.map_or_else(|| "None".to_string(), |altitude| format!("{altitude} ft barometric"));
writeln!(f, " Altitude: {altitude}")?;
writeln!(f, " CPR type: Airborne")?;
writeln!(f, " CPR odd flag: {}", self.odd_flag)?;
writeln!(f, " CPR latitude: ({})", self.lat_cpr)?;
writeln!(f, " CPR longitude: ({})", self.lon_cpr)?;
Ok(())
}
}
impl Altitude {
/// `decodeAC12Field`
fn read(rest: &BitSlice<u8, Msb0>) -> Result<(&BitSlice<u8, Msb0>, Option<u16>), DekuError> {
let (rest, num) = u32::read(rest, (deku::ctx::Endian::Big, deku::ctx::BitSize(12)))?;
let q = num & 0x10;
if q > 0 {
let n = ((num & 0x0fe0) >> 1) | (num & 0x000f);
let n = n * 25;
if n > 1000 {
// TODO: maybe replace with Result->Option
Ok((rest, u16::try_from(n - 1000).ok()))
} else {
Ok((rest, None))
}
} else {
let mut n = ((num & 0x0fc0) << 1) | (num & 0x003f);
n = mode_ac::decode_id13_field(n);
if let Ok(n) = mode_ac::mode_a_to_mode_c(n) {
Ok((rest, u16::try_from(n * 100).ok()))
} else {
Ok((rest, None))
}
}
}
}
/// SPI Condition
#[derive(Debug, PartialEq, Eq, DekuRead, Copy, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[deku(type = "u8", bits = "2")]
pub enum SurveillanceStatus {
NoCondition = 0,
PermanentAlert = 1,
TemporaryAlert = 2,
SPICondition = 3,
}
impl Default for SurveillanceStatus {
fn default() -> Self {
Self::NoCondition
}
}
/// Even / Odd
#[derive(Debug, PartialEq, Eq, DekuRead, Copy, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[deku(type = "u8", bits = "1")]
pub enum CPRFormat {
Even = 0,
Odd = 1,
}
impl Default for CPRFormat {
fn default() -> Self {
Self::Even
}
}
impl fmt::Display for CPRFormat {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(
f,
"{}",
match self {
Self::Even => "even",
Self::Odd => "odd",
}
)
}
}
/// Positive / Negative
#[derive(Debug, PartialEq, Eq, DekuRead, Copy, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[deku(type = "u8", bits = "1")]
pub enum Sign {
Positive = 0,
Negative = 1,
}
impl Sign {
#[must_use]
pub fn value(&self) -> i16 {
match self {
Self::Positive => 1,
Self::Negative => -1,
}
}
}
impl fmt::Display for Sign {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(
f,
"{}",
match self {
Self::Positive => "",
Self::Negative => "-",
}
)
}
}
/// 13 bit identity code
#[derive(Debug, PartialEq, Eq, DekuRead, Copy, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct IdentityCode(#[deku(reader = "Self::read(deku::rest)")] pub u16);
impl IdentityCode {
fn read(rest: &BitSlice<u8, Msb0>) -> result::Result<(&BitSlice<u8, Msb0>, u16), DekuError> {
let (rest, num) = u32::read(rest, (deku::ctx::Endian::Big, deku::ctx::BitSize(13)))?;
let c1 = (num & 0b1_0000_0000_0000) >> 12;
let a1 = (num & 0b0_1000_0000_0000) >> 11;
let c2 = (num & 0b0_0100_0000_0000) >> 10;
let a2 = (num & 0b0_0010_0000_0000) >> 9;
let c4 = (num & 0b0_0001_0000_0000) >> 8;
let a4 = (num & 0b0_0000_1000_0000) >> 7;
let b1 = (num & 0b0_0000_0010_0000) >> 5;
let d1 = (num & 0b0_0000_0001_0000) >> 4;
let b2 = (num & 0b0_0000_0000_1000) >> 3;
let d2 = (num & 0b0_0000_0000_0100) >> 2;
let b4 = (num & 0b0_0000_0000_0010) >> 1;
let d4 = num & 0b0_0000_0000_0001;
let a = a4 << 2 | a2 << 1 | a1;
let b = b4 << 2 | b2 << 1 | b1;
let c = c4 << 2 | c2 << 1 | c1;
let d = d4 << 2 | d2 << 1 | d1;
let num: u16 = (a << 12 | b << 8 | c << 4 | d) as u16;
Ok((rest, num))
}
}
/// ICAO Address; Mode S transponder code
#[derive(Debug, PartialEq, Eq, PartialOrd, DekuRead, Hash, Copy, Clone, Ord)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ICAO(pub [u8; 3]);
impl fmt::Display for ICAO {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{:02x}", self.0[0])?;
write!(f, "{:02x}", self.0[1])?;
write!(f, "{:02x}", self.0[2])?;
Ok(())
}
}
impl core::str::FromStr for ICAO {
type Err = core::num::ParseIntError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
let num = u32::from_str_radix(s, 16)?;
let bytes = num.to_be_bytes();
let num = [bytes[1], bytes[2], bytes[3]];
Ok(Self(num))
}
}
/// Type of `DownlinkRequest`
#[derive(Debug, PartialEq, Eq, DekuRead, Copy, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[deku(type = "u8", bits = "5")]
pub enum DownlinkRequest {
None = 0b00000,
RequestSendCommB = 0b00001,
CommBBroadcastMsg1 = 0b00100,
CommBBroadcastMsg2 = 0b00101,
#[deku(id_pat = "_")]
Unknown,
}
/// Uplink / Downlink
#[derive(Debug, PartialEq, Eq, DekuRead, Copy, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[deku(type = "u8", bits = "1")]
pub enum KE {
DownlinkELMTx = 0,
UplinkELMAck = 1,
}
#[derive(Debug, PartialEq, Eq, DekuRead, Copy, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct UtilityMessage {
#[deku(bits = "4")]
pub iis: u8,
pub ids: UtilityMessageType,
}
/// Message Type
#[derive(Debug, PartialEq, Eq, DekuRead, Copy, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[deku(type = "u8", bits = "2")]
pub enum UtilityMessageType {
NoInformation = 0b00,
CommB = 0b01,
CommC = 0b10,
CommD = 0b11,
}
/// Airborne / Ground and SPI
#[derive(Debug, PartialEq, Eq, DekuRead, Copy, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[deku(type = "u8", bits = "3")]
pub enum FlightStatus {
NoAlertNoSPIAirborne = 0b000,
NoAlertNoSPIOnGround = 0b001,
AlertNoSPIAirborne = 0b010,
AlertNoSPIOnGround = 0b011,
AlertSPIAirborneGround = 0b100,
NoAlertSPIAirborneGround = 0b101,
Reserved = 0b110,
NotAssigned = 0b111,
}
impl fmt::Display for FlightStatus {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(
f,
"{}",
match self {
Self::NoAlertNoSPIAirborne
| Self::AlertSPIAirborneGround
| Self::NoAlertSPIAirborneGround => "airborne?",
Self::NoAlertNoSPIOnGround => "ground?",
Self::AlertNoSPIAirborne => "airborne",
Self::AlertNoSPIOnGround => "ground",
_ => "reserved",
}
)
}
}
/// 13 bit encoded altitude
#[derive(Debug, PartialEq, Eq, DekuRead, Copy, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct AC13Field(#[deku(reader = "Self::read(deku::rest)")] pub u16);
impl AC13Field {
// TODO Add unit
fn read(rest: &BitSlice<u8, Msb0>) -> result::Result<(&BitSlice<u8, Msb0>, u16), DekuError> {
let (rest, num) = u32::read(rest, (deku::ctx::Endian::Big, deku::ctx::BitSize(13)))?;
let m_bit = num & 0x0040;
let q_bit = num & 0x0010;
if m_bit != 0 {
// TODO: this might be wrong?
Ok((rest, 0))
} else if q_bit != 0 {
let n = ((num & 0x1f80) >> 2) | ((num & 0x0020) >> 1) | (num & 0x000f);
let n = n * 25;
if n > 1000 {
Ok((rest, (n - 1000) as u16))
} else {
// TODO: add error
Ok((rest, 0))
}
} else {
// TODO 11 bit gillham coded altitude
if let Ok(n) = mode_ac::mode_a_to_mode_c(mode_ac::decode_id13_field(num)) {
Ok((rest, (100 * n) as u16))
} else {
Ok((rest, 0))
}
}
}
}
/// Transponder level and additional information (3.1.2.5.2.2.1)
#[derive(Debug, PartialEq, Eq, DekuRead, Copy, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[deku(type = "u8", bits = "3")]
#[allow(non_camel_case_types)]
pub enum Capability {
/// Level 1 transponder (surveillance only), and either airborne or on the ground
AG_UNCERTAIN = 0x00,
#[deku(id_pat = "0x01..=0x03")]
Reserved,
/// Level 2 or above transponder, on ground
AG_GROUND = 0x04,
/// Level 2 or above transponder, airborne
AG_AIRBORNE = 0x05,
/// Level 2 or above transponder, either airborne or on ground
AG_UNCERTAIN2 = 0x06,
/// DR field is not equal to 0, or fs field equal 2, 3, 4, or 5, and either airborne or on
/// ground
AG_UNCERTAIN3 = 0x07,
}
impl fmt::Display for Capability {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(
f,
"{}",
match self {
Self::AG_UNCERTAIN => "uncertain1",
Self::Reserved => "reserved",
Self::AG_GROUND => "ground",
Self::AG_AIRBORNE => "airborne",
Self::AG_UNCERTAIN2 => "uncertain2",
Self::AG_UNCERTAIN3 => "airborne?",
}
)
}
}
const CHAR_LOOKUP: &[u8; 64] = b"#ABCDEFGHIJKLMNOPQRSTUVWXYZ##### ###############0123456789######";
pub(crate) fn aircraft_identification_read(
rest: &BitSlice<u8, Msb0>,
) -> Result<(&BitSlice<u8, Msb0>, String), DekuError> {
let mut inside_rest = rest;
let mut chars = vec![];
for _ in 0..=6 {
let (for_rest, c) = <u8>::read(inside_rest, deku::ctx::BitSize(6))?;
if c != 32 {
chars.push(c);
}
inside_rest = for_rest;
}
let encoded = chars.into_iter().map(|b| CHAR_LOOKUP[b as usize] as char).collect::<String>();
Ok((inside_rest, encoded))
}