VisionBox Interface Library  1.7.5.0 (2021-12-10)
VIB::IOScheduler Class Reference
+ Inheritance diagram for VIB::IOScheduler:

Detailed Description

This class controls the I/O Scheduler which allows to store and emit output signals in hard real-time.

The I/O Scheduler is an internal unit which can be used to create output signals with timing based on other trigger events, encoder position, or timer values. The I/O Scheduler is only connected to the Multiplexer.

Each I/O Scheduler contains a buffer (FIFO) which stores entries with desired output values and their trigger activation values. These buffer entries are first pushed by software with no hard real-time requirement. The unit can then read and evaluate values from this buffer without further interaction by software.

The unit has three different counters to provide three different modes of operation. The mode is configured by selecting the counter used for comparison against the next buffer entry (see also SetCompareSource()):

  • Triggered mode uses a simple counter incrementing with the rising edge at the selected Multiplexer line.
  • Encoder mode uses a counter which holds the relative position of an encoder.
  • Timer mode uses a counter which increments with a fixed rate of 1 MHz.

The following image shows the internal structure of the I/O Scheduler, configured for encoder mode and some example values:

I/O Scheduler
IOScheduler block diagram

The size of the output buffer depends on the FPGA firmware (see Hardware, library and firmware dependencies) and can be read with GetBufferMaxElementCount(). The currently used space can be obtained by calling GetBufferFillLevel().

All counter values are 24 bit wide. The unit always compares the oldest valid buffer entry with the selected counter. When both values are equal, the output value of the entry is used for setting the output signal and the entry is removed from the buffer, moving to the next entry.

An additional delay unit can be used to create an output signal with a specified delay and hold time (see SetOutputPulsTiming()).

Current I/O Scheduler implementations have two output signals. Therefore, two bits are used for the output value in in each buffer entry.

In Encoder and Timer mode, software often needs to calculate the next activation value after a trigger event occurred. In order to reduce real-time requirements for software, copy registers exist for both counters. They can be used by software to get the exact counter value during the last trigger event and calculate the activation value just by adding a fixed offset. The offset is equal to the desired time or position difference since the trigger event occurred.

Note
  • The I/O Scheduler will be deactivated when closing the device object.
  • Depending on the setup, there can be a race condition if the activation value pushed into the buffer is lower than the current counter value. The unit will then be stalled until the counter overflows and reaches the requested activation value.
    To avoid this situation, the counters can be frozen while reading their values and while pushing the calculated values into the buffer. But note that the counters will ignore encoder / timer events during this time.
    Alternatively, this situation can be detected by observing a steady increase of valid buffer entries (see GetBufferFillLevel()). Software has to Reset() and reconfigure the I/O Scheduler after detection.

Advanced Features

New versions of the I/O scheduler provide additional features:

  • Encoder source: Multiplexer signals can be used for the encoder mode, instead of the dedicated RS-422 encoder signals and the counting mode can be selected, see SetEncoderSource()
  • Reset source: A signal can be configured to reset the counters, see SetCounterResetSource()
  • Counter freeze: Stops all counters and ignores all trigger events, see SetCounterFreeze()
  • Automatic re-queue mode: Buffer entries can be re-used for creation of repeating signals, see SetAutomaticRequeueMode()

Function Dependencies

The I/O Scheduler can be in two states: stopped or active.

Certain functions can only be called during initialization while the I/O Scheduler is stopped. Other functions can only be called while the I/O Scheduler is active. Start() is used to change the state from stopped to active. Reset() is used to reset everything to default values, but can also be used to stop the unit.

The following table lists the callability for all functions depending on the state:

Function callability
Function I/O Scheduler state
Stopped Active
SetAutomaticRequeueMode() yes no
SetCompareSource() yes no
SetTriggerSource() yes no
SetEncoderSource() yes no
SetEncoderDirection() yes no
SetOutputPulsTiming() yes no
Start() yes no
Reset() yes yes
SetCounterResetSource() yes yes
SetCounterFreeze() yes yes
GetBufferMaxElementCount() yes yes
GetNumberOfOutputs() yes yes
PushValue() no yes
GetCounter() no yes
GetBufferFillLevel() no yes
+ Example using a trigger signal

The following code example demonstrates the use of the I/O Scheduler:

  • The TriggerGenerator is used to produce a 100 Hz signal which simulates an external trigger input.
  • Two I/O schedulers are configured for triggered mode with Multiplexer output 0 as the source signal.
  • Trigger positions are pushed into the first I/O Scheduler so that both outputs toggle (non-inverted and inverted version) for every second trigger event, with an initial delay of three events.
  • The second I/O Scheduler use the same trigger event positions, but only use the output value 1 with a predefined pulse timing (8 ms delay and 2 ms active).
  • The Multiplexer is used to connect the I/O Schedulers with the TriggerGenerator and the DigitalOutput unit.
// Connection of the FPGA units:
//
// triggerUnit(0) -> multiplexer(0) +----------------------------------------> digitalOut(0)
// |
// +-> ioScheduler[0](0) -> multiplexer(1) -> digitalOut(1)
// |
// +-> ioScheduler[0](1) -> multiplexer(2) -> digitalOut(2)
// |
// +-> ioScheduler[1](0) -> multiplexer(3) -> digitalOut(3)
VIB::Multiplexer multiplexer;
VIB::IOScheduler ioScheduler[2];
VIB::DigitalOutput digitalOut;
// Open devices:
// Multiplexer:
multiplexer.Open();
// both I/O Schedulers:
ioScheduler[0].Open(0);
ioScheduler[0].Open(1);
// Digital Output:
digitalOut.Open(0);
// Trigger Unit:
triggerUnit.Open();
// Trigger Unit configuration:
// use Generator with 100 Hz signal:
triggerUnit.ConfigureSet("GenA_tLow=5ms GenA_tHigh=5ms");
// connect signal to output 0 of the unit:
triggerUnit.ConfigureSet("TrigOut0_Mux=GenA");
// Multiplexer:
// make sure that the 100 Hz signal is disconnected from the I/O schedulers, will be reconnected later:
// Connect I/O Scheduler output signals to Multiplexer output 1...3:
// Digital Outputs:
// use Multiplexer outputs as source:
// I/O Schedulers:
// Reset I/O Schedulers:
ioScheduler[0].Reset();
ioScheduler[1].Reset();
// Select multiplexer line 0 as trigger source
ioScheduler[0].SetTriggerSource(0, false);
ioScheduler[1].SetTriggerSource(0, false);
// Set delay and on time for the second I/O scheduler (8 ms delay, 2 ms active):
ioScheduler[1].SetOutputPulsTiming(8*1000, 2*1000);
// start the I/O Schedulers:
ioScheduler[0].Start();
ioScheduler[1].Start();
// Push five values into each I/O Scheduler
const unsigned int StartDelay = 3 + 1; // the first trigger starts with value 1
const unsigned int StepMul = 2;
for (int i = 0; i < 5; i++)
{
// first I/O Scheduler: we want to toggle both outputs (bits) at the same time => value 1 or 2
ioScheduler[0].PushValue(StartDelay+StepMul*i, i % 2 == 0 ? 1 : 2);
// second I/O Scheduler: uses specified pulse timing, we only need a value of 1
ioScheduler[1].PushValue(StartDelay+StepMul*i, 1);
}
// finally, connect the 100 Hz signal to the I/O Scheduler
// wait until all elements are sent
unsigned int iFillLevel = 0;
do
{
// read only the buffer level of the first I/O Scheduler, the second unit should have the same level:
ioScheduler[0].GetBufferFillLevel(iFillLevel);
} while (iFillLevel > 0);
// disconnect the 100 Hz signal from the schedulers

Please note that error checking was removed to keep the code as simple as possible.

The following image shows the signals that can be measured at the digital output terminals:

IO_Scheduler_CodeRes1
Measured input and output signals
+ Example using an Encoder

The following example demonstrates the effect of the different encoder edge modes. An encoder signal on the first RS-422 input connector with two phases and a zero pulse are required.
This example also shows the use of the automatic requeue mode.

//MainMux
//MuxLines to DigOut
for (UINT32 iMux=0; iMux<4; iMux++)
// Test all four encoder edge modes
for (UINT32 iTest=0; iTest<4; iTest++)
{
//IOScheduler (re)config
ioScheduler.Reset();
ioScheduler.SetCounterFreeze(true);
ioScheduler.SetAutomaticRequeueMode(true);
ioScheduler.SetOutputPulsTiming(0, 1*1000);
ioScheduler.Start();
ioScheduler.PushValue(1, 0x1);
ioScheduler.PushValue(2, 0x1);
ioScheduler.PushValue(3, 0x1);
ioScheduler.PushValue(4, 0x1);
ioScheduler.SetCounterFreeze(false);
HMI_WaitForKey();
}

The following image shows the measured signals:

IO_Scheduler_CodeRes2
Measured input and output signals

Hardware, library and firmware dependencies

+ Available features depend on the combination of hardware type, software library and FPGA version.
Available I/O Scheduler features
Hardware Library Version FPGA Version Features
I/O Scheduler units Buffer size Advanced Features
VisionBox AGE-X5 1.6.5.6 1.0.0.42 8 1024 yes
VisionBox AGE-X4 /
Machine Vision Controller
1.6.5.3 1.0.0.39 8 1024 yes
1.6.3 1.0.0.28 4 128 no
VisionBox AGE-X3 1.6.2 1.0.0.25 2 128 no
VisionBox AGE-X2 1.6.5.3 1.0.0.38 4 1024 yes
1.5.2 1.0.0.23 4 128 no
1.5.1 1.0.0.21 4 16 no
1.5.0 1.0.0.20 4 16 no
VisionBox DAYTONA 1.6.8.3 1.0.0.46 1 256 yes
VisionBox LE MANS 1.6.5 1.0.0.31 4 128 no
VisionCam XM 1.6.4 1.0.0.30 2 128 no
Machine Vision Manager 1.6.5.4 1.0.0.69 4 1024 yes
1.6.3 1.0.0.27 4 128 no

Public Types

enum  IO_SCHEDULER_CMP_SRC
 Operation mode type definition More...
 
enum  IO_SCHEDULER_COUNTER
 Available counters, used by GetCounter() More...
 
enum  IO_SCHEDULER_ENC_EDGE_MODE
 Encoder edge detection mode, used by SetEncoderSource() More...
 
enum  IO_SCHEDULER_ENC_SRC
 The trigger source type definition for the Encoder counter, used by SetEncoderSource() More...
 
enum  IO_SCHEDULER_ENCODER_DIR
 Encoder Direction, used by SetEncoderDirection() More...
 
enum  IO_SCHEDULER_RST_SRC
 The sources which reset the counter, used by SetCounterResetSource() More...
 

Public Member Functions

bool GetBufferFillLevel (unsigned int &BufferFillLevel)
 Returns the number of valid entries in the circular buffer. More...
 
bool GetBufferMaxElementCount (unsigned int &BufferSize)
 Returns the maximum space for elements inside the circular buffer. More...
 
bool GetCounter (const IOScheduler::IO_SCHEDULER_COUNTER CounterType, unsigned int &CounterValue)
 Read a counter value from the FPGA. More...
 
bool GetNumberOfOutputs (unsigned int &NumberOfOutputs)
 Returns the number output lines of this unit. More...
 
 IOScheduler ()
 Default constructor for the device object More...
 
bool PushValue (const unsigned int CompareValue, const unsigned int OutputValue)
 Pushes a new entry into the circular buffer within the FPGA. More...
 
bool Reset ()
 Resets the I/O Scheduler logic. More...
 
bool SetAutomaticRequeueMode (const bool boAutoRequeue)
 If automatic requeue mode is enabled, used output values will be added to the circular buffer again. More...
 
bool SetCompareSource (const IOScheduler::IO_SCHEDULER_CMP_SRC cmpSrc)
 Selects the counter which is compared against the current trigger value. More...
 
bool SetCounterFreeze (const bool boFreezed)
 Freezes the counters and counter copy registers. More...
 
bool SetCounterResetSource (const IOScheduler::IO_SCHEDULER_RST_SRC rstSrc, const bool InvertInput, const bool EdgeSensitive)
 Selects and configures the signal to reset the counters. More...
 
bool SetEncoderDirection (const IOScheduler::IO_SCHEDULER_ENCODER_DIR EncoderDir)
 Sets the direction of the encoder signal in encoder mode. More...
 
bool SetEncoderSource (const IOScheduler::IO_SCHEDULER_ENC_SRC encSrc, const IOScheduler::IO_SCHEDULER_ENC_EDGE_MODE encMode)
 Selects the source signal for encoder mode. More...
 
bool SetOutputPulsTiming (const unsigned int Delay_us, const unsigned int OnTime_us)
 Configures the output delay and hold time. More...
 
bool SetTriggerSource (const unsigned int InputIndex, const bool InvertInput)
 Selects the Multiplexer output signal to be used as trigger event. More...
 
bool Start ()
 Starts the I/O Scheduler logic within the FPGA. More...
 
- Public Member Functions inherited from VIB::iDevice
bool Close ()
 Closes a device More...
 
 iDevice (const iDevice &device)
 The copy constructor makes a copy of the existing device object More...
 
bool isOpen (bool &state)
 Returns the open state of a device object More...
 
bool Open (unsigned int Index=0)
 Opens a device More...
 
iDeviceoperator= (const iDevice &device)
 The assignment operator makes a copy of the existing device object More...
 
virtual ~iDevice ()
 Deletes the device object More...
 

Member Enumeration Documentation

◆ IO_SCHEDULER_CMP_SRC

Operation mode type definition

Selects which counter is compared against the trigger activation value of the current buffer entry.

Enumerator
IO_SCHEDULER_CMP_SRC_TRIGGER 

Trigger mode, signal can selected via SetTriggerSource()

IO_SCHEDULER_CMP_SRC_ENCODER 

Encoder mode, can be configured with SetEncoderSource() and SetEncoderDirection()

IO_SCHEDULER_CMP_SRC_TIMER 

Timer mode.

◆ IO_SCHEDULER_COUNTER

Available counters, used by GetCounter()

Enumerator
IO_SCHEDULER_COUNTER_TRIGGER 

Trigger counter.

IO_SCHEDULER_COUNTER_ENCODER 

Encoder counter.

IO_SCHEDULER_COUNTER_TIMER 

Timer counter.

IO_SCHEDULER_COUNTER_ENCODER_COPY 

Encoder counter copy.

IO_SCHEDULER_COUNTER_TIMER_COPY 

Trigger counter copy.

◆ IO_SCHEDULER_ENC_EDGE_MODE

Encoder edge detection mode, used by SetEncoderSource()

Enumerator
IO_SCHEDULER_ENC_EDGE_MODE_A_RISING 

Counter increments on the rising edge of the first signal.

IO_SCHEDULER_ENC_EDGE_MODE_A_FALLING 

Counter increments on the falling edge of the first signal.

IO_SCHEDULER_ENC_EDGE_MODE_A_BOTH 

Counter increments on rising and falling edge of the first signal.

IO_SCHEDULER_ENC_EDGE_MODE_AB_BOTH 

Counter increments on both edges for both encoder signals.

IO_SCHEDULER_ENC_EDGE_MODE_AB_ENCODER 

Counter increments or decrements depending on the encoder direction and the configured direction, see SetEncoderDirection()

◆ IO_SCHEDULER_ENC_SRC

The trigger source type definition for the Encoder counter, used by SetEncoderSource()

Enumerator
IO_SCHEDULER_ENC_SRC_SYNC_0_0 

SYNC Unit 0 Input 0.

IO_SCHEDULER_ENC_SRC_SYNC_0_1 

SYNC Unit 0 Input 1.

IO_SCHEDULER_ENC_SRC_MUX_OUT0 

Multiplexer Output 0.

IO_SCHEDULER_ENC_SRC_MUX_OUT1 

Multiplexer Output 1.

IO_SCHEDULER_ENC_SRC_MUX_OUT2 

Multiplexer Output 2.

IO_SCHEDULER_ENC_SRC_MUX_OUT3 

Multiplexer Output 3.

IO_SCHEDULER_ENC_SRC_MUX_OUT4 

Multiplexer Output 4.

IO_SCHEDULER_ENC_SRC_MUX_OUT5 

Multiplexer Output 5.

IO_SCHEDULER_ENC_SRC_MUX_OUT6 

Multiplexer Output 6.

IO_SCHEDULER_ENC_SRC_MUX_OUT7 

Multiplexer Output 7.

IO_SCHEDULER_ENC_SRC_MUX_OUT8 

Multiplexer Output 8.

IO_SCHEDULER_ENC_SRC_MUX_OUT9 

Multiplexer Output 9.

IO_SCHEDULER_ENC_SRC_MUX_OUT10 

Multiplexer Output 10.

IO_SCHEDULER_ENC_SRC_MUX_OUT11 

Multiplexer Output 11.

IO_SCHEDULER_ENC_SRC_MUX_OUT12 

Multiplexer Output 12.

IO_SCHEDULER_ENC_SRC_MUX_OUT13 

Multiplexer Output 13.

IO_SCHEDULER_ENC_SRC_MUX_OUT14 

Multiplexer Output 14.

IO_SCHEDULER_ENC_SRC_MUX_OUT15 

Multiplexer Output 15.

IO_SCHEDULER_ENC_SRC_MUX_OUT16 

Multiplexer Output 16.

IO_SCHEDULER_ENC_SRC_MUX_OUT17 

Multiplexer Output 17.

IO_SCHEDULER_ENC_SRC_MUX_OUT18 

Multiplexer Output 18.

IO_SCHEDULER_ENC_SRC_MUX_OUT19 

Multiplexer Output 19.

IO_SCHEDULER_ENC_SRC_MUX_OUT20 

Multiplexer Output 20.

IO_SCHEDULER_ENC_SRC_MUX_OUT21 

Multiplexer Output 21.

IO_SCHEDULER_ENC_SRC_MUX_OUT22 

Multiplexer Output 22.

IO_SCHEDULER_ENC_SRC_MUX_OUT23 

Multiplexer Output 23.

◆ IO_SCHEDULER_ENCODER_DIR

Encoder Direction, used by SetEncoderDirection()

Enumerator
IO_SCHEDULER_ENCODER_DIR_NORMAL 

Normal encoder direction.

IO_SCHEDULER_ENCODER_DIR_REVERSE 

Reversed encoder direction.

◆ IO_SCHEDULER_RST_SRC

The sources which reset the counter, used by SetCounterResetSource()

Enumerator
IO_SCHEDULER_RST_SRC_OFF 

static off

IO_SCHEDULER_RST_SRC_ON 

static on

IO_SCHEDULER_RST_SRC_MUX_OUT0 

Multiplexer Output 0.

IO_SCHEDULER_RST_SRC_MUX_OUT1 

Multiplexer Output 1.

IO_SCHEDULER_RST_SRC_MUX_OUT2 

Multiplexer Output 2.

IO_SCHEDULER_RST_SRC_MUX_OUT3 

Multiplexer Output 3.

IO_SCHEDULER_RST_SRC_MUX_OUT4 

Multiplexer Output 4.

IO_SCHEDULER_RST_SRC_MUX_OUT5 

Multiplexer Output 5.

IO_SCHEDULER_RST_SRC_MUX_OUT6 

Multiplexer Output 6.

IO_SCHEDULER_RST_SRC_MUX_OUT7 

Multiplexer Output 7.

IO_SCHEDULER_RST_SRC_MUX_OUT8 

Multiplexer Output 8.

IO_SCHEDULER_RST_SRC_MUX_OUT9 

Multiplexer Output 9.

IO_SCHEDULER_RST_SRC_MUX_OUT10 

Multiplexer Output 10.

IO_SCHEDULER_RST_SRC_MUX_OUT11 

Multiplexer Output 11.

IO_SCHEDULER_RST_SRC_MUX_OUT12 

Multiplexer Output 12.

IO_SCHEDULER_RST_SRC_MUX_OUT13 

Multiplexer Output 13.

IO_SCHEDULER_RST_SRC_MUX_OUT14 

Multiplexer Output 14.

IO_SCHEDULER_RST_SRC_MUX_OUT15 

Multiplexer Output 15.

IO_SCHEDULER_RST_SRC_MUX_OUT16 

Multiplexer Output 16.

IO_SCHEDULER_RST_SRC_MUX_OUT17 

Multiplexer Output 17.

IO_SCHEDULER_RST_SRC_MUX_OUT18 

Multiplexer Output 18.

IO_SCHEDULER_RST_SRC_MUX_OUT19 

Multiplexer Output 19.

IO_SCHEDULER_RST_SRC_MUX_OUT20 

Multiplexer Output 20.

IO_SCHEDULER_RST_SRC_MUX_OUT21 

Multiplexer Output 21.

IO_SCHEDULER_RST_SRC_MUX_OUT22 

Multiplexer Output 22.

IO_SCHEDULER_RST_SRC_MUX_OUT23 

Multiplexer Output 23.

Constructor & Destructor Documentation

◆ IOScheduler()

VIB::IOScheduler::IOScheduler ( )

Default constructor for the device object

The device must be opened with Open() before it can be used.

Member Function Documentation

◆ GetBufferFillLevel()

bool VIB::IOScheduler::GetBufferFillLevel ( unsigned int &  BufferFillLevel)

Returns the number of valid entries in the circular buffer.

Parameters
BufferFillLevelNumber of entries
Returns
true for success, use VIBSystem::GetLastErrorString() for an error description

◆ GetBufferMaxElementCount()

bool VIB::IOScheduler::GetBufferMaxElementCount ( unsigned int &  BufferSize)

Returns the maximum space for elements inside the circular buffer.

If GetBufferFillLevel() is equal to GetBufferMaxElementCount(), no element can be added / pushed

Parameters
BufferSizeNumber of entries that can be pushed with PushValue()
Returns
true for success, use VIBSystem::GetLastErrorString() for an error description

◆ GetCounter()

bool VIB::IOScheduler::GetCounter ( const IOScheduler::IO_SCHEDULER_COUNTER  CounterType,
unsigned int &  CounterValue 
)

Read a counter value from the FPGA.

Parameters
CounterTypeCounter type to read
CounterValueCounter value of the given type
Returns
true for success, use VIBSystem::GetLastErrorString() for an error description

◆ GetNumberOfOutputs()

bool VIB::IOScheduler::GetNumberOfOutputs ( unsigned int &  NumberOfOutputs)

Returns the number output lines of this unit.

Parameters
NumberOfOutputsNumber of outputs
Returns
true for success, use VIBSystem::GetLastErrorString() for an error description

◆ PushValue()

bool VIB::IOScheduler::PushValue ( const unsigned int  CompareValue,
const unsigned int  OutputValue 
)

Pushes a new entry into the circular buffer within the FPGA.

Note
If the I/O Scheduler is in automatic re-queue mode, the counters must be frozen (SetCounterFreeze()) before calling this function.
Parameters
CompareValue24 bit activation value which is compared against the selected counter, the upper 8 bits are ignored
OutputValueBinary representation of the output signal, two LSBs are currently used
Returns
true for success, use VIBSystem::GetLastErrorString() for an error description

◆ Reset()

bool VIB::IOScheduler::Reset ( )

Resets the I/O Scheduler logic.

The unit will be stopped if it was running before.

The function sets the following default values:

pIOScheduler->SetCounterFreeze(false);
pIOScheduler->SetAutomaticRequeueMode(false);
pIOScheduler->SetCompareSource(IOScheduler::IO_SCHEDULER_CMP_SRC_TRIGGER);
pIOScheduler->SetTriggerSource(0, false);
pIOScheduler->SetEncoderDirection(IOScheduler::IO_SCHEDULER_ENCODER_DIR_NORMAL); //The user can't call this without setting IO_SCHEDULER_CMP_SRC_ENCODER
pIOScheduler->SetCounterResetSource(IOScheduler::IO_SCHEDULER_RST_SRC_OFF, false, false);
pIOScheduler->SetOutputPulsTiming(0, 0);
Returns
true for success, use VIBSystem::GetLastErrorString() for an error description

◆ SetAutomaticRequeueMode()

bool VIB::IOScheduler::SetAutomaticRequeueMode ( const bool  active)

If automatic requeue mode is enabled, used output values will be added to the circular buffer again.

After the comparison of the current trigger activation value was true, the entry will be added to the circular buffer again. This allows to generate fixed signal sequences without CPU interaction.

In order to reset the sequence, the reset source (SetCounterResetSource()) can be used. At reset, the compare counter values are set to zero and the buffer moves back to the first entry with the lowest trigger value.

To prevent a race condition, it is only allowed to add an entries with PushValue() while the counters are frozen.

Parameters
activeEnable automatic requeue mode
Returns
true for success, use VIBSystem::GetLastErrorString() for an error description

◆ SetCompareSource()

bool VIB::IOScheduler::SetCompareSource ( const IOScheduler::IO_SCHEDULER_CMP_SRC  cmpSrc)

Selects the counter which is compared against the current trigger value.

Parameters
cmpSrcCounter to use for comparison
Returns
true for success, use VIBSystem::GetLastErrorString() for an error description

◆ SetCounterFreeze()

bool VIB::IOScheduler::SetCounterFreeze ( const bool  active)

Freezes the counters and counter copy registers.

If the freeze state is activated, the counters are stopped from counting. Any trigger or encoder event is ignored and the timer is stopped. No update of the counter copy registers will be done while the counters are frozen.

A reset event resets the counters regardless of the freeze state.

Parameters
activeFreeze state
Returns
true for success, use VIBSystem::GetLastErrorString() for an error description

◆ SetCounterResetSource()

bool VIB::IOScheduler::SetCounterResetSource ( const IOScheduler::IO_SCHEDULER_RST_SRC  rstSrc,
const bool  InvertInput,
const bool  EdgeSensitive 
)

Selects and configures the signal to reset the counters.

The reset signal sets the counters back to zero, but not the copy registers. The reset will be done regardless of the freeze state.

Parameters
rstSrcSignal or constant value which will be used
InvertInputPolarity of the reset signal
EdgeSensitivefalse: reset signal is level sensitive
true: reset signal is edge sensitive
Returns
true for success, use VIBSystem::GetLastErrorString() for an error description

◆ SetEncoderDirection()

bool VIB::IOScheduler::SetEncoderDirection ( const IOScheduler::IO_SCHEDULER_ENCODER_DIR  EncoderDir)

Sets the direction of the encoder signal in encoder mode.

This function can only be used after configuring the encoder source with SetEncoderSource(..., IOScheduler::IO_SCHEDULER_ENC_EDGE_MODE_AB_ENCODER).

Parameters
EncoderDirEncoder direction
Returns
true for success, use VIBSystem::GetLastErrorString() for an error description

◆ SetEncoderSource()

bool VIB::IOScheduler::SetEncoderSource ( const IOScheduler::IO_SCHEDULER_ENC_SRC  encSrc,
const IOScheduler::IO_SCHEDULER_ENC_EDGE_MODE  encMode 
)

Selects the source signal for encoder mode.

Depending on the edge mode, one signal (A) or two phase signals (A, B) of a rotary encoder are used to update the encoder counter.

Parameters
encSrcSelect the source for encoder signal A, signal B will be (encSrc+1)
encModeSpecifies the edge mode, when and how to update the counter
Returns
true for success, use VIBSystem::GetLastErrorString() for an error description

◆ SetOutputPulsTiming()

bool VIB::IOScheduler::SetOutputPulsTiming ( const unsigned int  Delay_us,
const unsigned int  OnTime_us 
)

Configures the output delay and hold time.

A delay can be specified after which the output value of the buffer entry gets transferred to the output of the I/O Scheduler.

A non-zero hold time will automatically set the output to low after the specified time. If the hold time is zero (default), the outputs have to be set explicitly to low by pushing a 0 bit with the desired location into the buffer.

Parameters
Delay_usDelay for activating the outputs in microseconds (0...1 s), default: 0
OnTime_usHold time for the output signal in microseconds (0...1 s), 0 for infinite, default: 0
Returns
true for success, use VIBSystem::GetLastErrorString() for an error description

◆ SetTriggerSource()

bool VIB::IOScheduler::SetTriggerSource ( const unsigned int  InputIndex,
const bool  InvertInput 
)

Selects the Multiplexer output signal to be used as trigger event.

The signal is used for the trigger counter in triggered mode, but it can also be used in encoder and timer mode in order trigger a copy of the counter values.

Parameters
InputIndexIndex of the Multiplexer output
InvertInputSignal polarity
Returns
true for success, use VIBSystem::GetLastErrorString() for an error description

◆ Start()

bool VIB::IOScheduler::Start ( )

Starts the I/O Scheduler logic within the FPGA.

Returns
true for success, use VIBSystem::GetLastErrorString() for an error description
VIB::Multiplexer::MUX_SRC_SYNC_2
@ MUX_SRC_SYNC_2
SYNC group 0, signal 2.
Definition: VIB_Interface.h:760
VIB::IOScheduler::IO_SCHEDULER_ENC_EDGE_MODE_AB_ENCODER
@ IO_SCHEDULER_ENC_EDGE_MODE_AB_ENCODER
Counter increments or decrements depending on the encoder direction and the configured direction,...
Definition: VIB_Interface.h:881
VIB::DigitalOutput::DIG_OUT_SRC_MUX_OUT0
@ DIG_OUT_SRC_MUX_OUT0
Multiplexer Output 0.
Definition: VIB_Interface.h:466
VIB::DigitalOutput::DIG_OUT_SRC_MUX_OUT1
@ DIG_OUT_SRC_MUX_OUT1
Multiplexer Output 1.
Definition: VIB_Interface.h:467
VIB::IOScheduler::IO_SCHEDULER_ENC_SRC_SYNC_0_0
@ IO_SCHEDULER_ENC_SRC_SYNC_0_0
SYNC Unit 0 Input 0.
Definition: VIB_Interface.h:844
VIB::DigitalOutput::SetSource
bool SetSource(unsigned int BitIndex, OUT_SOURCE Source, bool InvertOutput)
Sets the source for the specified output signal.
Definition: DigitalOutput.cpp:183
VIB::IOScheduler::SetCounterResetSource
bool SetCounterResetSource(const IOScheduler::IO_SCHEDULER_RST_SRC rstSrc, const bool InvertInput, const bool EdgeSensitive)
Selects and configures the signal to reset the counters.
Definition: IOScheduler.cpp:622
VIB::Multiplexer::MUX_SRC_IOSCHEDULER_0_OUT0
@ MUX_SRC_IOSCHEDULER_0_OUT0
IOScheduler unit 0, output 0.
Definition: VIB_Interface.h:766
VIB::Multiplexer::MUX_SRC_SYNC_0
@ MUX_SRC_SYNC_0
SYNC group 0, signal 0.
Definition: VIB_Interface.h:758
VIB::IOScheduler::IO_SCHEDULER_ENC_EDGE_MODE
IO_SCHEDULER_ENC_EDGE_MODE
Encoder edge detection mode, used by SetEncoderSource()
Definition: VIB_Interface.h:876
VIB::IOScheduler::SetOutputPulsTiming
bool SetOutputPulsTiming(const unsigned int Delay_us, const unsigned int OnTime_us)
Configures the output delay and hold time.
Definition: IOScheduler.cpp:641
VIB::IOScheduler
This class controls the I/O Scheduler which allows to store and emit output signals in hard real-time...
Definition: VIB_Interface.h:823
VIB::DigitalOutput::OUT_SOURCE
OUT_SOURCE
Sources for the digital outputs, used with SetSource()
Definition: VIB_Interface.h:464
VIB::Multiplexer::ConnectOutput
bool ConnectOutput(unsigned int OutputIndex, Multiplexer::MUX_SOURCE Source)
Selects the source signal for the specified output line.
Definition: Multiplexer.cpp:428
VIB::IOScheduler::IO_SCHEDULER_CMP_SRC_TRIGGER
@ IO_SCHEDULER_CMP_SRC_TRIGGER
Trigger mode, signal can selected via SetTriggerSource()
Definition: VIB_Interface.h:836
VIB::IOScheduler::GetBufferFillLevel
bool GetBufferFillLevel(unsigned int &BufferFillLevel)
Returns the number of valid entries in the circular buffer.
Definition: IOScheduler.cpp:707
VIB::TriggerGenerator::ConfigureSet
bool ConfigureSet(const char Command[])
Generic function for controlling the FPGA trigger unit.
Definition: TriggerGenerator.cpp:632
VIB::IOScheduler::IO_SCHEDULER_RST_SRC_MUX_OUT0
@ IO_SCHEDULER_RST_SRC_MUX_OUT0
Multiplexer Output 0.
Definition: VIB_Interface.h:896
VIB::Multiplexer::MUX_SRC_IOSCHEDULER_0_OUT1
@ MUX_SRC_IOSCHEDULER_0_OUT1
IOScheduler unit 0, output 1.
Definition: VIB_Interface.h:767
VIB::IOScheduler::SetTriggerSource
bool SetTriggerSource(const unsigned int InputIndex, const bool InvertInput)
Selects the Multiplexer output signal to be used as trigger event.
Definition: IOScheduler.cpp:572
VIB::IOScheduler::SetCounterFreeze
bool SetCounterFreeze(const bool boFreezed)
Freezes the counters and counter copy registers.
Definition: IOScheduler.cpp:544
VIB::IOScheduler::IO_SCHEDULER_ENC_EDGE_MODE_AB_BOTH
@ IO_SCHEDULER_ENC_EDGE_MODE_AB_BOTH
Counter increments on both edges for both encoder signals.
Definition: VIB_Interface.h:880
VIB::IOScheduler::IO_SCHEDULER_CMP_SRC_ENCODER
@ IO_SCHEDULER_CMP_SRC_ENCODER
Encoder mode, can be configured with SetEncoderSource() and SetEncoderDirection()
Definition: VIB_Interface.h:837
VIB::DigitalOutput
This class controls a group of digital output signals.
Definition: VIB_Interface.h:459
VIB::IOScheduler::IO_SCHEDULER_RST_SRC_OFF
@ IO_SCHEDULER_RST_SRC_OFF
static off
Definition: VIB_Interface.h:894
VIB::TriggerGenerator
This class controls the FPGA Trigger Unit.
Definition: VIB_Interface.h:710
VIB::IOScheduler::PushValue
bool PushValue(const unsigned int CompareValue, const unsigned int OutputValue)
Pushes a new entry into the circular buffer within the FPGA.
Definition: IOScheduler.cpp:682
VIB::Multiplexer::MUX_SRC_TRIGGEN_OUT0
@ MUX_SRC_TRIGGEN_OUT0
TriggerGenerator output 0.
Definition: VIB_Interface.h:762
VIB::IOScheduler::IO_SCHEDULER_ENC_EDGE_MODE_A_BOTH
@ IO_SCHEDULER_ENC_EDGE_MODE_A_BOTH
Counter increments on rising and falling edge of the first signal.
Definition: VIB_Interface.h:879
VIB::IOScheduler::IO_SCHEDULER_ENCODER_DIR_NORMAL
@ IO_SCHEDULER_ENCODER_DIR_NORMAL
Normal encoder direction.
Definition: VIB_Interface.h:887
VIB::Multiplexer
This class controls the Multiplexer unit which connects signal sources and sinks with each other.
Definition: VIB_Interface.h:733
VIB::DigitalOutput::DIG_OUT_SRC_MUX_OUT2
@ DIG_OUT_SRC_MUX_OUT2
Multiplexer Output 2.
Definition: VIB_Interface.h:468
VIB::DigitalOutput::DIG_OUT_SRC_MUX_OUT3
@ DIG_OUT_SRC_MUX_OUT3
Multiplexer Output 3.
Definition: VIB_Interface.h:469
VIB::IOScheduler::Start
bool Start()
Starts the I/O Scheduler logic within the FPGA.
Definition: IOScheduler.cpp:498
VIB::IOScheduler::Reset
bool Reset()
Resets the I/O Scheduler logic.
Definition: IOScheduler.cpp:526
VIB::IOScheduler::SetAutomaticRequeueMode
bool SetAutomaticRequeueMode(const bool boAutoRequeue)
If automatic requeue mode is enabled, used output values will be added to the circular buffer again.
Definition: IOScheduler.cpp:665
VIB::IOScheduler::IO_SCHEDULER_ENC_EDGE_MODE_A_FALLING
@ IO_SCHEDULER_ENC_EDGE_MODE_A_FALLING
Counter increments on the falling edge of the first signal.
Definition: VIB_Interface.h:878
VIB::IOScheduler::SetEncoderSource
bool SetEncoderSource(const IOScheduler::IO_SCHEDULER_ENC_SRC encSrc, const IOScheduler::IO_SCHEDULER_ENC_EDGE_MODE encMode)
Selects the source signal for encoder mode.
Definition: IOScheduler.cpp:591
VIB::Multiplexer::MUX_SRC_SYNC_1
@ MUX_SRC_SYNC_1
SYNC group 0, signal 1.
Definition: VIB_Interface.h:759
VIB::Multiplexer::MUX_SRC_IOSCHEDULER_1_OUT0
@ MUX_SRC_IOSCHEDULER_1_OUT0
IOScheduler unit 1, output 0.
Definition: VIB_Interface.h:768
VIB::IOScheduler::SetCompareSource
bool SetCompareSource(const IOScheduler::IO_SCHEDULER_CMP_SRC cmpSrc)
Selects the counter which is compared against the current trigger value.
Definition: IOScheduler.cpp:557
VIB::iDevice::Open
bool Open(unsigned int Index=0)
Opens a device
Definition: iDevice.cpp:109
VIB::Multiplexer::MUX_SRC_OFF
@ MUX_SRC_OFF
static off
Definition: VIB_Interface.h:744
VIB::IOScheduler::IO_SCHEDULER_ENC_EDGE_MODE_A_RISING
@ IO_SCHEDULER_ENC_EDGE_MODE_A_RISING
Counter increments on the rising edge of the first signal.
Definition: VIB_Interface.h:877