PN_API_IOD_stopLedBlinkCbf

typedef uint32_t( * PN_API_IOD_stopLedBlinkCbf) (PN_API_IOD_Handle_t *const pnHandle, const uint32_t portNum)

Callback function prototype to request the stop of LED blinking.

This function is called by Profinet stack to request from the user application to stop blinking the LED. In order to achieve this, the user application may call PN_API_IOD_ledBlink() with frequency set to zero.

Warning

For now, PN_API_IOD_stopLedBlinkCbf() is automatically called by the stack 3 seconds after PN_API_IOD_startLedBlinkCbf() is called.

Parameters

[in]	pnHandle	Profinet API Handle.
[in]	portNum	Port number (currently not used).

Returns

result of the operation as uint32_t.

Return values

PN_API_OK

Success.

Example

#include "pn_api_iod_bsp.h"
#include "pn_api_iod_callbacks.h"
#include "pn_api_iod_startup.h"
 
//Implement the callback function in the user application
uint32_t PN_APP_IOD_cbStopLedBlink(
   PN_API_IOD_Handle_t *const pnHandle,
   const uint32_t portNum)
{...}
 
PN_API_IOD_Handle_t* pnHandle = NULL;
uint32_t status;
 
pnHandle = PN_API_IOD_new();
 
//Store callback functions implemented by the user application
PN_API_IOD_Callbacks_t callbacks = {
    .stopLedBlink = PN_APP_IOD_cbStopLedBlink,
    ...}
 
//Register callback function
status = PN_API_IOD_registerCallbacks(pnHandle, &callbacks);