G2C 3G Click Example. More...

#include "board.h"
#include "log.h"
#include "g2c3g.h"
#include "conversions.h"

Macros
#define	SIM_APN ""

#define	SIM_USERNAME ""

#define	SIM_PASSWORD ""

#define	DEVICE_KEY ""

#define	DEVICE_PASSWORD ""

#define	DEVICE_SENSOR_REF ""

#define	APP_BUFFER_SIZE 300

#define	PROCESS_BUFFER_SIZE 300

#define	ENABLE_CONNECTOR_MODULE "1"

#define	CONNECT_TO_NETWORK "1"

#define	CONNECT_TO_BROKER "1"

#define	ACTUATOR_WAIT_TIME_MS 10000

#define	TEMPERATURE_MIN -20

#define	TEMPERATURE_MAX 80

#define	TEMPERATURE_STEP 5

Enumerations
enum	g2c3g_example_state_t { G2C3G_CONNECT_TO_NETWORK = 1 , G2C3G_CONNECT_TO_CLOUD , G2C3G_EXAMPLE }
	Example states. More...

Functions
void	application_init (void)

void	application_task (void)

int	main (void)

Detailed Description

G2C 3G Click Example.

Description

This example shows the device capability of connecting to the cloud and updating the sensor data on the cloud and receiving data from actuators.

The demo application is composed of two sections :

Application Init

Initializes the driver, restarts the device, and after that tests the communication by sending "AT" command.

Application Task

Application task is split in few stages:

G2C3G_CONNECT_TO_NETWORK: Sends commands to configure device to connect to the specified network.
G2C3G_CONNECT_TO_CLOUD: Sends commands to configure device to connect to the specified device on the cloud.
G2C3G_EXAMPLE: This function executes example which updates sensor data on the cloud and displays all data received from the module (ex. the actuator switch state change received from the cloud).

Additional Function

static void g2c3g_clear_app_buf ( void )
static err_t g2c3g_process ( void )
static void g2c3g_error_check( err_t error_flag )
static void g2c3g_log_app_buf ( void )
static err_t g2c3g_rsp_check ( uint8_t *rsp )
static err_t g2c3g_connect_to_network( void )
static err_t g2c3g_connect_to_cloud( void )
static err_t g2c3g_example( void )

Note: In order for the example to work, user needs to set the SIM card and the cloud device parameters. Enter valid values for the following macros: SIM_APN, SIM_USERNAME, SIM_PASSWORD, DEVICE_KEY, DEVICE_PASSWORD, DEVICE_SENSOR_REF. Example: SIM_APN "internet" SIM_USERNAME "internet" SIM_PASSWORD "internet" DEVICE_KEY "xxxxxxxxxxxxxxxx" DEVICE_PASSWORD "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" DEVICE_SENSOR_REF "TEMP_SEN_R"

DEVICE_KEY and DEVICE_PASSWORD strings should match the device credentials which were generated during the Click Cloud device creation step. DEVICE_SENSOR_REF is expected to be a reference to a temperature sensor with a data range from -20 to +80 degrees Celsius. For more information about the registration on the Click Cloud and creating the device refer to the following user guide: https://download.mikroe.com/documents/click-cloud/guide-to-click-cloud.pdf

Author: Stefan Filipovic

Macro Definition Documentation

◆ ACTUATOR_WAIT_TIME_MS

#define ACTUATOR_WAIT_TIME_MS 10000

◆ APP_BUFFER_SIZE

#define APP_BUFFER_SIZE 300

◆ CONNECT_TO_BROKER

#define CONNECT_TO_BROKER "1"

◆ CONNECT_TO_NETWORK

#define CONNECT_TO_NETWORK "1"

◆ DEVICE_KEY

#define DEVICE_KEY ""

◆ DEVICE_PASSWORD

#define DEVICE_PASSWORD ""

◆ DEVICE_SENSOR_REF

#define DEVICE_SENSOR_REF ""

◆ ENABLE_CONNECTOR_MODULE

#define ENABLE_CONNECTOR_MODULE "1"

◆ PROCESS_BUFFER_SIZE

#define PROCESS_BUFFER_SIZE 300

◆ SIM_APN

#define SIM_APN ""

◆ SIM_PASSWORD

#define SIM_PASSWORD ""

◆ SIM_USERNAME

#define SIM_USERNAME ""

◆ TEMPERATURE_MAX

#define TEMPERATURE_MAX 80

◆ TEMPERATURE_MIN

#define TEMPERATURE_MIN -20

◆ TEMPERATURE_STEP

#define TEMPERATURE_STEP 5

Enumeration Type Documentation

◆ g2c3g_example_state_t

enum g2c3g_example_state_t

Example states.

Predefined enum values for application example state.

Enumerator
G2C3G_CONNECT_TO_NETWORK
G2C3G_CONNECT_TO_CLOUD
G2C3G_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