5 — VEHICLE CONTROL LANGUAGE (VCL)
pg. 103
Curtis Model 1351 – December 2018
function
Setup_Recieve_Mailbox_Timeout()
Setup a timeout fault, trigger
Setup a timeout fault that is active if this mailbox does not receive new data within
the Timeout period
Usage example: set a fault if a slave controller/device fails to send data to the 1351
master controller. Critical data that is not received within a given time period
triggers a fault.
syntax
S e t u p _ R e c i e v e _ M a i l b o x _ T i m e o u t ( H a n d l e , F i r s t _
Timeout,Cycle_Timeout)
arguments:
Handle
Holds the ID of the mailbox
First_Timeout
0 = NO_TIMEOUT
Non-zero is the maximum time (in milliseconds)
allowed for the first message to be received after the
mailbox is enabled.
After this first timeout is triggered, a timeout flag
is set in the OS. This flag can be viewed by the VCL
Function,
Check_RX_Mailbox_Status()
If the mailbox has timed out, it will no longer receive
data.
Cycle_Timeout
0 = N0_TIMEOUT
Non-zero is the maximum time (in milliseconds)
allowed between receptions
After this timeout is triggered, a timeout flag is set in
the OS. This flag can be viewed by the VCL Function,
Check_RX_Mailbox_Status()
If the mailbox has timed out, it will no longer receive
data.
returns:
0
Mailbox not setup
1
Mailbox setup
reported errors:
Bad_ID
Handle out of Range
BAD_MO_ID
Message ID is NOT unique
