Machinekit Documentation

HAL Component — RINGWRITE

NAME

ringwrite — demonstrate wring write operations

SYNOPSIS

ringwrite

USAGE SYNOPSIS

loadrt ringwrite

DESCRIPTION

Demonstration of ringwrite operations

Will output

    Number of messages
    Number of failed writes
    Number of dropped writes


=== FUNCTIONS

*ringwrite.N*
(requires a floating-point thread)



=== PINS

*write* bit in  - send a message on pin transition

*sent* u32 out  - number of messages written

*overrun* u32 out  - number of failed write attempts

*dropped* u32 out  - number of records deleted when writing to full buffer

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




=== LICENCE

GPLv2 or later