PN_API_IOD_setDeviceState()

uint32_t PN_API_IOD_setDeviceState	(	PN_API_IOD_Handle_t *const	pnHandle,
		uint32_t	devState
	)

Sets the IO device state to either "operate" or "clear".

During startup, this function should be invoked once to transition the IO device to the "operate" state. When called with the "clear" option, all IO submodules retain their "superordinated locked" state until another call with the "operate" option is made. Each invocation of this function terminates any ongoing AR. The initial invocation with the "operate" option doesn't need to be performed separately, as its call is currently incorporated within PN_API_IOD_startup().

Warning

Resetting to "clear" can signal a critical device error, causing valid IO data no longer to be processed. Therefore, only use this function in exceptional cases.

Parameters

[in]	pnHandle	Profinet API Handle.
[in]	devState	DEVICE_STATE_OPERATE or DEVICE_STATE_CLEAR.

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()
...
 
status = PN_API_IOD_setDeviceState(pnHandle, DEVICE_STATE_CLEAR);