update cat1_pub_api.h in sdk_release/v1.0/4gsdk_new 1644/7 1644/head 1645/target/1
authorSnickerSun <snickersun@163.com>
Wed, 29 Jan 2025 14:48:23 +0000 (22:48 +0800)
committerSnickerSun <snickersun@163.com>
Wed, 29 Jan 2025 14:48:23 +0000 (22:48 +0800)
sdk_release/v1.0/4gsdk_new/code/sdk/zhihui/4gsdk/cat1Service/include/cat1_pub_api.h

index 3686147..b1a0ed1 100644 (file)
@@ -82,15 +82,54 @@ void cat1_api_keep_wakeup(uint8_t keep_wakeup);
 
 
 
-/******************* get Cat1 runtime status **********************/
+/******************* Cat1 实时状态获取函数,此变量每次开机后才会被赋值 **********************/
+/**
+ * @brief 获取cat1电源开启状态
+ * @return 1 开机,0 关机
+ * */
 uint8_t cat1_api_runtime_get_cat1_powerstat(void);
+/**
+ * @brief 获取cat1网络状态
+ * @return 1 网络在线,0 断网
+ * */
 uint8_t cat1_api_runtime_get_cat1_networkstat(void);
+/**
+ * @brief 获取cat1信号强度
+ * @return 1~31 或者 99,
+ *          99代表无网络,一般显示0信号格,或者无信号,
+ *          16以下,含16 表示信号很弱,偶尔可以接打电话,很容易失败。一般用一个信号格表示。
+ *          其他信号格17~31自行根据UI要求计算显示
+ * */
 int cat1_api_runtime_get_cat1_signal(void);
+/**
+ * @brief 获取sim卡状态
+ * @return 1 有sim卡,0 无sim卡
+ * */
 int cat1_api_runtime_get_cat1_simstat(void);
+/**
+ * @brief 获取网络类型,cat1网络状态networstat = 1时才有效
+ * @return 0 "无网络"
+ *         1 "GSM"
+ *         2 "3G"
+ *         4 "4G/LTE"
+ * */
 uint8_t cat1_api_runtime_get_cat1_networktype(void);    
-// char* cat1_api_runtime_get_cat1_operator(void);  //暂未解析  
+
+
+/**
+ * @brief 获取Cat1 IMEI号,Cat1开机后会传回IMEI值。
+ * @return 返回imei字符串
+ * */
 char* cat1_api_runtime_get_cat1_imei(void);    
+/**
+ * @brief 获取Cat1主应用版本号
+ * @return 返回主应用版本号,sdk当下最低版本PY_SRV_V16
+ * */
 char* cat1_api_runtime_get_cat1_pyver(void);    
+/**
+ * @brief 获取modem版本
+ * @return modem版本字符串,sdk当下版本唯一 EG810MCNLAR06A01M08_VOLTE_OCPU_QPY_BETA0312
+ * */
 char* cat1_api_runtime_get_cat1_modemver(void);