Machinekit Documentation

HAL Component — MESSAGE

INSTANTIABLE COMPONENTS — General

All instantiable components can be loaded in two manners

Using loadrt with or without count= | names= parameters as per legacy components
Using newinst, which names the instance and allows further parameters and arguments
primarily pincount= which can set the number of pins created for that instance (where applicable)

NAME

message — Display a message

SYNOPSIS

message

USAGE SYNOPSIS

loadrt message
OR
newinst message <newinstname> [ pincount=N | iprefix=prefix ] [instanceparamX=X | argX=X ]

( args in [ ] denote possible args and parameters, may not be used in all components )

DESCRIPTION

Allows HAL pins to trigger a message.

FUNCTIONS

message.N.funct ( OR <newinstname>.funct )

Display a message when triggered

PINS

message.N.trigger bit in (default: false) ( OR <newinstname>.trigger bit in (default: false) ) - signal that triggers the message

message.N.force bit in (default: false) ( OR <newinstname>.force bit in (default: false) ) - FALSE→TRUE transition forces message redisplay

message.N.edge bit io (default: true) ( OR <newinstname>.edge bit io (default: true) ) - Selects desired edge: TRUE = falling, FALSE = rising

message.N.message-num s32 in (default: 0) ( OR <newinstname>.message-num s32 in (default: 0) ) - Required message number

LICENCE

GPL v2