monarch2 0.1.0-beta.1

A driver crate for the Sequans Monarch 2 Platform chips.
Documentation 
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

use atat::atat_derive::AtatCmd;
use responses::{GnssAsssitance, GnssCloudServerName, GnssConfig, GnssTimeout};
use types::{
    AcquisitionMode, FixSensitivity, GnssAssitanceType, LocationMode, ProgramGnssAction,
    UrcNotificationSetting,
};

use crate::gnss::types::QuotedF32;

use super::{Bool, NoResponse, Reserved};

pub mod responses;
pub mod types;
pub mod urc;

/// Configures the GNSS (Global Navigation Satellite System) module.
#[derive(Clone, AtatCmd)]
#[at_cmd("+LPGNSSCFG?", GnssConfig)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct GetGnssConfig;

/// This AT command is used to set the GNSS approximate position as a hint for the next fix. It must be accurate within 100 km if <acq_mode> configuration is set to hot start by AT+LPGNSSCFG command.
///
/// Unless set by this command, the default values after power-on/reset are those of Paris (latitude: 48.8616948, longitude: 2.3469252, altitude: 15).
///
/// For subsequent fixes, unless overridden by this command, the last successful fix is taken as the approximate position.
#[derive(Clone, AtatCmd)]
#[at_cmd("+LPGNSSCFG", NoResponse)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct SetApproximatePositionAssitance {
    /// Approximate latitude in decimal degree (DD) format. Range is -90..90.
    #[at_arg(position = 0)]
    pub lat: QuotedF32,

    /// Approximate longitude in decimal degree (DD) format. Range is -180.180.
    #[at_arg(position = 1)]
    pub long: QuotedF32,

    /// Approximate elevation in metres. Range is -500..10000. This parameter is optional, but recommended.
    #[at_arg(position = 2)]
    pub elev: Option<QuotedF32>,
}

/// Configures the GNSS (Global Navigation Satellite System) module.
#[derive(Clone, AtatCmd)]
#[at_cmd("+LPGNSSCFG", NoResponse)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct SetGnssConfig {
    /// The GNSS location mode.
    #[at_arg(position = 0)]
    pub location_mode: LocationMode,

    /// The sensitivity mode.
    #[at_arg(position = 1)]
    pub fix_sensitivity: FixSensitivity,

    #[at_arg(position = 2)]
    pub urc_settings: UrcNotificationSetting,

    #[at_arg(position = 3)]
    pub reserved: Reserved,

    #[at_arg(position = 4)]
    pub metrics: Bool,

    /// The acquisition mode.
    #[at_arg(position = 5)]
    pub acquisition_mode: AcquisitionMode,

    /// Enables fast error report if satellite reception is too poor. 0: No early abort (default).
    #[at_arg(position = 6)]
    pub early_abort: Bool,
}

/// Triggers a connection to the GNSS cloud, downloads the almanac or the ephemeris files and stores them in persistent memory. This AT command only works with an available LTE connection.
#[derive(Clone, AtatCmd)]
#[at_cmd("+LPGNSSASSISTANCE", NoResponse)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct UpdateGnssAssitance {
    /// The GNSS location mode.
    #[at_arg(position = 0)]
    pub typ: GnssAssitanceType,
}

/// Verify the status of the assistance, or check if an update is required. If both the real-time and predicted ephemeris are valid when a fix is requested, the real-time ephemeris takes precedence.
#[derive(Clone, AtatCmd)]
#[at_cmd("+LPGNSSASSISTANCE?", heapless::Vec<GnssAsssitance, 3>)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct GetGnssAssitance;

/// This AT command programs or cancels a GNSS fix.
///
/// The command may return an extended error message <err>, with the following meaning:
///
/// • NO_RTC: There is no RTC available (no LTE connection). Attach to the LTE network to synchronise the clock and try again.
/// • LTE
/// _CONCURRENCY: The GNSS fix cannot be performed because the device is currently connected to the
/// LTE network. Disconnect using AT+CFUN=0 (on page 299).
/// • FIX
/// _IN_PROGRESS: Another fix is already being processed.
/// • NO_VALID_EPHEMERIS_FOR_ON-DEVICE_NAVIGATION: No ephemeris is available and <loc _mode> has been set to "on-device location" by AT+LPGNSSCFG (on page 231).
#[derive(Clone, AtatCmd)]
#[at_cmd("+LPGNSSFIXPROG", NoResponse)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct ProgramGnss {
    /// The GNSS location mode.
    #[at_arg(position = 0, len = 8)]
    pub action: ProgramGnssAction,
}

/// This AT command sets the name of the server the assistance data is downloaded from. The name is saved and preserved at reboot / reset.
#[derive(Clone, AtatCmd)]
#[at_cmd("+LPGNSSCLOUDSEL", NoResponse)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct SetGnssCloudServerName<'a> {
    /// Server's hostname.
    #[at_arg(position = 0, len = 256)]
    pub hostname: &'a str,
}

/// This AT command sets the name of the server the assistance data is downloaded from. The name is saved and preserved at reboot / reset.
#[derive(Clone, AtatCmd)]
#[at_cmd("+LPGNSSCLOUDSEL?", GnssCloudServerName)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct GetGnssCloudServerName;

/// This AT command sets a time-out for GNSS processing. If the time-out is reached, a +LPGNSSFIXSTOP URC is sent with "TIMEOUT" as the <reason> parameter.
#[derive(Clone, AtatCmd)]
#[at_cmd("+LPGNSSTIMEOUT", NoResponse)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct SetGnssTimeout {
    /// Time-out in seconds (0..999). 0 means no limit (default).
    #[at_arg(position = 0)]
    pub timeout: u32,
}

/// This AT command gets the currently configured time-out for GNSS processing.
#[derive(Clone, AtatCmd)]
#[at_cmd("+LPGNSSTIMEOUT?", GnssTimeout)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct GetGnssTimeout;