PN_API_IOD_removeDiagChannel()

uint32_t PN_API_IOD_removeDiagChannel	(	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 uint16_t	diagTag,
		const uint16_t	alarmState
	)

Remove channel diagnostic alarm to PN stack.

Removal of a diagnostic record previously added using PN_API_IOD_addDiagChannel(). The same values must be provided for referencing as in the corresponding PN_API_IOD_addDiagChannel() call. When the device owns this subslot in an AR, an 'Outgoing Diagnostic Alarm' is automatically transmitted to the IO controller. The 'alarmState' parameter determines whether additional diagnostic entries are accessible for the same channel. If 'channelNum' is equal to 0x8000, the diagnostic entry remains valid for the entire submodule, and the 'alarmState' value is also applicable to the complete submodule.

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]	diagTag	User defined diag tag != 0.
[in]	alarmState	PN_API_IOD_DiagChannelPropSpecErrDisappear, PN_API_IOD_DiagChannelPropSpecErrDisappearMore.

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()
//add a a diagnostic channel with PN_API_IOD_addDiagChannel()
...
 
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;
uint16_t alarmState = PN_API_IOD_DiagChannelPropSpecErrDisappear;
addr.type = PN_API_IOD_AddrGeo;
addr.address.geo.slot = 1;
addr.address.geo.subslot = 2;
 
status = PN_API_IOD_removeDiagChannel(pnHandle, api, &addr, channelNum
   errorNum, chanDir, chanTyp, diagTag, alarmState);