Ethernet Module Interface (EMI)
– API Description
Copyright IXXAT Automation GmbH
58
IEM Manual, 1.5
4.1.2.13 EMI_cmdChannelStart()
COM_e_ERROR EMI_cmdChannelStart(COM_t_BOARD_REF td_brdRef, BOOL o_blocking);
Description
This function starts the bus protocol and enables/forces it into the normal bus
operation mode. The Industrial Ethernet Module becomes an active participant
of the bus. The CMD channel is used for the transmission of this service. The
state of the MSM on both devices is updated. The function is blocked waiting
on the response if the o_blocking is TRUE, otherwise the application has to
query for the response by means of EMI_cmdCommandRespQuery.
Remarks
EMI_cmdChannelStart can only be called after a successful call of
EMI_cmdChannelOpen.
Parameter
Dir.
Description
td_brdRef
IN
unique IEM reference
o_blocking
IN
blocking/non-blocking execution
Return Value
Description
COM_k_OK
channel enabled for normal operation
COM_k_BUSY
BCC busy
COM_k_INVALID_BOARD
invalid IEM reference
COM_k_INVALID_STATE
routine called in invalid state
COM_k_ERROR
wrong board handle or error response
4.1.2.14 EMI_cmdChannelStop()
COM_e_ERROR EMI_cmdChannelStop(COM_t_BOARD_REF td_brdRef, BOOL o_blocking);
Description
This function forces the bus protocol stack on the IEM into the inactive state.
The module is no longer active on the bus. It can be restarted at any time by
calling EMI_cmdChannelStart. The CMD channel is used for the transmission
of this service. The state of the MSM on both devices is updated. The function
is blocked waiting on the response if the o_blocking is TRUE, otherwise the
application
has
to
query
for
the
response
by
means
of
EMI_cmdCommandRespQuery.