OpenViBE Documentation 3.6.0
Clock stimulator

Summary

  • Plugin name : Clock stimulator
  • Version : 1.0
  • Author : Yann Renard
  • Company : INRIA/IRISA
  • Short description : Periodic stimulation generator
  • Documentation template generation date : Jan 24 2024

Description

Triggers stimulation at fixed frequency

This box produces stimulations at specific times depending on
its configuration. The stimulation interval is fixed.

It is important to underline that this box runs as fast as possible
thus producting empty Doc_Streams_Stimulation chunks when needed.

Outputs

1. Generated stimulations

This output contains the generated stimulation stream.

  • Type identifier : Stimulations (0x6f752dd0, 0x082a321e)

Settings

1. Interstimulation interval (in sec)

The first setting \( i \) informs the box how often it should produce stimulations, with \( i > 0 \).

  • Type identifier : Float (0x512a166f, 0x5c3ef83f)
  • Default value : [ 1.0 ]

2. Stimulation

The second setting gives the stimulation code to trigger.

  • Type identifier : Stimulation (0x2c132d6e, 0x44ab0d97)
  • Default value : [ OVTK_StimulationId_Label_00 ]

Examples

In the designer, drag'n drop a Dox_BoxAlgorithm_StimulationListener
and connect it to a clock stimulator box. Configure it to your preferred
active log level, press start and see what happens.

The output should like this : 

[  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33024 (0x8100)[OVTK_StimulationId_Label_00] at date 4294967296 (0x100000000) and duration 0 (0x0)  
[  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33024 (0x8100)[OVTK_StimulationId_Label_00] at date 8589934592 (0x200000000) and duration 0 (0x0)  
[  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33024 (0x8100)[OVTK_StimulationId_Label_00] at date 12884901888 (0x300000000) and duration 0 (0x0)  
...

Miscellaneous

Notice that no stimulation is sent a time 0. The first stimulation to be sent
has the inter stimulation duration as date.