feat: add NTN (Non-Terrestrial Network) support

notecard/card.py

@@ -9,7 +9,6 @@
 # This module contains helper methods for calling card.* Notecard API commands.
 # This module is optional and not required for use with the Notecard.
 
-import notecard
 from notecard.validators import validate_card_object
 
 
@@ -132,21 +131,36 @@ def voltage(card, hours=None, offset=None, vmax=None, vmin=None):
 
 
 @validate_card_object
-def wireless(card, mode=None, apn=None):
+def wireless(card, mode=None, apn=None, method=None):
     """Retrieve wireless modem info or customize modem behavior.
 
     Args:
         card (Notecard): The current Notecard object.
-        mode (string): The wireless module mode to set.
+        mode (string): The wireless module mode to set. Must be one of:
+            "-" to reset to the default mode
+            "auto" to perform automatic band scan mode (default)
+            "m" to restrict the modem to Cat-M1
+            "nb" to restrict the modem to Cat-NB1
+            "gprs" to restrict the modem to EGPRS
         apn (string): Access Point Name (APN) when using an external SIM.
+            Use "-" to reset to the Notecard default APN.
+        method (string): The connectivity method to enable. Must be one of:
+            "-" to reset to device default
+            "ntn" to enable Non-Terrestrial Network mode
+            "wifi-ntn" to prioritize WiFi with NTN fallback
+            "cell-ntn" to prioritize cellular with NTN fallback
+            "wifi-cell-ntn" to prioritize WiFi, then cellular, then NTN
 
     Returns:
-        string: The result of the Notecard request.
+        dict: The result of the Notecard request containing network status and
+        signal information.
     """
     req = {"req": "card.wireless"}
     if mode:
         req["mode"] = mode
     if apn:
         req["apn"] = apn
+    if method:
+        req["method"] = method
 
     return card.Transaction(req)

test/fluent_api/test_card.py

@@ -3,67 +3,50 @@
 
 
 @pytest.mark.parametrize(
-    'fluent_api,notecard_api,req_params',
+    "fluent_api,notecard_api,req_params",
     [
         (
             card.attn,
-            'card.attn',
+            "card.attn",
             {
-                'mode': 'arm',
-                'files': ['data.qi', 'my-settings.db'],
-                'seconds': 60,
-                'payload': 'ewogICJpbnRlcnZhbHMiOiI2MCwxMiwxNCIKfQ==',
-                'start': True
-            }
-        ),
-        (
-            card.status,
-            'card.status',
-            {}
-        ),
-        (
-            card.time,
-            'card.time',
-            {}
-        ),
-        (
-            card.temp,
-            'card.temp',
-            {'minutes': 5}
-        ),
-        (
-            card.version,
-            'card.version',
-            {}
+                "mode": "arm",
+                "files": ["data.qi", "my-settings.db"],
+                "seconds": 60,
+                "payload": "ewogICJpbnRlcnZhbHMiOiI2MCwxMiwxNCIKfQ==",
+                "start": True,
+            },
         ),
+        (card.status, "card.status", {}),
+        (card.time, "card.time", {}),
+        (card.temp, "card.temp", {"minutes": 5}),
+        (card.version, "card.version", {}),
         (
             card.voltage,
-            'card.voltage',
-            {
-                'hours': 1,
-                'offset': 2,
-                'vmax': 1.1,
-                'vmin': 1.2
-            }
+            "card.voltage",
+            {"hours": 1, "offset": 2, "vmax": 1.1, "vmin": 1.2},
         ),
+        (card.wireless, "card.wireless", {"mode": "auto", "apn": "myapn.nb"}),
+        (card.wireless, "card.wireless", {"method": "ntn"}),
+        (card.wireless, "card.wireless", {"method": "wifi-ntn"}),
+        (card.wireless, "card.wireless", {"method": "cell-ntn"}),
         (
             card.wireless,
-            'card.wireless',
-            {
-                'mode': 'auto',
-                'apn': 'myapn.nb'
-            }
-        )
-    ]
+            "card.wireless",
+            {"method": "wifi-cell-ntn", "mode": "auto", "apn": "custom.apn"},
+        ),
+    ],
 )
 class TestCard:
     def test_fluent_api_maps_notecard_api_correctly(
-            self, fluent_api, notecard_api, req_params,
-            run_fluent_api_notecard_api_mapping_test):
-        run_fluent_api_notecard_api_mapping_test(fluent_api, notecard_api,
-                                                 req_params)
+        self,
+        fluent_api,
+        notecard_api,
+        req_params,
+        run_fluent_api_notecard_api_mapping_test,
+    ):
+        run_fluent_api_notecard_api_mapping_test(fluent_api, notecard_api, req_params)
 
     def test_fluent_api_fails_with_invalid_notecard(
-            self, fluent_api, notecard_api, req_params,
-            run_fluent_api_invalid_notecard_test):
+        self, fluent_api, notecard_api, req_params, run_fluent_api_invalid_notecard_test
+    ):
         run_fluent_api_invalid_notecard_test(fluent_api, req_params)