Probe

Description of the Probe component in Schematic Editor.

Description

The Probe component adds a signal to the analog signal list in HIL SCADA/TyphoonSim Scope.

A signal connected to Probe can also be read using HIL API commands read_analog_signal and read_analog_signals.

If the input is a vector, SCADA will split the signal so that each vector element can be read separately.In TyphonSim, vectorized input is not supported yet.

Enabling the Signal streaming property allows the acquisition and logging of the signal.In TyphonSim, enabling this property will have no effect on simulation

Ports

  • In (in)
    • Port to which the signal intended to be measured is connected.
      • Supported types: uint, int, real.
      • Vector support in real-time simulation: yes
      • Vector support in TyphoonSim: no

General (Tab)

  • Override signal name
    • Check this checkbox to override the signal name. Instead of using the default signal names (for example, Subsystem1.Subsystem2.Probe1), the user can specify a custom signal name.
  • Signal type
    • Select the type of signal you want to observe.
    • In real-time simulation, this is just a label that will be shown next to the monitoring widget of the related Probe in the SCADA panel.
    • In TyphoonSim, this property will have no effect in simulation.
  • Signal streaming
    • Signal streaming is ignored in TyphoonSim and changing its value will not affect TyphoonSim simulation at all.
    • Check this checkbox for allowing acquisition and logging of the signal at a medium sample rate. For more details on signal streaming, please refer to link: Signal streaming
  • Execution rate
    • Type in the desired signal processing execution rate. This value must be compatible with other signal processing components of the same circuit: the value must be a multiple of the fastest execution rate in the circuit. There can be up to four different execution rates. To specify the execution rate, you can use either decimal (e.g. 0.001) or exponential values (e.g. 1e-3) in seconds. Alternatively, you can type in ‘inherit’ in which case the component will be assigned execution rate based on the execution rate of the components it is receiving input from.

Extras (Tab)

The Extras tab gives you the opportunity to set Signal Access Management for the component.
Signal visibility is calculated based on the 'signal_access' property and whether or not a parent component in its hierarchy is locked or not. Components that are not contained within locked components expose their signals regardless of the 'signal_access' property. The 'signal_access' property can have one of three values:
  • Public - Components marked as public expose their signals on all levels.
  • Protected - Components marked as protected will hide their signals to components outside of their first locked parent component.
  • Inherit - Components marked as inherit will take the nearest parent 'signal_access' property value that is set to a value other than inherit.