Difference between revisions of "RadiMationInterface.can"

From RadiWiki
Jump to: navigation, search
(→‎Test_Modulation_Off)
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
The RadiMationInterface.can is an interface between the RadiMation software and CANoe and CANalyser.
+
The [[RadiMationInterface.can]] file is a [[CANoe]] CAPL file that provides specifically named CAPL functions that are called from the {{RadiMation}} software. Those CAPL functions are used to generate an interface to provide measurement values from the {{RadiMation}} software to the CANoe software.
  
−
By inserting this file inside your CANoe/CANalyser project you are able to extract information from RadiMation using CANoe/CANalyser.
+
You can download the zip file that contains the [[media:RadiMationInterface.zip‎|RadiMationInterface.can file here]].
  
−
You can download the file [[media:RadiMationInterface.zip‎|here]]
+
By including the [[RadiMationInterface.can]] file inside your CANoe or CANalyzer project, it will be possible to get updates of the {{RadiMation}} measurement values. The [[CANoe Switch Matrix]] device driver is calling the specifically named CAPL functions that are defined in the [[RadiMationInterface.can]] file.
  
−
= Explanation of available events/functions =
+
The functions that are called in the CAPL interface are event triggered. This means that the updated measurement values are transmitted to the CAPL interface at the moment that the updated measurement value becomes available.
 +
 
 +
For example, when the Forward power has been measured in the immunity test, then the forward power measurement result is directly transmitted to the corresponding CAPL function. The same happens for the other defined functions, like the updated frequency directly after a frequency change.
 +
 
 +
This also means that when a specific measurement value is not available, that the corresponding CAPL function is also not called. When a {{RadiMation}} immunity test, for example is configured to only perform a signal generator carrier level test, then the forward power is not available, and the corresponding CAPL function will not be called at all. Which events are triggered, and how often they are triggered is thus completely depending on the configuration of the [[TSF]] in {{RadiMation}}.
 +
 
 +
When filtering of the called CAPL function is needed, for example in the situation that the updated value of signal generator level value is not needed, then that should be done in implementation of the corresponding function in the [[RadiMationInterface.can]] file in the [[CANoe]] software. Those functions can for example be programmed to perform a 'No Operation' call.
 +
 
 +
{{Note|The [[CANoe Switch Matrix]] device driver is not able to determine if a specifically named CAPL function is existing in the running CANoe environment.
 +
When one or more of the specifically named CAPL functions from the [[RadiMationInterface.can]] file, is not implemented, the function call is being forwarded to the CANoe software itself, and there will be no error message or return value. The [[CANoe Switch Matrix]] is thus not able to warn or raise an error when one or more of the specifically called CAPL functions is not implemented.}}
 +
 
 +
For more details on how to use and attach this file in your CANoe project, please see then [[CANoe]] page.
 +
 
 +
= Explanation of the available specifically named CAPL functions =
 
==Test_Frequency==
 
==Test_Frequency==
 
The current frequency of the test, in other words the frequency of the signal generator.
 
The current frequency of the test, in other words the frequency of the signal generator.
Line 30: Line 43:
  
 
'''Unit parameter:''' dBm
 
'''Unit parameter:''' dBm
 +
 +
==Test_Net_Power==
 +
The measured value of the netto power.
 +
 +
'''Parameter:''' mdPowerIndBm
 +
 +
'''Unit parameter:''' dBm
 +
 
==Test_Average_Field==
 
==Test_Average_Field==
 
The measured value of the average field.
 
The measured value of the average field.
Line 36: Line 57:
  
 
'''Unit parameter:''' V/m
 
'''Unit parameter:''' V/m
 +
 
==Test_Calculated_Field==
 
==Test_Calculated_Field==
 
The calculated value of the field based on the calibration file.
 
The calculated value of the field based on the calibration file.
Line 43: Line 65:
 
'''Unit parameter:''' V/m
 
'''Unit parameter:''' V/m
 
==Test_Measured_Current==
 
==Test_Measured_Current==
 +
The measured value of the current.
 +
 +
'''Parameter:''' mdCurrentInmA
 +
 +
'''Unit parameter:''' mA
 +
 +
 +
==Test_Calculated_Current==
 +
The calculated value of the current.
 +
 +
'''Parameter:''' mdCurrentInmA
 +
 +
'''Unit parameter:''' mA
 +
 
==Test_Sensor_Power==
 
==Test_Sensor_Power==
 +
The measured power of by the current sensor power meter.
 +
 +
'''Parameter:''' mdPowerIndBm
 +
 +
'''Unit parameter:''' dBm
 +
 
==Test_Amplitude_Modulation_Internal==
 
==Test_Amplitude_Modulation_Internal==
 +
The modulation in the signal generator is configured as internal amplitude modulation.
 +
 +
'''Parameter1:''' mdFreqency
 +
 +
'''Unit parameter1:''' Hz
 +
 +
'''Parameter2:''' mdDepth
 +
 +
'''Unit parameter2:''' %
 +
 +
{{note|The modulation may not be active at this moment, [[#Test_Modulation_On|Test_Modulation_On]] is the event called when the modulation is turned on.}}
 +
 
==Test_Amplitude_Modulation_External==
 
==Test_Amplitude_Modulation_External==
 +
The modulation in the signal generator is configured as external amplitude modulation.
 +
{{note|The modulation may not be active at this moment, [[#Test_Modulation_On|Test_Modulation_On]] is the event called when the modulation is turned on.}}
 +
 
==Test_Frequency_Modulation_Internal==
 
==Test_Frequency_Modulation_Internal==
 +
The modulation in the signal generator is configured as internal frequency modulation.
 +
 +
'''Parameter1:''' mdFreqency
 +
 +
'''Unit parameter1:''' kHz
 +
 +
'''Parameter2:''' dmShift
 +
 +
'''Unit parameter2:''' kHz
 +
 +
{{note|The modulation may not be active at this moment, [[#Test_Modulation_On|Test_Modulation_On]] is the event called when the modulation is turned on.}}
 +
 
==Test_Frequency_Modulation_External==
 
==Test_Frequency_Modulation_External==
 +
The modulation in the signal generator is configured as external frequency modulation.
 +
{{note|The modulation may not be active at this moment, [[#Test_Modulation_On|Test_Modulation_On]] is the event called when the modulation is turned on.}}
 +
 
==Test_Pulse_Modulation_Internal==
 
==Test_Pulse_Modulation_Internal==
 +
The modulation in the signal generator is configured as internal pulse modulation.
 +
 +
'''Parameter1:''' mdFreqency
 +
 +
'''Unit parameter1:''' kHz
 +
 +
'''Parameter2:''' mdWidth
 +
 +
'''Unit parameter2:''' %
 +
 +
{{note|The modulation may not be active at this moment, [[#Test_Modulation_On|Test_Modulation_On]] is the event called when the modulation is turned on.}}
 +
 
==Test_Pulse_Modulation_External==
 
==Test_Pulse_Modulation_External==
−
The modulation in the signal generator is configured as external pulse
+
The modulation in the signal generator is configured as external pulse modulation.
 
{{note|The modulation may not be active at this moment, [[#Test_Modulation_On|Test_Modulation_On]] is the event called when the modulation is turned on.}}
 
{{note|The modulation may not be active at this moment, [[#Test_Modulation_On|Test_Modulation_On]] is the event called when the modulation is turned on.}}
  
 
==Test_Modulation_On==
 
==Test_Modulation_On==
 
The currently configured modulation is turned on.
 
The currently configured modulation is turned on.
 +
 
==Test_Modulation_Off==
 
==Test_Modulation_Off==
 
The current configured modulation is turned off.
 
The current configured modulation is turned off.
 +
 +
==Test_DwellTime_Start==
 +
The currently dwelltime has started.
 +
 +
==Test_DwellTime_Stop==
 +
The currently dwelltime has stopped.
  
 
==Antenna_Movement_Started==
 
==Antenna_Movement_Started==
Line 86: Line 177:
  
 
When the target is 2 the antenna is changed to vertical.
 
When the target is 2 the antenna is changed to vertical.
 +
 +
==Antenna_Polarisation_Changed==
 +
Notification that the changing of the antenna polarisation has finished.
 +
 +
'''Parameter:''' target
 +
 +
'''Unit parameter:''' unitless
 +
 +
When the target is 1 the antenna is changed to horizontal.
 +
 +
When the target is 2 the antenna is changed to vertical.
 +
 
==TurnTable_Movement_Started==
 
==TurnTable_Movement_Started==
 
Starting of the movement of the turn table with the target position of the turn table.
 
Starting of the movement of the turn table with the target position of the turn table.
Line 92: Line 195:
  
 
'''Unit parameter:''' Degrees
 
'''Unit parameter:''' Degrees
 +
 
==TurnTable_Movement_Stopped==
 
==TurnTable_Movement_Stopped==
 
The stop position of the turn table.
 
The stop position of the turn table.
Line 98: Line 202:
  
 
'''Unit parameter:''' Degrees
 
'''Unit parameter:''' Degrees
 +
 
==TurnTable_Movement_Turning_Percentage==
 
==TurnTable_Movement_Turning_Percentage==
 
The current percentage of the turn table movement from the start position to the end position
 
The current percentage of the turn table movement from the start position to the end position

Latest revision as of 19:14, 31 January 2022

The RadiMationInterface.can file is a CANoe CAPL file that provides specifically named CAPL functions that are called from the RadiMation® software. Those CAPL functions are used to generate an interface to provide measurement values from the RadiMation® software to the CANoe software.

You can download the zip file that contains the RadiMationInterface.can file here.

By including the RadiMationInterface.can file inside your CANoe or CANalyzer project, it will be possible to get updates of the RadiMation® measurement values. The CANoe Switch Matrix device driver is calling the specifically named CAPL functions that are defined in the RadiMationInterface.can file.

The functions that are called in the CAPL interface are event triggered. This means that the updated measurement values are transmitted to the CAPL interface at the moment that the updated measurement value becomes available.

For example, when the Forward power has been measured in the immunity test, then the forward power measurement result is directly transmitted to the corresponding CAPL function. The same happens for the other defined functions, like the updated frequency directly after a frequency change.

This also means that when a specific measurement value is not available, that the corresponding CAPL function is also not called. When a RadiMation® immunity test, for example is configured to only perform a signal generator carrier level test, then the forward power is not available, and the corresponding CAPL function will not be called at all. Which events are triggered, and how often they are triggered is thus completely depending on the configuration of the TSF in RadiMation®.

When filtering of the called CAPL function is needed, for example in the situation that the updated value of signal generator level value is not needed, then that should be done in implementation of the corresponding function in the RadiMationInterface.can file in the CANoe software. Those functions can for example be programmed to perform a 'No Operation' call.

Information.png
Note: The CANoe Switch Matrix device driver is not able to determine if a specifically named CAPL function is existing in the running CANoe environment.

When one or more of the specifically named CAPL functions from the RadiMationInterface.can file, is not implemented, the function call is being forwarded to the CANoe software itself, and there will be no error message or return value. The CANoe Switch Matrix is thus not able to warn or raise an error when one or more of the specifically called CAPL functions is not implemented.

For more details on how to use and attach this file in your CANoe project, please see then CANoe page.

Explanation of the available specifically named CAPL functions

Test_Frequency

The current frequency of the test, in other words the frequency of the signal generator.

Parameter: mdFreqMHz

Unit parameter: MHz

Test_Carrier_Level

The carrier level of the signal generator

Parameter: mdPowerIndBm

Unit parameter: dBm

Test_Forward_Power

The measured value of the forward power.

Parameter: mdPowerIndBm

Unit parameter: dBm

Test_Reflected_Power

The measured value of the reflected power.

Parameter: mdPowerIndBm

Unit parameter: dBm

Test_Net_Power

The measured value of the netto power.

Parameter: mdPowerIndBm

Unit parameter: dBm

Test_Average_Field

The measured value of the average field.

Parameter: mdFieldVm

Unit parameter: V/m

Test_Calculated_Field

The calculated value of the field based on the calibration file.

Parameter: mdFieldVm

Unit parameter: V/m

Test_Measured_Current

The measured value of the current.

Parameter: mdCurrentInmA

Unit parameter: mA


Test_Calculated_Current

The calculated value of the current.

Parameter: mdCurrentInmA

Unit parameter: mA

Test_Sensor_Power

The measured power of by the current sensor power meter.

Parameter: mdPowerIndBm

Unit parameter: dBm

Test_Amplitude_Modulation_Internal

The modulation in the signal generator is configured as internal amplitude modulation.

Parameter1: mdFreqency

Unit parameter1: Hz

Parameter2: mdDepth

Unit parameter2: %

Information.png
Note: The modulation may not be active at this moment, Test_Modulation_On is the event called when the modulation is turned on.

Test_Amplitude_Modulation_External

The modulation in the signal generator is configured as external amplitude modulation.

Information.png
Note: The modulation may not be active at this moment, Test_Modulation_On is the event called when the modulation is turned on.

Test_Frequency_Modulation_Internal

The modulation in the signal generator is configured as internal frequency modulation.

Parameter1: mdFreqency

Unit parameter1: kHz

Parameter2: dmShift

Unit parameter2: kHz

Information.png
Note: The modulation may not be active at this moment, Test_Modulation_On is the event called when the modulation is turned on.

Test_Frequency_Modulation_External

The modulation in the signal generator is configured as external frequency modulation.

Information.png
Note: The modulation may not be active at this moment, Test_Modulation_On is the event called when the modulation is turned on.

Test_Pulse_Modulation_Internal

The modulation in the signal generator is configured as internal pulse modulation.

Parameter1: mdFreqency

Unit parameter1: kHz

Parameter2: mdWidth

Unit parameter2: %

Information.png
Note: The modulation may not be active at this moment, Test_Modulation_On is the event called when the modulation is turned on.

Test_Pulse_Modulation_External

The modulation in the signal generator is configured as external pulse modulation.

Information.png
Note: The modulation may not be active at this moment, Test_Modulation_On is the event called when the modulation is turned on.

Test_Modulation_On

The currently configured modulation is turned on.

Test_Modulation_Off

The current configured modulation is turned off.

Test_DwellTime_Start

The currently dwelltime has started.

Test_DwellTime_Stop

The currently dwelltime has stopped.

Antenna_Movement_Started

Starting of the movement of the antenna tower with the target position of the antenna tower.

Parameter: position

Unit parameter: Meter

Antenna_Movement_Stopped

The stop position of the antenna tower.

Parameter: position

Unit parameter: Meter

Antenna_Movement_Percentage

The current percentage of the antenna tower movement from the start position to the end position

Parameter: percentage

Unit parameter: %

Antenna_Movement_Changing_Polarisation

Changing the antenna polarisation.

Parameter: target

Unit parameter: unitless

When the target is 1 the antenna is changed to horizontal.

When the target is 2 the antenna is changed to vertical.

Antenna_Polarisation_Changed

Notification that the changing of the antenna polarisation has finished.

Parameter: target

Unit parameter: unitless

When the target is 1 the antenna is changed to horizontal.

When the target is 2 the antenna is changed to vertical.

TurnTable_Movement_Started

Starting of the movement of the turn table with the target position of the turn table.

Parameter: position

Unit parameter: Degrees

TurnTable_Movement_Stopped

The stop position of the turn table.

Parameter: position

Unit parameter: Degrees

TurnTable_Movement_Turning_Percentage

The current percentage of the turn table movement from the start position to the end position

Parameter: percentage

Unit parameter: %

Retrieved from "https://wiki.radimation.com/wiki/index.php?title=RadiMationInterface.can&oldid=84778"