View the Complete TDC-E BaseOS Developer Documentation
The new TDC-E device with BaseOS documentation is available on GitHub Pages and includes:
- Getting Started - Installation, gRPC setup, Docker workflows
- Code Samples - Examples for CAN, DIO, GNSS, Serial, Networking, and more
- AppEngine Documentation - Lua crowns and capabilities
- Interface Snippets - Ready-to-use code for hardware interfaces
This is the SICK TDC-E L4M Developer's Documentation, aimed at customers and developers using the legacy L4M firmware. The wiki contains the following file structure:
- TDC-E Configuration
- Getting Started
- Development Documentation
- Interface Snippets
- Examples
- Tutorials
- Useful Links
- Docs
This repository contains:
- docs/tdc-e-base/ - BaseOS documentation source (published to GitHub Pages)
- interface-snippets/ - Code examples by interface type
- examples/ - Complete project examples
- tutorials/ - Step-by-step tutorials
- Wiki - Legacy L4M firmware documentation
- BaseOS Documentation: https://sickag.github.io/sick_tdc-e-developers-documentation/
- L4M Wiki: https://github.com/SICKAG/sick_tdc-e-developers-documentation/wiki
- Code Examples: examples/ | interface-snippets/
The TDC-E Configuration section describes how to configure parts of the TDC-E so as to be able to utilize it to its full extent. The configuration is split into two parts: network and interface configuration. Each one describes how to connect your TDC-E with the desired service.
Getting Started is a section which mostly focuses on deploying applications and environment creation for the TDC-E device. It also focuses on installing and setting services via Dockerfile and docker_compose.yml.
The Development Documentation is the part of the documentation that describes code examples split into two main categories: one that focuses on applications that are implemented to use TDC-E's hardware interface, while the other part focuses on describing applications that do not use it to access needed data. To that end, this section focuses on the hows and whys of the programming experience. This section also contains documentation of more complex examples that combine multiple service to fulfill functionalities.
The interface snippets, divided into sections pertaining the interface the service the application uses, are meant to be a help for starting application development with said service. Most examples are made with either Python or Go, with an additional Node-RED application as an alternative.
The examples contain more complex project examples that showcase various interfaces, technologies and services to fulfill their functionalities.
Tutorial examples are codes and environments written specifially for users to be able to download and set up their environment with no further actions needed.
Useful links contain relevant related articles regarding the TDC-E usage and configuration.
Useful documents for additional TDC-E support.
- Newer versions of L4M might require minor changes in application logic. Applications refactored for recent releases of the TDC-E device firmware are named in
appname_version_X_Xformat, where X is the version of the firmware.