pingpong.c

Back to Ping-Pong sample application.

#include <configServer.h>    // Config Server header
#include <taskManager.h>
#include <appFramework.h>    // Main stack types
#include <appTimer.h>        // Application timer header
#include <apsMacros.h>
#include <pingpong.h>        // Own application header
#include <uart.h>
#include <uid.h>
#include <aps.h>             // Main APS header
#include <zdo.h>             // Main ZDO header

#ifdef _DBG_
  #include <dbgPort.h>
#endif // _DBG_


/***********************************************************************************
  Local variables
***********************************************************************************/

static DeviceType_t appDeviceType = 0;  // Device type (Router/Coordinator/End device)
static uint8_t dataPayload; // Payload
static uint8_t appPayload[APP_PAYLOAD_SIZE + APS_AFFIX_LENGTH]; // Buffer for application payload
bool fwPacketFlag = false;  // Flag indicating that device is currently forwarding a packet

static AppState_t appState = APP_INITING_STATE; // Current application state
static ZDO_StartNetworkReq_t networkParams; // Request params for ZDO_StartNetworkReq

#ifdef TEST_NETWORK
static HAL_UartDescriptor_t appUartDescriptor; // UART descriptor (required by stack)
#endif // TEST_NETWORK

// Endpoint parameters
static SimpleDescriptor_t simpleDescriptor = {END_POINT, 1, 1, 1, 0, 0 , NULL, 0, NULL};
static APS_RegisterEndpointReq_t endpointParams;

static HAL_AppTimer_t startingNetworkTimer; // Timer indicating starting network
static HAL_AppTimer_t delayFwTimer;         // Timer period of waiting before forwarding packet to next node

static APS_DataReq_t dataReq;        // Request for APS_DataReq primitive

static ShortAddr_t srcAddr;          // Own network address
static ShortAddr_t dstAddr;          // Destination network address

/***********************************************************************************
  Local functions
***********************************************************************************/

static void ZDO_StartNetworkConf(ZDO_StartNetworkConf_t *confirmInfo); // Network start/join confirmation
static void APS_DataInd(APS_DataInd_t *indData); // Data reception handler
static void APS_DataConf(APS_DataConf_t *confInfo);  // Data transmission confirmation handler
static void buttonReleased(uint8_t buttonNumber); // Button release event handler
static void prepareMsgParams(void); // Configures general data message parameters

#ifdef TEST_NETWORK
// UART related functions (only required for test network)
static void uartInit(void);
static void uartSendHeartbeat(void);
static void uartWriteConf(void);
#endif // TEST_NETWORK

/********************************************************************
  Description: Starting network timer has fired. Toggle LED for blink

  Parameters: none.

  Returns: nothing.
********************************************************************/
void startingNetworkTimerFired(void)
{
  appToggleLed(NETWORK_LED);
}

/********************************************************************
  Description: Packet forwarding delay has expired. Forward packet and turn indicating LED off

  Parameters: none.

  Returns: nothing.
********************************************************************/
void delayFwTimerFired(void)
{
  appOnLed(DATA_LED);
  APS_DataReq(&dataReq);
}

/********************************************************************
  Description: Application task handler

  Parameters: none.

  Returns: nothing.
********************************************************************/
void APL_TaskHandler(void)
{
  switch (appState)
  {
    // Node is in initial state
    case APP_INITING_STATE:
    {
      uint64_t extPanId = COORDINATOR_EXT_PANID;
      CS_WriteParameter(CS_EXT_PANID_ID, &extPanId);

#ifdef _DBG_
      configure_dbgu();
#endif // _DBG_

      endpointParams.simpleDescriptor = &simpleDescriptor;

      // Read switches and assign own network address
       //uint8_t dswitch = 0;
      uint8_t dswitch;
      dswitch = appReadSliders() & 7;

      srcAddr = dswitch & 3;

      // If 3rd switch is on then destination address is 0 (coordinator)
      if (dswitch & 4)
        dstAddr = 0;
      else
        dstAddr = srcAddr + 1;

      CS_WriteParameter(CS_NWK_ADDR_ID, &srcAddr); // Assign own NWK address
      // Set device type: logical address equal to 0 is coordinator, otherwise router
      appDeviceType = srcAddr ? DEVICE_TYPE_ROUTER : DEVICE_TYPE_COORDINATOR;
      CS_WriteParameter(CS_DEVICE_TYPE_ID, &appDeviceType);

#ifdef _SECURITY_
      if (DEVICE_TYPE_COORDINATOR == appDeviceType)
      {
        CS_WriteParameter(CS_UID_ID, &extPanId);
        CS_WriteParameter(CS_APS_TRUST_CENTER_ADDRESS_ID, &extPanId);
      }
#endif

#ifdef TEST_NETWORK
      if (DEVICE_TYPE_COORDINATOR == appDeviceType)
        uartInit();
#endif // TEST_NETWORK

      { // Use static network addressing
        bool useStatAddr = true;
        CS_WriteParameter(CS_NWK_UNIQUE_ADDR_ID, &useStatAddr);
      }

      { // Set transceiver to be always on (no sleeping)
        bool rxOnWhenIdleFlag = true;
        CS_WriteParameter(CS_RX_ON_WHEN_IDLE_ID, &rxOnWhenIdleFlag);
      }

      appOpenLeds();

      endpointParams.APS_DataInd = APS_DataInd;   // Register handler for incoming data packets
      appState = APP_AWAITING_NETWORK_START_STATE; // Switch to awaiting network start state
      SYS_PostTask (APL_TASK_ID);
      break;
    }

    // Node is waiting network start/join request
    case APP_AWAITING_NETWORK_START_STATE:
      appOpenButtons(NULL, buttonReleased); // Set handlers for button events

#ifndef _BUTTONS_ // Button press simulating.
      buttonReleased(NETWORK_BUTTON);
#endif // _BUTTONS_
      break;

    // Node is starting/joining network
    case APP_NETWORK_STARTING_STATE:
      {
        uint32_t chMask = CS_CHANNEL_MASK;

        // Set network request parameters
        CS_WriteParameter(CS_CHANNEL_MASK_ID, &chMask);
        networkParams.ZDO_StartNetworkConf = ZDO_StartNetworkConf; // Handler for network start confirmation
        ZDO_StartNetworkReq(&networkParams); // Start/join network
      }
      break;

      // Data sending after indication
    case APP_NETWORK_DATA_SENDING_STATE:
      // No packet is being currently forwarded by the device
      if (fwPacketFlag == false)
      {
        // Set payload value
        appPayload[APS_ASDU_OFFSET] = dataPayload;
        dataReq.asdu = (uint8_t *) &appPayload[APS_ASDU_OFFSET];
        // Start delay packet transmission timer
        delayFwTimer.interval = TIMER_FW_DELAY;
        delayFwTimer.mode     = TIMER_ONE_SHOT_MODE;
        delayFwTimer.callback = delayFwTimerFired;

        HAL_StartAppTimer(&delayFwTimer);
        appState = APP_WAITING_CONFIRM_STATE; // Switch application state
        fwPacketFlag = true; // Mark node as currently forwarding a packet
      }
      else
      {
        SYS_PostTask(APL_TASK_ID);
      }
      break;

      // Waiting confirm
    case APP_WAITING_CONFIRM_STATE:
      break;

    // Node is in network
    case APP_IN_NETWORK_STATE:
#ifndef _BUTTONS_
  #if FINAL_DEVICE
        buttonReleased(DATA_TX_BUTTON); // Button released event simulating.
  #endif // FINAL_DEVICE == 1
#endif // _BUTTONS_
      break;

    // Node is out of network
    case APP_NO_NETWORK_STATE:
      break;

    default:
      break;
  }
}

/********************************************************************
  Description: ZDO_StartNetwork primitive confirmation was received.

  Parameters: confirmInfo - confirmation information

  Returns: nothing.
********************************************************************/
void ZDO_StartNetworkConf(ZDO_StartNetworkConf_t *confirmInfo)
{
  // Network start/join was successful
  if (ZDO_SUCCESS_STATUS == confirmInfo->status)
  {
    HAL_StopAppTimer(&startingNetworkTimer); // Stop network led blinking
    appOnLed(NETWORK_LED); // Indicate successfull network start/join

    CS_WriteParameter(CS_STACK_PROFILE_ID, &endpointParams.simpleDescriptor->AppProfileId);

    APS_RegisterEndpointReq(&endpointParams); // Register endpoint
    prepareMsgParams(); // Set basic data message parameters

    appState = APP_IN_NETWORK_STATE; // Switch application state
  }

  SYS_PostTask(APL_TASK_ID);
}

/********************************************************************
  Description: Button release handler

  Parameters: buttonNumber - number of button being released

  Returns: nothing.
********************************************************************/
static void buttonReleased(uint8_t buttonNumber)
{
  // Start/join network request
  if ((APP_AWAITING_NETWORK_START_STATE == appState) && (NETWORK_BUTTON == buttonNumber))
  {
    // Set and start timer for LED blinking during network start
    startingNetworkTimer.interval = TIMER_STARTING_NETWORK;
    startingNetworkTimer.mode     = TIMER_REPEAT_MODE;
    startingNetworkTimer.callback = startingNetworkTimerFired;
    HAL_StartAppTimer(&startingNetworkTimer);

    appState = APP_NETWORK_STARTING_STATE; // Switch application state
    SYS_PostTask(APL_TASK_ID);
  }

  // Initialize data packet transmission
  else if ((DATA_TX_BUTTON == buttonNumber) &&
           (APP_IN_NETWORK_STATE == appState) &&
           (false == fwPacketFlag))
  {
    uint8_t data = 0; // Initial payload value
    fwPacketFlag = true; // Transmitting packet, disable packet forwarding

    appPayload[APS_ASDU_OFFSET] = data;
    dataReq.asdu = (uint8_t *) &appPayload[APS_ASDU_OFFSET];

    // Configure and start delay packet forwarding timer
    delayFwTimer.interval = TIMER_FW_DELAY;
    delayFwTimer.mode     = TIMER_ONE_SHOT_MODE;
    delayFwTimer.callback = delayFwTimerFired;
    HAL_StartAppTimer(&delayFwTimer);

    appState = APP_WAITING_CONFIRM_STATE; // Switch application state
  }
}

/********************************************************************
  Description: Confirmation of message received.
  Turn off data forwarding indication LED

  Parameters: confData - confirmation information

  Returns: nothing.
********************************************************************/
static void APS_DataConf(APS_DataConf_t *confData)
{
  // TODO: add status checking
  confData = confData;         // Unused parameter, warning prevention
  fwPacketFlag = false;      // Enable packet forwarding

  if (APS_SUCCESS_STATUS != confData->status)
  {
    appState = APP_NETWORK_DATA_SENDING_STATE;
    SYS_PostTask(APL_TASK_ID);
  }
  else
  {
    appOffLed(DATA_LED);    // Transmission completed, turn off indication

    if (APP_WAITING_CONFIRM_STATE == appState)
      appState = APP_IN_NETWORK_STATE; // Switch application state
  }
}

/********************************************************************
  Description: Handler of aps data indication

  Parameters: indData - structure of incoming msg

  Returns: nothing.
********************************************************************/
void APS_DataInd(APS_DataInd_t *indData)
{
  // Update payload value
  dataPayload = *(indData->asdu);

  if (DEVICE_TYPE_ROUTER == appDeviceType)
  {
    dataPayload += 1;
    appState = APP_NETWORK_DATA_SENDING_STATE;
  }
  else
  {
    dataPayload = 0;
#ifdef TEST_NETWORK
    appState = APP_SENDING_HEARTBEAT;
    uartSendHeartbeat();
#else
    appState = APP_NETWORK_DATA_SENDING_STATE;
#endif // TEST_NETWORK
  }

  SYS_PostTask(APL_TASK_ID);
}

/********************************************************************
  Description: Prepare common data request parameters

  Parameters: none.

  Returns: nothing.
********************************************************************/
void prepareMsgParams(void)
{
  dataReq.dstAddrMode             = APS_SHORT_ADDRESS; // Use short (NWK) addressing
  dataReq.dstAddress.shortAddress = dstAddr;       // Destination NWK address
  dataReq.dstEndpoint             = END_POINT;       // Destination endpoint
  dataReq.profileId               = endpointParams.simpleDescriptor->AppProfileId;
  dataReq.clusterId               = 1;
  dataReq.srcEndpoint             = END_POINT;
  dataReq.asduLength              = APP_PAYLOAD_SIZE;
  dataReq.txOptions.acknowledgedTransmission = 1;//APP_USE_APS_ACK; // Whether ACKs on application level are used
  dataReq.radius                  = 0;
  dataReq.APS_DataConf            = APS_DataConf;  // Confirm callback function
}

/********************************************************************
  Description: update network status event handler

  Parameters: nwkParams - new network parameters

  Returns: nothing.
********************************************************************/
void ZDO_MgmtNwkUpdateNotf(ZDO_MgmtNwkUpdateNotf_t *nwkParams)
{
  // Network is lost/left
  if (ZDO_NETWORK_LOST_STATUS == nwkParams->status)
  {
    HAL_StartAppTimer(&startingNetworkTimer); // Start indication of network join process
    appState = APP_NETWORK_STARTING_STATE;    // Switch application state

    SYS_PostTask(APL_TASK_ID);
  }
}

/********************************************************************
  Description: dummy wakeup event handler

  Parameters: none.

  Returns: nothing.
********************************************************************/
void ZDO_WakeUpInd(void)
{
}

/********************************************************************
  Description: dummy sleep event handler

  Parameters: none.

  Returns: nothing.
********************************************************************/
void ZDO_SleepInd(void)
{
}

#ifdef TEST_NETWORK
/********************************************************************
  Description: Init UART, register UART callbacks.

  Parameters: none.

  Returns: nothing.
********************************************************************/
static void uartInit(void)
{
  appUartDescriptor.tty             = APP_UART_CHANNEL;
  appUartDescriptor.mode            = ASYNC;
  appUartDescriptor.baudrate        = UART_BAUDRATE_38400;
  appUartDescriptor.dataLength      = UART_DATA8;
  appUartDescriptor.parity          = UART_PARITY_NONE;
  appUartDescriptor.stopbits        = UART_STOPBIT_1;
  appUartDescriptor.rxBuffer        = NULL;
  appUartDescriptor.rxBufferLength  = 0;
  appUartDescriptor.txBuffer        = NULL;
  appUartDescriptor.txBufferLength  = 0;
  appUartDescriptor.rxCallback      = NULL;
  appUartDescriptor.txCallback      = uartWriteConf;
  appUartDescriptor.flowControl     = UART_FLOW_CONTROL_NONE;

  HAL_OpenUart(&appUartDescriptor);
}

/********************************************************************
  Description: Send Heartbeat Signal To Uart

  Parameters: none

  Returns: nothing.
********************************************************************/
static void uartSendHeartbeat(void)
{
  static uint8_t heartbeat = '#';

  HAL_WriteUart(&appUartDescriptor, &heartbeat, 1);
}

/********************************************************************
  Description: Writing confirmation has been received.

  Parameters: none.

  Returns: nothing.
********************************************************************/
static void uartWriteConf(void)
{
  appState = APP_NETWORK_DATA_SENDING_STATE;
}
#endif // TEST_NETWORK

//eof pingpong.c

---