tempsense_app.h

Go to the documentation of this file.

 
/*
 *  Copyright (c) 2019, Cascoda Ltd.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. 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.
 *  3. Neither the name of the copyright holder 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 HOLDER 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.
 */
#include "cascoda-bm/cascoda_serial.h"
#include "cascoda-bm/cascoda_types.h"
 
#ifndef TEMPSENSE_APP_H
#define TEMPSENSE_APP_H
 
/******************************************************************************/
/****** System Definitions                                               ******/
/******************************************************************************/
#define APP_WAKEUPINTERVALL 5
#define APP_TIMEOUTINTERVALL 15
#define APP_DEVICETIMEOUT 1000
#define APP_DEVICE_MAX_RETRIES 1
#define APP_MAX_DEVICES 32
#define APP_DEFAULT_PDN_MODE PDM_DPD
#define APP_USE_EXTERNAL_CLOCK 1
#define APP_LQI_LIMIT 75
#define APP_ED_LIMIT 50
#define APP_VBAT_LIMIT 1862 /* = 2.5 V */
#define APP_REPORT_VBATT 1
#define APP_REPORT_LQI 1
#define APP_REPORT_ED 1
#define APP_COORD_REPORTN 1
#define APP_COORD_SREINIT 0
#define APP_USE_DEBUG 0
 
/******************************************************************************/
/****** MAC PIB Default Values                                           ******/
/******************************************************************************/
#define MAC_PANID 0xCA5C
#define MAC_SHORTADD 0xCA00
#define MAC_LONGADD                                    \
    {                                                  \
        0x00, 0x00, 0x00, 0x00, 0xA0, 0x0D, 0x5C, 0xCA \
    }
#define MAC_CHANNELLIST \
    {                   \
        11, 18, 24      \
    }
 
/******************************************************************************/
/****** Application State Definitions                                    ******/
/******************************************************************************/
#define APP_ST_NORMAL 0      
#define APP_ST_COORDINATOR 1 
#define APP_ST_DEVICE 2      
 
/******************************************************************************/
/****** Communication State Definitions                                  ******/
/******************************************************************************/
#define APP_CST_DONE 0x00             
#define APP_CST_WAKEUP_REQUESTED 0x01 
#define APP_CST_WAKEUP_CONFIRMED 0x02 
#define APP_CST_WAKEUP_RECEIVED 0x03  
#define APP_CST_C_DATA_REQUESTED 0x04 
#define APP_CST_C_DATA_CONFIRMED 0x05 
#define APP_CST_C_DATA_RECEIVED 0x06  
#define APP_CST_D_DATA_REQUESTED 0x07 
#define APP_CST_GO_POWERDOWN 0x08     
#define APP_CST_ASSOC_REQUESTED 0x09  //|< assoc. request sent   (device)
#define APP_CST_SCANNING 0x0A         //|< scanning in progress  (device)
 
/******************************************************************************/
/****** Data Packet Types, defined by MSDU[0]                            ******/
/******************************************************************************/
#define PT_MSDU_D_WAKEUP 0x01 
#define PT_MSDU_C_DATA 0x02   
#define PT_MSDU_D_DATA 0x03   
 
/******************************************************************************/
/****** Global Variables                                                 ******/
/******************************************************************************/
extern u8_t APP_STATE;
extern u8_t APP_STATE_new;
extern u8_t APP_INITIALISE;
extern u8_t APP_CONNECTED;
 
extern u16_t APP_PANId;
extern u16_t APP_ShortAddress;
extern u8_t  APP_LongAddress[8];
extern u8_t  APP_Channel;
 
/******************************************************************************/
/****** APP Functions                                                    ******/
/******************************************************************************/
/* tempsense_app */
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Handler(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Initialise(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
int TEMPSENSE_APP_UpStreamDispatch(struct SerialBuffer *SerialRxBuffer, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_SwitchMode(u8_t mode);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_InitPIB(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
u8_t TEMPSENSE_APP_GetTempVal(void);
 
/******************************************************************************/
/***************************************************************************/ 
u16_t TEMPSENSE_APP_GetVoltsVal(void);
 
/******************************************************************************/
/***************************************************************************/ 
u32_t TEMPSENSE_APP_GetScanChannels(void);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_PrintScanChannels(void);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_PrintSeconds(void);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_LED_Handler(void);
 
/* tempsense_app_coord */
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Coordinator_Handler(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Coordinator_Initialise(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Coordinator_Start(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Coordinator_ProcessScanCnf(struct MLME_SCAN_confirm_pset *params, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Coordinator_AssociateResponse(struct MLME_ASSOCIATE_indication_pset *params,
                                                 struct ca821x_dev                     *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Coordinator_ProcessDataInd(struct MCPS_DATA_indication_pset *params, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Coordinator_ProcessDataCnf(struct MCPS_DATA_confirm_pset *params, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Coordinator_DisplayData(u8_t                              device,
                                           u8_t                              edcoord,
                                           struct MCPS_DATA_indication_pset *params,
                                           struct ca821x_dev                *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Coordinator_CheckTimeouts(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Coordinator_CheckVbatt(u16_t vbat);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Coordinator_CheckLQI(u8_t lqi_ts, u8_t lqi_coord);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Coordinator_CheckED(u8_t ed_ts, u8_t ed_coord);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Coordinator_SoftReinit(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Coordinator_ReportStatus(void);
/* tempsense_app_device */
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Device_Handler(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Device_Initialise(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Device_GetLongAddress(void);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Device_Start(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Device_ProcessScanCnf(struct MLME_SCAN_confirm_pset *params, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Device_ProcessAssociateCnf(struct MLME_ASSOCIATE_confirm_pset *params,
                                              struct ca821x_dev                  *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Device_ProcessDataInd(struct MCPS_DATA_indication_pset *params, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Device_ProcessDataCnf(struct MCPS_DATA_confirm_pset *params, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Device_ExchangeData(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Device_CheckTimeout(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Device_GoPowerDown(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Device_RestoreStateFromFlash(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void TEMPSENSE_APP_Device_SaveStateToFlash(void);
 
#endif // TEMPSENSE_APP_H