network.h

Application note Jennic wifi modules sensor wireless

/****************************************************************************/
/*!
 *\MODULE              Jenie Template
 *
 * COMPONENT           $RCSfile: Network.h,v $
 *
 * VERSION             $Name: HEAD $
 *
 * REVISION            $Revision: 1.6 $
 *
 * DATED               $Date: 2008/03/26 15:29:42 $
 *
 * STATUS              $State: Exp $
 *
 * AUTHOR              Martin Looker
 *
 *\DESCRIPTION         Network common handling header.
 *
 * Contains the network configuration settings and the public function prototypes
 * for the common network functions.
 */
/*\CHANGE HISTORY
 *
 * $Log: Network.h,v $
 * Revision 1.6  2008/03/26 15:29:42  mlook
 * Removed use of services, devices now send directly to coordinator.
 *
 * Revision 1.5  2007/11/30 08:01:59  mlook
 * Debug turned off
 *
 * Revision 1.4  2007/11/29 09:16:01  mlook
 * Updates to project files
 *
 * Revision 1.3  2007/11/21 16:11:28  mlook
 * JPI updates - completed
 *
 * Revision 1.2  2007/11/20 16:21:42  mlook
 * Updated to recent Jenie template.
 *
 * Revision 1.1  2007/11/02 12:32:47  mlook
 * Adding new application notes
 *
 *
 *
 * LAST MODIFIED BY    $Author: mlook $
 *                     $Modtime: $
 *
 ****************************************************************************
 *
 * This software is owned by Jennic and/or its supplier and is protected
 * under applicable copyright laws. All rights are reserved. We grant You,
 * and any third parties, a license to use this software solely and
 * exclusively on Jennic products. You, and any third parties must reproduce
 * the copyright and warranty notice and any other legend of ownership on each
 * copy or partial copy of the software.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS". JENNIC MAKES NO WARRANTIES, WHETHER
 * EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE,
 * ACCURACY OR LACK OF NEGLIGENCE. JENNIC SHALL NOT, IN ANY CIRCUMSTANCES,
 * BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, SPECIAL,
 * INCIDENTAL OR CONSEQUENTIAL DAMAGES FOR ANY REASON WHATSOEVER.
 *
 * Copyright Jennic Ltd 2005, 2006, 2007. All rights reserved
 *
 ****************************************************************************/

#ifndef  NETWORK_H_INCLUDED
#define  NETWORK_H_INCLUDED

#if defined __cplusplus
extern "C" {
#endif

/****************************************************************************/
/***        Include files                                                 ***/
/****************************************************************************/
#include <jendefs.h>
#include <jenie.h>

/****************************************************************************/
/***        Macro Definitions                                             ***/
/****************************************************************************/
#define NETWORK_VERSION				6			/**< Network version */
#define NETWORK_PAN_ID				0x1067		/**< Network ID             */
#define NETWORK_APPLICATION_ID		0x10671067	/**< Application ID         */
#define NETWORK_CHANNEL				0			/**< Channel				*/
#define NETWORK_SCAN_CHANNELS		0x07FFF800	/**< Scan channels (only used when CHANNEL is 0) */
#define NETWORK_MAX_CHILDREN		10			/**< Default max children - can't be larger than 10 */
#define NETWORK_ROUTING_TABLE_SIZE	100			/**< Entries in routing table */

#define NETWORK_DEBUG				FALSE  	  	/**< Debug network activity if wanted */
/****************************************************************************/
/***        Exported Function Prototypes                                  ***/
/****************************************************************************/
PUBLIC void 				vNetwork_ConfigureNetwork 		(teJenieDeviceType, uint8, bool_t);
PUBLIC void 				vNetwork_Init 			 		(bool_t, bool_t);
PUBLIC void 				vNetwork_Start 			  		(void);
PUBLIC void 				vNetwork_Main 			  		(void);
PUBLIC void 				vNetwork_StackMgmtEvent   		(teEventType, void *);
PUBLIC void 				vNetwork_StackDataEvent   		(teEventType, void *);
PUBLIC void 				vNetwork_HwEvent 		  		(uint32, uint32);
PUBLIC teJenieStatusCode 	eNetwork_Tx 					(uint64, uint16, uint8 *);
PUBLIC void 				vNetwork_Rx						(uint64, uint16, uint8 *);
PUBLIC teJenieStatusCode 	eNetwork_Sleep 					(uint32, teJenieSleepMode);

PUBLIC bool_t 			 bNetwork_Up 						(void);
PUBLIC bool_t 			 bNetwork_UartUp 					(void);
PUBLIC teJenieDeviceType eNetwork_DeviceType				(void);

#if defined __cplusplus
}
#endif

#endif  /* NETWORK_H_INCLUDED */

/***************************************************************************/
/*!
 *\mainpage Jenie Template Application
 *
 *\section Software_Design Software Design
 *
 * This template uses the Jenie API to provide a useful starting point
 * for Jenie wireless networking applications. Code is already included
 * to implement the features common to most Jenie applications, see
 * Network.c for full details.
 *
 *\section Coordinator_Node Coordinator Node
 *
 * Coordinator.c contains the code to set up and run the Jenie
 * coordinator, heavy use is made of functions in Network.c that provide
 * code common to most Jenie networking applications.
 *
 *\section Router_Node Router Node
 *
 * Router.c contains the code to set up and run the Jenie
 * router, heavy use is made of functions in Network.c that provide
 * code common to most Jenie networking applications.
 *
 *\section End_Device_Node End Device Node
 *
 * EndDevice.c contains the code to set up and run the Jenie
 * end device, heavy use is made of functions in Network.c that provide
 * code common to most Jenie networking applications.
 *
 ***************************************************************************/

/****************************************************************************/
/***        END OF FILE                                                   ***/
/****************************************************************************/