Hologram Python SDK v0.8.3 release

Author: rbalik

CHANGELOG.md

@@ -1,5 +1,13 @@
 # What's New in Hologram Python SDK
 
+## v0.8.3
+
+2019-08-27 Hologram <[email protected]>
+    * New command to view IMEI: `hologram modem imei`
+    * New command to get modem module firmware version: `hologram modem version`
+    * Make dependencies a little more flexible to prevent some problems on some systems
+    * Unit tests weren't properly checking some exceptions
+
 ## v0.8.2
 
 2018-11-16 Hologram <[email protected]>

Hologram/Cloud.py

@@ -13,7 +13,7 @@
 from Network import NetworkManager
 from Authentication import *
 
-__version__ = '0.8.2'
+__version__ = '0.8.3'
 
 class Cloud(object):
 

Hologram/Network/Ethernet.py

@@ -35,3 +35,6 @@ def getConnectionStatus(self):
 
     def getSignalStrength(self):
         raise Exception('Ethernet mode doesn\'t support this call')
+
+    def getAvgSignalStrength(self):
+        raise Exception('Ethernet mode doesn\'t support this call')

Hologram/Network/Modem/Modem.py

@@ -869,3 +869,13 @@ def localIPAddress(self):
     @property
     def remoteIPAddress(self):
         return self._mode.remoteIPAddress
+
+
+    @property
+    def version(self):
+        raise NotImplementedError('This modem does not support this property')
+
+    @property
+    def imei(self):
+        return self._basic_command('+GSN')
+

Hologram/Network/Modem/Nova.py

@@ -23,3 +23,8 @@ def __init__(self, device_name=None, baud_rate='9600',
 
     def disable_at_sockets_mode(self):
         self._at_sockets_available = False
+
+    @property
+    def version(self):
+        return self._basic_command('I9')
+

Hologram/Network/Network.py

@@ -44,6 +44,12 @@ def reconnect(self):
     def getConnectionStatus(self):
         raise NotImplementedError('Must instantiate a defined Network type')
 
+    def getSignalStrength(self):
+        raise NotImplementedError('Must instantiate a defined Network type')
+
+    def getAvgSignalStrength(self):
+        raise NotImplementedError('Must instantiate a defined Network type')
+
     def is_connected(self):
         return False
 

requirements.txt

@@ -1,13 +1,13 @@
-enum34==1.1.6
-hjson==2.0.2
-mock==2.0.0
-pyroute2==0.4.21
-pytest==3.0.5
-python-wifi==0.6.1
-pyserial==3.3
+enum34~=1.1.6
+hjson~=3.0.0
+mock~=3.0.5
+pyroute2==0.5.*
+pytest~=4.6.5
+python-wifi~=0.6.1
+pyserial~=3.4.0
 python-pppd==1.0.3
-python-sdk-auth==0.2.1
-pyudev==0.21.0
-pyusb==1.0.0
-psutil==5.3.1
-requests==2.20.1
+python-sdk-auth~=0.2.2
+pyudev~=0.21.0
+pyusb~=1.0.2
+psutil~=5.6.3
+requests~=2.22.0

scripts/hologram_modem.py

@@ -26,28 +26,27 @@
 help_sim = '''This subcommand prints the IMSI value of the attached SIM.\n
 '''
 
-help_type = '''This subcommand prints the modem name if it is supported and attached to the device.\n
+help_type = '''Prints the modem name if it is supported and attached to the device.\n
 '''
 
-help_operator = '''This subcommand prints the operator name.\n
+help_operator = '''Print the name of the operator the modem is attached to\n
 '''
 
-help_signal = '''This subcommand prints the RSSI signal strength values.\n
+help_imei = '''Print the IMEI of the modem\n
 '''
 
-help_location = '''This subcommand prints the encoded location of the modem.\n
-'''
+help_signal = '''Print the RSSI signal strength values.\n'''
 
-help_reset = '''This subcommand causes the modem to restart itself.\n
+help_location = '''Print the location of the modem based on cell towers if supported\n
 '''
 
-help_radio_off = '''This subcommand causes the modem to turn off the cellular
-radio\n
-'''
+help_reset = '''Restart the modem\n'''
 
-help_radio_on = '''This subcommand causes the modem to turn on the cellular
-radio\n
-'''
+help_radio_off = '''Turn off the cellular radio on the modem\n'''
+
+help_radio_on = '''Turn on the cellular radio\n'''
+
+help_version = '''Print the firmware version of the modem\n'''
 
 def run_modem_connect(args):
     print 'Note: "hologram modem connect" is deprecated '\
@@ -86,6 +85,16 @@ def run_modem_signal(args):
     else:
         print 'Signal strength: ' + str(cloud.network.signal_strength)
 
+def run_modem_version(args):
+    cloud = CustomCloud(None, network='cellular')
+    version = cloud.network.modem.version
+    print 'Modem version: ' + version
+
+def run_modem_imei(args):
+    cloud = CustomCloud(None, network='cellular')
+    imei = cloud.network.modem.imei
+    print 'IMEI: ' + imei
+
 def run_modem_reset(args):
     cloud = CustomCloud(None, network='cellular')
     cloud.network.modem.reset()
@@ -138,7 +147,9 @@ def run_modem_location(args):
     'modem_location': run_modem_location,
     'modem_reset': run_modem_reset,
     'modem_radio_on': run_modem_radio_on,
-    'modem_radio_off': run_modem_radio_off
+    'modem_radio_off': run_modem_radio_off,
+    'modem_version': run_modem_version,
+    'modem_imei': run_modem_imei
 }
 
 # EFFECTS: Parses the CLI arguments as options to the hologram modem subcommand.
@@ -189,15 +200,24 @@ def parse_hologram_modem_args(parser):
     parser_reset.add_argument('-v', nargs='?', action=VAction, dest='verbose', required=False)
 
     # radio-on
-    parser_radio_on = subparsers.add_parser('radio-on', help=help_reset)
+    parser_radio_on = subparsers.add_parser('radio-on', help=help_radio_on)
     parser_radio_on.set_defaults(command_selected='modem_radio_on')
     parser_radio_on.add_argument('-v', nargs='?', action=VAction, dest='verbose', required=False)
 
     # radio-off
-    parser_radio_off = subparsers.add_parser('radio-off', help=help_reset)
+    parser_radio_off = subparsers.add_parser('radio-off', help=help_radio_off)
     parser_radio_off.set_defaults(command_selected='modem_radio_off')
     parser_radio_off.add_argument('-v', nargs='?', action=VAction, dest='verbose', required=False)
 
+    # version
+    parser_version = subparsers.add_parser('version', help=help_version)
+    parser_version.set_defaults(command_selected='modem_version')
+    parser_version.add_argument('-v', nargs='?', action=VAction, dest='verbose', required=False)
+
+    # imei
+    parser_imei = subparsers.add_parser('imei', help=help_version)
+    parser_imei.set_defaults(command_selected='modem_imei')
+    parser_imei.add_argument('-v', nargs='?', action=VAction, dest='verbose', required=False)
 
 # EFFECTS: Runs the hologram modem interfaces.
 def run_hologram_modem(args):

tests/Authentication/test_CSRPSKAuthentication.py

@@ -39,5 +39,5 @@ def test_invalid_device_key_length(self):
         credentials = {'devicekey': '12345678'}
         auth = CSRPSKAuthentication(credentials)
         auth.credentials['devicekey'] = '12345'
-        with pytest.raises(Exception, message = 'AuthenticationError: Device key must be 8 characters long'):
+        with pytest.raises(Exception, match = 'Device key must be 8 characters long'):
             auth.buildPayloadString('test invalid device key')

tests/Authentication/test_HologramAuthentication.py

@@ -24,17 +24,17 @@ def test_create(self):
 
     def test_invalid_auth_string(self):
         auth = HologramAuthentication(credentials)
-        with pytest.raises(Exception, message = 'Must instantiate a subclass of HologramAuthentication'):
+        with pytest.raises(Exception, match = 'Must instantiate a subclass of HologramAuthentication'):
             auth.buildPayloadString('test msg', 'test topic')
 
     def test_invalid_topic_string(self):
         auth = HologramAuthentication(credentials)
-        with pytest.raises(Exception, message = 'Must instantiate a subclass of HologramAuthentication'):
+        with pytest.raises(Exception, match = 'Must instantiate a subclass of HologramAuthentication'):
             auth.buildTopicString('test topic')
 
     def test_invalid_msg_string(self):
         auth = HologramAuthentication(credentials)
-        with pytest.raises(Exception, message = 'Must instantiate a subclass of HologramAuthentication'):
+        with pytest.raises(Exception, match = 'Must instantiate a subclass of HologramAuthentication'):
             auth.buildMessageString('test msg')
 
     def test_build_modem_type_id_str(self):