Aim MIL-STD-1553 - Apicmdrtsamsgread

MIL-STD-1553 Reference Manual
311
Chapter 8 – Remote Terminal Functions
8.1.22 ApiCmdRTSAMsgRead
Prototype:
AiInt16 ApiCmdRTSAMsgRead ( AiUInt32 ul_ModuleHandle, AiUInt8 biu, AiUInt8 rt_addr,
AiUInt8 sa, AiUInt8 sa_type, AiUInt8 clr,
TY_API_RT_SA_MSG_DSP *psa_dsp );
Driver Command:
API_RT_SA_MSG_READ (0x9C)
Purpose:
This function is used to read the execution status of the specified RT
Subaddress/Mode code of the selected AIM board Remote Terminal (identified by its
RT Address).
I
I
n
n
p
p
u
u
t
t
A
A
i
i
U
U
I
I
n
n
t
t
8
8
r
r
t
t
_
_
a
a
d
d
d
d
r
r
Value
Description
0..31
Remote Terminal Address
A
A
i
i
U
U
I
I
n
n
t
t
8
8
s
s
a
a
Mode
Value
Description
Subaddress
1..30
RT Subaddress
ModeCode
0..31
Mode code Number
A
A
i
i
U
U
I
I
n
n
t
t
8
8
s
s
a
a
_
_
t
t
y
y
p
p
e
e
Subaddress Type
Value
Constant
Description
0
API_RT_TYPE_RECEIVE_SA
Receive Subaddress
1
API_RT_TYPE_TRANSMIT_SA
Transmit Subaddress
2
API_RT_TYPE_RECEIVE_MODECODE
Receive Mode code
3
API_RT_TYPE_TRANSMIT_MODECODE
Transmit Mode code
A
A
i
i
U
U
I
I
n
n
t
t
8
8
c
c
l
l
r
r
Buffer Status Flag Control
Value
Constant
Description
0
API_DONT_MODIFY_STATUS_BITS
Do not modify Buffer
Status bits
1
API_RESET_STATUS_BITS
Reset Buffer Status bits to
‘Buffer not used’ state
2
API_RESET_ERROR_BITS
Reset Buffer Error bits to ‘No
error’ state
3
API_RESET_ERR_STAT_BITS
Reset Buffer Status bits to ‘Buffer
not used’ state and Buffer Error
bits to ‘No error’ state