PN_API_IOD_addDiagChannel()

uint32_t PN_API_IOD_addDiagChannel	(	PN_API_IOD_Handle_t *const	pnHandle,
		const uint32_t	api,
		PN_API_IOD_DevAddr_t *const	addr,
		const uint16_t	channelNum,
		const uint16_t	errorNum,
		const PN_API_IOD_DiagChannelPropDirection_t	chanDir,
		const PN_API_IOD_DiagChannelPropType_t	chanTyp,
		const bool	maintenanceReq,
		const bool	maintenanceDem,
		const uint16_t	diagTag
	)

Add channel diagnostic alarm to PN stack.

Installs a diagnostic record into a subslot. When the device is the owner of this subslot in an AR, a 'Diagnostic alarm - incoming' is automatically dispatched to the IO controller. The PN_API_IOD_removeDiagChannel() function can be utilized to eliminate the diagnostic record once the issue is resolved. The 'diagTag' value is a user-defined variable <> 0, serving to differentiate between various alarms for a single subslot that are concurrently valid. Therefore, it must always remain unique within one subslot. If only one alarm can be accessible at a given time, a constant value (e.g. 1) can be employed. Otherwise, the application is responsible for managing 'diagTag' values and ensuring their uniqueness within this subslot.

Parameters

[in]	pnHandle	Profinet API Handle.
[in]	api	Application Process Identifier.
[in]	addr	Geographical address (slot/subslot) of the module/submodule.
[in]	channelNum	Channel number.
[in]	errorNum	Error number, see PNIO specification coding of "ChannelErrorType".
[in]	chanDir	Channel direction (see PN_API_IOD_DiagChannelPropDirection_t).
[in]	chanTyp	Channel type (see PN_API_IOD_DiagChannelPropType_t).
[in]	maintenanceReq	Maintenance required.
[in]	maintenanceDem	Maintenance demanded.
[in]	diagTag	User defined diag tag != 0.

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 channelNum = 1;
uint16_t errorNum;
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;
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_addDiagChannel(pnHandle, api, &addr, channelNum
   errorNum, chanDir, chanTyp, maintenanceReq, maintenanceDem, diagTag);