ams OSRAM TMF8X0X 1D Time of Flight Sensor User Guide
- June 9, 2024
- ams OSRAM
Table of Contents
- Log File Format
- Tags
- OBJ Field Numbers and Description
- PTX Field Numbers and Description
- SUM Field Numbers and Description
- CIX Field Numbers and Description
- CO0 Field Numbers and Description
- CAL Field Numbers and Description
- VER Field Numbers and Description
- TMP Field Numbers and Description
- ITT Field Numbers and Description
- Revision Information
- Legal Information
- References
- Read User Manual Online (PDF format)
- Download This Manual (PDF format)
OSRAM TMF8X0X 1D Time of Flight Sensor
User Guide
Log File Format
This document describes the log file format of the TMF8X0X EVM GUI. The user shall be able to log all data, which the TMF8X0X EVM GUI displays, into a single log file.
1.1 Overview
The TMF8X0X EVM GUI uses CSV as output format for the log file.
The first two lines are always (to allow usage independent of the Excel
regional settings): sep=; VersionGUI “
After that, the TMF8X0X EVM GUI adds a header line for each tag with the
description of fields. This is the same format as in the data lines but
instead of actual data there is a field description.
All but the very first two lines always start with a hash mark “#” and the
content as described in the next sections.
Tags
2.1 #OBJ Object Detection Result
Figure 1:
OBJ Field Numbers and Description
Field # | Description |
---|---|
1 | #OBJ – line tag |
2 | Timestamp in milliseconds since 1st January 1970. |
3 | Number of detected objects – for TMF8701 always ‘1’, for TMF880x see |
datasheet.
| The following fields are only filled if the number of detected objects is >
0.
4| Confidence level of object: (0-63, 63 best, 0-no object detected), where 10
and 20 is used also by the proximity algorithm.
5| Distance of detected object (center) in [mm].
6| Reference photon count.
7| Object photon count.
2.2 #PT0 … #PT4 Short Distance Histogram Data Figure 2:
PTX Field Numbers and Description
Field # | Description |
---|---|
1 | #PT0 … #PT4 – line tag |
2 – 257 | Target data histogram with 256 entries, each entry 5 characters wide |
with decimal encoding, valid values are 00000 to 65535.
2.3 #TG0 … #TG4 Distance Measurement Histogram Data
Field # | Description |
---|---|
1 | #TG0 … #TG4 – line tag |
2.4 #SUM Target Measurement Histogram Data Sum
Figure 4:
SUM Field Numbers and Description
Field # | Description |
---|---|
1 | #SUM – line tag |
2 – 257 | Sum of selected channels from TG1 … TG4 data histogram with 256 |
entries, each entry 5 characters wide with decimal encoding, valid values are 00000 to 65535.
2.5 #CI0 … #CI4 Internal Electrical Calibration Histogram Data
Figure 5:
CIX Field Numbers and Description
Field # | Description |
---|---|
1 | #CI0 … #CI4 – line tag |
2 – 257 | Calibration histogram data with 256 entries, each entry 5 characters |
wide with decimal encoding, valid values are 00000 to 65535.
2.6 #CO0 Optical Calibration Histogram Data
Figure 6:
CO0 Field Numbers and Description
Field # | Description |
---|---|
1 | #CO0 – line tag |
2 – 257 | Calibration histogram data with 256 entries, each entry 5 characters |
wide with decimal encoding, valid values are 00000 to 65535.
2.7 #CAL Calibration Data
The result of a calibration operation. Basically an unstructured blob of data.
Figure 7:
CAL Field Numbers and Description
Field # | Description |
---|---|
1 | #CAL – line tag |
2 | Calibration operation: 00 … new calibration, 01 … clear calibration, 02 … |
get current calibration.
3 …| Calibration data blob, 2 character hex values.
2.8 #VER Version
Figure 8:
VER Field Numbers and Description
Field # | Description |
---|---|
1 | #VER – line tag |
2 | Serial number of the ToF sensor. |
3 | Version of the application firmware running on the ToF sensor. |
4 | GUI version. |
5 | Host driver version. |
2.9 #TMP ToF Sensor Temperature
Figure 9:
TMP Field Numbers and Description
Field # | Description |
---|---|
1 | #TMP – line tag |
2 | Temperature of the ToF sensor in degrees Celsius |
2.10 #ITT Iterations and Object Detection Threshold
Figure 10:
ITT Field Numbers and Description
Field # | Description |
---|---|
1 | #ITT – line tag |
2 | Iterations |
3 | Object detection threshold |
Revision Information
Changes from previous version to current revision v1-00
Initial version
- 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.
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 eference 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
References
Read User Manual Online (PDF format)
Read User Manual Online (PDF format) >>