v2024-04-15

Author: ptr814

README.md

@@ -1,2 +1,27 @@
-# tmf8806_driver_python
-TMF8806 Python driver
+# Python
+This folder contains libraries, tools, and tests to interact with the ams OSRAM TMF8806 devices over I2C and GPIO.
+
+## Setup Python Environment
+This framework requires to use python 3.6 or newer for Window 10/11.
+To install the required packages, run `python -m pip install -r requirements.txt`.
+
+## Adding your own sub-directory
+When you add a new sub-directory and want to execute python files there you need to 
+`import __init__` before any other local import. Also you need to copy the file `__init__.py` into this subdirectory
+and make sure the python root path points to the directory where this readme.md file is located.
+`TOF_PYTHON_ROOT_DIR = os.path.normpath(os.path.dirname(__file__) + "/..")`
+
+This is a summary of the files and sub-folders:
+	
+## ./tmf8x0x
+All python classes, files and functions, specific to the TMF8806.
+There is a python class to control the device hardware and the bootloader that also allows to download intel hex files to the device.
+There is a second class that implements measurement application specific commands and controls and data readout, as well as histogram configuration and readout.
+
+### ./tmf8x0x/examples
+Several examples that show the usage:
+- how to perform measurements and read them out
+- how to configure for histogram dumping and how to read them out
+ 
+### ./tmf8x0x/tests
+Python tests to verify functonality of device and/or scripts.

packages/aos_com-1.0.10-py3-none-any.whl

@@ -0,0 +1,9 @@
+intelhex
+pytest
+matplotlib
+numpy
+pyzmq
+avrdude_windows
+setuptools
+./packages/aos_com-1.0.10-py3-none-any.whl
+./packages/aos_lab-1.0.10-py3-none-any.whl

requirements.txt

@@ -0,0 +1,2 @@
+# Version Changelog
+1.0 first released version

tmf8x0x/CHANGELOG.md

@@ -0,0 +1,32 @@
+# *****************************************************************************
+# * 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.      *
+# *****************************************************************************
+
+    
+""" Import this script to set up the python path.
+"""
+
+import os
+import sys
+
+TOF_PYTHON_ROOT_DIR = os.path.normpath(os.path.dirname(__file__) + "/..") 
+"""Change this path depending on the relative path between this file and the TOF python root dir."""
+
+if TOF_PYTHON_ROOT_DIR not in sys.path:
+    sys.path.append(TOF_PYTHON_ROOT_DIR)