LP_CC2674R10_FPGA/thread/door_lock/tiop_ui.h

Go to the documentation of this file.

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

 @file tiop_ui.h

 @brief TI-OpenThread CUI Functions

 Group: CMCU, LPC
 Target Device: cc13xx_cc26xx

 ******************************************************************************
 
 Copyright (c) 2017-2022, Texas Instruments Incorporated
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:

 *  Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

 *  Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.

 *  Neither the name of Texas Instruments Incorporated nor the names of
    its contributors may be used to endorse or promote products derived
    from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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

#ifndef TIOP_UI_H_
#define TIOP_UI_H_

#include "cui.h"
#include <openthread/thread.h>

typedef enum
{
    CUI_conn_disabled,
    CUI_conn_joining,
    CUI_conn_joined,
    CUI_conn_join_fail,
} cuiConn;

extern void tiopCUIInit(char* appString,
                        Button_Handle* rightButtonHandle);

extern void tiopCUIUpdateRole(otDeviceRole role);

extern void tiopCUIUpdateDeviceInfo(void);

extern void tiopCUIUpdatePANID(otPanId pan);

extern void tiopCUIUpdateChannel(uint8_t ch);

extern void tiopCUIUpdateShortAddr(otShortAddress s);

extern void tiopCUIUpdateMasterkey(otMasterKey key);

extern void tiopCUIUpdateExtPANID(otExtendedPanId extPan);

extern void tiopCUIUpdateNwkName(const char* name);

extern void tiopCUIUpdateConnStatus(cuiConn status);

extern void tiopCUIUpdateApp(char* appInfo);

extern void uiActionProcessConfigurePanId(const char _input, char* _pLines[3],
                                          CUI_cursorInfo_t* _pCurInfo);

extern void uiActionProcessConfigureChannel(const char _input,
                                            char* _pLines[3], CUI_cursorInfo_t* _pCurInfo);

extern void uiActionAttach(const int32_t _itemEntry);

extern void uiActionJoin(const int32_t _itemEntry);

extern void processKeyChangeCB(Button_Handle _buttonHandle,
                               Button_EventMask _buttonEvents);

extern void processMenuUpdateFn(void);

extern void tiopCUINwkReset(const char _input, char* _pLines[3],
                            CUI_cursorInfo_t* _pCurInfo);

extern void tiopCUIReset(const char _input, char* _pLines[3],
                         CUI_cursorInfo_t* _pCurInfo);


#endif /* TIOP_UI_H_ */