prns-core 0.3.4

Pure Reticulum engine and wire contract for Personal Reticulum
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

use crate::interfaces::{
    AirtimeDutyCycle, AnnounceBandwidthCap, BitrateBps, ConfiguredInterfacePolicy,
    EgressCapability, IngressCapability, InterfaceCapabilities, InterfaceDefaults,
    InterfaceDescriptor, InterfaceId, InterfaceMode, MtuPolicy, TransportCapability,
};

use super::framing::LORA_MAX_PAYLOAD;
use super::profile::RadioProfile;

pub fn descriptor(
    id: InterfaceId,
    profile: &RadioProfile,
    airtime_duty_cycle: Option<AirtimeDutyCycle>,
) -> InterfaceDescriptor {
    defaults(profile, airtime_duty_cycle)
        .configured(ConfiguredInterfacePolicy::default())
        .descriptor(id)
}

pub fn defaults(
    profile: &RadioProfile,
    airtime_duty_cycle: Option<AirtimeDutyCycle>,
) -> InterfaceDefaults {
    InterfaceDefaults {
        capabilities: InterfaceCapabilities {
            ingress: IngressCapability::Enabled,
            egress: EgressCapability::Enabled(TransportCapability::SameInterfaceRepeat),
        },
        mode: InterfaceMode::Full,
        gravity: crate::interfaces::InterfaceGravity::ZERO,
        bitrate: BitrateBps::guess(u64::from(profile.nominal_bitrate_bps())),
        mtu: MtuPolicy::fixed(LORA_MAX_PAYLOAD),
        announce_rate_limit: None,
        announce_bandwidth_cap: AnnounceBandwidthCap::RNS_DEFAULT,
        airtime_duty_cycle,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::interfaces::lora::{Region, DEFAULT_915_PROFILE};
    use crate::interfaces::INTERFACE_ID_LEN;

    #[test]
    fn descriptor_is_a_repeating_shared_half_duplex_interface() {
        let d = descriptor(
            InterfaceId::new([0x5C; INTERFACE_ID_LEN]),
            &DEFAULT_915_PROFILE,
            None,
        );
        assert!(matches!(d.mode, InterfaceMode::Full));
        assert_eq!(d.capabilities.ingress, IngressCapability::Enabled);
        assert_eq!(
            d.capabilities.egress,
            EgressCapability::Enabled(TransportCapability::SameInterfaceRepeat)
        );
        assert_eq!(d.hardware_mtu, Some(LORA_MAX_PAYLOAD));
        assert_eq!(
            d.bitrate,
            BitrateBps::new(u64::from(DEFAULT_915_PROFILE.nominal_bitrate_bps())).unwrap()
        );
        assert_eq!(d.announce_bandwidth_cap, AnnounceBandwidthCap::RNS_DEFAULT);
    }

    #[test]
    fn descriptor_uses_the_supplied_duty_cycle() {
        let id = InterfaceId::new([0x5C; INTERFACE_ID_LEN]);
        let eu_preset = Region::Eu868.regulatory_duty_cycle();
        let d = descriptor(id, &DEFAULT_915_PROFILE, eu_preset);
        assert_eq!(d.airtime_duty_cycle, eu_preset);
        let none = descriptor(id, &DEFAULT_915_PROFILE, None);
        assert_eq!(none.airtime_duty_cycle, None);
    }
}