Machinekit Documentation

HAL Component — RINGREAD

NAME

ringread — demonstrate ring read operations

SYNOPSIS

ringread

USAGE SYNOPSIS

loadrt ringread

DESCRIPTION

Demonstartion of ringread operations

Will output

Number of underruns
Number of successful reads
Number of times writer outstripped the reader

FUNCTIONS

ringread.N (requires a floating-point thread)

PINS

underrun u32 out - number of failed read attempts

received u32 out - number of successful read attempts

tooslow u32 out - number of times the reader couldnt keep up with the writer

circular bit in - circular flag - set to nonzero to enable circular record buffer

LICENCE

GPLv2 or later