http://www.wavecom.com/forum Open AT ®  Release version: 3.13

Sample - Download Library

• Changes
• Library Description
• Library API

• V2.00 : Initial revision
• V2.10 : FTP support
• V2.10b : XModem and FTP download enhancement
• V3.00 : Multi-Uart support ; A&D cells support
• V3.01 : TCPIP Add-on v3.00 interface changes
• V3.10 : FCM interface changes ; Uses the ADL RTC service, in order to measure the down/upload elapsed time ;
  FTP protocol removed ; now the DTL add-on library has to be used

This Download sample ADL Library allows applications to download or upload applications and data buffers via V24 or GSM Data flow, using the 1K XMODEM protocol.

The library has to be subscribed, with an event callback, before starting any download or upload process. In order to set up a download or upload session, the application must follow the steps bellow :

• in case of GSM Data call, it must establish the data call ;
   
• it must call either dwl_Download or dwl_Upload API to start the process, providing the requested modes and buffers ;
   
• if the authentification option is requested, the remote part is prompted for a defined password. This pass word can be modified by one another API ;
   
• the down/uploader then waits for the remote part to start the up/download process ;
   
• at the end of process, the event callback is called with an OK or ERROR message, according to the session result.
   

All constants and APIs are defined by the download.h header file, which must be included by any application to allows it to use the Download Library.

The library will need the global variable bellow on link operation, to define the trace level on which will be displayed the download traces :

extern u8 dwl_TraceLevel;

The download APIs are defined bellow :

s16  dwl_Subscribe ( dwl_Callback_f  dwlCallback );  
 


Parameter	Description
dwlCallback	event callback to be called at the end of the process (see bellow).

typedef  void ( * dwl_Callback_f ) ( u8  Event, s32  Length, u8  Flow, u8  Type, u8  Mode, u32  Time );  
 


Parameter	Description
Event	process result (DWL_OK or DWL_ERROR)
Length	on DWL_OK : number of downloaded/uploaded bytes on DWL_ERROR : error code
Flow	used flow for the process
Type	process type (ram or application)
Mode	process mode (DWL_MODE_DOWNLOAD or DWL_MODE_UPLOAD)
Time	on DWL_OK : down/upload time duration, in seconds on DWL_ERROR : error type

void  dwl_Unsubscribe ( void );  
 

s8  dwl_Download ( u8  DwlType, u32  Length, u8 *  pData, u8  FlowID, ascii *  FileName, ascii *  FilePath );  
 


Parameter	Description
DwlType	Download type. It is a logical or between following values :    Download destination :  DWL_TYPE_RAM -> copy downloaded data in the provided pData buffer.  DWL_TYPE_APPLI -> copy downloaded data in an A&D cell (ID provided in pData parameter).    Authentification mode :  DWL_AUTH_TYPE_NORMAL -> the download session start immediatly.  DWL_AUTH_TYPE_PASSWORD -> the remote part is prompted for a password.    Install mode (only used with DWL_TYPE_APPLI mode) :  DWL_APPLI_KEEP_MEM -> the application is downloaded and not installed.  DWL_APPLI_INSTALL -> the application is installed at the end of the download process.    Protocol :  DWL_PROTOCOL_XMODEM -> use the 1K XModem protocol on provided FlowID.
Length	buffer length in DWL_TYPE_RAM mode
pData	RAM buffer in DWL_TYPE_RAM mode A&D cell ID in DWL_TYPE_APPLI mode
FlowID	ADL flow ID to use for the download process
FileName	Reserved
FilePath	Reserved

s8  dwl_Upload ( u8  DwlType, u32  Length, u8 *  pData, u8  FlowID, ascii *  FileName, ascii *  FilePath );  
 


Parameter	Description
DwlType	Upload type. It is a logical or between following values :    Upload source :  DWL_TYPE_RAM -> upload data from the provided pData buffer.  DWL_TYPE_APPLI -> upload data from an A&D cell (ID provided in pData parameter).    Authentification mode :  DWL_AUTH_TYPE_NORMAL -> the upload session start immediatly.  DWL_AUTH_TYPE_PASSWORD -> the remote part is prompted for a password.    Protocol :  DWL_PROTOCOL_XMODEM -> use the 1K XModem protocol on provided FlowID.
Length	buffer length in DWL_TYPE_RAM mode
pData	RAM buffer in DWL_TYPE_RAM mode A&D cell ID in DWL_TYPE_APPLI mode
FlowID	ADL flow ID to use for the download process
FileName	Reserved
FilePath	Reserved

bool  dwl_IsAnAppliDownloaded ( u32  CellID );  
 


Parameter	Description
CellID	Cell ID to check.

bool  dwl_ChangePassword ( ascii *  OldPassword, ascii *  NewPassword );  
 


Parameter	Description
OldPassword	Current password (default value is "startdota")
NewPassword	New password to be set (will be stored in non-volatile memory)

Updated: Wed Apr 4 13:10:25 CEST 2007;