sdk api说明

目录

• 基础HAL接口详解
  • HAL_Free
  • HAL_GetChipID
  • HAL_GetDeviceID
  • HAL_GetDeviceName
  • HAL_GetDeviceSecret
  • HAL_GetFirmwareVersion
  • HAL_GetModuleID
  • HAL_GetPartnerID
  • HAL_GetProductKey
  • HAL_GetProductSecret
  • HAL_GetTimeStr
  • HAL_Kv_Del
  • HAL_Kv_Erase_All
  • HAL_Kv_Get
  • HAL_Kv_Set
  • HAL_Malloc
  • HAL_Printf
  • HAL_Random
  • HAL_Reboot
  • HAL_SetDeviceName
  • HAL_SetDeviceSecret
  • HAL_SetProductKey
  • HAL_SetProductSecret
  • HAL_SleepMs
  • HAL_Snprintf
  • HAL_Srandom
  • HAL_Timer_Create
  • HAL_Timer_Delete
  • HAL_Timer_Start
  • HAL_Timer_Stop
  • HAL_UptimeMs
  • HAL_UTC_Get
  • HAL_UTC_Set
  • HAL_Vsnprintf

基础HAL接口详解

HAL_Free

原型

void HAL_Free(_IN_ void *ptr);

接口说明

释放参数ptr指向的一块堆内存, 当传入的参数为NULL时不执行任何操作

参数说明

参数	数据类型	方向	说明
ptr	void *	输入	指向将要释放的堆内存的指针

返回值说明

void

---

HAL_GetChipID

(在3.0.1及以后版本中不需要实现）
原型

char *HAL_GetChipID(_OU_ char cid_str[HAL_CID_LEN]);

接口说明

获取唯一的芯片ID字符串, 字符串长度不能超过HAL_CID_LEN定义的数值。

注：该HAL只需要芯片商进行适配，如果用户不是芯片商，该HAL返回空字符串即可

参数说明

参数	数据类型	方向	说明
cid_str	char[]	输出	存放芯片ID的字符串缓冲区

返回值说明

指向字符串缓冲区的指针

---

HAL_GetDeviceID

(在2.3.1及以后版本中不需要实现）
原型

int HAL_GetDeviceID(_OU_ char device_id[DEVICE_ID_LEN]);

接口说明

获取设备的DeviceID, 用于标识设备单品的ID

参数说明

参数	数据类型	方向	说明
device_id	char[]	输出	存放DeviceID的字符串缓冲区

返回值说明

实际获取到的DeviceID字符串长度

---

HAL_GetDeviceName

原型

int HAL_GetDeviceName(_OU_ char device_name[DEVICE_NAME_LEN]);

接口说明

获取设备的DeviceName, 用于唯一标识单个设备的名字, 三元组之一, 在云端控制台注册得到并烧写到设备中

参数说明

参数	数据类型	方向	说明
devi