amq amq / CNManager

Fork of CNManager by u-blox

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers CNData.h Source File

CNData.h

00001 #pragma once 
00002 
00003 #include "CNManager.h"
00004 #include "CNReg.h"
00005 
00006 //!Data Status
00007 typedef enum{
00008     DATA_NO_CHANGES,           //!< No changes
00009     DATA_IS_CONNECTED,         //!< Data channel is connected
00010     DATA_IS_DISCONNECTED,      //!< Data channel is disconnected
00011 } DataConnStatus;
00012 
00013 /** Data Init.
00014   This function has to be called prior to dataTick
00015  */
00016 void cnDataInit();
00017 
00018 /** Loop data module
00019   \param lib  pointer to CN library
00020   \param regStatus for registration status
00021   \param dataStatus [output] data status
00022   \return CNResp
00023  */
00024 CNResp cnDataLoop(CNLib* const lib, RegStatus regStatus, DataConnStatus* const dataStatus);
00025 
00026 /** Register (Attach) the MT to the GPRS service.
00027  This function can be called at any time.
00028    \param enabled if true data connection is requested, if false not.
00029  */
00030 void cnDataEnable(bool enabled);
00031 
00032 /** Reset
00033  */
00034 void cnDataReset();
00035 
00036 /** Set parameters for the GPRS service.
00037 If Apn parameters are not set, the internal APN info database will be used.
00038  \param apn the of the network provider e.g.
00039  \param apn the of the network provider e.g. "internet" or "apn.provider.com"
00040  \param username is the user name text string for the authentication phase
00041  \param password is the password text string for the authentication phase
00042  \param auth is the authentication mode (CHAP,PAP,NONE or DETECT)
00043  */
00044 void cnDataSetupApn(const char* apn, const char* username, const char* password);