Merge branch 'feat/add-pip-setup'

Author: Ramsay, Grant (NZ)

.gitignore

@@ -0,0 +1,2 @@
+build
+.idea

README.md

@@ -31,13 +31,18 @@ Notes on Multiple sensor support:
 Notes on using TCA9548A I2C Multiplexer:
 - If limited on GPIO's that would be needed to set a new addresses for each sensor, using a TCA9548A I2C Multiplexer is a good option since it allows using up to 8 sensors without using GPIO's.
 - The TCA9548A is also a good option if using multiple boards on the same I2C bus and the total of all the combined I2C pullups would cause the bus not to function. 
-- Theoretically you can connect mutltiple TCA9548A Multiplexers, each with up to 8 sensors as long each TCA9548A has a different address. This has not been tested but should work in theory.
+- Theoretically you can connect multiple TCA9548A Multiplexers, each with up to 8 sensors as long each TCA9548A has a different address. This has not been tested but should work in theory.
 
 (Please note that while the author is an embedded software engineer, this is a first attempt at extending python and the author is by no means a python expert so any improvement suggestions are appreciated).
 
 
 ### Installation
-
+```bash
+# Python2
+pip2 install git+https://github.com/johnbryanmoore/VL53L0X_rasp_python.git
+# Python3
+pip3 install git+https://github.com/johnbryanmoore/VL53L0X_rasp_python.git
+```
 
 ### Compilation
 

python/VL53L0X.py

@@ -21,51 +21,61 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-
-import time
 from ctypes import *
-import smbus
+import smbus2 as smbus
+import site
 
-VL53L0X_GOOD_ACCURACY_MODE      = 0   # Good Accuracy mode
-VL53L0X_BETTER_ACCURACY_MODE    = 1   # Better Accuracy mode
-VL53L0X_BEST_ACCURACY_MODE      = 2   # Best Accuracy mode
-VL53L0X_LONG_RANGE_MODE         = 3   # Longe Range mode
-VL53L0X_HIGH_SPEED_MODE         = 4   # High Speed mode
+VL53L0X_GOOD_ACCURACY_MODE = 0      # Good Accuracy mode
+VL53L0X_BETTER_ACCURACY_MODE = 1    # Better Accuracy mode
+VL53L0X_BEST_ACCURACY_MODE = 2      # Best Accuracy mode
+VL53L0X_LONG_RANGE_MODE = 3         # Longe Range mode
+VL53L0X_HIGH_SPEED_MODE = 4         # High Speed mode
 
 i2cbus = smbus.SMBus(1)
 
+
 # i2c bus read callback
 def i2c_read(address, reg, data_p, length):
-    ret_val = 0;
+    ret_val = 0
     result = []
 
     try:
         result = i2cbus.read_i2c_block_data(address, reg, length)
     except IOError:
-        ret_val = -1; 
+        ret_val = -1
 
-    if (ret_val == 0):
+    if ret_val == 0:
         for index in range(length):
             data_p[index] = result[index]
 
     return ret_val
 
+
 # i2c bus write callback
 def i2c_write(address, reg, data_p, length):
-    ret_val = 0;
+    ret_val = 0
     data = []
 
     for index in range(length):
         data.append(data_p[index])
     try:
         i2cbus.write_i2c_block_data(address, reg, data)
     except IOError:
-        ret_val = -1; 
+        ret_val = -1
 
     return ret_val
 
-# Load VL53L0X shared lib 
-tof_lib = CDLL("../bin/vl53l0x_python.so")
+
+# Load VL53L0X shared lib
+_possible_lib_locations = site.getsitepackages() + ['../bin']
+for lib_location in _possible_lib_locations:
+    try:
+        tof_lib = CDLL(lib_location + "/vl53l0x_python.so")
+        break
+    except OSError:
+        pass
+else:
+    raise OSError('Could not find vl53l0x_python.so')
 
 # Create read function pointer
 READFUNC = CFUNCTYPE(c_int, c_ubyte, c_ubyte, POINTER(c_ubyte), c_ubyte)
@@ -78,22 +88,24 @@ def i2c_write(address, reg, data_p, length):
 # pass i2c read and write function pointers to VL53L0X library
 tof_lib.VL53L0X_set_i2c(read_func, write_func)
 
+
 class VL53L0X(object):
     """VL53L0X ToF."""
 
     object_number = 0
 
-    def __init__(self, address=0x29, TCA9548A_Num=255, TCA9548A_Addr=0, **kwargs):
+    def __init__(self, address=0x29, TCA9548A_Num=255, TCA9548A_Addr=0):
         """Initialize the VL53L0X ToF Sensor from ST"""
         self.device_address = address
         self.TCA9548A_Device = TCA9548A_Num
         self.TCA9548A_Address = TCA9548A_Addr
         self.my_object_number = VL53L0X.object_number
         VL53L0X.object_number += 1
 
-    def start_ranging(self, mode = VL53L0X_GOOD_ACCURACY_MODE):
+    def start_ranging(self, mode=VL53L0X_GOOD_ACCURACY_MODE):
         """Start VL53L0X ToF Sensor Ranging"""
-        tof_lib.startRanging(self.my_object_number, mode, self.device_address, self.TCA9548A_Device, self.TCA9548A_Address)
+        tof_lib.startRanging(self.my_object_number, mode, self.device_address,
+                             self.TCA9548A_Device, self.TCA9548A_Address)
 
     def stop_ranging(self):
         """Stop VL53L0X ToF Sensor Ranging"""
@@ -106,12 +118,11 @@ def get_distance(self):
     # This function included to show how to access the ST library directly
     # from python instead of through the simplified interface
     def get_timing(self):
-        Dev = POINTER(c_void_p)
-        Dev = tof_lib.getDev(self.my_object_number)
+        dev = tof_lib.getDev(self.my_object_number)
         budget = c_uint(0)
         budget_p = pointer(budget)
-        Status =  tof_lib.VL53L0X_GetMeasurementTimingBudgetMicroSeconds(Dev, budget_p)
-        if (Status == 0):
-            return (budget.value + 1000)
+        status = tof_lib.VL53L0X_GetMeasurementTimingBudgetMicroSeconds(dev, budget_p)
+        if status == 0:
+            return budget.value + 1000
         else:
             return 0

setup.py

@@ -0,0 +1,57 @@
+from distutils.core import setup, Extension
+from distutils.command.build_ext import build_ext
+
+
+# Found this on stack overflow:
+# https://stackoverflow.com/questions/4529555/building-a-ctypes-based-c-library-with-distutils
+# noinspection PyPep8Naming
+class build_ext(build_ext):
+
+    def build_extension(self, ext):
+        # noinspection PyAttributeOutsideInit
+        self._ctypes = isinstance(ext, CTypesExtension)
+        return super().build_extension(ext)
+
+    def get_export_symbols(self, ext):
+        if self._ctypes:
+            return ext.export_symbols
+        return super().get_export_symbols(ext)
+
+    def get_ext_filename(self, ext_name):
+        if self._ctypes:
+            return ext_name + '.so'
+        return super().get_ext_filename(ext_name)
+
+
+class CTypesExtension(Extension):
+    pass
+
+
+extension = CTypesExtension(
+    'vl53l0x_python',
+    define_macros=[],
+    include_dirs=['.', 'Api/core/inc', 'platform/inc'],
+    libraries=[],
+    library_dirs=[],
+    sources=['Api/core/src/vl53l0x_api_calibration.c',
+             'Api/core/src/vl53l0x_api_core.c',
+             'Api/core/src/vl53l0x_api_ranging.c',
+             'Api/core/src/vl53l0x_api_strings.c',
+             'Api/core/src/vl53l0x_api.c',
+             'platform/src/vl53l0x_platform.c',
+             'python_lib/vl53l0x_python.c'])
+
+setup(name='VL53L0X_rasp_python',
+      version='1.0.2',
+      description='VL53L0X sensor for raspberry PI',
+      # author='?',
+      # author_email='?',
+      url='https://github.com/johnbryanmoore/VL53L0X_rasp_python',
+      long_description='''
+VL53L0X sensor for raspberry PI.
+''',
+      ext_modules=[extension],
+      package_dir={'': 'python'},
+      py_modules=['VL53L0X'],
+      requires=['smbus2'],
+      cmdclass={'build_ext': build_ext})