c4glte3e 2.1.0.0
Loading...
Searching...
No Matches
main.c File Reference

4G LTE 3 E Click Example. More...

#include "board.h"
#include "log.h"
#include "c4glte3e.h"
#include "generic_pointer.h"
#include "conversions.h"

Macros

#define EXAMPLE_TCP_UDP   0
 
#define EXAMPLE_SMS   1
 
#define DEMO_EXAMPLE   EXAMPLE_TCP_UDP
 
#define SIM_APN   "internet"
 
#define SIM_SMSC   ""
 
#define PHONE_NUMBER   ""
 
#define SMS_MODE   "1"
 
#define REMOTE_IP   "77.46.162.162"
 
#define REMOTE_PORT   "51111"
 
#define MESSAGE_CONTENT   "4G LTE 3 E Click board - demo example."
 
#define APP_BUFFER_SIZE   256
 
#define PROCESS_BUFFER_SIZE   256
 
#define READ_RESPONSE_TIMEOUT_MS   120000
 
#define NETWORK_STATUS_LED   "14,2"
 
#define MODULE_STATUS_LED   "15,10"
 
#define DEREGISTER_FROM_NETWORK   "2"
 
#define FULL_FUNCTIONALITY   "1"
 
#define ENABLE_REG   "2"
 
#define AUTOMATIC_REGISTRATION   "0"
 
#define CONNECTED   "+CEREG: 2,1"
 
#define ACTIVATE_PDP_CONTEXT   "1,1"
 
#define PDP_CID   "1"
 
#define TCP_PROTOCOL   "6"
 
#define UDP_PROTOCOL   "17"
 

Enumerations

enum  c4glte3e_app_state_t {
  C4GLTE3E_POWER_UP = 1 , C4GLTE3E_CONFIG_CONNECTION , C4GLTE3E_CHECK_CONNECTION , C4GLTE3E_CONFIG_EXAMPLE ,
  C4GLTE3E_EXAMPLE
}
 Example states. More...
 

Functions

void application_init (void)
 
void application_task (void)
 
int main (void)
 

Detailed Description

4G LTE 3 E Click Example.

Description

Application example shows device capability of connecting to the network and sending SMS or TCP/UDP messages using standard "AT" commands.

The demo application is composed of two sections :

Application Init

Initializes the driver and logger.

Application Task

Application task is split in few stages:

  • C4GLTE3E_POWER_UP: Powers up the device, performs a factory reset and reads system information.
  • C4GLTE3E_CONFIG_CONNECTION: Sets configuration to device to be able to connect to the network.
  • C4GLTE3E_CHECK_CONNECTION: Waits for the network registration indicated via CEREG command and then checks the signal quality report.
  • C4GLTE3E_CONFIG_EXAMPLE: Configures device for the selected example.
  • C4GLTE3E_EXAMPLE: Depending on the selected demo example, it sends an SMS message (in PDU or TXT mode) or TCP/UDP message.

By default, the TCP/UDP example is selected.

Additional Function

  • static void c4glte3e_clear_app_buf ( void )
  • static void c4glte3e_log_app_buf ( void )
  • static err_t c4glte3e_process ( c4glte3e_t *ctx )
  • static err_t c4glte3e_read_response ( c4glte3e_t *ctx, uint8_t *rsp )
  • static err_t c4glte3e_power_up ( c4glte3e_t *ctx )
  • static err_t c4glte3e_config_connection ( c4glte3e_t *ctx )
  • static err_t c4glte3e_check_connection ( c4glte3e_t *ctx )
  • static err_t c4glte3e_config_example ( c4glte3e_t *ctx )
  • static err_t c4glte3e_example ( c4glte3e_t *ctx )
Note
In order for the examples to work, user needs to set the APN and SMSC (SMS PDU mode only) of entered SIM card as well as the phone number (SMS mode only) to which he wants to send an SMS. Enter valid values for the following macros: SIM_APN, SIM_SMSC and PHONE_NUMBER. Example: SIM_APN "internet" SIM_SMSC "+381610401" PHONE_NUMBER "+381659999999"
Author
Stefan Filipovic

Macro Definition Documentation

◆ ACTIVATE_PDP_CONTEXT

#define ACTIVATE_PDP_CONTEXT   "1,1"

◆ APP_BUFFER_SIZE

#define APP_BUFFER_SIZE   256

◆ AUTOMATIC_REGISTRATION

#define AUTOMATIC_REGISTRATION   "0"

◆ CONNECTED

#define CONNECTED   "+CEREG: 2,1"

◆ DEMO_EXAMPLE

#define DEMO_EXAMPLE   EXAMPLE_TCP_UDP

◆ DEREGISTER_FROM_NETWORK

#define DEREGISTER_FROM_NETWORK   "2"

◆ ENABLE_REG

#define ENABLE_REG   "2"

◆ EXAMPLE_SMS

#define EXAMPLE_SMS   1

◆ EXAMPLE_TCP_UDP

#define EXAMPLE_TCP_UDP   0

◆ FULL_FUNCTIONALITY

#define FULL_FUNCTIONALITY   "1"

◆ MESSAGE_CONTENT

#define MESSAGE_CONTENT   "4G LTE 3 E Click board - demo example."

◆ MODULE_STATUS_LED

#define MODULE_STATUS_LED   "15,10"

◆ NETWORK_STATUS_LED

#define NETWORK_STATUS_LED   "14,2"

◆ PDP_CID

#define PDP_CID   "1"

◆ PHONE_NUMBER

#define PHONE_NUMBER   ""

◆ PROCESS_BUFFER_SIZE

#define PROCESS_BUFFER_SIZE   256

◆ READ_RESPONSE_TIMEOUT_MS

#define READ_RESPONSE_TIMEOUT_MS   120000

◆ REMOTE_IP

#define REMOTE_IP   "77.46.162.162"

◆ REMOTE_PORT

#define REMOTE_PORT   "51111"

◆ SIM_APN

#define SIM_APN   "internet"

◆ SIM_SMSC

#define SIM_SMSC   ""

◆ SMS_MODE

#define SMS_MODE   "1"

◆ TCP_PROTOCOL

#define TCP_PROTOCOL   "6"

◆ UDP_PROTOCOL

#define UDP_PROTOCOL   "17"

Enumeration Type Documentation

◆ c4glte3e_app_state_t

Example states.

Predefined enum values for application example state.

Enumerator
C4GLTE3E_POWER_UP 
C4GLTE3E_CONFIG_CONNECTION 
C4GLTE3E_CHECK_CONNECTION 
C4GLTE3E_CONFIG_EXAMPLE 
C4GLTE3E_EXAMPLE 

Function Documentation

◆ application_init()

void application_init ( void )

< Logger config object.

< Click config object.

Logger initialization. Default baud rate: 115200 Default log level: LOG_LEVEL_DEBUG

Note
If USB_UART_RX and USB_UART_TX are defined as HAL_PIN_NC, you will need to define them manually for log to work. See LOG_MAP_USB_UART macro definition for detailed explanation.

◆ application_task()

void application_task ( void )

◆ main()

int main ( void )