Hologram Python SDK v0.7.5 release

Author: tzhenghao

CHANGELOG.md

@@ -1,5 +1,23 @@
 # What's New in Hologram Python SDK
 
+## v0.7.5
+
+2018-02-13 Hologram <[email protected]>
+    * Force persistent connection for hologram spacebridge
+    * hologram spacebridge no longer sets default route
+    * Remove redundant manifest includes
+
+2018-02-06 Hologram <[email protected]>
+    * Increase socket connect and write timeouts
+
+2018-02-05 Hologram <[email protected]>
+    * Fix infinite loop in `send_message`
+
+## v0.7.4
+
+2018-01-08 Hologram <[email protected]>
+    * Just a bunch of internal tool changes. Happy New Year! :)
+
 ## v0.7.3
 
 2018-01-04 Hologram <[email protected]>

Hologram/Cloud.py

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

Hologram/Network/Cellular.py

@@ -10,13 +10,13 @@
 
 from ..Event import Event
 from Exceptions.HologramError import NetworkError
+from Hologram.Network.Route import Route
 from Modem import Modem
 from Modem import E303
 from Modem import MS2131
 from Modem import Nova_U201
 from Modem import NovaM_R404
-from Network import Network
-import subprocess
+from Network import Network, NetworkScope
 import time
 import usb.core
 
@@ -43,6 +43,7 @@ def __init__(self, event=Event()):
         super(Cellular, self).__init__(event=event)
         self._connection_status = CLOUD_DISCONNECTED
         self._modem = None
+        self._route = Route()
 
     def autodetect_modem(self):
         # scan for a modem and set it if found
@@ -66,11 +67,13 @@ def connect(self, timeout = DEFAULT_CELLULAR_TIMEOUT):
         except KeyboardInterrupt as e:
             pass
 
+
         if success:
             self.logger.info('Successfully connected to cell network')
             # Disable at sockets mode since we're already establishing PPP.
             # This call is needed in certain modems that have limited interfaces to work with.
             self.disable_at_sockets_mode()
+            self.__configure_routing()
             self._connection_status = CLOUD_CONNECTED
             self.event.broadcast('cellular.connected')
             super(Cellular, self).connect()
@@ -144,6 +147,13 @@ def popReceivedSMS(self):
     def get_sim_otp_response(self, command):
         return self.modem.get_sim_otp_response(command)
 
+    def __configure_routing(self):
+        self.logger.info('Adding routes to Hologram cloud')
+        self._route.add('10.176.0.0/16', self.localIPAddress)
+        self._route.add('10.254.0.0/16', self.localIPAddress)
+        if self.scope == NetworkScope.SYSTEM:
+            self.logger.info('Adding system-wide default route to cellular interface')
+            self._route.add_default(self.localIPAddress)
 
     def _scan_for_modems(self):
         res = None

Hologram/Network/Modem/Modem.py

@@ -24,6 +24,7 @@
 import pyudev
 import serial
 import time
+from serial.serialutil import Timeout
 
 DEFAULT_CHATSCRIPT_PATH = '/chatscripts/default-script'
 
@@ -33,6 +34,9 @@ class Modem(IModem):
     DEFAULT_SERIAL_READ_SIZE = 256
     DEFAULT_SERIAL_TIMEOUT = 1
     DEFAULT_SERIAL_RETRIES = 0
+    DEFAULT_SEND_TIMEOUT = 10
+
+    _RETRY_DELAY = 0.05  # 50 millisecond delay to avoid spinning loops
 
     SOCKET_INIT = 0
     SOCKET_WRITE_STATE = 1
@@ -232,14 +236,19 @@ def set_network_registration_status(self):
     def reset(self):
         self.set('+CFUN', '16') # restart the modem
 
-    def send_message(self, data):
+    def send_message(self, data, timeout=DEFAULT_SEND_TIMEOUT):
 
         self.urc_state = Modem.SOCKET_INIT
 
         self.write_socket(data)
 
+        loop_timeout = Timeout(timeout)
         while self.urc_state != Modem.SOCKET_SEND_READ:
             self.checkURC()
+            if self.urc_state != Modem.SOCKET_SEND_READ:
+                if loop_timeout.expired():
+                    raise SerialError('Timeout occurred waiting for message status')
+                time.sleep(self._RETRY_DELAY)
 
         return self.read_socket()
 
@@ -269,7 +278,7 @@ def create_socket(self):
     # EFFECTS: Issues an AT command to connect to the specified socket identifier.
     def connect_socket(self, host, port):
         at_command_val = "%d,\"%s\",%s" % (self.socket_identifier, host, port)
-        ok, _ = self.set('+USOCO', at_command_val, timeout=5)
+        ok, _ = self.set('+USOCO', at_command_val, timeout=20)
         if ok != ModemResult.OK:
             self.logger.error('Failed to connect socket')
         else:
@@ -287,7 +296,7 @@ def write_socket(self, data):
 
         self.enable_hex_mode()
         value = '%d,%s,\"%s\"' % (self.socket_identifier, len(data), binascii.hexlify(data))
-        ok, _ = self.set('+USOWR', value)
+        ok, _ = self.set('+USOWR', value, timeout=10)
         if ok != ModemResult.OK:
             self.logger.error('Failed to write to socket')
         self.disable_hex_mode()

Hologram/Network/Modem/ModemMode/PPP.py

@@ -46,7 +46,6 @@ def connect(self, timeout=DEFAULT_PPP_TIMEOUT):
 
         if result == True and self.route.wait_for_interface(DEFAULT_PPP_INTERFACE,
                                                             MAX_PPP_INTERFACE_UP_RETRIES):
-            self.__reroute_packets()
             return True
         else:
             return False
@@ -92,16 +91,6 @@ def __check_for_existing_ppp_sessions(self):
 
         return existing_ppp_pids
 
-    def __reroute_packets(self):
-        self.logger.info('Rerouting packets to %s interface', DEFAULT_PPP_INTERFACE)
-        # Make sure that we still have ppp interface before adding the routes.
-        ppp_available = self.route.wait_for_interface(DEFAULT_PPP_INTERFACE, MAX_REROUTE_PACKET_RETRIES)
-        if not ppp_available:
-            return
-        self.route.add('10.176.0.0/16', self.localIPAddress)
-        self.route.add('10.254.0.0/16', self.localIPAddress)
-        self.route.add_default(self.localIPAddress)
-
     @property
     def localIPAddress(self):
         return self._ppp.raddr

Hologram/Network/Network.py

@@ -9,9 +9,15 @@
 #
 
 from Hologram.Event import Event
-import os
 import logging
 from logging import NullHandler
+from enum import Enum
+
+
+class NetworkScope(Enum):
+    SYSTEM = 1
+    HOLOGRAM = 2
+
 
 class Network(object):
 
@@ -23,6 +29,7 @@ def __init__(self, event=Event()):
         # Logging setup.
         self.logger = logging.getLogger(__name__)
         self.logger.addHandler(NullHandler())
+        self.scope = NetworkScope.SYSTEM
 
     def connect(self):
         self.event.broadcast('network.connected')

MANIFEST.in

@@ -1,6 +1,4 @@
-include AUTHORS
 include LICENSE
-include ChangeLog
 include MANIFEST.in
 include Makefile
 include requirements.txt

requirements.txt

@@ -1,3 +1,4 @@
+enum34==1.1.6
 hjson==2.0.2
 mock==2.0.0
 pyroute2==0.4.21

scripts/hologram_receive.py

@@ -9,7 +9,6 @@
 # LICENSE: Distributed under the terms of the MIT License
 
 from Hologram.HologramCloud import HologramCloud
-from hologram_util import handle_timeout
 from hologram_util import handle_polling
 from hologram_util import VAction
 import sys
@@ -32,12 +31,17 @@ def popReceivedSMS():
     if recv is not None:
         print 'Received SMS:', recv
 
-def parse_hologram_receive_args(parser):
+
+def parse_common_receive_args(parser):
     parser.add_argument('-m', '--modem', nargs='?', default='nova',
                         help='The modem type. Choose between nova, ms2131 and e303.')
     parser.add_argument('-v', nargs='?', action=VAction, dest='verbose', required=False)
     parser.add_argument('-t', '--timeout', type=int, nargs='?', default=-1,
                         help='The number of seconds before the socket is closed. Default is to block indefinitely.')
+
+
+def parse_hologram_receive_args(parser):
+    parse_common_receive_args(parser)
     parse_data_args(parser)
     parse_sms_args(parser)
 

scripts/hologram_spacebridge.py

@@ -10,14 +10,45 @@
 #
 # LICENSE: Distributed under the terms of the MIT License
 
+from Hologram.HologramCloud import HologramCloud
+from Hologram.Network import NetworkScope
+from hologram_util import handle_polling
+from scripts.hologram_receive import parse_common_receive_args
+import sys
+
+# pylint: disable=W0603
+hologram = None
+
+
+def popReceivedMessage():
+    recv = hologram.popReceivedMessage()
+    if recv is not None:
+        print('Received message: ' + str(recv))
 
-from scripts.hologram_receive import run_hologram_receive
-from scripts.hologram_receive import parse_hologram_receive_args
 
 def parse_hologram_spacebridge_args(parser):
-    parse_hologram_receive_args(parser)
+    parse_common_receive_args(parser)
     parser.set_defaults(command_selected='spacebridge')
 
+
 def run_hologram_spacebridge(args):
-    args['command_selected'] = 'receive_data'
-    run_hologram_receive(args)
+    global hologram
+    hologram = HologramCloud(dict(), network='cellular')
+
+    hologram.event.subscribe('message.received', popReceivedMessage)
+
+    hologram.network.disable_at_sockets_mode()  # Persistent cellular connection
+    hologram.network.scope = NetworkScope.HOLOGRAM  # Default route NOT set to cellular
+    hologram.network.connect()
+
+    hologram.openReceiveSocket()
+    print ('Ready to receive data on port %s' % hologram.receive_port)
+
+    try:
+        handle_polling(args['timeout'], popReceivedMessage, 1)
+    except KeyboardInterrupt as e:
+        print('Closing socket...')
+        hologram.closeReceiveSocket()
+        sys.exit(e)
+    finally:
+        hologram.network.disconnect()