Home

1. Welcome!

Welcome to the sick_tdc-e-developers-documentation wiki!

Find out more about the TDC-E device by reviewing its structure, contents, and, more importantly, what it can do and how it can be done. This documentation aims to show the TDC-E device in a transparent light, providing simple examples and explanations for applications that are developed for the device and simultaneously describing the TDC-E and related interface structure and configuration.

2. Get Started With Exploring

To get started, select the area of interest below, and happy exploring!

• TDC-E Configuration
  • Network Configuration
  • Interface Container Configuration
• Getting Started
  • Environment Setup
    • Setting up Node-RED Application Environment
    • Setting up Python Application Environment
    • Setting up C# Application Environment
    • Setting up Go Application Environment
    • Setting up MySql Environment
  • Image Building and Composing
• Development Documentation
  • Snippets Using the Hardware Interface
  • Snippets Without the Hardware Interface
  • Project Examples Documentation
• Interface Snippets
• Examples
• Tutorials

3. Quick Description of Contents

3.1. TDC-E Configuration

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.

3.2. Getting Started

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.

3.3. Development Documentation

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.

3.4. Interface Snippets

The examples, 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.

3.5. Examples

This section covers more complex examples that use various interfaces and services to fulfill their functionalities. They are larger project examples that showcase more detailed examples of the TDC-E usage.

3.6. Tutorials

Tutorial examples are codes and environments written specifically for users to be able to download and set up their environment with no further actions needed.