Added documentation section for ftp custom converter functionality #2467
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
samson0v
suggested changes
Jan 5, 2026
docs/iot-gateway/config/ftp.md
Outdated
|
|
||
| #### Subsection "converter" | ||
|
|
||
| This configuration section is **optional** and is used only when you want to process incoming data with a custom FTP converter instead of the built-in **FTPUplinkConverter**. |
docs/iot-gateway/config/ftp.md
Outdated
|
|
||
| Typical use cases: | ||
|
|
||
| - Files with **extensions not supported** by default (.txt, .csv, .json), or Supported extensions, but with a different data structure, for example: |
Contributor
There was a problem hiding this comment.
Remove (.txt, .csv, .json)
because it confuses whether we support them or not
Contributor
There was a problem hiding this comment.
Supported extensions - supported extensions
docs/iot-gateway/config/ftp.md
Outdated
Comment on lines
333
to
348
| **extension-config** fields used in this example | ||
|
|
||
| | **Parameter** | **Example value** | **Description** | | ||
| |--------------------|-------------------| ------------------------------------------------------------------------------------------------------ | | ||
| | devicePatternName | **0** | Column index used to resolve the device name (here: value from column `0`). | | ||
| | devicePatternType | **1** | Column index or literal used to resolve the device type (here: value from column `1`). | | ||
| | attributes | **array** | List of attribute mappings. Each item describes how to read an attribute value from a specific column. | | ||
| | timeseries | **array** | List of timeseries mappings. Each item describes how to read a telemetry value from a specific column. | | ||
|
|
||
| Each item in attributes / timeseries has the following fields: | ||
|
|
||
| | **Field** | **Example value** | **Description** | | ||
| |-----------|-------------------------------------| --------------------------------------------------------------------------- | | ||
| | key | **meterAddress** | Attribute / telemetry key that will appear in ThingsBoard. | | ||
| | column | **0** | Zero-based column index in the CSV line from which the value will be taken. | | ||
| | type | **string** / **int** / **double** | Value type. The custom converter will cast the raw string to this type. | |
Contributor
There was a problem hiding this comment.
Use config example instead of tables
Andry925
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR description
The documentation updated for Thingsboard IOT gateway FTP connector.
Link checker
The links will be checked by the build agent automatically once you create or update your PR.
You can use the following command to check the broken links locally.