ntn: add ntn.reset and ntn.status

Author: gauteh

src/lib.rs

@@ -20,6 +20,7 @@ pub mod dfu;
 pub mod hub;
 pub mod note;
 pub mod web;
+pub mod ntn;
 
 /// Delay between polling for new response.
 const RESPONSE_DELAY: u16 = 25;
@@ -560,6 +561,11 @@ impl<IOM: Write<SevenBitAddress> + Read<SevenBitAddress>, const BUF_SIZE: usize>
     pub fn dfu(&mut self) -> dfu::DFU<IOM, BUF_SIZE> {
         dfu::DFU::from(self)
     }
+
+    /// [NtN Requests](https://dev.blues.io/reference/notecard-api/ntn-requests/)
+    pub fn ntn(&mut self) -> ntn::NTN<IOM, BUF_SIZE> {
+        ntn::NTN::from(self)
+    }
 }
 
 /// A future response.

src/ntn.rs

@@ -0,0 +1,64 @@
+//! https://dev.blues.io/api-reference/notecard-api/ntn-requests/
+
+#[allow(unused_imports)]
+use defmt::{debug, error, info, trace, warn};
+use embedded_hal::blocking::delay::DelayMs;
+use embedded_hal::blocking::i2c::{Read, SevenBitAddress, Write};
+use serde::{Deserialize, Serialize};
+
+use super::{FutureResponse, NoteError, Notecard};
+
+pub struct NTN<'a, IOM: Write<SevenBitAddress> + Read<SevenBitAddress>, const BS: usize> {
+    note: &'a mut Notecard<IOM, BS>,
+}
+
+impl<'a, IOM: Write<SevenBitAddress> + Read<SevenBitAddress>, const BS: usize> NTN<'a, IOM, BS> {
+    pub fn from(note: &mut Notecard<IOM, BS>) -> NTN<'_, IOM, BS> {
+        NTN { note }
+    }
+
+    /// Once a Notecard is connected to a Starnote device, the presence of a physical Starnote is stored in a permanent configuration that is not affected by a card.restore request. This request clears this configuration and allows you to return to testing NTN mode over cellular or Wi-Fi.
+    pub fn reset<const PS: usize>(
+        self,
+        delay: &mut impl DelayMs<u16>,
+    ) -> Result<FutureResponse<'a, res::Empty, IOM, BS>, NoteError> {
+        self.note
+            .request_raw(delay, b"{\"req\":\"ntn.reset\"}\n")?;
+        Ok(FutureResponse::from(self.note))
+    }
+
+    /// Gets and sets the background download status of MCU host or Notecard
+    /// firmware updates.
+    pub fn status(
+        self,
+        delay: &mut impl DelayMs<u16>,
+    ) -> Result<FutureResponse<'a, res::Status, IOM, BS>, NoteError> {
+        self.note
+            .request_raw(delay, b"{\"req\":\"ntn.status\"}\n")?;
+
+        Ok(FutureResponse::from(self.note))
+    }
+}
+
+pub mod req {
+    use super::*;
+}
+
+pub mod res {
+    use super::*;
+
+    #[derive(Deserialize, defmt::Format)]
+    pub struct Empty {}
+
+    #[derive(Deserialize, defmt::Format)]
+    pub struct Status {
+        pub err: Option<heapless::String<120>>,
+        pub status: Option<heapless::String<120>>,
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+}
+