RUI3 (RAK Unified Interface 3) - RAK4631
atcmd.h File Reference

Go to the source code of this file.

Data Structures

struct  _stParam
 
struct  _at_cmd_info
 
struct  _at_cmd_cust_info
 

Macros

#define atcmd_printf(fmt, ...)   udrv_serial_log_printf(fmt, ##__VA_ARGS__)
 
#define MAX_CMD_LEN   (32)
 
#define MAX_ARGUMENT   25
 

Typedefs

typedef enum AT_PERM_ AT_PERMISSION
 
typedef enum AT_ERRNO_E_ AT_ERRNO_E
 
typedef struct _stParam stParam
 
typedef int(* PF_handle) (SERIAL_PORT port, char *cmd, stParam *param)
 
typedef struct _at_cmd_info at_cmd_info
 
typedef struct _at_cmd_cust_info at_cmd_cust_info
 

Enumerations

enum  AT_PERM_ {
  ATCMD_PERM_WRITE = 1 << 0,
  ATCMD_PERM_READ = 1 << 1,
  ATCMD_PERM_WRITEONCEREAD = 1 << 2,
  ATCMD_PERM_ISWRITE = 1 << 3,
  ATCMD_PERM_DISABLE = 1 << 4
}
 
enum  AT_ERRNO_E_ {
  AT_OK = 0,
  AT_ERROR,
  AT_PARAM_ERROR,
  AT_BUSY_ERROR,
  AT_TEST_PARAM_OVERFLOW,
  AT_NO_CLASSB_ENABLE,
  AT_NO_NETWORK_JOINED,
  AT_RX_ERROR,
  AT_MODE_NO_SUPPORT,
  AT_COMMAND_NOT_FOUND
}
 

Functions

uint32_t At_CmdGetTotalNum (void)
 
int At_Parser (SERIAL_PORT port, char *buff, int len)
 
void At_RespOK (char *pStr)
 
void StrToHex (uint8_t *pbDest, const char *pbSrc, int nLen)
 
uint8_t at_separate_param (const char *param, char **argv, uint32_t *argc)
 
uint8_t at_check_hex_param (const char *p_str, uint32_t str_len, uint8_t *p_hex)
 
uint8_t at_check_alphanumeric_param (const char *p_str, uint32_t str_len)
 
uint8_t at_check_hex_uint16 (const char *p_str, uint16_t *value)
 
uint8_t at_check_hex_uint32 (const char *p_str, uint32_t *value)
 
uint8_t at_check_digital_uint32_t (const char *p_str, uint32_t *value)
 
void update_permission ()
 
uint8_t at_error_code_form_udrv (int8_t udrv_code)
 

Macro Definition Documentation

◆ atcmd_printf

#define atcmd_printf (   fmt,
  ... 
)    udrv_serial_log_printf(fmt, ##__VA_ARGS__)

◆ MAX_CMD_LEN

#define MAX_CMD_LEN   (32)

◆ MAX_ARGUMENT

#define MAX_ARGUMENT   25

Typedef Documentation

◆ AT_PERMISSION

typedef enum AT_PERM_ AT_PERMISSION

◆ AT_ERRNO_E

typedef enum AT_ERRNO_E_ AT_ERRNO_E

◆ stParam

typedef struct _stParam stParam

◆ PF_handle

typedef int(* PF_handle) (SERIAL_PORT port, char *cmd, stParam *param)

◆ at_cmd_info

typedef struct _at_cmd_info at_cmd_info

◆ at_cmd_cust_info

Enumeration Type Documentation

◆ AT_PERM_

enum AT_PERM_
Enumerator
ATCMD_PERM_WRITE 
ATCMD_PERM_READ 
ATCMD_PERM_WRITEONCEREAD 
ATCMD_PERM_ISWRITE 
ATCMD_PERM_DISABLE 

◆ AT_ERRNO_E_

Enumerator
AT_OK 
AT_ERROR 
AT_PARAM_ERROR 
AT_BUSY_ERROR 
AT_TEST_PARAM_OVERFLOW 
AT_NO_CLASSB_ENABLE 
AT_NO_NETWORK_JOINED 
AT_RX_ERROR 
AT_MODE_NO_SUPPORT 
AT_COMMAND_NOT_FOUND 

Function Documentation

◆ At_CmdGetTotalNum()

uint32_t At_CmdGetTotalNum ( void  )

◆ At_Parser()

int At_Parser ( SERIAL_PORT  port,
char *  buff,
int  len 
)

◆ At_RespOK()

void At_RespOK ( char *  pStr)

◆ StrToHex()

void StrToHex ( uint8_t *  pbDest,
const char *  pbSrc,
int  nLen 
)

◆ at_separate_param()

uint8_t at_separate_param ( const char *  param,
char **  argv,
uint32_t *  argc 
)

◆ at_check_hex_param()

uint8_t at_check_hex_param ( const char *  p_str,
uint32_t  str_len,
uint8_t *  p_hex 
)

◆ at_check_alphanumeric_param()

uint8_t at_check_alphanumeric_param ( const char *  p_str,
uint32_t  str_len 
)

◆ at_check_hex_uint16()

uint8_t at_check_hex_uint16 ( const char *  p_str,
uint16_t *  value 
)

◆ at_check_hex_uint32()

uint8_t at_check_hex_uint32 ( const char *  p_str,
uint32_t *  value 
)

◆ at_check_digital_uint32_t()

uint8_t at_check_digital_uint32_t ( const char *  p_str,
uint32_t *  value 
)

◆ update_permission()

void update_permission ( )

◆ at_error_code_form_udrv()

uint8_t at_error_code_form_udrv ( int8_t  udrv_code)