Update dev to latest

.github/workflows/main.yml

@@ -0,0 +1,46 @@
+name: minify
+
+on:
+  # Allow manual trigger
+  workflow_dispatch:
+  # Triggers the workflow on push request events but only for the main branch
+  push:
+    branches: [ main ]
+    paths:
+      - 'PiicoDev_VL53L1X.py'
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      - name: setup python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.9'
+
+      - name: install python packages
+        run: pip install python-minifier 
+
+      - name: run minifier
+        run: pyminify PiicoDev_VL53L1X.py > min/PiicoDev_VL53L1X.py
+
+      - name: commit files
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add -A
+          git commit -m "Update min/PiicoDev_VL53L1X.py" -a --allow-empty
+
+      - name: push changes
+        uses: ad-m/github-push-action@v0.6.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: main

PiicoDev_VL53L1X.py

@@ -1,136 +1,148 @@
 from PiicoDev_Unified import *
-i2c = PiicoDev_Unified_I2C() 
+
+compat_str = '\nUnified PiicoDev library out of date.  Get the latest module: https://piico.dev/unified \n'
 
 VL51L1X_DEFAULT_CONFIGURATION = bytes([
 0x00, # 0x2d : set bit 2 and 5 to 1 for fast plus mode (1MHz I2C), else don't touch */
 0x00, # 0x2e : bit 0 if I2C pulled up at 1.8V, else set bit 0 to 1 (pull up at AVDD) */
 0x00, # 0x2f : bit 0 if GPIO pulled up at 1.8V, else set bit 0 to 1 (pull up at AVDD) */
 0x01, # 0x30 : set bit 4 to 0 for active high interrupt and 1 for active low (bits 3:0 must be 0x1), use SetInterruptPolarity() */
 0x02, # 0x31 : bit 1 = interrupt depending on the polarity, use CheckForDataReady() */
-0x00, # 0x32 : not user-modifiable */
-0x02, # 0x33 : not user-modifiable */
-0x08, # 0x34 : not user-modifiable */
-0x00, # 0x35 : not user-modifiable */
-0x08, # 0x36 : not user-modifiable */
-0x10, # 0x37 : not user-modifiable */
-0x01, # 0x38 : not user-modifiable */
-0x01, # 0x39 : not user-modifiable */
-0x00, # 0x3a : not user-modifiable */
-0x00, # 0x3b : not user-modifiable */
-0x00, # 0x3c : not user-modifiable */
-0x00, # 0x3d : not user-modifiable */
-0xff, # 0x3e : not user-modifiable */
-0x00, # 0x3f : not user-modifiable */
-0x0F, # 0x40 : not user-modifiable */
-0x00, # 0x41 : not user-modifiable */
-0x00, # 0x42 : not user-modifiable */
-0x00, # 0x43 : not user-modifiable */
-0x00, # 0x44 : not user-modifiable */
-0x00, # 0x45 : not user-modifiable */
+0x00, # 0x32 : not user-modifiable (NUM)*/
+0x02, # 0x33 : NUM */
+0x08, # 0x34 : NUM */
+0x00, # 0x35 : NUM */
+0x08, # 0x36 : NUM */
+0x10, # 0x37 : NUM */
+0x01, # 0x38 : NUM */
+0x01, # 0x39 : NUM */
+0x00, # 0x3a : NUM */
+0x00, # 0x3b : NUM */
+0x00, # 0x3c : NUM */
+0x00, # 0x3d : NUM */
+0xff, # 0x3e : NUM */
+0x00, # 0x3f : NUM */
+0x0F, # 0x40 : NUM */
+0x00, # 0x41 : NUM */
+0x00, # 0x42 : NUM */
+0x00, # 0x43 : NUM */
+0x00, # 0x44 : NUM */
+0x00, # 0x45 : NUM */
 0x20, # 0x46 : interrupt configuration 0->level low detection, 1-> level high, 2-> Out of window, 3->In window, 0x20-> New sample ready , TBC */
-0x0b, # 0x47 : not user-modifiable */
-0x00, # 0x48 : not user-modifiable */
-0x00, # 0x49 : not user-modifiable */
-0x02, # 0x4a : not user-modifiable */
-0x0a, # 0x4b : not user-modifiable */
-0x21, # 0x4c : not user-modifiable */
-0x00, # 0x4d : not user-modifiable */
-0x00, # 0x4e : not user-modifiable */
-0x05, # 0x4f : not user-modifiable */
-0x00, # 0x50 : not user-modifiable */
-0x00, # 0x51 : not user-modifiable */
-0x00, # 0x52 : not user-modifiable */
-0x00, # 0x53 : not user-modifiable */
-0xc8, # 0x54 : not user-modifiable */
-0x00, # 0x55 : not user-modifiable */
-0x00, # 0x56 : not user-modifiable */
-0x38, # 0x57 : not user-modifiable */
-0xff, # 0x58 : not user-modifiable */
-0x01, # 0x59 : not user-modifiable */
-0x00, # 0x5a : not user-modifiable */
-0x08, # 0x5b : not user-modifiable */
-0x00, # 0x5c : not user-modifiable */
-0x00, # 0x5d : not user-modifiable */
-0x01, # 0x5e : not user-modifiable */
-0xdb, # 0x5f : not user-modifiable */
-0x0f, # 0x60 : not user-modifiable */
-0x01, # 0x61 : not user-modifiable */
-0xf1, # 0x62 : not user-modifiable */
-0x0d, # 0x63 : not user-modifiable */
+0x0b, # 0x47 : NUM */
+0x00, # 0x48 : NUM */
+0x00, # 0x49 : NUM */
+0x02, # 0x4a : NUM */
+0x0a, # 0x4b : NUM */
+0x21, # 0x4c : NUM */
+0x00, # 0x4d : NUM */
+0x00, # 0x4e : NUM */
+0x05, # 0x4f : NUM */
+0x00, # 0x50 : NUM */
+0x00, # 0x51 : NUM */
+0x00, # 0x52 : NUM */
+0x00, # 0x53 : NUM */
+0xc8, # 0x54 : NUM */
+0x00, # 0x55 : NUM */
+0x00, # 0x56 : NUM */
+0x38, # 0x57 : NUM */
+0xff, # 0x58 : NUM */
+0x01, # 0x59 : NUM */
+0x00, # 0x5a : NUM */
+0x08, # 0x5b : NUM */
+0x00, # 0x5c : NUM */
+0x00, # 0x5d : NUM */
+0x01, # 0x5e : NUM */
+0xdb, # 0x5f : NUM */
+0x0f, # 0x60 : NUM */
+0x01, # 0x61 : NUM */
+0xf1, # 0x62 : NUM */
+0x0d, # 0x63 : NUM */
 0x01, # 0x64 : Sigma threshold MSB (mm in 14.2 format for MSB+LSB), use SetSigmaThreshold(), default value 90 mm  */
 0x68, # 0x65 : Sigma threshold LSB */
 0x00, # 0x66 : Min count Rate MSB (MCPS in 9.7 format for MSB+LSB), use SetSignalThreshold() */
 0x80, # 0x67 : Min count Rate LSB */
-0x08, # 0x68 : not user-modifiable */
-0xb8, # 0x69 : not user-modifiable */
-0x00, # 0x6a : not user-modifiable */
-0x00, # 0x6b : not user-modifiable */
+0x08, # 0x68 : NUM */
+0xb8, # 0x69 : NUM */
+0x00, # 0x6a : NUM */
+0x00, # 0x6b : NUM */
 0x00, # 0x6c : Intermeasurement period MSB, 32 bits register, use SetIntermeasurementInMs() */
 0x00, # 0x6d : Intermeasurement period */
 0x0f, # 0x6e : Intermeasurement period */
 0x89, # 0x6f : Intermeasurement period LSB */
-0x00, # 0x70 : not user-modifiable */
-0x00, # 0x71 : not user-modifiable */
+0x00, # 0x70 : NUM */
+0x00, # 0x71 : NUM */
 0x00, # 0x72 : distance threshold high MSB (in mm, MSB+LSB), use SetD:tanceThreshold() */
 0x00, # 0x73 : distance threshold high LSB */
 0x00, # 0x74 : distance threshold low MSB ( in mm, MSB+LSB), use SetD:tanceThreshold() */
 0x00, # 0x75 : distance threshold low LSB */
-0x00, # 0x76 : not user-modifiable */
-0x01, # 0x77 : not user-modifiable */
-0x0f, # 0x78 : not user-modifiable */
-0x0d, # 0x79 : not user-modifiable */
-0x0e, # 0x7a : not user-modifiable */
-0x0e, # 0x7b : not user-modifiable */
-0x00, # 0x7c : not user-modifiable */
-0x00, # 0x7d : not user-modifiable */
-0x02, # 0x7e : not user-modifiable */
+0x00, # 0x76 : NUM */
+0x01, # 0x77 : NUM */
+0x0f, # 0x78 : NUM */
+0x0d, # 0x79 : NUM */
+0x0e, # 0x7a : NUM */
+0x0e, # 0x7b : NUM */
+0x00, # 0x7c : NUM */
+0x00, # 0x7d : NUM */
+0x02, # 0x7e : NUM */
 0xc7, # 0x7f : ROI center, use SetROI() */
 0xff, # 0x80 : XY ROI (X=Width, Y=Height), use SetROI() */
-0x9B, # 0x81 : not user-modifiable */
-0x00, # 0x82 : not user-modifiable */
-0x00, # 0x83 : not user-modifiable */
-0x00, # 0x84 : not user-modifiable */
-0x01, # 0x85 : not user-modifiable */
+0x9B, # 0x81 : NUM */
+0x00, # 0x82 : NUM */
+0x00, # 0x83 : NUM */
+0x00, # 0x84 : NUM */
+0x01, # 0x85 : NUM */
 0x01, # 0x86 : clear interrupt, use ClearInterrupt() */
 0x40  # 0x87 : start ranging, use StartRanging() or StopRanging(), If you want an automatic start after VL53L1X_init() call, put 0x40 in location 0x87 */
 ])
 
 
 class PiicoDev_VL53L1X:
-    def __init__(self, address=0x29, i2c=i2c):
-        self.i2c = i2c
-        self.address = address
-
+    def __init__(self, bus=None, freq=None, sda=None, scl=None, address=0x29):
+        try:
+            if compat_ind >= 1:
+                pass
+            else:
+                print(compat_str)
+        except:
+            print(compat_str)
+        self.i2c = create_unified_i2c(bus=bus, freq=freq, sda=sda, scl=scl)
+        self.addr = address
+        self.status = None
         self.reset()
         sleep_ms(1)
         if self.read_model_id() != 0xEACC:
             raise RuntimeError('Failed to find expected ID register values. Check wiring!')
         # write default configuration
-        self.i2c.writeto_mem(self.address, 0x2D, VL51L1X_DEFAULT_CONFIGURATION, addrsize=16)
-#         self.i2c._i2c_write(self.address, 0x002D, VL51L1X_DEFAULT_CONFIGURATION, len(VL51L1X_DEFAULT_CONFIGURATION))
+        self.i2c.writeto_mem(self.addr, 0x2D, VL51L1X_DEFAULT_CONFIGURATION, addrsize=16)
         sleep_ms(100)
         # the API triggers this change in VL53L1_init_and_start_range() once a
         # measurement is started; assumes MM1 and MM2 are disabled
         self.writeReg16Bit(0x001E, self.readReg16Bit(0x0022) * 4)
         sleep_ms(200)
 
     def writeReg(self, reg, value):
-        return self.i2c.writeto_mem(self.address, reg, bytes([value]), addrsize=16)
+        return self.i2c.writeto_mem(self.addr, reg, bytes([value]), addrsize=16)
     def writeReg16Bit(self, reg, value):
-        return self.i2c.writeto_mem(self.address, reg, bytes([(value >> 8) & 0xFF, value & 0xFF]), addrsize=16)
+        return self.i2c.writeto_mem(self.addr, reg, bytes([(value >> 8) & 0xFF, value & 0xFF]), addrsize=16)
     def readReg(self, reg):
-        return self.i2c.readfrom_mem(self.address, reg, 1, addrsize=16)[0]
+        return self.i2c.readfrom_mem(self.addr, reg, 1, addrsize=16)[0]
     def readReg16Bit(self, reg):
-        data = self.i2c.readfrom_mem(self.address, reg, 2, addrsize=16)
+        data = self.i2c.readfrom_mem(self.addr, reg, 2, addrsize=16)
         return (data[0]<<8) + data[1]
     def read_model_id(self):
-        return self.readReg16Bit(0x010F)        
+        return self.readReg16Bit(0x010F) 
     def reset(self):
         self.writeReg(0x0000, 0x00)
         sleep_ms(100)
         self.writeReg(0x0000, 0x01)
+
     def read(self):
-        data = self.i2c.readfrom_mem(self.address, 0x0089, 17, addrsize=16) # RESULT__RANGE_STATUS
+        try:
+            data = self.i2c.readfrom_mem(self.addr, 0x0089, 17, addrsize=16) # RESULT__RANGE_STATUS
+        except:
+            print(i2c_err_str.format(self.addr))
+            return float('NaN')
         range_status = data[0]
         # report_status = data[1]
         stream_count = data[2]
@@ -141,33 +153,33 @@ def read(self):
         # phase_sd0 = (data[11]<<8) + data[12]
         final_crosstalk_corrected_range_mm_sd0 = (data[13]<<8) + data[14]
         peak_signal_count_rate_crosstalk_corrected_mcps_sd0 = (data[15]<<8) + data[16]
-        #status = None
-        #if range_status in (17, 2, 1, 3):
-            #status = "HardwareFail"
-        #elif range_status == 13:
-            #status = "MinRangeFail"
-        #elif range_status == 18:
-            #status = "SynchronizationInt"
-        #elif range_status == 5:
-            #status = "OutOfBoundsFail"
-        #elif range_status == 4:
-            #status = "SignalFail"
-        #elif range_status == 6:
-            #status = "SignalFail"
-        #elif range_status == 7:
-            #status = "WrapTargetFail"
-        #elif range_status == 12:
-            #status = "XtalkSignalFail"
-        #elif range_status == 8:
-            #status = "RangeValidMinRangeClipped"
-        #elif range_status == 9:
-            #if stream_count == 0:
-                #status = "RangeValidNoWrapCheckFail"
-            #else:
-                #status = "OK"
+        status = None
+        if range_status in (17, 2, 1, 3):
+            self.status = "HardwareFail"
+        elif range_status == 13:
+            self.status = "MinRangeFail"
+        elif range_status == 18:
+            self.status = "SynchronizationInt"
+        elif range_status == 5:
+            self.status = "OutOfBoundsFail"
+        elif range_status == 4:
+            self.status = "SignalFail"
+        elif range_status == 6:
+            self.status = "SignalFail"
+        elif range_status == 7:
+            self.status = "WrapTargetFail"
+        elif range_status == 12:
+            self.status = "XtalkSignalFail"
+        elif range_status == 8:
+            self.status = "RangeValidMinRangeClipped"
+        elif range_status == 9:
+            if stream_count == 0:
+                self.status = "RangeValidNoWrapCheckFail"
+            else:
+                self.status = "OK"
         return final_crosstalk_corrected_range_mm_sd0
 
-    def change_id(self, new_id):
-        self.writeReg(0x0001, new_id & 0x7F)
+    def change_addr(self, new_addr):
+        self.writeReg(0x0001, new_addr & 0x7F)
         sleep_ms(50)
-        self.address = new_id
+        self.addr = new_addr

README.md

@@ -1,15 +1,45 @@
 # PiicoDev® VL53L1X MicroPython Module
 
-<!-- TODO update link -->
-This is the firmware repo for the [Core Electronics PiicoDev® Distance Sensor VL53L1X](https://core-electronics.com.au)
+This is the firmware repo for the [Core Electronics PiicoDev® Distance Sensor VL53L1X](https://core-electronics.com.au/catalog/product/view/sku/CE07741)
 
-<!-- TODO update tutorial link
-See the [Quickstart Guide](https://core-electronics.com.au/tutorials/quickstart-guide-piicodev-precision-temperature-sensor-tmp117-and-micropython.html)
+This module depends on the [PiicoDev Unified Library](https://github.com/CoreElectronics/CE-PiicoDev-Unified). Place `PiicoDev_Unified.py` in the same directory.
 
-This module has been tested on:
- - Micro:bit v1, (expected to work with Micro:bit v2 without changes)
- - Raspberry Pi Pico
- -->
+See the Quickstart Guides for:
+- [Micro:bit v2](https://core-electronics.com.au/tutorials/piicodev-distance-sensor-vl53l1x-micro-bit-guide.html)
+- [Raspberry Pi Pico](https://core-electronics.com.au/tutorials/piicodev-distance-sensor-vl53l1x-raspberry-pi-pico-guide.html).
+- [Raspberry Pi](https://core-electronics.com.au/tutorials/piicodev-raspberrypi/piicodev-distance-sensor-vl53l1x-raspberry-pi-guide.html)
+
+# Usage
+## Example
+[main.py](https://github.com/CoreElectronics/CE-PiicoDev-VL53L1X-MicroPython-Module/blob/main/main.py) is a simple example to get started.
+```
+from PiicoDev_VL53L1X import PiicoDev_VL53L1X
+from time import sleep
+
+distSensor = PiicoDev_VL53L1X()
+
+while True:
+    dist = distSensor.read() # read the distance in millimetres
+    print(str(dist) + " mm") # convert the number to a string and print
+    sleep(0.1)
+```
+## Details
+### PiicoDev_VL53L1X(bus=, freq=, sda=, scl=, address=0x29)
+Parameter | Type | Range | Default | Description
+--- | --- | --- | --- | ---
+bus | int | 0,1 | Raspberry Pi Pico: 0, Raspberry Pi: 1 | I2C Bus.  Ignored on Micro:bit
+freq | int | 100-1000000 | Device dependent | I2C Bus frequency (Hz).  Ignored on Raspberry Pi
+sda | Pin | Device Dependent | Device Dependent | I2C SDA Pin. Implemented on Raspberry Pi Pico only
+scl | Pin | Device Dependent | Device Dependent | I2C SCL Pin. Implemented on Raspberry Pi Pico only
+address | int | 0x29 | 0x29 | The VL53L1X Distance Sensor address can be set using the change_addr function.
+
+### PiicoDev_VL53L1X.read()
+Parameter | Type | Unit | Description
+--- | --- | --- | ---
+returned | int | mm | Range
+
+### Using Multiple Sensors
+Since the VL53L1X defaults to a single address, multiple sensors on the same bus will conflict. You can use the change_addr function to use something other than the default, but it will be lost on power down. You can use any spare GPIO on your microcontroller to drive the SHT (shutdown) pin low to disable all the sensors you are using, then bring them up one at a time to give them a unique address each time your code starts. Be sure to pick addresses that are at least 2 away from each other, as reading from the sensor uses your set address + 1.
 
 # License
 This project is open source - please review the LICENSE.md file for further licensing information.