Hologram Python SDK v0.7.6 release

Author: jtide

CHANGELOG.md

@@ -1,5 +1,11 @@
 # What's New in Hologram Python SDK
 
+## v0.7.6
+
+2018-04-04 Hologram <[email protected]>
+    * hologram receive reconnects after forced disconnect
+    * Replace usb dependency with cross platform library
+
 ## v0.7.5
 
 2018-02-13 Hologram <[email protected]>

Hologram/Cloud.py

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

Hologram/Event/Event.py

@@ -6,6 +6,7 @@
 #
 #
 # LICENSE: Distributed under the terms of the MIT License
+import logging
 
 class Event(object):
     _funcLookupTable = {}
@@ -17,7 +18,10 @@ def subscribe(self, event, callback):
         if not self.__dict__.get(event):
             self.__dict__[event] = [callback]
         else:
-            self.__dict__[event].append(callback)
+            if callback not in self.__dict__[event]:
+                self.__dict__[event].append(callback)
+            else:
+                logging.debug("Callback already subscribed: event[%s] callback[%s]", event, str(callback))
 
     def unsubscribe(self, event, callback):
 

Hologram/Network/Cellular.py

@@ -18,7 +18,7 @@
 from Modem import NovaM_R404
 from Network import Network, NetworkScope
 import time
-import usb.core
+from serial.tools import list_ports
 
 # Cellular return codes.
 CLOUD_DISCONNECTED = 0
@@ -44,6 +44,7 @@ def __init__(self, event=Event()):
         self._connection_status = CLOUD_DISCONNECTED
         self._modem = None
         self._route = Route()
+        self.__receive_port = None
 
     def autodetect_modem(self):
         # scan for a modem and set it if found
@@ -126,6 +127,8 @@ def send_message(self, data):
         return self.modem.send_message(data)
 
     def open_receive_socket(self, receive_port):
+        self.__receive_port = receive_port
+        self.event.subscribe('cellular.forced_disconnect', self.__reconnect_after_forced_disconnect)
         return self.modem.open_receive_socket(receive_port)
 
     def pop_received_message(self):
@@ -147,6 +150,21 @@ def popReceivedSMS(self):
     def get_sim_otp_response(self, command):
         return self.modem.get_sim_otp_response(command)
 
+    def __reconnect_and_receive(self):
+        if not self.at_sockets_available:
+            self.connect()
+        self.open_receive_socket(self.__receive_port)
+
+    def __reconnect_after_forced_disconnect(self):
+        self.logger.info('Reconnecting after forced disconnect...')
+        time.sleep(5)  # uBlox takes some time to update internal state after disconnect
+        self.__reconnect_and_receive()
+        while not self.is_connected():
+            self.logger.info('Reconnect failed. Retrying in 5 seconds...')
+            time.sleep(5)
+            self.__reconnect_and_receive()
+        self.logger.info('Ready to receive data on port %s', self.__receive_port)
+
     def __configure_routing(self):
         self.logger.info('Adding routes to Hologram cloud')
         self._route.add('10.176.0.0/16', self.localIPAddress)
@@ -170,10 +188,7 @@ def _scan_for_modem(self, modemHandler):
             if not vid_pid:
                 continue
             self.logger.debug('checking for vid_pid: %s', str(vid_pid))
-            vid = int(vid_pid[0], 16)
-            pid = int(vid_pid[1], 16)
-            dev = usb.core.find(idVendor=vid, idProduct=pid)
-            if dev:
+            for dev in list_ports.grep("{0}:{1}".format(vid_pid[0], vid_pid[1])):
                 self.logger.info('Detected modem %s', modemHandler.__name__)
                 return True
         return False

Hologram/Network/Modem/Modem.py

@@ -21,8 +21,8 @@
 import datetime
 import logging
 import os
-import pyudev
 import serial
+from serial.tools import list_ports
 import time
 from serial.serialutil import Timeout
 
@@ -42,6 +42,7 @@ class Modem(IModem):
     SOCKET_WRITE_STATE = 1
     SOCKET_RECEIVE_READ = 2
     SOCKET_SEND_READ = 3
+    SOCKET_CLOSED = 4
 
     GSM = u"@£$¥èéùìòÇ\nØø\rÅåΔ_ΦΓΛΩΠΨΣΘΞ ÆæßÉ !\"#¤%&'()*+,-./0123456789:;<=>?¡ABCDEFGHIJKLMNOPQRSTUVWXYZÄÖÑܧ¿abcdefghijklmnopqrstuvwxyzäöñüà"
     EXT = {
@@ -180,31 +181,28 @@ def popReceivedSMS(self):
 
     def __detect_all_serial_ports(self, stop_on_first=False, include_all_ports=True):
         # figures out the serial ports associated with the modem and returns them
-        context = pyudev.Context()
         device_names = []
         for usb_id in self.usb_ids:
             vid = usb_id[0]
             pid = usb_id[1]
-            for udevice in context.list_devices(subsystem='tty', ID_BUS='usb',
-                                                ID_VENDOR_ID=vid):
-                # pyudev has some weird logic where you can't AND two different
-                # properties together so we have to check it later
-                if udevice['ID_MODEL_ID'] != pid:
-                    continue
-                devname = udevice['DEVNAME']
 
+            # The list_ports function returns devices in descending order, so reverse
+            # the order here to iterate in ascending order (e.g. from /dev/xx0 to /dev/xx6)
+            # since our usable serial devices usually start at 0.
+            udevices = [x for x in list_ports.grep("{0}:{1}".format(vid, pid))]
+            for udevice in reversed(udevices):
                 if include_all_ports == False:
-                    self.logger.debug('checking port %s', devname)
-                    port_opened = self.openSerialPort(devname)
+                    self.logger.debug('checking port %s', udevice.name)
+                    port_opened = self.openSerialPort(udevice.device)
                     if not port_opened:
                         continue
 
                     res = self.command('', timeout=1)
                     if res[0] != ModemResult.OK:
                         continue
-                    self.logger.info('found working port at %s', devname)
+                    self.logger.info('found working port at %s', udevice.name)
 
-                device_names.append(devname)
+                device_names.append(udevice.device)
                 if stop_on_first:
                     break
             if stop_on_first and device_names:
@@ -249,6 +247,8 @@ def send_message(self, data, timeout=DEFAULT_SEND_TIMEOUT):
                 if loop_timeout.expired():
                     raise SerialError('Timeout occurred waiting for message status')
                 time.sleep(self._RETRY_DELAY)
+            elif self.urc_state == Modem.SOCKET_CLOSED:
+                return '[1,0]' #this is connection closed for hologram cloud response
 
         return self.read_socket()
 
@@ -389,6 +389,10 @@ def handleURC(self, urc):
             self._handle_listen_urc(urc)
             self.last_read_payload_length = 0
             next_urc_state = Modem.SOCKET_RECEIVE_READ
+        elif urc.startswith('+UUPSDD: '):
+            self.event.broadcast('cellular.forced_disconnect')
+        elif urc.startswith('+UUSOCL: '):
+            next_urc_state = Modem.SOCKET_CLOSED
         else:
             self.logger.debug("URC was not handled. \'%s\'",  urc)
 

tests/MessageMode/test_Cloud.py

@@ -48,4 +48,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.7.5'
+        assert cloud.version == '0.7.6'

version.txt

@@ -1 +1 @@
-0.7.5
+0.7.6