PN_API_IOD_startLedBlinkCbf

typedef uint32_t(* PN_API_IOD_startLedBlinkCbf) (PN_API_IOD_Handle_t *const pnHandle, const uint32_t portNum, const uint32_t frequency)

Callback function prototype to request the start of LED blinking.

This function is called by Profinet stack to request from the user application to start blinking the LED with a specific frequency. This usually happens in response to LED blinking DCP requests.

Warning

For now, LED blinking lasts for 3 seconds only. Afterwards, the stack automatically asks the user application to stop LED blinking using PN_API_IOD_stopLedBlinkCbf().

Parameters

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

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_cbStartLedBlink(
   PN_API_IOD_Handle_t *const pnHandle,
   const uint32_t portNum, const uint32_t frequency)
{...}
 
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 = {
    .startLedBlink = PN_APP_IOD_cbStartLedBlink,
    ...}
 
//Register callback function
status = PN_API_IOD_registerCallbacks(pnHandle, &callbacks);