ams TMF882X EVM Demonstration Kit

Product Information: TMF882X Time-of-Flight EVM Demonstration Kit

The TMF882X Time-of-Flight (ToF) EVM demonstration kit is designed to evaluate ToF optical sensor(s) from ams-OSRAM AG. Thiskit includes a ToF sensor EVM enclosure and sample glass, USB type
A to micro-USB cable(s), USB flash drive with EVM GUI software, and EVM documentation.

Kit Content

• ToF sensor EVM enclosure and sample glass (some EVMs come without an enclosure)
• USB type A to micro-USB cable(s)
• USB flash drive with EVM GUI software
• EVM documentation (including this guide)

The kit can be ordered using the ordering code TMF882X-EVM and is an evaluation kit for TMF8820, TMF8821 & TMF8828.

Product Usage Instructions

Setting Up the EVM Hardware
The ToF sensor enclosure is already assembled and ready to plug-in to a PC. The EVM with the enclosure exposes only one micro-USB connector. On EVMs without enclosure (or if the enclosure has been removed), plug-in the micro- USB connector to the USB connector closer to the center of the Raspberry Pi Zero W board. Install the necessary USB driver (ams-raspi-rndis.inf) when the EVM is plugged into the PC for the first time.

Installing the EVM Graphical User Interface
The ToF EVM GUI software is included on the USB flash drive. Launch the Windows installer and choose the desired installation options. The EVM graphical user interface executable is titled TMF882X_EVM_GUI.exe.

Product Document

Published by ams OSRAM Group

User Guide
UG000495
TMF882X
EVM User Guide TMF882X-EVM
v9-00 · 2023-Apr-05

Document Feedback

TMF882X Content Guide

Introduction

The Time-of-Flight (hereafter referred to as `ToF’) EVM demonstration kit provides a way to evaluate ToF optical sensor(s) from ams-OSRAM AG. This document is a basic user guide to the setup and operation of the ToF EVM software.

1.1

Kit Content
Below is a checklist of what is included in the ToF EVM kit.
ToF sensor EVM enclosure and sample glass (some EVMs come without an enclosure) USB type A to micro-USB cable(s) USB flash drive with EVM GUI software EVM documentation (including this guide)
Figure 1: Kit Content

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 3

Document Feedback

TMF882X Introduction

1.2 Ordering Information
Ordering Code TMF882X-EVM

Description Evaluation Kit for TMF8820, TMF8821 & TMF8828.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 4

Document Feedback

TMF882X Setting Up the EVM

2 Setting Up the EVM

This section describes the setup steps necessary to start using the EVM software.

2.1

Setting Up the EVM Hardware
The ToF sensor enclosure is already assembled and ready to plug-in to a PC. The EVM with the enclosure exposes only one micro-USB connector:
Figure 2: EVM with Enclosure

On EVMs without enclosure (or if the enclosure has been removed) plug-in the micro-USB connector to the USB connector closer to the center of the Raspberry Pi Zero W board (see Figure 3).

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 5

Document Feedback
Figure 3: EVM Without Enclosure ­ Front Side (TMF882X facing to table)

TMF882X Setting Up the EVM

The TMF882X is shown when placing the Raspberry Pi Zero W on the backside (see Figure 4).
Figure 4: EVM Without Enclosure ­ Back Side (TMF882X facing to ceiling)

2.1.1

Install the EVM USB Windows (one-time only)
When the EVM is plugged into the PC, Windows should recognize the EVM as a “Removable Disk”.
Install this necessary USB driver (right-click and choose “Install” from the context menu): ams-raspi-rndis.inf This step is only necessary during first- time setup, but will need to be repeated if using the EVM software on a new PC.

2.1.2

Installing the EVM Graphical User Interface
The ToF EVM GUI software is included on the USB flash drive. Launch the Windows installer and choose the desired installation options. The EVM graphical user interface executable is titled TMF882X_EVM_GUI.exe.
To check for newer versions of the ToF EVM GUI, see TMF882X-EVM.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 6

Document Feedback

TMF882X Using the EVM Software

3 Using the EVM Software
This section describes the operation and capabilities of the EVM Graphical User Interface (EVM GUI). Figure 5: EVM GUI Overview in 3 x 3, 3 x 6, and 4 x 4 Pixel Mode
3 1

6

2 7

4 8

9

10

11

5

1 Main Tab Selector (see section 3.1.2)
2 Histogram Display Selector (see section
3.1.3) 3 “Control” Box (see section 3.1.4) 4 “Data Logging” Box (see section 3.1.5) 5 Connection Status Indicators (see section 3.1.6)

6 Distance Bar Chart (see section 3.2.1)
7 Histograms Plot (see section 3.2.1)
8 “Histograms” Box (see section 3.2.2) 9 “Display” Box (see section 3.2.2) 10 “Information” Box (see section 3.2.2) 11 “Measurement” Box (see section 3.2.2)

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 7

Document Feedback
Figure 6: EVM GUI Overview in 8 x 8 Pixel Mode
1 6

TMF882X Using the EVM Software
3
4 10 11

5

1 Main Tab Selector (see section 3.1.2)
3 “Control” Box (see section 3.1.4) 4 “Data Logging” Box (see section 3.1.5) 5 Connection Status Indicators (see section
3.1.6)

6 Distance Bar Chart (see section 3.2.1)
10 “Information” Box (see section 3.2.2) 11 “Measurement” Box (see section 3.2.2)

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 8

Document Feedback

TMF882X Using the EVM Software

3.1 Controls for All Tabs

3.1.1

Menu
The global menu contains these entries:
“File” Menu “Save Configuration” – save all EVM GUI settings (control values). “Load Configuration” – loads all EVM GUI settings (control values). “Exit” – leave the EVM GUI.
“Help” Menu “About Dialog” – shows version information and copyright notices.

3.1.2

Main Tab Selector [1] Select your view context here:
The “Main” tab shows histograms (also in a histogram matrix) and data for the object in the sensor’s field of view as a bar chart (distance and confidence).
The “3D” tab shows a 3D graphical representation the same object data (distance and confidence).
The “Interrupt” tab is similar to the 3D tab and allows you to set object detection parameters (e.g. relevant object distance).
You can update the firmware on the EVM module with the “File Upload” tab.

3.1.3

Histogram Display Selector [2] Figure 7: Histogram Display Selector

You can display histograms either in a combined graph as shown above or separately for each of the channels by selecting “Histogram Matrix”.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 9

Document Feedback

TMF882X Using the EVM Software

Information
The 8 x 8-histogram view is not enabled in the EVM GUI. It automatically hides this element in 8 x 8 mode.

3.1.4

“Control” Box [3] Figure 8: Control Box

“Pixels” Combo Box The TMF882X detects objects in more than one zone. Select the zone setup here.
Select one of these: 3 x 3 – divides the field of view into nine zones, arranged in a 3 by 3 rectangle. 4 x 4 – divides the field of view into sixteen zones, arranged in a 4 by 4 rectangle. 3 x 6 – divides the field of view into eighteen zones, arranged in a 3 by 6 rectangle. 8 x 8 – divides the field of view into 64 zones, arranged in a 8 by 8 rectangle.
“SPAD Map” Combo Box Define the field of view with the entries in this combo box. For a narrow field of view, select e.g. “33°x32°”.
For a wide field of view, select e.g. “41°x52°” – 41° horizontal, 52° vertical.
For 8 x 8 zones, the SPAD Map is fixed to a “Custom Map” that cannot be changed.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 10

Document Feedback

TMF882X Using the EVM Software

“Mode” Combo Box This control is available for 3 x 3, 4 x 4, and 3 x 6 zones. It selects three predefined parameter sets for iterations and threshold: Default Mode – 550000 iterations, the TMF882X runs with a measurement frequency of 30 Hz in
this mode. Low Power Mode – 50000 iterations, the TMF882X runs with minimal power consumption in this
mode. High Performance Mode – 4000000 iterations, used for detecting objects with maximum range.
In all three modes, the default value for the object detection threshold is 6. This is the minimum confidence required to display an object in the distance bar chart and the 3D graphs.
“Iterations” Spin Box Select the number of iterations in a single target measurement here. If you increase the number of iterations for a single measurement the overall measurement frequency will decrease.
For 8 x 8 zones, the EVM GUI will display the frame rate depending on the number of iterations. The maximum framerate is 15 samples/second.
“Threshold” Spin Box Select the minimum confidence threshold for target detection here. If the calculated target detection confidence is below this level, the GUI will not display the corresponding object in the graphs.
“Run” Check Box Enable this check box to run target measurements continuously.
Sequence Controls The sequence spin box and the sequence button enable you to run a defined number of target measurements. With the default setting clicking the sequence button will trigger 10 measurements. After that, the EVM GUI will stop requesting new measurement results. This is especially useful for logging an exactly defined number of measurements.
Calibration Controls The EVM needs to be calibrated for precise measurements. The factory calibration indicator (the dot left of the “Calibrate” button) shows if the EVM was calibrated for the current operation mode (e.g. 3 x 3) and the selected SPAD map.
Without calibration data, the ToF possibly also detects the cross-talk peak caused by the cover glass on the EVM case as valid object.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 11

Document Feedback

TMF882X Using the EVM Software

To initiate a new factory calibration you have to click on the “Calibrate” button. It is recommended to set “High performance mode” before starting the calibration.
To clear the existing calibration data and to set the EVM back to the uncalibrated mode, you have to click on the “Clear Calibration” button.
Both calibration and clearing the calibration take approximately 1 – 2 seconds to complete. During this short time, the device is reset and all graphs will stop updating until the reset is complete.
Information When performing factory calibration no object should be within 400 mm of the ToF sensor’s field of view and use low ambient light (avoid high IR content).

“Enable De-Scattering” Check Box
Enable this checkbox to apply a de-scattering software filter to remove ghost targets from the measurements results.

“Short Range Mode” Check Box
Enable this checkbox to switch to short-range mode. In short-range mode, the maximum measurement distance reduces, and the measurement accuracy for close objects is improved. Please have a look at the TMF882X datasheet for details about the short-range mode.

3.1.5

“Data Logging” Box [4] Figure 9: Data Logging Box

To log measurement data to a file you need to:
Click on the button “Select File” to select an existing log file or enter the file name for a new file. The EVM GUI then displays the log file name in the text field below.
Enable the check box “Save Data To File”. From now on the EVM GUI logs all measurement results and configuration changes to the selected log file. Please note that logging is only done on enabled objects ­ for full logging please enable histogram display.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 12

Document Feedback

TMF882X Using the EVM Software

After all measurements are done you have to disable the check box “Save Data To File”. Access to the log file with e.g. MS Excel is now possible.
Please refer to the separate documentation for the EVM GUI log file format for more details.
Information Be careful when logging with multiple data options selected over a long period. With all histograms enabled and continuous logging, the resulting log file can be in the gigabyte range for size in 1 ­ 2 hours.

3.1.6

Connection Status Indicators [5] Figure 10: Connection Status Indicators

These are connection status indicators between the EVM GUI software and the TMF882X EVM software running in the enclosure.
“Control HID” is the connection status with the enclosure software: A red label indicates there is no working connection with the enclosure software. A green label means the connection is working.
“Module HID” is the connection status with the TMF882X demo software: A red label indicates that there is a problem communicating with the TMF882X demo software
or an internal software error. A green label means the TMF882X software connection is working.
A third indicator displays the type of the ToF sensor the EVM contains. Either “TMF8820”, “TMF8821”, or “TMF8828”.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 13

Document Feedback
3.2 EVM GUI “Main” Tab
3.2.1 Main Tab Graphs
Distance Bar Chart [6] Figure 11: Distance Bar Chart

TMF882X Using the EVM Software

This is a plot of the detected objects’ distance vs the confidence value (range 0 ­ 255) of the current detection (measurement). The X-axis indicates the distance in millimeters and the Y-axis indicates the confidence value. The GUI displays up to 128 bars here (8 x 8 mode, two objects per zone).
The legend of this chart has four entries:
Photon Count Object – this value increases with the reflectivity of the target object surface. Photon Count Reference – related to the optical reference channel, not influenced by the target
object. Background Light – related to the (IR only) ambient light, the TMF882X sensor sees. Temperature – the temperature of the TMF882X sensor (on-chip SPAD sensor array
temperature).

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 14

Histograms Plot [7] Figure 12: Histograms Plot

Document Feedback

TMF882X Using the EVM Software

This is a plot of the TDC histogram information based on the selections in the “Display” box and the “Histograms” box.
The X-axis indicates the “time buckets” in 400-picosecond increments, and the Y-axis indicates the number of photonic triggers/hits at the given time interval.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 15

Histogram Matrix
Figure 13: Histogram Matrix

Document Feedback

TMF882X Using the EVM Software

This is a plot of the TDC histograms for each of the zones (pixels) in the field of view.
Information The 8 x 8-histogram view is not enabled in the EVM GUI. It automatically hides this element in 8 x 8 mode.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 16

3.2.2 Main Tab Controls
“Histograms” Box [8] Figure 14: Histograms Box

Document Feedback

TMF882X Using the EVM Software

The controls in this box influence the display of the histograms in the histograms plot and the histogram matrix: Switch on the histogram legend with the check box “Show Legend”. Enable automatic scaling for the Y-axis with the check box “Y Axis Autoscale “. If this check box
is disabled the histogram plots use the value of the check box “Y Axis” as maximum value. As default the histogram graphs are linear in x direction and y direction. You can change the
scaling for the Y-axis to logarithmic. This allows to better observe very low values in the first few bins and in the (object and cross-talk) peak tails.
Information The 8 x 8-histogram view is not enabled in the EVM GUI. It automatically hides this element in 8 x 8 mode.
“Display” Box [9] Figure 15: Display Box

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 17

Document Feedback

TMF882X Using the EVM Software

Select which histograms you are interested in with the controls in this box: The “Reference” check box tells the GUI to display the optical reference histograms. The optical
path for this histogram is entirely within the sensor package. The target objects in the field of view of the sensor do not influence this histogram. The “Measurement” histograms show the reflected light from the objects in the field of view of the sensor.
The Histogram “Snapshot” button allows the user to “freeze frame” the current histogram plot while still plotting the measurement histograms concurrently. This gives you the ability to examine two histogram plots (one current, the other one a snapshot) at the same time in the histogram plotting area. Releasing the “Snapshot” button deletes the saved snapshot histograms.
Information
The 8 x 8-histogram view is not enabled in the EVM GUI. It automatically hides this element in 8 x 8 mode.

Information To get the fastest ranging time, disable all histogram display check boxes here.

“Information” Box [10] Figure 16: Information Box

This box contains information about the hardware and software in the EVM enclosure:
The serial number is the unique hardware ID of the TMF882X sensor. Below that you can find the revision of the embedded sensor firmware. The driver revision refers to the software on the controller board (a Raspberry Pi Zero W) in the
EVM enclosure. The TMF882X device chip revision. The revision of the Raspberry Pi Zero W binary file (see Section 3.6).

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 18

Document Feedback

TMF882X Using the EVM Software

You can find the version of the current EVM GUI in the “About” dialog in the main menu ­ “Help / About Dialog”. The EVM GUI also writes this information into the first lines of each generated log file. Please refer to the separate documentation for the EVM GUI log file format for more details.
“Measurement” Box [11] Figure 17: Measurement Box

The controls in this box allow you to select one zone in the field of view. For this zone, the GUI displays the current object data values.
“Zone” – select the zone you are interested in. “Dist. 1.” – distance to the first object in the selected zone (in mm). “Conf. 1.” – confidence for the object detection of the first object in the selected zone. “Dist. 2.” and “Conf. 2.” provide the current data for the second object in the selected zone (in
mm).
The sensor did not detect objects, if confidence 1 or 2 is equal zero.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 19

Document Feedback
3.3 EVM GUI “2D” Tab
Figure 18: 2D Tab

TMF882X Using the EVM Software

This graph shows the detected objects in all zones (pixels) in the field of view of the sensor. As you can see in the screenshot, the sensor detects up to two objects in each zone. The graph shows each object with distance and confidence. The distance of the object closer to the sensor also affects the background color of each zone. Zones with objects close to the sensor have “warm” colors like red and orange. Zones with objects far away from the sensor have “cold” colors like green and blue.
Adjust the distance range for the full color spectrum from red to blue with the controls “Gradient Minimum D.” and “Gradient Maximum D.”.
If you prefer a greyscale graph uncheck the box “Color Mode”. Zones with objects close to the sensor will then have a black background. Zones with far away objects will have a white background.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 20

Document Feedback

TMF882X Using the EVM Software

The gradient range does not filter objects by distance. Zones with objects below the selected minimum distance will have a red background (black in greyscale mode). Zones with objects beyond the selected maximum distance will have a blue background (white in greyscale mode). If you only want to see the closer object for each zone uncheck the box “2nd Object Data”.
3.4 EVM GUI “3D” Tab
Figure 19: 3D Tab

This graph shows the detected objects in all the zones (pixels) in the field of view of the sensor. As you can see in the screenshot, the sensor detects up to two objects in each zone. Each object is shown as a plate above the base plane. If the calculated detection confidence is high, the object plate is fully colored. If the confidence is low, the plate becomes transparent.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 21

Document Feedback

TMF882X Using the EVM Software

In the example screenshot, the sensor sees a close target at around 20 cm in all zones. In addition, it detects the ceiling above the test setup at around 250 cm. The ceiling does not reflect much light. The confidence values for detecting the ceiling are low because of that.
You can freely rotate and zoom this graph with your mouse:
Click and hold the right mouse button. Now move the mouse around and observe how the graph is rotated. Use the mouse scroll well to zoom in and out.
You can set the maximum distance for this graph with the spin box in the “3D” box.
The user can also choose to display the calculated object center in the field- of-view of the sensor with the check box “Show Object Center” and to show the detected objects in the individual zones with the check box “Show Zones”.
Select “Confidence Instead of Distance” to display the object detection confidence for each individual zone.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 22

Document Feedback
3.5 EVM GUI “Interrupt” Tab
Figure 20: Interrupt Tab

TMF882X Using the EVM Software

This tab looks very much like the “3D” tab. The only difference here are the controls that allow setting parameters for object detection.
Set the minimum and maximum distance for object detection with the corresponding spin boxes. Use the “Persistence” control to set the required minimum number of sequential object
detections: e.g. only display an object if it is detected six times in a row.
You can also define which of the zones in the field of view are relevant for object detection with the “Enable Interrupt per Pixel” check boxes.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 23

Document Feedback

TMF882X Using the EVM Software

Information The EVM GUI displays all objects in the field of view if one object in the field of view satisfies the defined requirements. If “Persistence” is set to zero, all other parameters are not relevant anymore. The EVM GUI will then display all objects in the field of view.
The GUI has a timeout implemented ­ if there is no object detection within one second, the GUI automatically clears the graph. Object logging will be stopped too.
3.6 EVM GUI “File Upload” Tab
Figure 21: File Upload Tab

This tab allows you to update the software running on the controller board in the EVM enclosure (Raspberry Pi Zero W). The binaries file (e.g. TMF882x_Driver_Linux_v3.52.zip) contains all the necessary files in a single ZIP archive.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 24

Document Feedback

TMF882X Using the EVM Software

How to update:
Click on “Select Binaries File” and select the binaries archive in the file dialog that opens now. Click on “Update Binaries” and wait until the binaries file upload process is complete. Disconnect and reconnect the EVM kit. Wait several minutes until the update process on the EVM finished updating the binaries on the
controller board. If the update was not successful after several minutes (all connection indicators have to be
green after a successful update), disconnect and reconnect again.
Click on the “Clear Log” button to clear the log file area if necessary.

3.7 Automation of Measurements

3.7.1

Overview
The EVM firmware allows control through a separate (e.g. customer) program. The communication link is achieved through TCP/IP using TCP port 39998 on the host where the EVM GUI is running. To start the automation mode, the automation host needs to open a TCP connection to
127.0.0.1 port 39998. To use 127.0.0.1 (localhost), the automation host must run on the same machine as the EVM GUI. Once connected the GUI shows the following status:
Figure 22: Status

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 25

Document Feedback

TMF882X Using the EVM Software

After the connection is established, the EVM sends version and calibration information to the automation host. This will look like this:

VER;4c-c0-00-00;2.49.4.2;2.4.23.0;2.6.2.19;8;0

CAL;1594814890830;0;2;00;0B;03;00;01;FF;26;02;79;56;34;12;53;49;47;F7;6B;A2;

07;00;6B;A2;07;00;6B;A2;07;00;6B;A2;07;00;6B;A2;07;00;6B;A2;07;00;6B;A2;07;00 ;6B;A2;07;00;6B;A2;07;00;6B;A2;07;00;77;09;02;00;02;00;00;00;02;00;00;00;02;0 0;00;00;02;00;00;00;02;00;00;00;02;00;00;00;02;00;00;00;02;00;00;00;02;00;00; 00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00 ;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;0 0;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00; 00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00 The EVM GUI also sends header information for easy import of the log output into Microsoft Excel. The header output is too long to include it here into this document. To trigger a single measurement, the automation host has to send the command string “(m0)” to the EVM GUI. The EVM GUI sends all histograms the user selects with the checkboxes in the GUI. The default is the “Measurement” histograms. The protocol for the measurement data is described in the document”TMF_8820_EVM_GUI_Logfile_Format.docx”.

3.7.2

Automation Interface Reference
These commands are simple strings the remote control programs sends to the GUI via the TCP/IP connection. The GUI sends the command response back to the remote control program over the same connection (socket).
Each command starts with an opening parenthesis “(“. The GUI executes the command after the remote control sends a closing parenthesis “)”.
The first character in the command (after the opening parenthesis) is the command code. All characters after that are the command parameter (until the closing parenthesis). Command codes are case-insensitive.
e.g.: (I1000) sets the “Iterations [k]” spin box in the GUI to the value 1000.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 26

Document Feedback

TMF882X Using the EVM Software

Set Iterations Sets the number of ToF measurement iterations (“Iterations [k]” spin box).
Figure 23: Command Overview

Command Code I

Parameter
Number of iterations, 0 <= iterations <= 65535

Example (I1000)

Set Object Detection Threshold Sets the object detection threshold (“Threshold” spin box).
Figure 24: Command Overview

Command Code T

Parameter
Object detection threshold, 0 <= threshold <= 255

Example (T128)

Run Measurement
Run one GUI measurement and send the results to the remote control program via the TCP/IP connection.
Figure 25: Command Overview

Command Code M

Parameter Ignored

Example (M0)

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 27

Document Feedback

TMF882X Using the EVM Software

Calibration Handling Control the EVM GUI Calibration Handling.
Figure 26: Command Overview

Command Code C

Parameter
0 – Initiate new calibration, 1 – Clear calibration, 2 – Get calibration data. The EVM GUI ignores all other parameter values

Example (C2)

Set Operation Mode Set the operation mode (the number of pixel rows).
Figure 27: Command Overview

Command Code P

Parameter
0 ­ 3 x 3 1 ­ 4 x 4 2 ­ 3 x 6 3 ­ 8 x 8 The EVM GUI ignores all other parameter values.

Example (P0)

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 28

Document Feedback

TMF882X Using the EVM Software

Set SPAD Map Set the SPAD map for the current operation mode.
Figure 28: Command Overview

Command Code S

Parameter
0 ­ 1st SPAD map, 1 ­ 2nd SPAD map, … The number of SPAD maps varies for each operation mode. Setting an out-of-range SPAD map index does not change anything in the GUI.

Example (S1)

Control Histogram Display / Logging Controls the check boxes for histogram display and histogram data logging.
Figure 29: Command Overview

Command Code H

Parameter
0 ­ Switch off all histograms, 1 ­ Switch on reference histograms, 2 ­ Switch on measurement histograms, 3 ­ Switch on reference and measurement histograms. The EVM GUI ignores all other parameter values.

Example (H2)

Switch ON / OFF Short Range Mode Controls the check box for short range mode.
Figure 30: Command Overview

Command Code R

Parameter
0 ­ Switch off short range mode, 1 ­ Switch on short range mode, The EVM GUI ignores all other parameter values.

Example (R1)

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 29

Document Feedback

TMF882X Using the EVM Software

3.7.3

Automation Example Session
To operate the following example, the EVM GUI needs to be started first. Start the Windows shell “cmd” and connect through the Windows program “telnet”:
telnet 127.0.0.1 39998
This causes an immediate response and in the GUI the status `Automation On’ is displayed (removed headers in the output data):
sep=; #VER;ToF Serial Number;App0 Version Number;GUI Version Number;Host Driver Version Number;Chip ID;Chip Revision

VER;4c-c0-00-00;2.49.4.2;2.4.23.0;2.6.2.19;8;0

CAL;1594816397308;0;2;00;0B;03;00;01;FF;26;02;79;56;34;12;53;49;47;F7;6B;A2;07;00

;6B;A2;07;00;6B;A2;07;00;6B;A2;07;00;6B;A2;07;00;6B;A2;07;00;6B;A2;07;00;6B;A2;07; 00;6B;A2;07;00;6B;A2;07;00;77;09;02;00;02;00;00;00;02;00;00;00;02;00;00;00;02;00;0 0;00;02;00;00;00;02;00;00;00;02;00;00;00;02;00;00;00;02;00;00;00;00;00;00;00;00;00 ;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00; 00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;0 0;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00;00 ;00;00;00;00
Send the command (m0) – it executes one measurement and transfers the enabled histograms (removed all but one histogram).
(m0)

TMP;1594816405200;207;33

OBJ;1594816405203;207;3;3;1970;19;0;0;1938;42;0;0;1961;16;0;0;1947;49;0;0;1931;11

8;0;0;1944;47;0;0;1946;20;0;0;1929;38;0;0;1948;20;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0; 0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0

LIGHT;1594816405205;207;25079;199532;14146

HLONG01;1500;1542;1452;1498;1425;1527;1513;1440;1533;1443;1502;1415;1423;1457;150

5;1429;1404;1432;1452;1440;1460;1439;1460;1405;1499;1358;1368;1379;1420;1392;1429; 1374;1420;1388;1413;1327;1341;1382;1346;1314;1369;1368;1397;1361;1292;1294;1261;12 99;1479;1778;1747;1572;1341;1317;1362;1270;1356;1235;1266;1324;1273;1314;1179;1283 ;1244;1231;1260;1294;1305;1275;1255;1253;1254;1243;1242;1281;1212;1231;1223;1230;1 205;1162;1179;1163;1246;1161;1164;1199;1205;1127;1232;1178;1120;1128;1176;1193;113 2;1122;1147;1180;1166;1171;1153;1108;1113;1129;1106;1113;1102;1082;1152;1113;1075; 1112;1098;1043;1021;1100;1130;1113;1145;1038;1148;1087;992;1064;1055;1028

HOCAL0;28;22;39;36;28;31;33;22;28;19;36;23;23;28;13087;134440;51569;16061;8389;44

44;2898;1977;1544;1224;1006;876;727;618;509;403;341;292;222;192;153;125;85;77;49;5 2;47;30;34;32;33;22;25;22;22;18;22;14;17;11;14;23;17;12;23;15;22;10;19;11;13;16;19 ;15;22;13;19;15;13;15;20;16;19;14;11;9;19;18;16;9;14;17;26;16;18;15;23;13;11;12;23 ;19;14;23;21;20;17;16;15;17;10;22;9;11;19;17;22;16;7;16;17;11;17;8;14;14;12;17;21; 15;20;14;12;17 #ITT;1594816405325;550;6;1;2.5 m;3 x 3

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 30

Document Feedback

TMF882X Using the EVM Software

Disable measurement histograms and trigger another measurement – send the command (m0) again:
(m0)

TMP;1594816859466;251;38

OBJ;1594816859470;251;3;3;1951;20;0;0;1939;42;0;0;1957;17;0;0;1942;47;0;0;1925;11

6;0;0;1943;41;0;0;1937;19;0;0;1929;36;0;0;1951;17;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0; 0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0;0

LIGHT;1594816859471;251;23091;184970;15377

HOCAL0;33;27;33;26;15;28;30;31;32;26;21;32;26;32;13765;134106;50918;16168;8370;45

28;2876;2077;1535;1247;1031;844;704;575;484;437;327;286;244;171;159;151;89;82;67;4 3;32;48;26;20;17;37;22;21;18;12;20;16;18;19;17;19;10;20;19;13;7;14;15;15;10;19;8;1 8;15;29;9;13;18;15;17;16;14;19;18;18;19;18;11;14;12;18;25;20;11;11;16;17;11;19;14; 17;13;14;22;13;26;17;20;15;19;16;14;7;15;10;19;16;12;13;18;16;16;16;13;19;18;19;15 ;16;16;9;12;16 #ITT;1594816859492;550;6;1;2.5 m;3 x 3
Windows telnet can be stopped by using Ctrl-] and then entering the command quit.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 31

Document Feedback

TMF882X Drivers

4 Drivers
ams OSRAM recommends to use one of the available software drivers to operate the TMF882X. The following drivers are available: Linux driver ­ use this for any Linux system (e.g. Android) where the driver is running on the
application processor. MCU driver (sometimes referenced as bare metal driver) ­ the hardware functions for executing
the I2C routines can be easily replaced to simply port this driver to systems without operating systems or systems not running Linux.
Information
Please find the documentation for the “User Application Programming Interface” for the TMF882X Linux kernel driver in the driver sources archive (e.g. in TMF882x_Driver_Linux_Source_v3.51.zip). The documentation is in a file in MarkDown format (TMF882X_Driver_UAPI_Guide.md).

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 32

Document Feedback

TMF882X Schematics, Layers and BOM

5 Schematics, Layers and BOM

5.1 Daughter Card
Figure 31: Daughter Card Picture

Figure 32: Daughter Card Schematic

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 33

Document Feedback
Figure 33: Daughter Card Layout ­ Layers 1-4

TMF882X Schematics, Layers and BOM

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 34

5.1.1

BOM
Figure 34: Daughter Card BOM

Document Feedback

TMF882X Schematics, Layers and BOM

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 35

Document Feedback
6 Revision Information

TMF882X Revision Information

Changes from previous version to current revision v9-00 Updated installation guide for Windows drivers

Page 6

Page and figure numbers for the previous version may differ from page and figure numbers in the current revision.

Correction of typographical errors is not explicitly mentioned.

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 36

Document Feedback

TMF882X Legal Information

7 Legal Information

Copyrights & Disclaimer
Copyright ams-OSRAM AG, Tobelbader Strasse 30, 8141 Premstaetten, Austria- Europe. Trademarks Registered. All rights reserved. The material herein may not be reproduced, adapted, merged, translated, stored, or used without the prior written consent of the copyright owner.
Demo Kits, Evaluation Kits and Reference Designs are provided to recipient on an “as is” basis for demonstration and evaluation purposes only and are not considered to be finished end-products intended and fit for general consumer use, commercial applications and applications with special requirements such as but not limited to medical equipment or automotive applications. Demo Kits, Evaluation Kits and Reference Designs have not been tested for compliance with electromagnetic compatibility (EMC) standards and directives, unless otherwise specified. Demo Kits, Evaluation Kits and Reference Designs shall be used by qualified personnel only.
ams-OSRAM AG reserves the right to change functionality and price of Demo Kits, Evaluation Kits and Reference Designs at any time and without notice.
Any express or implied warranties, including, but not limited to the implied warranties of merchantability and fitness for a particular purpose are disclaimed. Any claims and demands and any direct, indirect, incidental, special, exemplary or consequential damages arising from the inadequacy of the provided Demo Kits, Evaluation Kits and Reference Designs or incurred losses of any kind (e.g. loss of use, data or profits or business interruption however caused) as a consequence of their use are excluded.
ams-OSRAM AG shall not be liable to recipient or any third party for any damages, including but not limited to personal injury, property damage, loss of profits, loss of use, interruption of business or indirect, special, incidental or consequential damages, of any kind, in connection with or arising out of the furnishing, performance or use of the technical data herein. No obligation or liability to recipient or any third party shall arise or flow out of ams-OSRAM AG rendering of technical or other services.
RoHS Compliant & ams Green Statement
RoHS Compliant: The term RoHS compliant means that ams-OSRAM AG products fully comply with current RoHS directives. Our semiconductor products do not contain any chemicals for all 6 substance categories plus additional 4 substance categories (per amendment EU 2015/863), including the requirement that lead not exceed 0.1% by weight in homogeneous materials. Where designed to be soldered at high temperatures, RoHS compliant products are suitable for use in specified lead-free processes.
ams Green (RoHS compliant and no Sb/Br/Cl): ams Green defines that in addition to RoHS compliance, our products are free of Bromine (Br) and Antimony (Sb) based flame retardants (Br or Sb do not exceed 0.1% by weight in homogeneous material) and do not contain Chlorine (Cl not exceed 0.1% by weight in homogeneous material).
Important Information: The information provided in this statement represents ams-OSRAM AG knowledge and belief as of the date that it is provided. ams- OSRAM AG bases its knowledge and belief on information provided by third parties, and makes no representation or warranty as to the accuracy of such information. Efforts are underway to better integrate information from third parties. ams-OSRAM AG has taken and continues to take reasonable steps to provide representative and accurate information but may not have conducted destructive testing or chemical analysis on incoming materials and chemicals. ams-OSRAM AG and ams-OSRAM AG suppliers consider certain information to be proprietary, and thus CAS numbers and other limited information may not be available for release.

Headquarters ams-OSRAM AG Tobelbader Strasse 30 8141 Premstaetten Austria, Europe Tel: +43 (0) 3136 500 0

Please visit our website at www.ams.com Buy our products or get free samples online at www.ams.com/Products Technical Support is available at www.ams.com /Technical-Support Provide feedback about this document at www.ams.com /Document-Feedback For sales offices, distributors and representatives go to www.ams.com/Contact For further information and requests, e-mail us at ams_sales@ams.com

Demo Kit Manual · PUBLIC UG000495 · v9-00 · 2023-Apr-05

37 37

References

• Sensor Solutions | ams
• TMF8828 - 5 meter, 8x8 multi-zone time of flight module | ams

Read User Manual Online (PDF format)

Read User Manual Online (PDF format)  >>

Download This Manual (PDF format)

Download this manual  >>