Aim MIL-STD-1553 - Apicmdbmftwini

MIL-STD-1553 Reference Manual
332
Chapter 9 – Bus Monitor Functions
9.1.6 ApiCmdBMFTWIni
Prototype:
AiInt16 ApiCmdBMFTWIni ( AiUInt32 ul_ModuleHandle, AiUInt8 biu, AiUInt8 con,
AiUInt8 htm, AiUInt8 htc, AiUInt8 stm, AiUInt8 stc );
Driver Command:
API_BM_INI_FTW (0xC2)
Purpose:
This function is used to define the BM Function Trigger Word bit patterns to be used
by the BM to identify a Start Trigger Event and/or Stop Trigger Event. The
Start/Stop Trigger Events are used by the BM for Start/Stop of the “Data Capture”.
The Function Trigger pattern specified is compared to the BM’s Monitor Status
Trigger pattern which is set/reset as specified for each trigger with the
ApiBMTCBIni function.
I
I
n
n
p
p
u
u
t
t
A
A
i
i
U
U
I
I
n
n
t
t
8
8
c
c
o
o
n
n
Value
Constant
Description
0
API_BM_WRITE_ALL
Write all bytes
1
API_BM_WRITE_STC
Write ‘stc’ bytes
2
API_BM_WRITE_STM
Write ‘stm’ bytes
3
API_BM_WRITE_HTC
Write ‘htc’ bytes
4
API_BM_WRITE_HTM
Write ‘htm’ bytes
A
A
i
i
U
U
I
I
n
n
t
t
8
8
h
h
t
t
m
m
Stop Trigger Mask pattern
A
A
i
i
U
U
I
I
n
n
t
t
8
8
h
h
t
t
c
c
Stop Trigger Compare pattern
A
A
i
i
U
U
I
I
n
n
t
t
8
8
s
s
t
t
m
m
Start Trigger Mask pattern
A
A
i
i
U
U
I
I
n
n
t
t
8
8
s
s
t
t
c
c
Start Trigger Compare pattern
O
O
u
u
t
t
p
p
u
u
t
t
n
n
o
o
n
n
e
e
Return Value
A
A
i
i
I
I
n
n
t
t
1
1
6
6
All API functions return API_OK if no error occurred. If the return value is not
equal to API_OK the function ApiGetErrorDescription can be used to obtain an
error description.