PN_API_IOD_plugSubmod()

uint32_t PN_API_IOD_plugSubmod	(	PN_API_IOD_Handle_t *const	pnHandle,
		uint32_t	api,
		PN_API_IOD_DevAddr_t *	addr,
		uint32_t	modId,
		uint32_t	submodId,
		uint32_t	inDataLen,
		uint32_t	outDataLen,
		uint8_t	im0Support,
		PN_API_IOD_Im0Data_t *	im0Data,
		uint8_t	iopsInitVal
	)

Inserts a submodule into a subslot.

During operation, this function can be invoked to add a new submodule or re-install a previously failed or removed submodule.

Warning

PN_API_IOD_startup() must be called first during startup to insert the DAP and PDev data at least. Only then may additional modules be plugged in.

Parameters

[in]	pnHandle	Profinet API Handle.
[in]	api	Application Process Identifier.
[in]	addr	Geographical address (slot/subslot) of the module/submodule.
[in]	modId	Module identifier.
[in]	submodId	Submodule identifier.
[in]	inDataLen	Length of input data.
[in]	outDataLen	Length of output data.
[in]	im0Support	Type of IM0 support (see PN_API_IOD_Im0Support_t).
[in]	im0Data	If the module supports IM0, there is a pointer to the IM0 data here.
[in]	iopsInitVal	Initial value for IOPS-input, used for submodules without IO data (e.g. PDev) which act like input modules with data length of 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_device.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, modId = 0x03010300, submodId = 0x31030004;
uint32_t inDataLen = 4, outDataLen = 0;
uint8_t im0Support = PN_API_IOD_Im0Submodule;
uint8_t iopsInitVal = 0;
PN_API_IOD_Im0Data_t im0Data; //Fill up this array with the
                              //own data
PN_API_IOD_DevAddr_t addr;
addr.type = PN_API_IOD_AddrGeo;
addr.address.geo.slot = 1;
addr.address.geo.subslot = 2;
 
status = PN_API_IOD_plugSubmod(pnHandle, api, &addr, modId
   submodId, inDataLen, outDataLen, im0Support, im0Data, iopsInitVal);