README.md 697 Bytes
Newer Older
1
# Metronome
Simon Spannagel's avatar
Simon Spannagel committed
2
**Maintainer**: Simon Spannagel (<simon.spannagel@cern.ch>)  
3
**Module Type**: *GLOBAL*  
Simon Spannagel's avatar
Simon Spannagel committed
4
5
**Status**: Functional  

6
### Description
Simon Spannagel's avatar
Simon Spannagel committed
7
8
9
10
The `Metronome` module is can be used to slice data without strict event structure in arbitrarily long time slots, which serve as events for subsequent modules. This is done by configuring an event length and by setting the variables `eventStart` and `eventStop` on the clipboard.

Subsequent modules should read these values and adhere to them.

11
### Parameters
Simon Spannagel's avatar
Simon Spannagel committed
12
* `event_length`: Length of the event to be defined in physical units (not clock cycles of a specific device). Default value is `10us`.
Simon Spannagel's avatar
Simon Spannagel committed
13

14
### Usage
Simon Spannagel's avatar
Simon Spannagel committed
15
16
17
18
```toml
[Metronome]
eventLength = 500ns
```