Communication

Overview

Functions and callback-prototypes needed to handle ARs.

Typedefs
typedef void(*	PN_API_IOD_reportArFsuRecordCbf) (PN_API_IOD_Handle_t *const pnHandle, const uint8_t arFsuEnabled, const uint8_t arFsuChanged)
	Callback function prototype to notify the user application about an AR FSU update.
typedef void(*	PN_API_IOD_readyForInputUpdateCbf) (PN_API_IOD_Handle_t *const pnHandle, const uint16_t arNum, const PN_API_IOD_InputUpdateState_t inputUpdateState)
	Callback function prototype to notify the user application that the stack is ready to receive the first valid input data.
typedef void(*	PN_API_IOD_arConnectCbf) (PN_API_IOD_Handle_t *const pnHandle, PN_API_IOD_ArType_t arType, uint32_t arNum, uint16_t sessionKey, uint16_t sendClock, uint16_t redRatioIoCrIn, uint16_t redRatioIoCrOut, uint32_t hostIpAddr)
	Callback function prototype to notify the user application that a new connection to an IO controller has been established.
typedef void(*	PN_API_IOD_arDisconnCbf) (PN_API_IOD_Handle_t *const pnHandle, const uint16_t arNum, const uint16_t sessionKey, const PN_API_IOD_ArReason_t reasonCode)
	Callback function prototype to notify the user application that an AR connection with the IO controller has been terminated.
typedef void(*	PN_API_IOD_arOwnershipCbf) (PN_API_IOD_Handle_t *const pnHandle, uint32_t arNum, PN_API_IOD_Exp_t *ownSubmod)
	Callback function prototype to inform the user application about the submodule configuration assumed by the IO controller and to ask the IO device to claim the ownership of these submodules.
typedef PN_API_IOD_SubmodStatus_t(*	PN_API_IOD_paramEndCbf) (PN_API_IOD_Handle_t *const pnHandle, const uint16_t arNum, const uint16_t sessionKey, const uint32_t api, const uint16_t slot, const uint16_t subslot, const bool moreFollows)
	Callback function prototype to notify the user application that the parameter assignment for all modules has been completed.

Functions
uint32_t	PN_API_IOD_arAbort (PN_API_IOD_Handle_t *const pnHandle, uint32_t arNum)
	A running application relationship to a PROFINET controller is terminated by this function.
PN_API_IOD_ArType_t	PN_API_IOD_arGetType (PN_API_IOD_Handle_t *const pnHandle, uint16_t arNum)
	Retrieves an application relation's type.
#define	PN_API_IOD_ARFSU_ENABLED   0x01
	FSU enabled.
#define	PN_API_IOD_ARFSU_DISABLED   0x00
	FSU disabled.
#define	PN_API_IOD_ARFSU_CHANGED   0x01
	ARFSU_UUID changed in NV memory.
#define	PN_API_IOD_ARFSU_NOT_CHANGED   0x00
	ARFSU_UUID not changed in NV memory.