- changes for 10m mode release

Author: mp020422-amsOSRAM

LICENSE

@@ -1,21 +1,18 @@
-/*
- *****************************************************************************
- * Copyright by ams OSRAM AG                                                       *
- * All rights are reserved.                                                  *
- *                                                                           *
- * IMPORTANT - PLEASE READ CAREFULLY BEFORE COPYING, INSTALLING OR USING     *
- * THE SOFTWARE.                                                             *
- *                                                                           *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT         *
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS         *
- * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT  *
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,     *
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT          *
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,     *
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY     *
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT       *
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE     *
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.      *
- *****************************************************************************
- */
+Copyright 2024 ams-OSRAM AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of 
+this software and associated documentation files (the “Software”), to deal in 
+the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
+of the Software, and to permit persons to whom the Software is furnished to do 
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 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.

README.md

@@ -47,6 +47,7 @@ UART commands (single character)
 - i ... I2C address change
 - m ... start measure
 - p ... power down
+- r ... remote control mode
 - s ... stop measure
 - t ... switch persistence and thresholds
 - w ... wakeup
@@ -113,9 +114,35 @@ The simplest way is to do a live factory calibration. I.e. do the following step
 6. Enter the following commands in your terminal console:  
     - e 
     - f  
-7. The application reports the calibration data: e.g. #Cal,2,0,0,A,B0,BE,BD,7C,F5,F0,F3,F7,7,4
+7. The application reports the calibration data: e.g. #Cal,0x2,0x0,0x0,0xA,0xB0,0xBE,0xBD,0x7C,0xF5,0xF0,0xF3,0xF7,0x7,0x4
 8. If the application does not send the calibration data the calibration has failed. Check your cover glass and check if there is no object (within 40cm) in the field-of-view of the sensor.
 
+To use the obtained factory calibration data as default add this code to the sketch:
+
+```
+static const uint8_t deviceFactoryCalibration[sizeof(tmf8806FactoryCalibData)] = 
+{
+  0x2,0x0,0x0,0xA,0xB0,0xBE,0xBD,0x7C,0xF5,0xF0,0xF3,0xF7,0x7,0x4
+};
+
+void tmf8806Initialise ( tmf8806Driver * driver, uint8_t logLevel )
+{
+  tmf8806ResetClockCorrection( driver );
+  driver->i2cSlaveAddress = TMF8806_SLAVE_ADDR;
+  driver->clkCorrectionEnable = 1;                  // default is on
+  driver->logLevel = logLevel;
+  driver->measureConfig = defaultConfig;
+  // driver->factoryCalib = defaultFactoryCalib;
+  tmf8806DeserializeFactoryCalibration(deviceFactoryCalibration,&(driver->factoryCalib));
+  driver->stateData = defaultStateData;
+  driver->info = tmf8806DriverInfoReset;
+  driver->device = tmf8806DeviceInfoReset;
+}
+```
+
+Put the device calibration data into the array **deviceFactoryCalibration** and replace the assignment of the default factory 
+calibration with a call to deserialize the calibration data from that array.
+
 ## Crosstalk readout
 
 The application reports the crosstalk with each measurement result. E.g.:
@@ -167,4 +194,11 @@ Line Tag  | Histogram Type
   \#PT    | proximity
   \#TG    | distance
   \#TGPUC | pileup-corrected distance
-  \#SUM   | summed
+  \#SUM   | summed
+
+## Remote Control Mode
+
+This is a new operation mode for the TMF8806 VCSEL (laser diode) to act as an infrared LED controlled 
+by the input signal on GPIO1. GPIO1 == LO -> VCSEL OFF, GPIO1 == HI -> VCSEL ON. 
+This function requires firmware patch 4.14.1.x or newer. It does not work with standard ROM firmware.
+To exit the remote control mode send the command "s" (stop measure).

how_to_generate_image_from_hex/generate_tof_image.bat

@@ -1 +1,2 @@
-srec_cat.exe -o tmf8806_image.c -C-Array tmf8806_image -INClude mainapp_PATCH_Leica_k3.hex -Intel
+srec_cat.exe -o tmf8806_image.c -C-Array tmf8806_image -INClude mainapp_PATCH_Maxwell.hex -Intel
+