/**************************************************************************************************
  Filename:       zcl_sampleLight.c
  Revised:        $Date: 2014-10-24 16:04:46 -0700 (Fri, 24 Oct 2014) $
  Revision:       $Revision: 40796 $


  Description:    Zigbee Cluster Library - sample light application.


  Copyright 2006-2014 Texas Instruments Incorporated. All rights reserved.

  IMPORTANT: Your use of this Software is limited to those specific rights
  granted under the terms of a software license agreement between the user
  who downloaded the software, his/her employer (which must be your employer)
  and Texas Instruments Incorporated (the "License").  You may not use this
  Software unless you agree to abide by the terms of the License. The License
  limits your use, and you acknowledge, that the Software may not be modified,
  copied or distributed unless embedded on a Texas Instruments microcontroller
  or used solely and exclusively in conjunction with a Texas Instruments radio
  frequency transceiver, which is integrated into your product.  Other than for
  the foregoing purpose, you may not use, reproduce, copy, prepare derivative
  works of, modify, distribute, perform, display or sell this Software and/or
  its documentation for any purpose.

  YOU FURTHER ACKNOWLEDGE AND AGREE THAT THE SOFTWARE AND DOCUMENTATION ARE
  PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
  INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, TITLE,
  NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL
  TEXAS INSTRUMENTS OR ITS LICENSORS BE LIABLE OR OBLIGATED UNDER CONTRACT,
  NEGLIGENCE, STRICT LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR OTHER
  LEGAL EQUITABLE THEORY ANY DIRECT OR INDIRECT DAMAGES OR EXPENSES
  INCLUDING BUT NOT LIMITED TO ANY INCIDENTAL, SPECIAL, INDIRECT, PUNITIVE
  OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF PROCUREMENT
  OF SUBSTITUTE GOODS, TECHNOLOGY, SERVICES, OR ANY CLAIMS BY THIRD PARTIES
  (INCLUDING BUT NOT LIMITED TO ANY DEFENSE THEREOF), OR OTHER SIMILAR COSTS.

  Should you have any questions regarding your right to use this Software,
  contact Texas Instruments Incorporated at www.TI.com.
**************************************************************************************************/

/*********************************************************************
  This application implements a ZigBee Light, based on Z-Stack 3.0. It can be configured as an
  On/Off light or as a dimmable light, by undefining or defining ZCL_LEVEL_CTRL, respectively.

  This application is based on the common sample-application user interface. Please see the main
  comment in zcl_sampleapp_ui.c. The rest of this comment describes only the content specific for
  this sample applicetion.

  Application-specific UI peripherals being used:

  - LEDs:
    LED1 reflect the current light state (On / Off accordingly).

  Application-specific menu system:

    <TOGGLE LIGHT> Toggle the local light and display its status and level
      Press OK to toggle the local light on and off.
      This screen shows the following information
        Line1: (only populated if ZCL_LEVEL_CTRL is defined)
          LEVEL XXX - xxx is the current level of the light if the light state is ON, or the target level
            of the light when the light state is off. The target level is the level that the light will be
            set to when it is switched from off to on using the on or the toggle commands.
        Line2:
          LIGHT OFF / ON: shows the current state of the light.
      Note when ZCL_LEVEL_CTRL is enabled:
        - If the light state is ON and the light level is X, and then the light receives the OFF or TOGGLE
          commands: The level will decrease gradually until it reaches 1, and only then the light state will
          be changed to OFF. The level then will be restored to X, with the state staying OFF. At this stage
          the light is not lighting, and the level represent the target level for the next ON or TOGGLE
          commands.
        - If the light state is OFF and the light level is X, and then the light receives the ON or TOGGLE
          commands; The level will be set to 1, the light state will be set to ON, and then the level will
          increase gradually until it reaches level X.
        - Any level-setting command will affect the level directly, and may also affect the on/off state,
          depending on the command's arguments.

*********************************************************************/

/*********************************************************************
 * INCLUDES
 */
#include "ZComDef.h"
#include "OSAL.h"
#include "AF.h"
#include "ZDApp.h"
#include "ZDObject.h"
#include "MT_SYS.h"

#include "nwk_util.h"

#include "zcl.h"
#include "zcl_general.h"
#include "zcl_ha.h"
#include "zcl_diagnostic.h"

#include "zcl_samplelight.h"

#include "bdb.h"
#include "bdb_interface.h"

//GP_UPDATE
#include "gp_interface.h"

#include "onboard.h"

/* HAL */
#include "hal_lcd.h"
#include "hal_led.h"
#include "hal_key.h"

#include "NLMEDE.h"

// Added to include TouchLink initiator functionality
#if defined ( BDB_TL_INITIATOR )
#include "bdb_touchlink_initiator.h"
#endif // BDB_TL_INITIATOR

#if defined ( BDB_TL_TARGET )
#include "bdb_touchlink_target.h"
#endif // BDB_TL_TARGET

#if defined ( BDB_TL_INITIATOR ) || defined ( BDB_TL_TARGET )
#include "bdb_touchlink.h"
#endif

#include "zcl_sampleapps_ui.h"

/*********************************************************************
 * MACROS
 */
#define UI_STATE_TOGGLE_LIGHT 1 //UI_STATE_BACK_FROM_APP_MENU is item #0, so app item numbers should start from 1

#define APP_TITLE "TI Sample Light"

/*********************************************************************
 * TYPEDEFS
 */

/*********************************************************************
 * GLOBAL VARIABLES
 */
byte zclSampleLight_TaskID;
uint8 zclSampleLightSeqNum;

/*********************************************************************
 * GLOBAL FUNCTIONS
 */

/*********************************************************************
 * LOCAL VARIABLES
 */
afAddrType_t zclSampleLight_DstAddr;

// Test Endpoint to allow SYS_APP_MSGs
static endPointDesc_t sampleLight_TestEp = {
    SAMPLELIGHT_ENDPOINT,
    0,
    &zclSampleLight_TaskID,
    (SimpleDescriptionFormat_t *)NULL,  // No Simple description for this test endpoint
    (afNetworkLatencyReq_t)0            // No Network Latency req
};

#ifdef ZCL_LEVEL_CTRL
uint8 zclSampleLight_WithOnOff;       // set to TRUE if state machine should set light on/off
uint8 zclSampleLight_NewLevel;        // new level when done moving
uint8 zclSampleLight_LevelChangeCmd; // current level change was triggered by an on/off command
bool  zclSampleLight_NewLevelUp;      // is direction to new level up or down?
int32 zclSampleLight_CurrentLevel32;  // current level, fixed point (e.g. 192.456)
int32 zclSampleLight_Rate32;          // rate in units, fixed point (e.g. 16.123)
uint8 zclSampleLight_LevelLastLevel;  // to save the Current Level before the light was turned OFF
#endif

/*********************************************************************
 * LOCAL FUNCTIONS
 */
static void zclSampleLight_HandleKeys( byte shift, byte keys );
static void zclSampleLight_BasicResetCB( void );
static void zclSampleLight_OnOffCB( uint8 cmd );
//GP_UPDATE
#if (ZG_BUILD_RTR_TYPE)
static void gp_CommissioningMode(bool isEntering);
static uint8 gp_ChangeChannelReq(void);
#endif


static void zclSampleLight_ProcessCommissioningStatus(bdbCommissioningModeMsg_t *bdbCommissioningModeMsg);


#ifdef ZCL_LEVEL_CTRL
static void zclSampleLight_LevelControlMoveToLevelCB( zclLCMoveToLevel_t *pCmd );
static void zclSampleLight_LevelControlMoveCB( zclLCMove_t *pCmd );
static void zclSampleLight_LevelControlStepCB( zclLCStep_t *pCmd );
static void zclSampleLight_LevelControlStopCB( void );
static void zclSampleLight_DefaultMove( uint8 OnOff );
static uint32 zclSampleLight_TimeRateHelper( uint8 newLevel );
static uint16 zclSampleLight_GetTime ( uint8 level, uint16 time );
static void zclSampleLight_MoveBasedOnRate( uint8 newLevel, uint32 rate );
static void zclSampleLight_MoveBasedOnTime( uint8 newLevel, uint16 time );
static void zclSampleLight_AdjustLightLevel( void );
#endif

// Functions to process ZCL Foundation incoming Command/Response messages
static void zclSampleLight_ProcessIncomingMsg( zclIncomingMsg_t *msg );
#ifdef ZCL_READ
static uint8 zclSampleLight_ProcessInReadRspCmd( zclIncomingMsg_t *pInMsg );
#endif
#ifdef ZCL_WRITE
static uint8 zclSampleLight_ProcessInWriteRspCmd( zclIncomingMsg_t *pInMsg );
#endif
static uint8 zclSampleLight_ProcessInDefaultRspCmd( zclIncomingMsg_t *pInMsg );
#ifdef ZCL_DISCOVER
static uint8 zclSampleLight_ProcessInDiscCmdsRspCmd( zclIncomingMsg_t *pInMsg );
static uint8 zclSampleLight_ProcessInDiscAttrsRspCmd( zclIncomingMsg_t *pInMsg );
static uint8 zclSampleLight_ProcessInDiscAttrsExtRspCmd( zclIncomingMsg_t *pInMsg );
#endif

static void zclSampleApp_BatteryWarningCB( uint8 voltLevel);

void zclSampleLight_UiActionToggleLight(uint16 keys);
void zclSampleLight_UiUpdateLcd(uint8 uiCurrentState, char * line[3]);
void zclSampleLight_UpdateLedState(void);

/*********************************************************************
 * CONSTANTS
 */
const uiState_t zclSampleLight_UiStatesMain[] = {
    /*  UI_STATE_BACK_FROM_APP_MENU  */   {UI_STATE_DEFAULT_MOVE,       UI_STATE_TOGGLE_LIGHT,  UI_KEY_SW_5_PRESSED, &UI_ActionBackFromAppMenu}, //do not change this line, except for the second item, which should point to the last entry in this menu
    /*  UI_STATE_TOGGLE_LIGHT        */   {UI_STATE_BACK_FROM_APP_MENU, UI_STATE_DEFAULT_MOVE,  UI_KEY_SW_5_PRESSED, &zclSampleLight_UiActionToggleLight},
};

#define LEVEL_CHANGED_BY_LEVEL_CMD  0
#define LEVEL_CHANGED_BY_ON_CMD     1
#define LEVEL_CHANGED_BY_OFF_CMD    2

/*********************************************************************
 * STATUS STRINGS
 */
#ifdef LCD_SUPPORTED
const char sLightOn[]      = "   LIGHT ON     ";
const char sLightOff[]     = "   LIGHT OFF    ";
#ifdef ZCL_LEVEL_CTRL
char sLightLevel[]        = "   LEVEL ###    "; // displays level 1-254
#endif
#endif

/*********************************************************************
 * REFERENCED EXTERNALS
 */
extern int16 zdpExternalStateTaskID;

/*********************************************************************
 * ZCL General Profile Callback table
 */
static zclGeneral_AppCallbacks_t zclSampleLight_CmdCallbacks = {
    zclSampleLight_BasicResetCB,            // Basic Cluster Reset command
    NULL,                                   // Identify Trigger Effect command
    zclSampleLight_OnOffCB,                 // On/Off cluster commands
    NULL,                                   // On/Off cluster enhanced command Off with Effect
    NULL,                                   // On/Off cluster enhanced command On with Recall Global Scene
    NULL,                                   // On/Off cluster enhanced command On with Timed Off
#ifdef ZCL_LEVEL_CTRL
    zclSampleLight_LevelControlMoveToLevelCB, // Level Control Move to Level command
    zclSampleLight_LevelControlMoveCB,        // Level Control Move command
    zclSampleLight_LevelControlStepCB,        // Level Control Step command
    zclSampleLight_LevelControlStopCB,        // Level Control Stop command
#endif
#ifdef ZCL_GROUPS
    NULL,                                   // Group Response commands
#endif
#ifdef ZCL_SCENES
    NULL,                                  // Scene Store Request command
    NULL,                                  // Scene Recall Request command
    NULL,                                  // Scene Response command
#endif
#ifdef ZCL_ALARMS
    NULL,                                  // Alarm (Response) commands
#endif
#ifdef SE_UK_EXT
    NULL,                                  // Get Event Log command
    NULL,                                  // Publish Event Log command
#endif
    NULL,                                  // RSSI Location command
    NULL                                   // RSSI Location Response command
};

/*********************************************************************
 * @fn          zclSampleLight_Init
 *
 * @brief       Initialization function for the zclGeneral layer.
 *
 * @param       none
 *
 * @return      none
 */
void zclSampleLight_Init( byte task_id ) {
    zclSampleLight_TaskID = task_id;

    // Set destination address to indirect
    zclSampleLight_DstAddr.addrMode = (afAddrMode_t)AddrNotPresent;
    zclSampleLight_DstAddr.endPoint = 0;
    zclSampleLight_DstAddr.addr.shortAddr = 0;

    // Register the Simple Descriptor for this application
    bdb_RegisterSimpleDescriptor( &zclSampleLight_SimpleDesc );

    // Register the ZCL General Cluster Library callback functions
    zclGeneral_RegisterCmdCallbacks( SAMPLELIGHT_ENDPOINT, &zclSampleLight_CmdCallbacks );

    // Register the application's attribute list
    zclSampleLight_ResetAttributesToDefaultValues();
    zcl_registerAttrList( SAMPLELIGHT_ENDPOINT, zclSampleLight_NumAttributes, zclSampleLight_Attrs );

#ifdef ZCL_LEVEL_CTRL
    zclSampleLight_LevelLastLevel = zclSampleLight_LevelCurrentLevel;
#endif

    // Register the Application to receive the unprocessed Foundation command/response messages
    zcl_registerForMsg( zclSampleLight_TaskID );

#ifdef ZCL_DISCOVER
    // Register the application's command list
    zcl_registerCmdList( SAMPLELIGHT_ENDPOINT, zclCmdsArraySize, zclSampleLight_Cmds );
#endif

    // Register low voltage NV memory protection application callback
    RegisterVoltageWarningCB( zclSampleApp_BatteryWarningCB );

    // Register for all key events - This app will handle all key events
    RegisterForKeys( zclSampleLight_TaskID );

    bdb_RegisterCommissioningStatusCB( zclSampleLight_ProcessCommissioningStatus );

    // Register for a test endpoint
    afRegister( &sampleLight_TestEp );

#ifdef ZCL_DIAGNOSTIC
    // Register the application's callback function to read/write attribute data.
    // This is only required when the attribute data format is unknown to ZCL.
    zcl_registerReadWriteCB( SAMPLELIGHT_ENDPOINT, zclDiagnostic_ReadWriteAttrCB, NULL );

    if ( zclDiagnostic_InitStats() == ZSuccess ) {
        // Here the user could start the timer to save Diagnostics to NV
    }
#endif

//GP_UPDATE
#if (ZG_BUILD_RTR_TYPE)
    gp_RegisterCommissioningModeCB(gp_CommissioningMode);
    gp_RegisterGPChangeChannelReqCB(gp_ChangeChannelReq);
#endif

    zdpExternalStateTaskID = zclSampleLight_TaskID;

    UI_Init(zclSampleLight_TaskID, SAMPLEAPP_LCD_AUTO_UPDATE_EVT, SAMPLEAPP_KEY_AUTO_REPEAT_EVT, &zclSampleLight_IdentifyTime, APP_TITLE, &zclSampleLight_UiUpdateLcd, zclSampleLight_UiStatesMain);

    UI_UpdateLcd();
}

/*********************************************************************
 * @fn          zclSample_event_loop
 *
 * @brief       Event Loop Processor for zclGeneral.
 *
 * @param       none
 *
 * @return      none
 */
uint16 zclSampleLight_event_loop( uint8 task_id, uint16 events ) {
    afIncomingMSGPacket_t *MSGpkt;

    (void)task_id;  // Intentionally unreferenced parameter

    if ( events & SYS_EVENT_MSG ) {
        while ( (MSGpkt = (afIncomingMSGPacket_t *)osal_msg_receive( zclSampleLight_TaskID )) ) {
            switch ( MSGpkt->hdr.event ) {
            case ZCL_INCOMING_MSG:
                // Incoming ZCL Foundation command/response messages
                zclSampleLight_ProcessIncomingMsg( (zclIncomingMsg_t *)MSGpkt );
                break;

            case KEY_CHANGE:
                zclSampleLight_HandleKeys( ((keyChange_t *)MSGpkt)->state, ((keyChange_t *)MSGpkt)->keys );
                break;

            case ZDO_STATE_CHANGE:
                UI_DeviceStateUpdated((devStates_t)(MSGpkt->hdr.status));
                break;

            default:
                break;
            }

            // Release the memory
            osal_msg_deallocate( (uint8 *)MSGpkt );
        }

        // return unprocessed events
        return (events ^ SYS_EVENT_MSG);
    }

#ifdef ZCL_LEVEL_CTRL
    if ( events & SAMPLELIGHT_LEVEL_CTRL_EVT ) {
        zclSampleLight_AdjustLightLevel();
        return ( events ^ SAMPLELIGHT_LEVEL_CTRL_EVT );
    }
#endif

#if ZG_BUILD_ENDDEVICE_TYPE
    if ( events & SAMPLEAPP_END_DEVICE_REJOIN_EVT ) {
        bdb_ZedAttemptRecoverNwk();
        return ( events ^ SAMPLEAPP_END_DEVICE_REJOIN_EVT );
    }
#endif

    if ( events & SAMPLEAPP_LCD_AUTO_UPDATE_EVT ) {
        UI_UpdateLcd();
        return ( events ^ SAMPLEAPP_LCD_AUTO_UPDATE_EVT );
    }

    if ( events & SAMPLEAPP_KEY_AUTO_REPEAT_EVT ) {
        UI_MainStateMachine(UI_KEY_AUTO_PRESSED);
        return ( events ^ SAMPLEAPP_KEY_AUTO_REPEAT_EVT );
    }

    // Discard unknown events
    return 0;
}


/*********************************************************************
 * @fn      zclSampleLight_HandleKeys
 *
 * @brief   Handles all key events for this device.
 *
 * @param   shift - true if in shift/alt.
 * @param   keys - bit field for key events. Valid entries:
 *                 HAL_KEY_SW_5
 *                 HAL_KEY_SW_4
 *                 HAL_KEY_SW_2
 *                 HAL_KEY_SW_1
 *
 * @return  none
 */
static void zclSampleLight_HandleKeys( byte shift, byte keys ) {
    UI_MainStateMachine(keys);
}

//GP_UPDATE
#if (ZG_BUILD_RTR_TYPE)
/*********************************************************************
 * @fn      gp_CommissioningMode
 *
 * @brief   Callback that notifies the application that gp Proxy is entering
 *          into commissioning mode
 *
 * @param   isEntering -
 *
 * @return
 */
static void gp_CommissioningMode(bool isEntering) {
    if(isEntering) {
        //Led on indicating enter commissioning mode
    } else {
        //Led off indicating enter commissioning mode
    }
}



//GP_UPDATE
/*********************************************************************
 * @fn      gp_ChangeChannelReq
 *
 * @brief   Callback function to notify the application about a GP commissioning
 * request that will change the current channel for at most
 * gpBirectionalCommissioningChangeChannelTimeout ms
 *
 * @param   channel - Channel in which the commissioning will take place
 *
 * @return  TRUE to allow change channel, FALSE to do not allow
 */
static uint8 gp_ChangeChannelReq(void) {
    bool allowChangeChannel = TRUE;

    //Check application state to decide if allow change channel or not

    return allowChangeChannel;
}

#endif


/*********************************************************************
 * @fn      zclSampleLight_ProcessCommissioningStatus
 *
 * @brief   Callback in which the status of the commissioning process are reported
 *
 * @param   bdbCommissioningModeMsg - Context message of the status of a commissioning process
 *
 * @return  none
 */
static void zclSampleLight_ProcessCommissioningStatus(bdbCommissioningModeMsg_t *bdbCommissioningModeMsg) {
    switch(bdbCommissioningModeMsg->bdbCommissioningMode) {
    case BDB_COMMISSIONING_FORMATION:
        if(bdbCommissioningModeMsg->bdbCommissioningStatus == BDB_COMMISSIONING_SUCCESS) {
            //After formation, perform nwk steering again plus the remaining commissioning modes that has not been process yet
            bdb_StartCommissioning(BDB_COMMISSIONING_MODE_NWK_STEERING | bdbCommissioningModeMsg->bdbRemainingCommissioningModes);
        } else {
            //Want to try other channels?
            //try with bdb_setChannelAttribute
        }
        break;
    case BDB_COMMISSIONING_NWK_STEERING:
        if(bdbCommissioningModeMsg->bdbCommissioningStatus == BDB_COMMISSIONING_SUCCESS) {
            //YOUR JOB:
            //We are on the nwk, what now?
        } else {
            //See the possible errors for nwk steering procedure
            //No suitable networks found
            //Want to try other channels?
            //try with bdb_setChannelAttribute
        }
        break;
    case BDB_COMMISSIONING_FINDING_BINDING:
        if(bdbCommissioningModeMsg->bdbCommissioningStatus == BDB_COMMISSIONING_SUCCESS) {
            //YOUR JOB:
        } else {
            //YOUR JOB:
            //retry?, wait for user interaction?
        }
        break;
    case BDB_COMMISSIONING_INITIALIZATION:
        //Initialization notification can only be successful. Failure on initialization
        //only happens for ZED and is notified as BDB_COMMISSIONING_PARENT_LOST notification

        //YOUR JOB:
        //We are on a network, what now?

        break;
#if ZG_BUILD_ENDDEVICE_TYPE
    case BDB_COMMISSIONING_PARENT_LOST:
        if(bdbCommissioningModeMsg->bdbCommissioningStatus == BDB_COMMISSIONING_NETWORK_RESTORED) {
            //We did recover from losing parent
        } else {
            //Parent not found, attempt to rejoin again after a fixed delay
            osal_start_timerEx(zclSampleLight_TaskID, SAMPLEAPP_END_DEVICE_REJOIN_EVT, SAMPLEAPP_END_DEVICE_REJOIN_DELAY);
        }
        break;
#endif
    }

    UI_UpdateComissioningStatus(bdbCommissioningModeMsg);
}

/*********************************************************************
 * @fn      zclSampleLight_BasicResetCB
 *
 * @brief   Callback from the ZCL General Cluster Library
 *          to set all the Basic Cluster attributes to default values.
 *
 * @param   none
 *
 * @return  none
 */
static void zclSampleLight_BasicResetCB( void ) {
    //Reset every attribute in all supported cluster to their default value.

    zclSampleLight_ResetAttributesToDefaultValues();

    zclSampleLight_UpdateLedState();

    // update the display
    UI_UpdateLcd( );
}

/*********************************************************************
 * @fn      zclSampleLight_OnOffCB
 *
 * @brief   Callback from the ZCL General Cluster Library when
 *          it received an On/Off Command for this application.
 *
 * @param   cmd - COMMAND_ON, COMMAND_OFF or COMMAND_TOGGLE
 *
 * @return  none
 */
static void zclSampleLight_OnOffCB( uint8 cmd ) {
    afIncomingMSGPacket_t *pPtr = zcl_getRawAFMsg();

    uint8 OnOff;

    zclSampleLight_DstAddr.addr.shortAddr = pPtr->srcAddr.addr.shortAddr;


    // Turn on the light
    if ( cmd == COMMAND_ON ) {
        OnOff = LIGHT_ON;
    }
    // Turn off the light
    else if ( cmd == COMMAND_OFF ) {
        OnOff = LIGHT_OFF;
    }
    // Toggle the light
    else if ( cmd == COMMAND_TOGGLE ) {
#ifdef ZCL_LEVEL_CTRL
        if (zclSampleLight_LevelRemainingTime > 0) {
            if (zclSampleLight_NewLevelUp) {
                OnOff = LIGHT_OFF;
            } else {
                OnOff = LIGHT_ON;
            }
        } else {
            if (zclSampleLight_OnOff == LIGHT_ON) {
                OnOff = LIGHT_OFF;
            } else {
                OnOff = LIGHT_ON;
            }
        }
#else
        if (zclSampleLight_OnOff == LIGHT_ON) {
            OnOff = LIGHT_OFF;
        } else {
            OnOff = LIGHT_ON;
        }
#endif
    }

#ifdef ZCL_LEVEL_CTRL
    zclSampleLight_LevelChangeCmd = (OnOff == LIGHT_ON ? LEVEL_CHANGED_BY_ON_CMD : LEVEL_CHANGED_BY_OFF_CMD);

    zclSampleLight_DefaultMove(OnOff);
#else
    zclSampleLight_OnOff = OnOff;
#endif

    zclSampleLight_UpdateLedState();

    // update the display
    UI_UpdateLcd( );
}

#ifdef ZCL_LEVEL_CTRL
/*********************************************************************
 * @fn      zclSampleLight_TimeRateHelper
 *
 * @brief   Calculate time based on rate, and startup level state machine
 *
 * @param   newLevel - new level for current level
 *
 * @return  diff (directly), zclSampleLight_CurrentLevel32 and zclSampleLight_NewLevel, zclSampleLight_NewLevelUp
 */
static uint32 zclSampleLight_TimeRateHelper( uint8 newLevel ) {
    uint32 diff;
    uint32 newLevel32;

    // remember current and new level
    zclSampleLight_NewLevel = newLevel;
    zclSampleLight_CurrentLevel32 = (uint32)1000 * zclSampleLight_LevelCurrentLevel;

    // calculate diff
    newLevel32 = (uint32)1000 * newLevel;
    if ( zclSampleLight_LevelCurrentLevel > newLevel ) {
        diff = zclSampleLight_CurrentLevel32 - newLevel32;
        zclSampleLight_NewLevelUp = FALSE;  // moving down
    } else {
        diff = newLevel32 - zclSampleLight_CurrentLevel32;
        zclSampleLight_NewLevelUp = TRUE;   // moving up
    }

    return ( diff );
}

/*********************************************************************
 * @fn      zclSampleLight_MoveBasedOnRate
 *
 * @brief   Calculate time based on rate, and startup level state machine
 *
 * @param   newLevel - new level for current level
 * @param   rate16   - fixed point rate (e.g. 16.123)
 *
 * @return  none
 */
static void zclSampleLight_MoveBasedOnRate( uint8 newLevel, uint32 rate ) {
    uint32 diff;

    // determine how much time (in 10ths of seconds) based on the difference and rate
    zclSampleLight_Rate32 = rate;
    diff = zclSampleLight_TimeRateHelper( newLevel );
    zclSampleLight_LevelRemainingTime = diff / rate;
    if ( !zclSampleLight_LevelRemainingTime ) {
        zclSampleLight_LevelRemainingTime = 1;
    }

    osal_start_timerEx( zclSampleLight_TaskID, SAMPLELIGHT_LEVEL_CTRL_EVT, 100 );
}

/*********************************************************************
 * @fn      zclSampleLight_MoveBasedOnTime
 *
 * @brief   Calculate rate based on time, and startup level state machine
 *
 * @param   newLevel  - new level for current level
 * @param   time      - in 10ths of seconds
 *
 * @return  none
 */
static void zclSampleLight_MoveBasedOnTime( uint8 newLevel, uint16 time ) {
    uint16 diff;

    // determine rate (in units) based on difference and time
    diff = zclSampleLight_TimeRateHelper( newLevel );
    zclSampleLight_LevelRemainingTime = zclSampleLight_GetTime( newLevel, time );
    zclSampleLight_Rate32 = diff / time;

    osal_start_timerEx( zclSampleLight_TaskID, SAMPLELIGHT_LEVEL_CTRL_EVT, 100 );
}

/*********************************************************************
 * @fn      zclSampleLight_GetTime
 *
 * @brief   Determine amount of time that MoveXXX will take to complete.
 *
 * @param   level = new level to move to
 *          time  = 0xffff=default, or 0x0000-n amount of time in tenths of seconds.
 *
 * @return  none
 */
static uint16 zclSampleLight_GetTime( uint8 newLevel, uint16 time ) {
    // there is a hiearchy of the amount of time to use for transistioning
    // check each one in turn. If none of defaults are set, then use fastest
    // time possible.
    if ( time == 0xFFFF ) {
        // use On or Off Transition Time if set (not 0xffff)
        if ( zclSampleLight_LevelCurrentLevel > newLevel ) {
            time = zclSampleLight_LevelOffTransitionTime;
        } else {
            time = zclSampleLight_LevelOnTransitionTime;
        }

        // else use OnOffTransitionTime if set (not 0xffff)
        if ( time == 0xFFFF ) {
            time = zclSampleLight_LevelOnOffTransitionTime;
        }

        // else as fast as possible
        if ( time == 0xFFFF ) {
            time = 1;
        }
    }

    if ( time == 0 ) {
        time = 1; // as fast as possible
    }

    return ( time );
}

/*********************************************************************
 * @fn      zclSampleLight_DefaultMove
 *
 * @brief   We were turned on/off. Use default time to move to on or off.
 *
 * @param   zclSampleLight_OnOff - must be set prior to calling this function.
 *
 * @return  none
 */
static void zclSampleLight_DefaultMove( uint8 OnOff ) {
    uint8  newLevel;
    uint32 rate;      // fixed point decimal (3 places, eg. 16.345)
    uint16 time;

    // if moving to on position, move to on level
    if ( OnOff ) {
        if (zclSampleLight_OnOff == LIGHT_OFF) {
            zclSampleLight_LevelCurrentLevel = ATTR_LEVEL_MIN_LEVEL;
        }

        if ( zclSampleLight_LevelOnLevel == ATTR_LEVEL_ON_LEVEL_NO_EFFECT ) {
            // The last Level (before going OFF) should be used)
            newLevel = zclSampleLight_LevelLastLevel;
        } else {
            newLevel = zclSampleLight_LevelOnLevel;
        }

        time = zclSampleLight_LevelOnTransitionTime;

    } else {
        newLevel = ATTR_LEVEL_MIN_LEVEL;

        time = zclSampleLight_LevelOffTransitionTime;
    }

    // else use OnOffTransitionTime if set (not 0xffff)
    if ( time == 0xFFFF ) {
        time = zclSampleLight_LevelOnOffTransitionTime;
    }

    // else as fast as possible
    if ( time == 0xFFFF ) {
        time = 1;
    }

    // calculate rate based on time (int 10ths) for full transition (1-254)
    rate = 255000 / time;    // units per tick, fixed point, 3 decimal places (e.g. 8500 = 8.5 units per tick)

    // start up state machine.
    zclSampleLight_WithOnOff = TRUE;
    zclSampleLight_MoveBasedOnRate( newLevel, rate );
}

/*********************************************************************
 * @fn      zclSampleLight_AdjustLightLevel
 *
 * @brief   Called each 10th of a second while state machine running
 *
 * @param   none
 *
 * @return  none
 */
static void zclSampleLight_AdjustLightLevel( void ) {
    // one tick (10th of a second) less
    if ( zclSampleLight_LevelRemainingTime ) {
        --zclSampleLight_LevelRemainingTime;
    }

    // no time left, done
    if ( zclSampleLight_LevelRemainingTime == 0) {
        zclSampleLight_LevelCurrentLevel = zclSampleLight_NewLevel;
    }

    // still time left, keep increment/decrementing
    else {
        if ( zclSampleLight_NewLevelUp ) {
            zclSampleLight_CurrentLevel32 += zclSampleLight_Rate32;
        } else {
            zclSampleLight_CurrentLevel32 -= zclSampleLight_Rate32;
        }
        zclSampleLight_LevelCurrentLevel = (uint8)( zclSampleLight_CurrentLevel32 / 1000 );
    }

    if (( zclSampleLight_LevelChangeCmd == LEVEL_CHANGED_BY_LEVEL_CMD ) && ( zclSampleLight_LevelOnLevel == ATTR_LEVEL_ON_LEVEL_NO_EFFECT )) {
        zclSampleLight_LevelLastLevel = zclSampleLight_LevelCurrentLevel;
    }

    // also affect on/off
    if ( zclSampleLight_WithOnOff ) {
        if ( zclSampleLight_LevelCurrentLevel > ATTR_LEVEL_MIN_LEVEL ) {
            zclSampleLight_OnOff = LIGHT_ON;
        } else {
            if (zclSampleLight_LevelChangeCmd != LEVEL_CHANGED_BY_ON_CMD) {
                zclSampleLight_OnOff = LIGHT_OFF;
            } else {
                zclSampleLight_OnOff = LIGHT_ON;
            }

            if (( zclSampleLight_LevelChangeCmd != LEVEL_CHANGED_BY_LEVEL_CMD ) && ( zclSampleLight_LevelOnLevel == ATTR_LEVEL_ON_LEVEL_NO_EFFECT )) {
                zclSampleLight_LevelCurrentLevel = zclSampleLight_LevelLastLevel;
            }
        }
    }

    zclSampleLight_UpdateLedState();

    // display light level as we go
    UI_UpdateLcd( );

    // keep ticking away
    if ( zclSampleLight_LevelRemainingTime ) {
        osal_start_timerEx( zclSampleLight_TaskID, SAMPLELIGHT_LEVEL_CTRL_EVT, 100 );
    }
}

/*********************************************************************
 * @fn      zclSampleLight_LevelControlMoveToLevelCB
 *
 * @brief   Callback from the ZCL General Cluster Library when
 *          it received a LevelControlMoveToLevel Command for this application.
 *
 * @param   pCmd - ZigBee command parameters
 *
 * @return  none
 */
static void zclSampleLight_LevelControlMoveToLevelCB( zclLCMoveToLevel_t *pCmd ) {
    zclSampleLight_LevelChangeCmd = LEVEL_CHANGED_BY_LEVEL_CMD;

    zclSampleLight_WithOnOff = pCmd->withOnOff;
    zclSampleLight_MoveBasedOnTime( pCmd->level, pCmd->transitionTime );
}

/*********************************************************************
 * @fn      zclSampleLight_LevelControlMoveCB
 *
 * @brief   Callback from the ZCL General Cluster Library when
 *          it received a LevelControlMove Command for this application.
 *
 * @param   pCmd - ZigBee command parameters
 *
 * @return  none
 */
static void zclSampleLight_LevelControlMoveCB( zclLCMove_t *pCmd ) {
    uint8 newLevel;
    uint32 rate;

    // convert rate from units per second to units per tick (10ths of seconds)
    // and move at that right up or down
    zclSampleLight_WithOnOff = pCmd->withOnOff;

    if ( pCmd->moveMode == LEVEL_MOVE_UP ) {
        newLevel = ATTR_LEVEL_MAX_LEVEL;  // fully on
    } else {
        newLevel = ATTR_LEVEL_MIN_LEVEL; // fully off
    }

    zclSampleLight_LevelChangeCmd = LEVEL_CHANGED_BY_LEVEL_CMD;

    rate = (uint32)100 * pCmd->rate;
    zclSampleLight_MoveBasedOnRate( newLevel, rate );
}

/*********************************************************************
 * @fn      zclSampleLight_LevelControlStepCB
 *
 * @brief   Callback from the ZCL General Cluster Library when
 *          it received an On/Off Command for this application.
 *
 * @param   pCmd - ZigBee command parameters
 *
 * @return  none
 */
static void zclSampleLight_LevelControlStepCB( zclLCStep_t *pCmd ) {
    uint8 newLevel;

    // determine new level, but don't exceed boundaries
    if ( pCmd->stepMode == LEVEL_MOVE_UP ) {
        if ( (uint16)zclSampleLight_LevelCurrentLevel + pCmd->amount > ATTR_LEVEL_MAX_LEVEL ) {
            newLevel = ATTR_LEVEL_MAX_LEVEL;
        } else {
            newLevel = zclSampleLight_LevelCurrentLevel + pCmd->amount;
        }
    } else {
        if ( pCmd->amount >= zclSampleLight_LevelCurrentLevel ) {
            newLevel = ATTR_LEVEL_MIN_LEVEL;
        } else {
            newLevel = zclSampleLight_LevelCurrentLevel - pCmd->amount;
        }
    }

    zclSampleLight_LevelChangeCmd = LEVEL_CHANGED_BY_LEVEL_CMD;

    // move to the new level
    zclSampleLight_WithOnOff = pCmd->withOnOff;
    zclSampleLight_MoveBasedOnTime( newLevel, pCmd->transitionTime );
}

/*********************************************************************
 * @fn      zclSampleLight_LevelControlStopCB
 *
 * @brief   Callback from the ZCL General Cluster Library when
 *          it received an Level Control Stop Command for this application.
 *
 * @param   pCmd - ZigBee command parameters
 *
 * @return  none
 */
static void zclSampleLight_LevelControlStopCB( void ) {
    // stop immediately
    osal_stop_timerEx( zclSampleLight_TaskID, SAMPLELIGHT_LEVEL_CTRL_EVT );
    zclSampleLight_LevelRemainingTime = 0;
}
#endif

/*********************************************************************
 * @fn      zclSampleApp_BatteryWarningCB
 *
 * @brief   Called to handle battery-low situation.
 *
 * @param   voltLevel - level of severity
 *
 * @return  none
 */
void zclSampleApp_BatteryWarningCB( uint8 voltLevel ) {
    if ( voltLevel == VOLT_LEVEL_CAUTIOUS ) {
        // Send warning message to the gateway and blink LED
    } else if ( voltLevel == VOLT_LEVEL_BAD ) {
        // Shut down the system
    }
}

/******************************************************************************
 *
 *  Functions for processing ZCL Foundation incoming Command/Response messages
 *
 *****************************************************************************/

/*********************************************************************
 * @fn      zclSampleLight_ProcessIncomingMsg
 *
 * @brief   Process ZCL Foundation incoming message
 *
 * @param   pInMsg - pointer to the received message
 *
 * @return  none
 */
static void zclSampleLight_ProcessIncomingMsg( zclIncomingMsg_t *pInMsg ) {
    switch ( pInMsg->zclHdr.commandID ) {
#ifdef ZCL_READ
    case ZCL_CMD_READ_RSP:
        zclSampleLight_ProcessInReadRspCmd( pInMsg );
        break;
#endif
#ifdef ZCL_WRITE
    case ZCL_CMD_WRITE_RSP:
        zclSampleLight_ProcessInWriteRspCmd( pInMsg );
        break;
#endif
    case ZCL_CMD_CONFIG_REPORT:
    case ZCL_CMD_CONFIG_REPORT_RSP:
    case ZCL_CMD_READ_REPORT_CFG:
    case ZCL_CMD_READ_REPORT_CFG_RSP:
    case ZCL_CMD_REPORT:
        //bdb_ProcessIncomingReportingMsg( pInMsg );
        break;

    case ZCL_CMD_DEFAULT_RSP:
        zclSampleLight_ProcessInDefaultRspCmd( pInMsg );
        break;
#ifdef ZCL_DISCOVER
    case ZCL_CMD_DISCOVER_CMDS_RECEIVED_RSP:
        zclSampleLight_ProcessInDiscCmdsRspCmd( pInMsg );
        break;

    case ZCL_CMD_DISCOVER_CMDS_GEN_RSP:
        zclSampleLight_ProcessInDiscCmdsRspCmd( pInMsg );
        break;

    case ZCL_CMD_DISCOVER_ATTRS_RSP:
        zclSampleLight_ProcessInDiscAttrsRspCmd( pInMsg );
        break;

    case ZCL_CMD_DISCOVER_ATTRS_EXT_RSP:
        zclSampleLight_ProcessInDiscAttrsExtRspCmd( pInMsg );
        break;
#endif
    default:
        break;
    }

    if ( pInMsg->attrCmd )
        osal_mem_free( pInMsg->attrCmd );
}

#ifdef ZCL_READ
/*********************************************************************
 * @fn      zclSampleLight_ProcessInReadRspCmd
 *
 * @brief   Process the "Profile" Read Response Command
 *
 * @param   pInMsg - incoming message to process
 *
 * @return  none
 */
static uint8 zclSampleLight_ProcessInReadRspCmd( zclIncomingMsg_t *pInMsg ) {
    zclReadRspCmd_t *readRspCmd;
    uint8 i;

    readRspCmd = (zclReadRspCmd_t *)pInMsg->attrCmd;
    for (i = 0; i < readRspCmd->numAttr; i++) {
        // Notify the originator of the results of the original read attributes
        // attempt and, for each successfull request, the value of the requested
        // attribute
    }

    return ( TRUE );
}
#endif // ZCL_READ

#ifdef ZCL_WRITE
/*********************************************************************
 * @fn      zclSampleLight_ProcessInWriteRspCmd
 *
 * @brief   Process the "Profile" Write Response Command
 *
 * @param   pInMsg - incoming message to process
 *
 * @return  none
 */
static uint8 zclSampleLight_ProcessInWriteRspCmd( zclIncomingMsg_t *pInMsg ) {
    zclWriteRspCmd_t *writeRspCmd;
    uint8 i;

    writeRspCmd = (zclWriteRspCmd_t *)pInMsg->attrCmd;
    for ( i = 0; i < writeRspCmd->numAttr; i++ ) {
        // Notify the device of the results of the its original write attributes
        // command.
    }

    return ( TRUE );
}
#endif // ZCL_WRITE

/*********************************************************************
 * @fn      zclSampleLight_ProcessInDefaultRspCmd
 *
 * @brief   Process the "Profile" Default Response Command
 *
 * @param   pInMsg - incoming message to process
 *
 * @return  none
 */
static uint8 zclSampleLight_ProcessInDefaultRspCmd( zclIncomingMsg_t *pInMsg ) {
    // zclDefaultRspCmd_t *defaultRspCmd = (zclDefaultRspCmd_t *)pInMsg->attrCmd;

    // Device is notified of the Default Response command.
    (void)pInMsg;

    return ( TRUE );
}

#ifdef ZCL_DISCOVER
/*********************************************************************
 * @fn      zclSampleLight_ProcessInDiscCmdsRspCmd
 *
 * @brief   Process the Discover Commands Response Command
 *
 * @param   pInMsg - incoming message to process
 *
 * @return  none
 */
static uint8 zclSampleLight_ProcessInDiscCmdsRspCmd( zclIncomingMsg_t *pInMsg ) {
    zclDiscoverCmdsCmdRsp_t *discoverRspCmd;
    uint8 i;

    discoverRspCmd = (zclDiscoverCmdsCmdRsp_t *)pInMsg->attrCmd;
    for ( i = 0; i < discoverRspCmd->numCmd; i++ ) {
        // Device is notified of the result of its attribute discovery command.
    }

    return ( TRUE );
}

/*********************************************************************
 * @fn      zclSampleLight_ProcessInDiscAttrsRspCmd
 *
 * @brief   Process the "Profile" Discover Attributes Response Command
 *
 * @param   pInMsg - incoming message to process
 *
 * @return  none
 */
static uint8 zclSampleLight_ProcessInDiscAttrsRspCmd( zclIncomingMsg_t *pInMsg ) {
    zclDiscoverAttrsRspCmd_t *discoverRspCmd;
    uint8 i;

    discoverRspCmd = (zclDiscoverAttrsRspCmd_t *)pInMsg->attrCmd;
    for ( i = 0; i < discoverRspCmd->numAttr; i++ ) {
        // Device is notified of the result of its attribute discovery command.
    }

    return ( TRUE );
}

/*********************************************************************
 * @fn      zclSampleLight_ProcessInDiscAttrsExtRspCmd
 *
 * @brief   Process the "Profile" Discover Attributes Extended Response Command
 *
 * @param   pInMsg - incoming message to process
 *
 * @return  none
 */
static uint8 zclSampleLight_ProcessInDiscAttrsExtRspCmd( zclIncomingMsg_t *pInMsg ) {
    zclDiscoverAttrsExtRsp_t *discoverRspCmd;
    uint8 i;

    discoverRspCmd = (zclDiscoverAttrsExtRsp_t *)pInMsg->attrCmd;
    for ( i = 0; i < discoverRspCmd->numAttr; i++ ) {
        // Device is notified of the result of its attribute discovery command.
    }

    return ( TRUE );
}
#endif // ZCL_DISCOVER

void zclSampleLight_UiActionToggleLight(uint16 keys) {
    zclSampleLight_OnOffCB(COMMAND_TOGGLE);
}

void zclSampleLight_UpdateLedState(void) {
    // set the LED1 based on light (on or off)
    if ( zclSampleLight_OnOff == LIGHT_ON ) {
        HalLedSet ( UI_LED_APP, HAL_LED_MODE_ON );
    } else {
        HalLedSet ( UI_LED_APP, HAL_LED_MODE_OFF );
    }
}

void zclSampleLight_UiUpdateLcd(uint8 UiState, char * line[3]) {
#ifdef LCD_SUPPORTED
#ifdef ZCL_LEVEL_CTRL
    zclHA_uint8toa( zclSampleLight_LevelCurrentLevel, &sLightLevel[9] );
    line[0] = (char *)sLightLevel;
#endif // ZCL_LEVEL_CTRL
    line[1] = (char *)(zclSampleLight_OnOff ? sLightOn : sLightOff);
    line[2] = "< TOGGLE LIGHT >";
#endif
}

/****************************************************************************
****************************************************************************/