Files | Macros | Typedefs | Functions

le_atDefs API Reference

Files

file  le_atDefs_common.h
 
file  le_atDefs_interface.h
 

Macros

#define LE_ATDEFS_COMMAND_MAX_LEN   511
 
#define LE_ATDEFS_COMMAND_MAX_BYTES   512
 
#define LE_ATDEFS_PARAMETER_MAX_LEN   128
 
#define LE_ATDEFS_PARAMETER_MAX_BYTES   129
 
#define LE_ATDEFS_RESPONSE_MAX_LEN   520
 
#define LE_ATDEFS_RESPONSE_MAX_BYTES   521
 
#define LE_ATDEFS_UNSOLICITED_MAX_LEN   256
 
#define LE_ATDEFS_UNSOLICITED_MAX_BYTES   257
 
#define LE_ATDEFS_TEXT_MAX_LEN   4095
 
#define LE_ATDEFS_TEXT_MAX_BYTES   4096
 
#define LE_ATDEFS_COMMAND_DEFAULT_TIMEOUT   30000
 
#define LE_ATDEFS_CME_ERROR   "+CME ERROR: "
 
#define LE_ATDEFS_CMS_ERROR   "+CMS ERROR: "
 

Typedefs

typedef void(* le_atDefs_DisconnectHandler_t) (void *)
 

Functions

void le_atDefs_ConnectService (void)
 
le_result_t le_atDefs_TryConnectService (void)
 
LE_FULL_API void le_atDefs_SetServerDisconnectHandler (le_atDefs_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
void le_atDefs_DisconnectService (void)
 

Detailed Description

Macro Definition Documentation

◆ LE_ATDEFS_CME_ERROR

#define LE_ATDEFS_CME_ERROR   "+CME ERROR: "

CME error pattern

◆ LE_ATDEFS_CMS_ERROR

#define LE_ATDEFS_CMS_ERROR   "+CMS ERROR: "

CMS error pattern

◆ LE_ATDEFS_COMMAND_DEFAULT_TIMEOUT

#define LE_ATDEFS_COMMAND_DEFAULT_TIMEOUT   30000

Command default timeout (in ms)

◆ LE_ATDEFS_COMMAND_MAX_BYTES

#define LE_ATDEFS_COMMAND_MAX_BYTES   512

Command string maximum length. One extra byte is added for the null character.

◆ LE_ATDEFS_COMMAND_MAX_LEN

#define LE_ATDEFS_COMMAND_MAX_LEN   511

Command string maximum length.

Warning
Special characters cost more than one byte

◆ LE_ATDEFS_PARAMETER_MAX_BYTES

#define LE_ATDEFS_PARAMETER_MAX_BYTES   129

Parameter string maximum length. One extra byte is added for the null character.

◆ LE_ATDEFS_PARAMETER_MAX_LEN

#define LE_ATDEFS_PARAMETER_MAX_LEN   128

Parameter string maximum length.

Warning
Special characters cost more than one byte

◆ LE_ATDEFS_RESPONSE_MAX_BYTES

#define LE_ATDEFS_RESPONSE_MAX_BYTES   521

AT command response maximum length. One extra byte is added for the null character.

◆ LE_ATDEFS_RESPONSE_MAX_LEN

#define LE_ATDEFS_RESPONSE_MAX_LEN   520

AT command response maximum length.

Warning
Special characters cost more than one byte

◆ LE_ATDEFS_TEXT_MAX_BYTES

#define LE_ATDEFS_TEXT_MAX_BYTES   4096

Maximum number of bytes in an text message (including the null-terminator).

◆ LE_ATDEFS_TEXT_MAX_LEN

#define LE_ATDEFS_TEXT_MAX_LEN   4095

Maximum number of bytes in a text message (not including the null-terminator).

Warning
Special characters cost more than one byte

◆ LE_ATDEFS_UNSOLICITED_MAX_BYTES

#define LE_ATDEFS_UNSOLICITED_MAX_BYTES   257

Maximum number of bytes in an unsolicited response (including the null-terminator).

◆ LE_ATDEFS_UNSOLICITED_MAX_LEN

#define LE_ATDEFS_UNSOLICITED_MAX_LEN   256

Maximum number of bytes in an unsolicited response (not including the null-terminator).

Warning
Special characters cost more than one byte

Typedef Documentation

◆ le_atDefs_DisconnectHandler_t

typedef void(* le_atDefs_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

◆ le_atDefs_ConnectService()

void le_atDefs_ConnectService ( void  )

Connect the current client thread to the service providing this API. Block until the service is available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client Specific Functions.

This function is created automatically.

◆ le_atDefs_DisconnectService()

void le_atDefs_DisconnectService ( void  )

Disconnect the current client thread from the service providing this API.

Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see Client Specific Functions.

This function is created automatically.

◆ le_atDefs_SetServerDisconnectHandler()

LE_FULL_API void le_atDefs_SetServerDisconnectHandler ( le_atDefs_DisconnectHandler_t  disconnectHandler,
void *  contextPtr 
)

Set handler called when server disconnection is detected.

When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.

◆ le_atDefs_TryConnectService()

le_result_t le_atDefs_TryConnectService ( void  )

Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client Specific Functions.

This function is created automatically.

Returns
  • LE_OK if the client connected successfully to the service.
  • LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
  • LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
  • LE_COMM_ERROR if the Service Directory cannot be reached.