Aim MIL-STD-1553 - Apicmdbminimsgfltrec

MIL-STD-1553 Reference Manual
336
Chapter 9 – Bus Monitor Functions
9.1.10 ApiCmdBMIniMsgFltRec
Prototype:
AiInt16 ApiCmdBMIniMsgFltRec ( AiUInt32 ul_ModuleHandle, AiUInt8 biu, AiUInt8 cnt,
TY_API_BM_INI_MSG_FLT_REC *pmrec );
Driver Command:
API_BM_INI_MSG_FLT_REC (0xC8)
Purpose:
This function is used to setup the BM Message Filter Recording according to the
specified Filter Command Words and data word positions when the Bus Monitor is
setup in Message Filter Recording mode (see ApiCmdBMCapMode library
function). Together with the ApiCmdBMReadMsgFltRec instruction this function can
be used to implement a Message Filter Recording with output formats which are
described in the following section.
Note: For RT-RT transfers the first Command Word shall be specified as the Filter
Command Word. If a single data word is required from the message specified
in ‘cw’ the value of ‘pos1’ shall be set to the value of ‘pos2’. Values of ‘pos1’
or ‘pos2’ which do not match the Word Count range of the corresponding
Command Word are returning a negative acknowledge character (NAK). Note
that this function will override the initial settings from library function
ApiCmdBMFilterIni’.
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
n
n
t
t
Value
Description
1..255
Amount of Filter Command Words
T
T
Y
Y
_
_
A
A
P
P
I
I
_
_
B
B
M
M
_
_
I
I
N
N
I
I
_
_
M
M
S
S
G
G
_
_
F
F
L
L
T
T
_
_
R
R
E
E
C
C
*
*
p
p
m
m
r
r
e
e
c
c
BM Message Filter Recording setup structure
typedef struct ty_api_bm_ini_msg_flt_rec
{
AiUInt16 cw;
AiUInt8 pos1;
AiUInt8 pos2;
} TY_API_BM_INI_MSG_FLT_REC;
A
A
i
i
U
U
I
I
n
n
t
t
1
1
6
6
c
c
w
w
Filter Command Word (MS-Byte first)
A
A
i
i
U
U
I
I
n
n
t
t
8
8
p
p
o
o
s
s
1
1
Value
Description
1..Word Count Field of CW
First Data Word position in message ‘cw’
32
If Word Count Field is 0