Hologram Python SDK v0.5.27 release

Author: tzhenghao

Hologram/Cloud.py

@@ -14,7 +14,7 @@
 from Network import NetworkManager
 from Authentication import *
 
-__version__ = '0.5.26'
+__version__ = '0.5.27'
 
 class Cloud(object):
 

Hologram/HologramCloud.py

@@ -104,6 +104,9 @@ def sendMessage(self, message, topics = None, timeout = 5):
                                                                    nonce=nonce)
             modem_response = self.network.get_sim_otp_response(command)
             self.authentication.generate_sim_otp_token(modem_response)
+        elif self.authenticationType == 'totp':
+            self.authentication.credentials['device_id'] = self.network.iccid
+            self.authentication.credentials['private_key'] = self.network.imsi
 
         output = self.authentication.buildPayloadString(message,
                                                         topics=topics,

Hologram/Network/Modem/ModemMode/PPP.py

@@ -9,11 +9,15 @@
 #
 import subprocess
 import sys
+import time
 from pppd import PPPConnection
 from IPPP import IPPP
 from Exceptions.HologramError import PPPError
 
 DEFAULT_PPP_TIMEOUT = 200
+DEFAULT_PPP_INTERFACE = 'ppp0'
+MAX_PPP_INTERFACE_UP_RETRIES = 10
+MAX_REROUTE_PACKET_RETRIES = 15
 
 class PPP(IPPP):
 
@@ -49,14 +53,38 @@ def connect(self, timeout=DEFAULT_PPP_TIMEOUT):
 
         result = self._ppp.connect(timeout=timeout)
 
-        if result == True:
+        if result == True and self.__is_ppp_interface_up():
             self.__reroute_packets()
-        return result
+            return True
+        else:
+            return False
 
     def disconnect(self):
         self.__shut_down_existing_ppp_session()
         return self._ppp.disconnect()
 
+    # EFFECTS: Blocks to make sure ppp interface is up.
+    def __is_ppp_interface_up(self):
+        count = 0
+        while count <= MAX_PPP_INTERFACE_UP_RETRIES:
+            try:
+                out_list = subprocess.check_output(['ip', 'address', 'show', 'dev',
+                                                    DEFAULT_PPP_INTERFACE],
+                                                   stderr=subprocess.STDOUT)
+
+                # Check if ready to break out of loop when ppp0 is found.
+                if 'does not exist' in out_list:
+                    time.sleep(1)
+                    count += 1
+                else:
+                    break
+            except subprocess.CalledProcessError as e:
+                pass
+
+        if count <= MAX_PPP_INTERFACE_UP_RETRIES:
+            return True
+        return False
+
     # EFFECTS: Makes sure that there are no existing PPP instances on the same
     #          device interface.
     def __enforce_no_existing_ppp_session(self):
@@ -116,10 +144,31 @@ def __split_PID_from_process(self, process):
         return None
 
     def __reroute_packets(self):
-        self.logger.info('Rerouting packets to ppp0 interface')
-        subprocess.call('ip route add 10.176.0.0/16 dev ppp0', shell=True)
-        subprocess.call('ip route add 10.254.0.0/16 dev ppp0', shell=True)
-        subprocess.call('ip route add default dev ppp0', shell=True)
+        self.logger.info('Rerouting packets to %s interface', DEFAULT_PPP_INTERFACE)
+
+        count = 0
+        # Make sure that we still have ppp interface before adding the routes.
+        while count <= MAX_REROUTE_PACKET_RETRIES:
+            try:
+                out_list = subprocess.check_output(['ip', 'route', 'add',
+                                                    '10.176.0.0/16', 'dev',
+                                                    DEFAULT_PPP_INTERFACE],
+                                                   stderr=subprocess.STDOUT)
+
+                # Check if ready to break out of loop when ppp0 is found.
+                if 'Network is down' in out_list:
+                    time.sleep(1)
+                    count += 1
+                else:
+                    break
+            except Exception as e:
+                pass
+
+        if count > MAX_REROUTE_PACKET_RETRIES:
+            return
+
+        subprocess.call('ip route add 10.254.0.0/16 dev %s' % DEFAULT_PPP_INTERFACE, shell=True)
+        subprocess.call('ip route add default dev %s' % DEFAULT_PPP_INTERFACE, shell=True)
 
     @property
     def localIPAddress(self):

examples/example-hologram-cloud-totp.py

@@ -21,25 +21,12 @@
     print ''
     print 'Testing Hologram Cloud class...'
     print ''
-    print '* Note: You can obtain device keys from the Devices page'
-    print '* at https://dashboard.hologram.io'
-    print ''
-
-    device_id = raw_input('What is your device id? ')
-    private_key = raw_input('What is your private key? ')
-
-    credentials = {'device_id': device_id, 'private_key': private_key}
-
-    hologram = HologramCloud(credentials, enable_inbound=False, authentication_type='totp')
 
-    print 'Hologram SDK version:'
-    print hologram.version
+    hologram = HologramCloud(dict(), enable_inbound=False, network='cellular', authentication_type='totp')
 
-    print ''
-    print 'Cloud type: ' + str(hologram)
-    print ''
-    print 'Network type: ' + hologram.network_type
-    print ''
+    result = hologram.network.connect()
+    if result == False:
+        print 'Failed to connect to cell network'
 
     recv = hologram.sendMessage('YESYESYES!',
                                 topics = ['YES'],
@@ -51,3 +38,5 @@
     print ''
     print 'Testing complete.'
     print ''
+
+    hologram.network.disconnect()

scripts/hologram_send.py

@@ -33,8 +33,6 @@ def parse_hologram_send_args(parser):
     parser.add_argument('-v', '--verbose', action='store_true', required=False)
     parser.add_argument('--host', required=False, help=argparse.SUPPRESS)
     parser.add_argument('-p', '--port', required=False, help=argparse.SUPPRESS)
-    parser.add_argument('--iccid', nargs='?', help=argparse.SUPPRESS)
-    parser.add_argument('--imsi', nargs='?', help=argparse.SUPPRESS)
     parser.add_argument('--authtype', default='totp', nargs='?',
                         help='The authentication type used if HologramCloud is in use')
 
@@ -72,26 +70,10 @@ def parse_sms_args(parser):
 # EFFECTS: Parses and sends the Hologram message using TOTP Authentication
 def sendTOTP(args, data, is_sms=False):
 
-    if not args['iccid'] and ('device_id' in data):
-        args['iccid'] = data['device_id']
-
-    if not args['imsi'] and ('private_key' in data):
-        args['imsi'] = data['private_key']
-
-    credentials = {'device_id': args['iccid'], 'private_key': args['imsi']}
-    hologram = HologramCloud(credentials, enable_inbound=False,
+    hologram = HologramCloud(dict(), enable_inbound=False,
                              authentication_type='totp',
                              network='cellular')
 
-    modem = ''
-    # Load the ICCID and IMSI values if modem is physically attached to machine
-    if hologram.network.isModemAttached():
-        hologram.credentials = {'device_id': hologram.network.iccid,
-                                'private_key': hologram.network.imsi}
-
-    if (hologram.credentials['device_id'] is None) or (hologram.credentials['private_key'] is None):
-        raise HologramError('Device id or private key not specified or cannot be pulled from modem. Please specify them or rerun the program with a provided device key')
-
     result = hologram.network.connect()
     if result == False:
         raise HologramError('Failed to connect to cell network')

tests/MessageMode/test_Cloud.py

@@ -40,4 +40,4 @@ def test_invalid_send_sms(self):
     def test_sdk_version(self):
         cloud = Cloud(None, send_host = '127.0.0.1', send_port = 9999)
 
-        assert cloud.version == '0.5.26'
+        assert cloud.version == '0.5.27'

version.txt

@@ -1 +1 @@
-0.5.26
+0.5.27