FreeRTOS: FreeRTOS 蜂窝网库 v1.2.0
FreeRTOS 蜂窝网库
蜂窝枚举类型

蜂窝网库的枚举类型。 更多……

枚举

enum  CellularError_t {
  CELLULAR_SUCCESS = 0 , CELLULAR_INVALID_HANDLE , CELLULAR_MODEM_NOT_READY , CELLULAR_LIBRARY_NOT_OPEN ,
  CELLULAR_LIBRARY_ALREADY_OPEN , CELLULAR_BAD_PARAMETER , CELLULAR_NO_MEMORY , CELLULAR_TIMEOUT ,
  CELLULAR_SOCKET_CLOSED , CELLULAR_SOCKET_NOT_CONNECTED , CELLULAR_INTERNAL_FAILURE , CELLULAR_RESOURCE_CREATION_FAIL ,
  CELLULAR_UNSUPPORTED , CELLULAR_NOT_ALLOWED , CELLULAR_UNKNOWN
}
 状态代码从 API 返回。 更多……
 
enum  CellularRat_t {
  CELLULAR_RAT_GSM = 0 , CELLULAR_RAT_WCDMA = 2 , CELLULAR_RAT_EDGE = 3 , CELLULAR_RAT_HSDPA = 4 ,
  CELLULAR_RAT_HSUPA = 5 , CELLULAR_RAT_HSDPAHSUPA = 6 , CELLULAR_RAT_LTE = 7 , CELLULAR_RAT_CATM1 = 8 ,
  CELLULAR_RAT_NBIOT = 9 , CELLULAR_RAT_MAX , CELLULAR_RAT_INVALID = 0xFF
}
 表示无线接入技术 (RAT) 的枚举。参考 3GPP TS 27.007 PLMN 选择 + COPS。 更多……
 
enum  CellularSimCardState_t { CELLULAR_SIM_CARD_REMOVED = 0 , CELLULAR_SIM_CARD_INSERTED , CELLULAR_SIM_CARD_STATUS_MAX , CELLULAR_SIM_CARD_UNKNOWN }
 SIM 卡状态代码。 更多……
 
enum  CellularSimCardLockState_t {
  CELLULAR_SIM_CARD_READY = 0 , CELLULAR_SIM_CARD_PIN , CELLULAR_SIM_CARD_PUK , CELLULAR_SIM_CARD_PIN2 ,
  CELLULAR_SIM_CARD_PUK2 , CELLULAR_SIM_CARD_PH_NET_PIN , CELLULAR_SIM_CARD_PH_NET_PUK , CELLULAR_SIM_CARD_PH_NETSUB_PIN ,
  CELLULAR_SIM_CARD_PH_NETSUB_PUK , CELLULAR_SIM_CARD_SP_PIN , CELLULAR_SIM_CARD_SP_PUK , CELLULAR_SIM_CARD_CORP_PIN ,
  CELLULAR_SIM_CARD_CORP_PUK , CELLULAR_SIM_CARD_IMSI_PIN , CELLULAR_SIM_CARD_IMSI_PUK , CELLULAR_SIM_CARD_INVALID ,
  CELLULAR_SIM_CARD_LOCK_UNKNOWN
}
 SIM 卡锁定状态代码。参考 3GPP TS 27.007 输入PIN + CPIN。 更多……
 
enum  CellularNetworkRegistrationMode_t {
  REGISTRATION_MODE_AUTO = 0 , REGISTRATION_MODE_MANUAL = 1 , REGISTRATION_MODE_DEREGISTER = 2 , REGISTRATION_MODE_MANUAL_THEN_AUTO = 4 ,
  REGISTRATION_MODE_MAX , REGISTRATION_MODE_UNKNOWN
}
 表示网络注册模式。参考 3GPP TS 27.007 PLMN 选择 + COPS。 更多……
 
enum   CellularNetworkRegistrationStatus_t {
  REGISTRATION_STATUS_NO_REGISTERED_SEARCHING = 0 , REGISTRATION_STATUS_REGISTERED_HOME = 1 , REGISTRATION_STATUS_NOT_REGISTERED_SEARCHING = 2 , REGISTRATION_STATUS_REGISTRATION_DENIED = 3 ,
  REGISTRATION_STATUS_UNKNOWN = 4 , REGISTRATION_STATUS_ROAMING_REGISTERED = 5 , REGISTRATION_STATUS_HOME_SMS_ONLY_REGISTERED = 6 , REGISTRATION_STATUS_SMS_ONLY_ROAMING_REGISTERED = 7 ,
  REGISTRATION_STATUS_ATTACHED_EMERG_SERVICES_ONLY = 8 , REGISTRATION_STATUS_MAX
}
 表示网络注册状态。参考 3GPP TS 27.007 网络注册状态。 更多……
 
enum  CellularOperatorNameFormat_t {
  OPERATOR_NAME_FORMAT_LONG = 0 , OPERATOR_NAME_FORMAT_SHORT = 1 , OPERATOR_NAME_FORMAT_NUMERIC = 2 , OPERATOR_NAME_FORMAT_NOT_PRESENT = 9 ,
  OPERATOR_NAME_FORMAT_MAX
}
 表示运算符名称格式。 更多……
 
enum  CellularUrcEvent_t {
  CELLULAR_URC_EVENT_NETWORK_CS_REGISTRATION , CELLULAR_URC_EVENT_NETWORK_PS_REGISTRATION , CELLULAR_URC_EVENT_PDN_ACTIVATED , CELLULAR_URC_EVENT_PDN_DEACTIVATED ,
  CELLULAR_URC_EVENT_SIGNAL_CHANGED , CELLULAR_URC_SOCKET_OPENED , CELLULAR_URC_SOCKET_OPEN_FAILED , CELLULAR_URC_EVENT_OTHER
}
 表示 URC 事件。 更多……
 
enum  CellularModemEvent_t { CELLULAR_MODEM_EVENT_BOOTUP_OR_REBOOT , CELLULAR_MODEM_EVENT_POWERED_DOWN , CELLULAR_MODEM_EVENT_PSM_ENTER }
 表示调制解调器事件。 更多……
 
enum  CellularPdnContextType_t { CELLULAR_PDN_CONTEXT_IPV4 = 1 , CELLULAR_PDN_CONTEXT_IPV6 = 2 , CELLULAR_PDN_CONTEXT_IPV4V6 = 3 , CELLULAR_PDN_CONTEXT_TYPE_MAX }
 表示 PDN上下文类型。 更多……
 
enum  CellularPdnAuthType_t { CELLULAR_PDN_AUTH_NONE = 0 , CELLULAR_PDN_AUTH_PAP , CELLULAR_PDN_AUTH_CHAP , CELLULAR_PDN_AUTH_PAP_OR_CHAP }
 表示 PDN 身份验证类型。 更多……
 
enum  CellularSocketDomain_t { CELLULAR_SOCKET_DOMAIN_AF_INET , CELLULAR_SOCKET_DOMAIN_AF_INET6 }
 表示套接字域。 更多……
 
enum  CellularSocketType_t { CELLULAR_SOCKET_TYPE_DGRAM , CELLULAR_SOCKET_TYPE_STREAM }
 表示套接字类型。 更多……
 
enum  CellularSocketProtocol_t { CELLULAR_SOCKET_PROTOCOL_UDP , CELLULAR_SOCKET_PROTOCOL_TCP }
 表示套接字协议。
 
enum  CellularSocketAccessMode_t { CELLULAR_ACCESSMODE_BUFFER = 0 , CELLULAR_ACCESSMODE_DIRECT_PUSH , CELLULAR_ACCESSMODE_TRANSPARENT , CELLULAR_ACCESSMODE_NOT_SET }
 表示数据访问模式。
 
enum  CellularIPAddressType_t { CELLULAR_IP_ADDRESS_V4 , CELLULAR_IP_ADDRESS_V6 }
 表示 IP 地址。 更多……
 
enum  CellularSocketOptionLevel_t { CELLULAR_SOCKET_OPTION_LEVEL_IP , CELLULAR_SOCKET_OPTION_LEVEL_TRANSPORT }
 表示套接字选项级别。 更多……
 
enum  CellularSocketOption_t { CELLULAR_SOCKET_OPTION_MAX_IP_PACKET_SIZE , CELLULAR_SOCKET_OPTION_SEND_TIMEOUT , CELLULAR_SOCKET_OPTION_RECV_TIMEOUT , CELLULAR_SOCKET_OPTION_PDN_CONTEXT_ID }
 套接字选项名称。 更多……
 
enum  CellularPktStatus_t {
  CELLULAR_PKT_STATUS_OK = 0 , CELLULAR_PKT_STATUS_TIMED_OUT , CELLULAR_PKT_STATUS_FAILURE , CELLULAR_PKT_STATUS_BAD_REQUEST ,
  CELLULAR_PKT_STATUS_BAD_RESPONSE , CELLULAR_PKT_STATUS_SIZE_MISMATCH , CELLULAR_PKT_STATUS_BAD_PARAM , CELLULAR_PKT_STATUS_SEND_ERROR ,
  CELLULAR_PKT_STATUS_INVALID_HANDLE , CELLULAR_PKT_STATUS_CREATION_FAIL , CELLULAR_PKT_STATUS_PREFIX_MISMATCH , CELLULAR_PKT_STATUS_INVALID_DATA ,
  CELLULAR_PKT_STATUS_PENDING_DATA , CELLULAR_PKT_STATUS_PENDING_BUFFER
}
 数据包状态名称。
 
enum  CellularATCommandType_t {
  CELLULAR_AT_NO_RESULT , CELLULAR_AT_WO_PREFIX , CELLULAR_AT_WITH_PREFIX , CELLULAR_AT_MULTI_WITH_PREFIX ,
  CELLULAR_AT_MULTI_WO_PREFIX , CELLULAR_AT_MULTI_DATA_WO_PREFIX , CELLULAR_AT_NO_COMMAND
}
 表示 AT 命令类型。 更多……
 

详细描述

蜂窝网库的枚举类型。

枚举类型文档

◆ CellularError_t

状态代码从 API 返回。

枚举器
CELLULAR_SUCCESS  

运算成功。

CELLULAR_INVALID_HANDLE  

句柄无效。

CELLULAR_MODEM_NOT_READY  

调制解调器尚未就绪。

CELLULAR_LIBRARY_NOT_OPEN 

蜂窝网库尚未打开。

CELLULAR_LIBRARY_ALREADY_OPEN 

蜂窝网库已经打开。

CELLULAR_BAD_PARAMETER 

一个或多个输入参数无效。

CELLULAR_NO_MEMORY  

内存分配失败。

CELLULAR_TIMEOUT  

操作超时。

CELLULAR_SOCKET_CLOSED  

提供的套接字已关闭。

CELLULAR_SOCKET_NOT_CONNECTED  

提供的套接字未连接。

CELLULAR_INTERNAL_FAILURE 

蜂窝网库内部故障。

CELLULAR_RESOURCE_CREATION_FAIL 

为蜂窝网库创建资源失败。

CELLULAR_UNSUPPORTED 

不支持此操作。

CELLULAR_NOT_ALLOWED  

不允许进行此操作。

CELLULAR_UNKNOWN  

除上述错误之外的任何其他错误。

◆ CellularRat_t

表示无线电接入技术 (RAT) 的枚举。参考 3GPP TS 27.007 PLMN 选择 + COPS。

枚举器
CELLULAR_RAT_GSM 

GSM RATS 网络。

CELLULAR_RAT_WCDMA  

WCDMA RATS 网络。

CELLULAR_RAT_EDGE 

EDGE RAT 网络。

CELLULAR_RAT_HSDPA 

HSDPA RATS 网络。

CELLULAR_RAT_HSUPA  

HSUPA RATS 网络。

CELLULAR_RAT_HSDPAHSUPA 

HSDPAHSUPA RATS 网络。

CELLULAR_RAT_LTE  

LTE RATS 网络。

CELLULAR_RAT_CATM1  

CAT M1 RATS 网络。

CELLULAR_RAT_NBIOT  

NBIOT RATS 网络。

CELLULAR_RAT_MAX  

RAT 网络的最大支持数。

CELLULAR_RAT_INVALID  

除上述错误之外的任何其他错误。

◆ CellularSimCardState_t

SIM 卡状态代码。

枚举器
CELLULAR_SIM_CARD_REMOVED  

该状态代表蜂窝 SIM 卡已移除。

CELLULAR_SIM_CARD_INSERT  

该状态代表蜂窝 SIM 卡已插入。

CELLULAR_SIM_CARD_STATUS_MAX  

支持的 SIM 卡状态的数量。

CELLULAR_SIM_CARD_UNKNOWN  

该状态代表未知的蜂窝 SIM 卡。

◆ CellularSimCardLockState_t

SIM 卡锁定状态代码。参考 3GPP TS 27.007 输入 PIN + CPIN。

枚举器
CELLULAR_SIM_CARD_READY  

处于准备就绪锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_PIN  

处于 PIN(个人识别码)锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_PUK  

处于 PUK(个人解锁码)锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_PIN2  

处于 PIN2 锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_PUK2  

处于 PUK2 锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_PH_NET_PIN  

处于 ph-net PIN 锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_PH_NET_PUK  

处于 ph-net PUK 锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_PH_NETSUB_PIN  

处于 ph-netsub PIN 锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_PH_NETSUB_PUK 

处于 ph-netsub PUK 锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_SP_PIN  

处于 ph-sp PIN 锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_SP_PUK  

处于 ph-sp PUK 锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_CORP_PIN  

处于 ph-corpPIN 锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_CORP_PUK 

处于 ph-sp PUK 锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_IMSI_PIN  

处于 IMSI PIN 锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_IMSI_PUK  

处于 IMSI PUK 锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_INVALID 

处于无效锁定状态的蜂窝 SIM 卡。

CELLULAR_SIM_CARD_LOCK_UNKNOWN  

处于未知锁定状态的蜂窝 SIM 卡。

◆ CellularNetworkRegistrationMode_t

表示网络注册模式。参考 3GPP TS 27.007 PLMN 选择 + COPS。

枚举器
REGISTRATION_MODE_AUTO 

自动网络注册模式。

REGISTRATION_MODE_MANUAL 

手动网络注册模式。

REGISTRATION_MODE_DEREGISTER 

取消注册网络注册模式。

REGISTRATION_MODE_MANUAL_THEN_AUTO 

手动后再自动网络注册模式。

REGISTRATION_MODE_MAX 

支持的注册模式的数量。

REGISTRATION_MODE_UNKNOWN 

未知的网络注册模式。

◆ CellularNetworkRegistrationStatus_t

表示网络注册状态。参考 3GPP TS 27.007 网络注册状态。

枚举器
REGISTRATION_STATUS_NO_REGISTERED_SEARCHING  

尚无注册的搜索网络注册状态。

REGISTRATION_STATUS_REGISTERED_HOME  

已注册的家庭网络注册状态。

REGISTRATION_STATUS_NOT_REGISTERED_SEARCHING  

未注册的搜索网络注册状态。

REGISTRATION_STATUS_REGISTRATION_DENIED  

注册被拒绝的网络注册状态。

REGISTRATION_STATUS_UNKNOWN  

未知的网络注册状态。

REGISTRATION_STATUS_ROAMING_REGISTERED  

漫游注册的网络注册状态。

REGISTRATION_STATUS_HOME_SMS_ONLY_REGISTED  

家庭短信仅限已注册的网络注册状态。

REGISTRATION_STATUS_SMS_ONLY_ROAMING_REGISTERED 

短信仅漫游已注册的网络注册状态。

REGISTRATION_STATUS_ATTACHED_EMERG_SERVICES_ONLY 

附加紧急服务仅网络注册状态。

REGISTRATION_STATUS_MAX  

注册状态的最大支持数。

◆ CellularOperatorNameFormat_t

表示运算符名称格式。

枚举器
OPERATOR_NAME_FORMAT_LONG  

长运算符名称格式。

OPERATOR_NAME_FORMAT_SHORT  

短运算符名称格式。

OPERATOR_NAME_FORMAT_NUMBERIC  

数字运算符名称格式。

OPERATOR_NAME_FORMAT_NOT_PRESENT  

运算符名称格式不存在。

OPERATOR_NAME_FORMAT_MAX  

运算符名称格式的最大支持数。

◆ CellularUrcEvent_t

表示 URC 事件。

枚举器
CELLULAR_URC_EVENT_NETWORK_CS_REGISTRATION  

网络 CS 注册 URC 事件。

CELLULAR_URC_EVENT_NETWORK_PS_REGISTRATION  

网络 PS 注册 URC 事件。

CELLULAR_URC_EVENT_PDN_ACTIVATED  

PDN 激活注册 URC 事件。

CELLULAR_URC_EVENT_PDN_DEACTIVATED  

PDN 已停用注册 URC 事件。

CELLULAR_URC_EVENT_SIGNAL_CHANGED  

信号更改注册 URC 事件。

CELLULAR_URC_SOCKET_OPEN  

套接字打开注册 URC 事件。

CELLULAR_URC_SOCKET_OPEN_FAILED  

套接字打开注册 URC 事件失败。

CELLULAR_URC_EVENT_OTHER  

上述事件以外的任何 URC 事件。

◆ CellularModemEvent_t

表示调制解调器事件。

枚举器
CELLULAR_MODEM_EVENT_BOOTUP_OR_REBOOT  

启动或重新启动调制解调器事件。

CELLULAR_MODEM_EVENT_POWERED_DOWN  

关闭调制解调器事件。

CELLULAR_MODEM_EVENT_PSM_ENTER 

PSM 输入调制解调器事件。

◆ CellularPdnContextType_t

表示 PDN 上下文类型。

枚举器
CELLULAR_PDN_CONTEXT_IPV4  

IPV4 PDN 上下文。

CELLULAR_PDN_CONTEXT_IPV6  

IPV6 PDN 上下文。

CELLULAR_PDN_CONTEXT_IPV4V6  

IPV4V6 PDN 上下文。

CELLULAR_PDN_CONTEXT_TYPE_MAX  

支持的 PDN 上下文的最大数量。

◆ CellularPdnAuthType_t

表示 PDN 身份验证类型。

枚举器
CELLULAR_PDN_AUTH_NONE  

无身份验证。

CELLULAR_PDN_AUTH_PAP  

密码身份验证协议 (PAP)。

CELLULAR_PDN_AUTH_CHAP  

质询握手身份验证协议 (CHAP)。

CELLULAR_PDN_AUTH_PAP_OR_CHAP 

PAP 或 CHAP。

◆ CellularSocketDomain_t

表示套接字域。

枚举器
CELLULAR_SOCKET_DOMAIN_AF_INET  

IPv4 互联网协议。

CELLULAR_SOCKET_DOMAIN_AF_INET6  

IPv6 互联网协议。

◆ CellularSocketType_t

表示套接字类型。

枚举器
CELLULAR_SOCKET_TYPE_DGRAM 

数据报。

CELLULAR_SOCKET_TYPE_STREAM  

字节流。

◆ CellularIPAddressType_t

表示 IP 地址。

枚举器
CELLULAR_IP_ADDRESS_V4 

IP V4 IP 地址。

CELLULAR_IP_ADDRESS_V6 

IP V6 IP 地址。

◆ CellularSocketOptionLevel_t

表示套接字选项级别。

枚举器
CELLULAR_SOCKET_OPTION_LEVEL_IP  

IP 图层选项。

CELLULAR_SOCKET_OPTION_LEVEL_TRANSPORT  

传输(TCP/UDP)层选项。

◆ CellularSocketOption_t

套接字选项名称。

枚举器
CELLULAR_SOCKET_OPTION_MAX_IP_PACKET_SIZE  

设置最大 IP 数据包大小。

CELLULAR_SOCKET_OPTION_SEND_TIMEOUT  

设置发送超时(单位:毫秒)。

CELLULAR_SOCKET_OPTION_RECV_TIMEOUT  

设置接收超时(单位:毫秒)。

CELLULAR_SOCKET_OPTION_PDN_CONTEXT_ID  

设置要用于套接字的 PDN 上下文 ID。

◆ CellularATCommandType_t

表示 AT 命令类型。

枚举器
CELLULAR_AT_NO_RESULT  

没有预期的响应,仅出现 OK、ERROR 等。

CELLULAR_AT_WO_PREFIX  

无前缀的字符串响应。

CELLULAR_AT_WITH_PREFIX  

有前缀字的符串响应。

CELLULAR_AT_MULTI_WITH_PREFIX  

多行响应都以前缀开头。

CELLULAR_AT_MULTI_WO_PREFIX  

带或不带前缀的多行响应。

CELLULAR_AT_MULTI_DATA_WO_PREFIX  

带或不带前缀的多行数据响应。

CELLULAR_AT_NO_COMMAND  

没有命令正在等待响应。