Port MODELACCESS 🛈¶
Stimulation¶
This port has no stimulus capabilities.
Supported execution modes¶
See also: Temporal behaviour: Real time and simulation time modes
Preferred time source/mode: Real-time
- Real-time:
To use real-time mode, the Test configuration in the Execution tab must be configured as the source ‘real time’.
Info
The following modes are not supported: Stepwise simulation time, Continuous simulation time
Properties 🛈¶
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
Serial number |
[ONLINE] |
string |
Serial number of the BT |
||
Channel number |
1 |
[ONLINE] |
int |
Channel number (from the BT manager) |
|
Support for online model querying |
☑ |
bool |
(De-)Activates the interface for online querying of model information by the test configuration |
Jobs 🛈¶
ActivateManualMode¶
Sets the channel into manual mode
DeactivateManualMode¶
Deactivates manual mode for this channel
GetActualChannelMeasurement¶
Queries the current measurement values of the channel
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
Dictionary with the current measurement values |
GetAllActualMeasurementNames¶
Queries the names of the measurements of the channel
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
List of measurement names |
GetBoundedChannelReport¶
Queries the report currently bound to the channel
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
string |
Path to the report |
GetChannelErrorCode¶
Queries the channel’s error code.
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
Error code of the channel |
GetChannelState¶
Queries the channel’s status.
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
Status of the channel |
GetExtIOInputByName¶
Returns the value of the external input
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
inputName |
string |
Name of the input |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
float |
GetOneActualChannelMeasurement¶
Queries a current measurement value from the channel
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
measurementName |
int |
Name of the measurement |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
float |
Measurement value |
GetReflectedExtIOOutputByName¶
Returns the reflected value of the external output
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
outputName |
string |
Name of the output |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
float |
GetSystemState¶
Queries the system’s status.
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
Status of the system |
GetTBGChannelErrorCode¶
Queries the test bench guard error code of the channel.
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
Error code of the test bench guard |
GetTBGChannelState¶
Queries the test bench guard status of the channel.
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
Status of the test bench guard |
IsChannelInManualMode¶
Queries whether the channel is in manual mode
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
[False, True] |
bool |
Pause¶
Pauses/Resumes the execution on the channel
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
int |
Reset¶
Resets the channel
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
int |
SetChannelParametrization¶
Sets the parameters for the test program
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
batteryPath |
string |
Path to battery file |
|||
parameters |
object |
Parameter set for the test program (as dict) |
|||
reportPath |
string |
Path to the report |
|||
testProgramPath |
string |
Path to the test program |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
int |
SetChannelReParametrization¶
Changes the parameters for the paused test program
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
parameters |
object |
Parameter set for the test program (as dict) |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
int |
SetExtIOOutputByName¶
Sets the value of the external output
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
outputName |
string |
Name of the output |
|||
value |
float |
Value |
SetLocalChannelParametrization¶
Sets the parameters for the test program
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
batteryPath |
string |
Path to battery file |
|||
parameters |
object |
Parameter set for the test program (as dict) |
|||
reportPath |
string |
Path to the report |
|||
testProgramName |
string |
Name of the test program |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
int |
SetTBGParametrization¶
Sets the parameterization for the test bench guard. CAUTION: This parameterization applies to all channels!
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
parametrizationPath |
string |
Path to the parameterization file |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
int |
Start¶
Starts the execution on the channel
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
int |
Stop¶
Stops the execution on the channel
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
int |