PN_API_IOD_addDiagGeneric()

uint32_t PN_API_IOD_addDiagGeneric	(	PN_API_IOD_Handle_t *const	pnHandle,
		const uint32_t	api,
		PN_API_IOD_DevAddr_t *const	addr,
		const uint16_t	chanNum,
		const PN_API_IOD_DiagChannelPropDirection_t	chanDir,
		const PN_API_IOD_DiagChannelPropType_t	chanTyp,
		const uint16_t	diagTag,
		const uint16_t	userStructIdent,
		uint8_t *const	pInfoData,
		const uint32_t	infoDataLen,
		const bool	maintenanceReq,
		const bool	maintenanceDem
	)

Add generic channel diagnostic alarm to PN stack.

Installs a manufacturer-specific diagnostic record within a subslot. The diagnostic data can be retrieved using a distinct record call (as described in IEC61158-5-10), such as through a diagnostic tool. Multiple diagnostic records associated with a user-specified tag can be transferred to asubslot. The diagnostic record can be deleted using the PN_API_IOD_removeDiagGeneric() function via this reference. If the device assumes ownership of this subslot within an AR, a 'manufacturer specific incoming alarm' is automatically dispatched to the IO controller.

Parameters

[in]	pnHandle	Profinet API Handle.
[in]	api	Application Process Identifier.
[in]	addr	Geographical address (slot/subslot) of the module/submodule.
[in]	chanNum	Channel number.
[in]	chanDir	Channel direction (see PN_API_IOD_DiagChannelPropDirection_t).
[in]	chanTyp	Channel type (see PN_API_IOD_DiagChannelPropType_t).
[in]	diagTag	User defined diag tag != 0.
[in]	userStructIdent	Manufacturer specific, 0...0x7fff, see IEC 61158.
[in]	pInfoData	User defined generic diagnostic data.
[in]	infoDataLen	Length of generic diagnostic data.
[in]	maintenanceReq	Maintenance required.
[in]	maintenanceDem	Maintenance demanded.

Returns

result of the operation as uint32_t.

Return values

PN_API_OK	Success.
PN_API_NOT_OK	Something went wrong.
PN_API_ERR_PARAM	Invalid parameter.

Example

#include "pn_api_iod_diagnostic.h"
#include "pn_api_iod_startup.h"
 
PN_API_IOD_Handle_t* pnHandle = NULL;
uint32_t status;
 
pnHandle = PN_API_IOD_new();
 
//Prepare and call PN_API_IOD_startup()
...
 
uint32_t api = 0;
uint16_t diagTag = 1;
PN_API_IOD_DevAddr_t addr;
PN_API_IOD_DiagChannelPropDirection_t chanDir = PN_API_IOD_DiagChannelPropDirectionIn;
PN_API_IOD_DiagChannelPropType_t chanTyp = PN_API_IOD_DiagChannelPropTypeByte;
uint16_t userStructIdent = ..; // look at IEC61158-5-10/
uint16_t infoDataLen = ..; // look at IEC61158-5-10/
uint16_t pInfoData = ..; // look at IEC61158-5-10/
uint16_t chanNum = 1;
bool maintenanceReq = 1;
bool maintenanceDem = 0;
addr.type = PN_API_IOD_AddrGeo;
addr.address.geo.slot = 1;
addr.address.geo.subslot = 2;
 
status = PN_API_IOD_addDiagGeneric(pnHandle, api, &addr, chanNum,
   chanDir, chanTyp, diagTag, userStructIdent, pInfoData,
   infoDataLen, maintenanceReq, maintenanceDem);