PN_API_IOD_sendUploadRetrievalAlarm()

uint32_t PN_API_IOD_sendUploadRetrievalAlarm	(	PN_API_IOD_Handle_t *const	pnHandle,
		const uint32_t	api,
		PN_API_IOD_DevAddr_t *const	addr,
		uint8_t *const	data,
		const uint32_t	dataSize,
		const uint32_t	userHandle
	)

This function sends an event to a central parameter server. As a result of this event, the server runs a record read service to retrieve a set of parameters from the device or a record write service to transmit a set of parameters to it. Part of the alarm data header indicates which record index is being utilized and whether the data is intended to be written or read.

Parameters

[in]	pnHandle	Profinet API Handle.
[in]	api	Application Process Identifier.
[in]	addr	Geographical address (slot/subslot) of the module/submodule.
[in]	data	Alarm data.
[in]	dataSize	Size of alarm data in bytes.
[in]	userHandle	User defined handle.

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_alarm.h"
 
PN_API_IOD_Handle_t* pnHandle = NULL;
uint32_t status, api = 0, userHandle = 0;
PN_API_IOD_DevAddr_t addr;
addr.Type = PN_API_IOD_AddrGeo;
addr.address.geo.slot = 0;
addr.address.geo.subslot = 0;
uint8_t buf[64];
uint8_t bufSize = 64:
 
pnHandle = PN_API_IOD_new();
 
status = PN_API_IOD_sendUploadRetrievalAlarm(pnHandle, api, &addr, &buf, bufSize, userHandle);