Communication via Profinet IO interface
Profinet Device Integration
-20250226-122529.png?inst-v=3465c3c6-4b72-4ca8-82f8-335d867be8c1) | The GSD-file is available for download in the Download Center of the OndoSense support website. |
A device master file (GSD-file) is required for the configuration of a Profinet IO device. It describes the configurable functions of the device and must be integrated into the development environment (e.g. Tia Portal). The GSD-file is found on the Download Center of the OndoSense support website.
Module Overview
The functions (modules) described in the GSD-file allow reading and configuration of the sensor. They are defined by the following variables:
Module: Name of the concerned module/description of its function
Size: Size of the data to be transferred in Bytes
Module type:
Input module: Cyclical data is transferred from the device to the control.
Mixed module: Cyclical data is transferred between the controller and the device, while parameters can be written non-cyclical.
Parameter module: Configuration data is exchanged non-cyclical.
Submodule: Name of the concerned submodule/description of its function
Data type: Data type of data in a submodule
Category Measurements
Modul | Size [Byte] | Module type | Submodule | Data type |
|---|---|---|---|---|
Distance [µm] | 5 | Input module | Distance Status | Integer8 |
Distance [µm] | Unsigned32 | |||
Measurement counter | 5 | Input module | Measurement Counter Status | Integer8 |
Measurement Counter Value | Unsigned32 | |||
Peak | 11 | Input module | Peak Status | Integer8 |
Peak Frequency | Unsigned32 | |||
Peak Phase | Unsigned16 | |||
Peak Amplitude | Unsigned32 | |||
Temperature | 5 | Input module | Temperature Status | Integer8 |
Temperature Value | Intege32 | |||
High Precision Distance (only for apex P500) | 7 | Mixed module | High Precision Distance Status | Intege8 |
High Precision Distance Target Lost Counter | Unsigned8 | |||
High Precision Distance Value | Intege32 | |||
High Precision Distance Configuration | Unsigned8 |
Category Device Configuration
Modul | Size [Byte] | Module type | Submodule | Data type |
|---|---|---|---|---|
Device Configuration | Parameter module | Radar Configuration | - | |
Configuration Source | - |
Submodule overview
Module Distance [µm]
Input value | Value range | Data type | Comment |
|---|---|---|---|
Distance Status | -9 … 3 | Integer8 | Quality of measuring signal: |
Distance [µm] | Unsigned32 | Measured distance in µm |
Module Measurement Counter
Input value | Value range | Data type | Comment |
|---|---|---|---|
Measurement Counter Status | -9 … 3 | Integer8 | Quality of measuring signal: |
Measurement Counter Value | Unsigned32 | Value of the sensor's internal measurement counter |
Module Peak
Input value | Value range | Data type | Comment |
|---|---|---|---|
Peak Status | -9 … 3 | Integer8 | Quality of peak signal: |
Peak Frequency | Unsigned32 | Frequency value of the detected peak | |
Peak Phase | Unsigned16 | Phase value of the detected peak | |
Peak Amplitude | Unsigned32 | Signal strength of the detected peak signal |
Module Temperature
Input value | Value range | Data type | Comment |
|---|---|---|---|
Temperature Status | -9 … 3 | Integer8 | Quality of temperature signal: |
Temperature Value | Integer32 | Internal temperature of the sensor in °C |
Module High Precision Distance
Input value | Value range | Data type | Comment |
|---|---|---|---|
High Precision Distance Status | -9 … 3 | Intege8 | Quality of High Precision Distance signal: |
High Precision Distance Target Lost Counter | Unsigned8 | Counts how often the target could not be detected | |
High Precision Distance Value | Intege32 | Measured displacement of the target relative to the reference in µm | |
High Precision Distance Configuration | Unsigned8 | Contains the parameter “Restart HP Mode” |
Submodule High Precision Distance Configuration
This submodule contains the parameter to set a new reference for the high precision displacement.
Non-cyclical
Parameter Name | Value range | Default value | Data type | Comment |
|---|---|---|---|---|
Reset HP Mode | 1 | 0 | Unsigned8 | Sets a new reference for the high precision displacement 1 = Restart |
Submodule Radar Configuration
This submodule contains parameters for the configuration of the sensor.
Parameter Name | Value range | Default value | Data type | Comment |
|---|---|---|---|---|
Minimum Distance [mm] | 100 … 40000 | 100 | Unsigned32 | Measuring Range start |
Maximum Distance [mm] | 300 … 40000 | 40000 | Unsigned32 | Measuring Range end |
Radar Profile | 3/7/26 | 26 | Unsigned8 | 3 = High accuracy - mid range up to 20 m 7 = Std. accuracy - long range 26 = Max. accuracy - close range up to 6 m |
Submodule Configuration Source
This submodule contains parameters to set the configuration source of the sensor.
Parameter Name | Value range | Default value | Data type | Comment |
|---|---|---|---|---|
Configuration Source | 0/1/2 | 1 = Web GUI | Unsigned8 | 0 = PLC 1 = Web GUI 2 = ConfigBox (RS485) |
API Status Codes
Status Code | Value | Description |
|---|---|---|
API_SUCCESS | 1 | Command was successfully executed. |
API_SUCCESS_WEAK_SIGNAL | 2 | The measurement was successful, but the reflected signal amplitude is too low for consistent target detection (check amplification parameters or targe |
API_SUCCESS_OUTLIER | 3 | The measurement was successful, but the measured distance is an outlier/unexpected. |
API_ERROR | -1 | An error has occurred. |
API_ERROR_COMMAND | -2 | Unknown command. |
API_ERROR_PARAMETER | -3 | Unknown parameter. |
API_ERROR_RANGE | -4 | The value set for this parameter is not within the allowed range of values. |
API_ERROR_FORBIDDEN | -5 | This parameter is protected and cannot be changed. |
API_ERROR_NO_TARGET | -6 | The sensor has not detected a target. |
API_ERROR_TARGET_LOST | -7 | Only applicable to high precision mode: The sensor lost the target. |
API_ERROR_CALCULATION | -8 | An error occurred in the distance calculation module. |
API_ERROR_OTHER_CONFIG_SOURCE_SELECTED | -9 | Another config source is selected and therefore you cannot write parameters. |