RC 0.9.2

.github/workflows/publish.yml

@@ -10,10 +10,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python 3.7
+    - name: Set up Python 3.9
       uses: actions/setup-python@v2
       with:
-        python-version: '3.7'
+        python-version: '3.9'
 
     - name: Install dependencies
       run: |

.github/workflows/testlint.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7]
+        python-version: [3.9]
 
     steps:
     - uses: actions/checkout@v2
@@ -20,6 +20,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
+        pip install -r requirements-test.txt
         pip install -r requirements.txt
 
     - name: Lint with flake8

CHANGELOG.md

@@ -1,5 +1,13 @@
 # What's New in Hologram Python SDK
 
+## v0.10.0
+2023-09-05 Hologram <[email protected]>
+* targets python version 3.9
+* Allow setting a specific modem when initializing a network. This can be done by passing the modem into the `HologramCloud` intializing method for example: `HologramCloud({}, authentication_type='totp', network='cellular', modem=modem)`. Initialize a modem using one of the following methods:
+  1. Initialize a modem object with a known good port using a supported modem class in `Hologram.Network.Modem` for example: `EC21(device_name="/dev/ttyUSB4")` This initializes a Quectel EC21 on port `/dev/ttyUSB4`
+  2. Scan for all available modems through the new `Cellular.scan_for_all_usable_modems()` method at `Hologram.Network.Cellular`. This returns a list of accessible intialized modem objects. Just pass one of these in as a modem.
+* Allow modems to send SMS messages through the modem interface. For example: `hologram.network.modem.send_sms_message("+80112", "Hi dashboard!")`. *Note: Extra charges for sending SMS with this method may apply*
+
 ## v0.9.1
 2021-04-30 Hologram <[email protected]>
 includes the following bug fixes

Hologram/Cloud.py

@@ -10,6 +10,8 @@
 import logging
 from logging import NullHandler
 from Hologram.Event import Event
+from typing import Union
+from Hologram.Network.Modem.Modem import Modem
 from Hologram.Network import NetworkManager
 from Hologram.Authentication import *
 
@@ -21,7 +23,7 @@ def __repr__(self):
         return type(self).__name__
 
     def __init__(self, credentials, send_host = '', send_port = 0,
-                 receive_host = '', receive_port = 0, network = ''):
+                 receive_host = '', receive_port = 0, network = '', modem: Union[None, Modem] = None):
 
         # Logging setup.
         self.logger = logging.getLogger(__name__)
@@ -33,21 +35,21 @@ def __init__(self, credentials, send_host = '', send_port = 0,
         self.__initialize_host_and_port(send_host, send_port,
                                         receive_host, receive_port)
 
-        self.initializeNetwork(network)
+        self.initializeNetwork(network, modem)
 
     def __initialize_host_and_port(self, send_host, send_port, receive_host, receive_port):
         self.send_host = send_host
         self.send_port = send_port
         self.receive_host = receive_host
         self.receive_port = receive_port
 
-    def initializeNetwork(self, network):
+    def initializeNetwork(self, network, modem):
 
         self.event = Event()
         self.__message_buffer = []
 
         # Network Configuration
-        self._networkManager = NetworkManager.NetworkManager(self.event, network)
+        self._networkManager = NetworkManager.NetworkManager(self.event, network, modem=modem)
 
         # This registers the message buffering feature based on network availability.
         self.event.subscribe('network.connected', self.__clear_payload_buffer)

Hologram/CustomCloud.py

@@ -12,6 +12,8 @@
 import sys
 import threading
 import time
+from typing import Union
+from Hologram.Network.Modem.Modem import Modem
 from Hologram.Cloud import Cloud
 from Exceptions.HologramError import HologramError
 
@@ -25,14 +27,15 @@ class CustomCloud(Cloud):
 
     def __init__(self, credentials, send_host='', send_port=0,
                  receive_host='', receive_port=0, enable_inbound=False,
-                 network=''):
+                 network='', modem: Union[None, Modem] = None):
 
         super().__init__(credentials,
                          send_host=send_host,
                          send_port=send_port,
                          receive_host=receive_host,
                          receive_port=receive_port,
-                         network=network)
+                         network=network,
+                         modem=modem)
 
         # Enforce that the send and receive configs are set before using the class.
         if enable_inbound and (receive_host == '' or receive_port == 0):

Hologram/HologramCloud.py

@@ -11,10 +11,12 @@
 import binascii
 import json
 import sys
+from typing import Union
+from Hologram.Network.Modem.Modem import Modem
 from Hologram.CustomCloud import CustomCloud
 from HologramAuth import TOTPAuthentication, SIMOTPAuthentication
 from Hologram.Authentication import CSRPSKAuthentication
-from Exceptions.HologramError import HologramError
+from Exceptions.HologramError import HologramError, AuthenticationError
 
 DEFAULT_SEND_MESSAGE_TIMEOUT = 5
 HOLOGRAM_HOST_SEND = 'cloudsocket.hologram.io'
@@ -60,14 +62,16 @@ class HologramCloud(CustomCloud):
     }
 
     def __init__(self, credentials, enable_inbound=False, network='',
-                 authentication_type='totp'):
+                 authentication_type='totp', modem: Union[None, Modem] = None):
         super().__init__(credentials,
                          send_host=HOLOGRAM_HOST_SEND,
                          send_port=HOLOGRAM_PORT_SEND,
                          receive_host=HOLOGRAM_HOST_RECEIVE,
                          receive_port=HOLOGRAM_PORT_RECEIVE,
                          enable_inbound=enable_inbound,
-                         network=network)
+                         network=network,
+                         modem=modem
+                         )
 
         self.setAuthenticationType(credentials, authentication_type=authentication_type)
 
@@ -125,6 +129,7 @@ def __populate_totp_credentials(self):
             self.authentication.credentials['private_key'] = self.network.imsi
         except Exception as e:
             self.logger.error('Unable to fetch device id or private key')
+            raise AuthenticationError('Unable to fetch device id or private key for TOTP authenication')
 
     def __populate_sim_otp_credentials(self):
         nonce = self.request_hex_nonce()

Hologram/Network/Cellular.py

@@ -11,9 +11,10 @@
 from Hologram.Event import Event
 from Exceptions.HologramError import NetworkError
 from Hologram.Network.Route import Route
-from Hologram.Network.Modem import Modem, E303, MS2131, E372, BG96, Nova_U201, NovaM, DriverLoader
+from Hologram.Network.Modem import Modem, E303, MS2131, E372, BG96, EC21, Nova_U201, NovaM, DriverLoader
 from Hologram.Network import Network, NetworkScope
 import time
+from typing import Union
 from serial.tools import list_ports
 
 # Cellular return codes.
@@ -32,6 +33,7 @@ class Cellular(Network):
         'ms2131': MS2131.MS2131,
         'e372': E372.E372,
         'bg96': BG96.BG96,
+        'ec21': EC21.EC21,
         'nova': Nova_U201.Nova_U201,
         'novam': NovaM.NovaM,
         '': Modem
@@ -47,10 +49,10 @@ def __init__(self, event=Event()):
 
     def autodetect_modem(self):
         # scan for a modem and set it if found
-        dev_devices = self._scan_for_modems()
-        if dev_devices is None:
+        first_modem_handler = Cellular._scan_and_select_first_supported_modem()
+        if first_modem_handler is None:
             raise NetworkError('Modem not detected')
-        self.modem = dev_devices[0]
+        self.modem = first_modem_handler(event=self.event)
 
     def load_modem_drivers(self):
         self._load_modem_drivers()
@@ -207,27 +209,45 @@ def _load_modem_drivers(self):
                             dl.force_driver_for_device(syspath, vid_pid[0], vid_pid[1])
 
 
-
-    def _scan_for_modems(self):
-        res = None
-        for (modemName, modemHandler) in self._modemHandlers.items():
-            if self._scan_for_modem(modemHandler):
-                res = (modemName, modemHandler)
-                break
-        return res
+    @staticmethod
+    def _scan_and_select_first_supported_modem() -> Union[Modem, None]:
+        for (_, modemHandler) in Cellular._modemHandlers.items():
+            modem_exists = Cellular._does_modem_exist_for_handler(modemHandler)
+            if modem_exists:
+                return modemHandler
+        return None
 
 
-    def _scan_for_modem(self, modemHandler):
+    @staticmethod
+    def _does_modem_exist_for_handler(modemHandler):
         usb_ids = modemHandler.usb_ids
         for vid_pid in usb_ids:
             if not vid_pid:
                 continue
-            self.logger.debug('checking for vid_pid: %s', str(vid_pid))
-            for dev in list_ports.grep("{0}:{1}".format(vid_pid[0], vid_pid[1])):
-                self.logger.info('Detected modem %s', modemHandler.__name__)
+            for _ in list_ports.grep("{0}:{1}".format(vid_pid[0], vid_pid[1])):
                 return True
         return False
 
+    @staticmethod
+    def scan_for_all_usable_modems() -> list[Modem]:
+        modems = []
+        unique_imeis = set()
+        for (_, modemHandler) in Cellular._modemHandlers.items():
+            modem_exists = Cellular._does_modem_exist_for_handler(modemHandler)
+            if modem_exists:
+                try:
+                    test_handler = modemHandler()
+                    usable_ports = test_handler.detect_usable_serial_port(stop_on_first=False)
+                    for port in usable_ports:
+                        modem = modemHandler(device_name=port)
+                        imei = modem.imei
+                        if imei not in unique_imeis:
+                            unique_imeis.add(imei)
+                            modems.append(modem)
+                except Exception:
+                    # Any exception already logged up the chain
+                    pass
+        return modems
 
 
 
@@ -236,11 +256,8 @@ def modem(self):
         return self._modem
 
     @modem.setter
-    def modem(self, modem):
-        if modem not in self._modemHandlers:
-            raise NetworkError('Invalid modem type: %s' % modem)
-        else:
-            self._modem = self._modemHandlers[modem](event=self.event)
+    def modem(self, modem: Union[None, Modem] = None):
+        self._modem = modem
 
     @property
     def localIPAddress(self):