g2c3g  2.1.0.0
Main Page

G2C 3G click

Go to Cloud (G2C) 3G click is a gateway Click boardâ„¢ which provides a simple and reliable connection to the Click Cloud platform, a cloud-based rapid prototyping environment, hosted by Mikroe. G2C 3G offers an unprecedented simplicity for adding Click Cloud connectivity over UMTS/HSPA to any embedded application, by utilizing the simple UART interface: it can be configured and managed using a minimal set of well-documented AT commands.

click Product page


Click library

  • Author : Stefan Filipovic
  • Date : May 2023.
  • Type : UART type

Software Support

We provide a library for the G2C 3G Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for G2C 3G Click driver.

Standard key functions :

Example key functions :

  • g2c3g_reset_device This function resets the device by toggling the RST pin.
  • g2c3g_set_net_creds This function sets the APN, username, and password for entered sim card.
    void g2c3g_set_net_creds ( g2c3g_t *ctx, uint8_t *sim_apn, uint8_t *username, uint8_t *password );
  • g2c3g_set_broker_creds This function sets the broker credentials (device key and password).
    void g2c3g_set_broker_creds ( g2c3g_t *ctx, uint8_t *dev_key, uint8_t *password );

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.

void application_init ( void )
{
log_cfg_t log_cfg;
g2c3g_cfg_t g2c3g_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
g2c3g_cfg_setup( &g2c3g_cfg );
G2C3G_MAP_MIKROBUS( g2c3g_cfg, MIKROBUS_2 );
if ( UART_ERROR == g2c3g_init( &g2c3g, &g2c3g_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
// Clear RX buffer
g2c3g_process( );
g2c3g_clear_app_buf( );
Delay_ms ( 100 );
// Reset device
g2c3g_reset_device ( &g2c3g );
error_flag = g2c3g_rsp_check( G2C3G_RSP_DEVICE_READY );
g2c3g_error_check( error_flag );
// Check communication
error_flag = g2c3g_rsp_check( G2C3G_RSP_OK );
g2c3g_error_check( error_flag );
log_info( &logger, " Application Task " );
example_state = G2C3G_CONNECT_TO_NETWORK;
}

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).

void application_task ( void )
{
switch ( example_state )
{
{
if ( G2C3G_OK == g2c3g_connect_to_network( ) )
{
example_state = G2C3G_CONNECT_TO_CLOUD;
}
break;
}
{
if ( G2C3G_OK == g2c3g_connect_to_cloud( ) )
{
example_state = G2C3G_EXAMPLE;
}
break;
}
{
g2c3g_example( );
break;
}
default:
{
log_error( &logger, " Example state." );
break;
}
}
}

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.

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.G2C3G

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. UART terminal is available in all MikroElektronika compilers.


G2C3G_CONNECT_TO_CLOUD
@ G2C3G_CONNECT_TO_CLOUD
Definition: main.c:88
g2c3g_t
G2C 3G Click context object.
Definition: g2c3g.h:141
g2c3g_cfg_t
G2C 3G Click configuration object.
Definition: g2c3g.h:165
g2c3g_send_cmd
void g2c3g_send_cmd(g2c3g_t *ctx, uint8_t *cmd)
G2C 3G send command function.
G2C3G_MAP_MIKROBUS
#define G2C3G_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: g2c3g.h:124
application_task
void application_task(void)
Definition: main.c:228
g2c3g_set_broker_creds
void g2c3g_set_broker_creds(g2c3g_t *ctx, uint8_t *dev_key, uint8_t *password)
G2C 3G set broker credentials.
G2C3G_RSP_OK
#define G2C3G_RSP_OK
G2C 3G device response for AT commands.
Definition: g2c3g.h:92
G2C3G_CONNECT_TO_NETWORK
@ G2C3G_CONNECT_TO_NETWORK
Definition: main.c:87
g2c3g_cfg_setup
void g2c3g_cfg_setup(g2c3g_cfg_t *cfg)
G2C 3G configuration object setup function.
g2c3g_init
err_t g2c3g_init(g2c3g_t *ctx, g2c3g_cfg_t *cfg)
G2C 3G initialization function.
G2C3G_RSP_DEVICE_READY
#define G2C3G_RSP_DEVICE_READY
Definition: g2c3g.h:94
g2c3g_set_net_creds
void g2c3g_set_net_creds(g2c3g_t *ctx, uint8_t *sim_apn, uint8_t *username, uint8_t *password)
G2C 3G set network credentials.
application_init
void application_init(void)
Definition: main.c:182
g2c3g_reset_device
void g2c3g_reset_device(g2c3g_t *ctx)
G2C 3G reset device function.
G2C3G_EXAMPLE
@ G2C3G_EXAMPLE
Definition: main.c:89
G2C3G_OK
@ G2C3G_OK
Definition: g2c3g.h:192
G2C3G_CMD_AT
#define G2C3G_CMD_AT
G2C 3G control commands.
Definition: g2c3g.h:69