API  2.3.0
TSmarT Software Library
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages

Data Structures

struct  tsmart_cellular_2g_time_t
 time struct More...
 
struct  tsmart_cellular_2g_notif_type_t
 Indicator of notification structure. More...
 
struct  tsmart_cellular_2g_notif_new_conn_t
 New connection structure. More...
 
struct  tsmart_cellular_2g_notif_new_data_t
 New data received structure. More...
 
struct  tsmart_cellular_2g_notif_conn_closed_t
 Close connection structure. More...
 
struct  tsmart_cellular_2g_notif_cme_t
 CME error structure. More...
 
struct  tsmart_cellular_2g_notif_sms_t
 New SMS received structure. More...
 
struct  tsmart_cellular_2g_notif_shutdown_t
 Shoutdown structure. More...
 
struct  tsmart_cellular_2g_notif_alarm_t
 alarm structure. More...
 
union  tsmart_cellular_2g_notif_t
 Union of the possible notifications structures. More...
 
struct  tsmart_cellular_2g_file_location_t
 FTP File location structure. More...
 
struct  tsmart_cellular_2g_ip_t
 IP address format structure. More...
 
struct  tsmart_cellular_2g_mask_t
 Subnet mask format structure. More...
 
struct  tsmart_cellular_2g_dns_t
 Domain name system address format structure. More...
 
struct  tsmart_cellular_2g_tcp_server_t
 TCP server structure. More...
 
struct  tsmart_cellular_2g_ftp_client_t
 FTP client structure. More...
 
struct  tsmart_cellular_2g_tcp_client_t
 TCP client structure. More...
 
struct  tsmart_cellular_2g_session_t
 Session parameters. More...
 
struct  tsmart_cellular_2g_sessions_t
 Currently active sessions in the module. More...
 
struct  tsmart_cellular_2g_sms_inbox_t
 SMS inbox structure. More...
 
struct  tsmart_cellular_2g_cell_info_t
 Cell info structure. More...
 
struct  tsmart_cellular_2g_device_config_t
 configuration structure More...
 
struct  tsmart_cellular_2g_tcp_ip_stack_config_t
 TCP/IP stack configuration structure. More...
 
struct  tsmart_cellular_2g_bearer_config_t
 Bearer configuration structure. More...
 
struct  tsmart_cellular_2g_t
 Cellular 2g module handler structure. More...
 

Enumerations

enum  tsmart_cellular_2g_reg_t {
  TSMART_CELLULAR_2G_NOT_REGISTERED, TSMART_CELLULAR_2G_REGISTERED_HOME, TSMART_CELLULAR_2G_SEARCHING_OPERATOR, TSMART_CELLULAR_2G_REGISTRATION_DENIED,
  TSMART_CELLULAR_2G_REGISTERED_ROAMING, TSMART_CELLULAR_2G_UNKNOWN, TSMART_CELLULAR_2G_ATTACHED, TSMART_CELLULAR_2G_DETTACHED,
  TSMART_CELLULAR_2G_FAIL = TSMART_FAIL
}
 GSM/GPRS/Attach registration states. More...
 
enum  tsmart_cellular_2g_flag_t { TSMART_CELLULAR_2G_DISABLE, TSMART_CELLULAR_2G_ENABLE }
 Standard label for enabling/disabling. More...
 
enum  tsmart_cellular_2g_sms_label_t {
  TSMART_CELLULAR_2G_REC_UNREAD, TSMART_CELLULAR_2G_REC_READ, TSMART_CELLULAR_2G_STO_UNSET, TSMART_CELLULAR_2G_STO_SENT,
  TSMART_CELLULAR_2G_ALL
}
 Label to filter SMS reading. More...
 
enum  tsmart_cellular_2g_protocol_t { TSMART_CELLULAR_2G_TCP_CLIENT = 2, TSMART_CELLULAR_2G_TCP_SERVER = 3, TSMART_CELLULAR_2G_FTP_CLIENT = 4 }
 Type of protocol. More...
 
enum  tsmart_cellular_2g_location_t { TSMART_CELLULAR_2G_STM32FLASH, TSMART_CELLULAR_2G_RAM }
 Label to select location. More...
 
enum  tsmart_cellular_2g_type_t {
  TSMART_CELLULAR_2G_NEW_CONN, TSMART_CELLULAR_2G_NEW_DATA, TSMART_CELLULAR_2G_CONN_CLOSE, TSMART_CELLULAR_2G_CME,
  TSMART_CELLULAR_2G_SMS, TSMART_CELLULAR_2G_SHOUTDOWN, TSMART_CELLULAR_2G_ALARM
}
 Types of notifications. More...
 

Detailed Description

Enumeration Type Documentation

Standard label for enabling/disabling.

Enumerator
TSMART_CELLULAR_2G_DISABLE 

Enable

TSMART_CELLULAR_2G_ENABLE 

Disable

Label to select location.

This label is used to select the adequate location to save the downloaded FTP file.

Enumerator
TSMART_CELLULAR_2G_STM32FLASH 

Selection of the internal flash memory to receive FTP file

TSMART_CELLULAR_2G_RAM 

Selection of the internal RAM memory to receive FTP file

Type of protocol.

Enumerator
TSMART_CELLULAR_2G_TCP_CLIENT 

TCP Client protocol

TSMART_CELLULAR_2G_TCP_SERVER 

TCP Server protocol

TSMART_CELLULAR_2G_FTP_CLIENT 

FTP Client protocol

GSM/GPRS/Attach registration states.

Enumerator
TSMART_CELLULAR_2G_NOT_REGISTERED 

Not registered, ME is not currently searching a new operator to register to

TSMART_CELLULAR_2G_REGISTERED_HOME 

Registered, home network

TSMART_CELLULAR_2G_SEARCHING_OPERATOR 

Not registered, but ME is currently searching a new operator to register to

TSMART_CELLULAR_2G_REGISTRATION_DENIED 

Registration denied

TSMART_CELLULAR_2G_REGISTERED_ROAMING 

Registered, roaming

TSMART_CELLULAR_2G_UNKNOWN 

Unknown

TSMART_CELLULAR_2G_ATTACHED 

Attached

TSMART_CELLULAR_2G_DETTACHED 

Detached

TSMART_CELLULAR_2G_FAIL 

Data request failure

Label to filter SMS reading.

Enumerator
TSMART_CELLULAR_2G_REC_UNREAD 

Received unread message

TSMART_CELLULAR_2G_REC_READ 

Received read message

TSMART_CELLULAR_2G_STO_UNSET 

Stored unsent message

TSMART_CELLULAR_2G_STO_SENT 

Stored sent message

TSMART_CELLULAR_2G_ALL 

All messages

Types of notifications.

Enumerator
TSMART_CELLULAR_2G_NEW_CONN 

New connection

TSMART_CELLULAR_2G_NEW_DATA 

New data received, it's advisable to read the data when the notification has happened before close the session because these data won't be removed until the application gets them.

TSMART_CELLULAR_2G_CONN_CLOSE 

Connection close

TSMART_CELLULAR_2G_CME 

CME error

TSMART_CELLULAR_2G_SMS 

New SMS received

TSMART_CELLULAR_2G_SHOUTDOWN 

Shoutdown connection, it's necessary to stop connection

TSMART_CELLULAR_2G_ALARM 

Alarm