GSM 3 Click Example. More...

#include "board.h"
#include "log.h"
#include "gsm3.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_TO_MESSAGE ""

#define	SMS_MODE "1"

#define	REMOTE_IP "77.46.162.162"

#define	REMOTE_PORT "51111"

#define	MESSAGE_CONTENT "GSM 3 click board - demo example."

#define	APP_BUFFER_SIZE 256

#define	PROCESS_BUFFER_SIZE 256

#define	RESTART_DEVICE "1,1"

#define	DEREGISTER_FROM_NETWORK "2"

#define	FULL_FUNCTIONALITY "1"

#define	ENABLE_REG "2"

#define	AUTOMATIC_REGISTRATION "0"

#define	CONNECTED "+CREG: 2,1"

#define	NO_SIGNAL "99,99"

#define	ENABLE_RESPONSE_HEADER "1"

#define	RESPONSE_CONNECT "CONNECT OK"

#define	TCP_SERVICE_TYPE "\"TCP\","

#define	RESPONSE_URC "+IPD"

#define	UDP_SERVICE_TYPE "\"UDP\","

Enumerations
enum	gsm3_example_state_t { GSM3_CONFIGURE_FOR_NETWORK = 1 , GSM3_WAIT_FOR_CONNECTION , GSM3_CONFIGURE_FOR_EXAMPLE , GSM3_EXAMPLE }
	Example states. More...

Functions
void	application_init (void)

void	application_task (void)

int	main (void)

Detailed Description

GSM 3 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, tests the communication by sending "AT" command, and after that restarts the device.

Application Task

Application task is split in few stages:

GSM3_CONFIGURE_FOR_NETWORK: Sets configuration to device to be able to connect to the network.
GSM3_WAIT_FOR_CONNECTION: Waits for the network registration indicated via CREG URC event and then checks the connection status.
GSM3_CONFIGURE_FOR_EXAMPLE: Sets the device configuration for sending SMS or TCP/UDP messages depending on the selected demo example.
GSM3_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 gsm3_clear_app_buf ( void )
static err_t gsm3_process ( void )
static void gsm3_error_check( err_t error_flag )
static void gsm3_log_app_buf ( void )
static err_t gsm3_rsp_check ( uint8_t *rsp )
static err_t gsm3_configure_for_connection( void )
static err_t gsm3_check_connection( void )
static err_t gsm3_configure_for_messages( void )
static err_t gsm3_send_message( void )

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_TO_MESSAGE. Example: SIM_APN "internet" SIM_SMSC "+381610401" PHONE_NUMBER_TO_MESSAGE "+381659999999"

Author: Stefan Filipovic

Macro Definition Documentation

◆ APP_BUFFER_SIZE

#define APP_BUFFER_SIZE 256

◆ AUTOMATIC_REGISTRATION

#define AUTOMATIC_REGISTRATION "0"

◆ CONNECTED

#define CONNECTED "+CREG: 2,1"

◆ DEMO_EXAMPLE

#define DEMO_EXAMPLE EXAMPLE_TCP_UDP

◆ DEREGISTER_FROM_NETWORK

#define DEREGISTER_FROM_NETWORK "2"

◆ ENABLE_REG

#define ENABLE_REG "2"

◆ ENABLE_RESPONSE_HEADER

#define ENABLE_RESPONSE_HEADER "1"

◆ 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 "GSM 3 click board - demo example."

◆ NO_SIGNAL

#define NO_SIGNAL "99,99"

◆ PHONE_NUMBER_TO_MESSAGE

#define PHONE_NUMBER_TO_MESSAGE ""

◆ PROCESS_BUFFER_SIZE

#define PROCESS_BUFFER_SIZE 256

◆ REMOTE_IP

#define REMOTE_IP "77.46.162.162"

◆ REMOTE_PORT

#define REMOTE_PORT "51111"

◆ RESPONSE_CONNECT

#define RESPONSE_CONNECT "CONNECT OK"

◆ RESPONSE_URC

#define RESPONSE_URC "+IPD"

◆ RESTART_DEVICE

#define RESTART_DEVICE "1,1"

◆ SIM_APN

#define SIM_APN "internet"

◆ SIM_SMSC

#define SIM_SMSC ""

◆ SMS_MODE

#define SMS_MODE "1"

◆ TCP_SERVICE_TYPE

#define TCP_SERVICE_TYPE "\"TCP\","

◆ UDP_SERVICE_TYPE

#define UDP_SERVICE_TYPE "\"UDP\","

Enumeration Type Documentation

◆ gsm3_example_state_t

enum gsm3_example_state_t

Example states.

Predefined enum values for application example state.

Enumerator
GSM3_CONFIGURE_FOR_NETWORK
GSM3_WAIT_FOR_CONNECTION
GSM3_CONFIGURE_FOR_EXAMPLE
GSM3_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 )

Macros

Enumerations

Functions