管理中心
我的
API参考设备虚拟化能力Linux设备接入开放EngineLinux设备北向接入APIInterface Summary

Interface Summary

展开

FileName

Description

dvagent.h

北向接口。

Public Methods

DVAgentInit

展开

Method

int32_t DVAgentInit(DVAgentConfig *dvAgentConfig)

完成DVAgent SDK内部初始化。开始使用DVAgent业务时,第一个被调用接口。

Parameters

展开

Name

Description

dvAgentConfig

设备配置信息。

收起
自动换行
深色代码主题
复制
  1. typedef struct {
  2. /* Vendor ID */
  3. uint32_t vendorID;
  4. /* 设备蓝牙地址 */
  5. uint8_t brMac[DVAGENT_BR_MAC_LEN];
  6. /* 设备支持的连接方式,
  7. 第0bit位为0表示不支持无线,为1表示支持无线;
  8. 第1bit位为0表示不支持USB,为1标志支持USB */
  9. int32_t connectAllowType;
  10. /* 设备唯一标识 */
  11. char *deviceId;
  12. /* 标识的长度 */
  13. uint32_t idLen;
  14. /* 设备名字 */
  15. char *deviceName;
  16. /* 设备名字长度 */
  17. uint32_t nameLen;
  18. } DVAgentDeviceInfo;
  19. typedef struct {
  20. DVAgentDeviceInfo deviceInfo;
  21. } DVAgentConfig;

Return

展开

Type

Description

int32_t

0:成功,小于0失败。

DVAgentRelease

展开

Method

int32_t DVAgentRelease()

完成DVAgent系统内部注销。不再使用DVAgent业务时调用。

Return

展开

Type

Description

int32_t

0:成功,小于0失败。

DVAgentRegisterListener

展开

Method

int (*SetParam)(SetParamsType paramType, void* priv)

向DVAgent注册一系列监听,用于接收DVAgent设备状态变化,服务变化等。

Parameters

展开

Name

Description

listener

DVAgent监听者集合,结构体。

typedef void (*DVAgentLogFunc)(const char *tag, const char *funcName, const char *format, …);

收起
自动换行
深色代码主题
复制
  1. typedef struct {
  2. DVAgentLogFunc logD;
  3. DVAgentLogFunc logI;
  4. DVAgentLogFunc logW;
  5. DVAgentLogFunc logE;
  6. } DvAgentLogFuncGroup;
  7. typedef struct {
  8. /* DVAgent设备状态上报 */
  9. void (*DeviceChange)(DV_AGENT_HANDLE handle, const char *remoteDeviceName, uint32_t nameLen, int state);
  10. /* DVAgent服务状态上报 */
  11. void (*DeviceServiceChange)(DV_AGENT_HANDLE handle, const char *serviceId, uint32_t idLen, int state);
  12. /* 接收来自DVAgent的数据 */
  13. void (*DataReceive)(DV_AGENT_HANDLE handle, int dataType, char *data, uint32_t dataLen);
  14. /* 接收来自DVAgent鉴权认证过程中的PIN码并显示 */
  15. void (*PinCode)(const char *pinCode, uint32_t codeLen);
  16. /* 获取DVAgent鉴权认证中文件存储的大小 */
  17. int32_t (*GetSecureFileSize)(const char *filename);
  18. /* 读鉴权认证文件的内容 */
  19. int32_t (*ReadSecureFile)(const char *filename, uint32_t offset, uint8_t *buf, uint32_t len);
  20. /* 向鉴权认证文件写数据 */
  21. int32_t (*WriteSecureFile)(const char *filename, uint32_t offset, uint8_t *buf, uint32_t len);
  22. /* 删除鉴权认证文件 */
  23. int32_t (*RemoveSecureFile)(const char *filename);
  24. /* 日志回调 */
  25. DvAgentLogFuncGroup logGroup;
  26. } DVAgentListener;

Return

展开

Type

Description

int32_t

0:成功,小于0失败。

DVAgentUnRegisterListener

展开

Method

int32_t DVAgentUnRegisterListener()

向DVAgent注销监听。

Return

展开

Type

Description

int32_t

0:成功,小于0失败。

DVAgentCreateServiceHandle

展开

Method

DV_AGENT_HANDLE DVAgentCreateServiceHandle()

创建DVAgent会话句柄,基于会话句柄与DV Engine服务进行交互。

Return

展开

Type

Description

int32_t

0:成功,小于0失败。

DVAgentDestoryServiceHandle

展开

Method

void DVAgentDestoryServiceHandle(DV_AGENT_HANDLE handle)

删除DVAgent会话句柄。

Parameters

展开

Name

Description

handle

DVAgent句柄。

Return

展开

Type

Description

int32_t

0:成功,小于0失败。

DVAgentGetSdkVersion

展开

Method

char *DVAgentGetSdkVersion()

获取DVAgent的版本号。用于后续SDK的版本升级。

Return

展开

Type

Description

int32_t

0:成功,小于0失败。

DVAgentGetTrustDeviceList

展开

Method

int32_t DVAgentGetTrustDeviceList(DV_AGENT_HANDLE handle, DVAgentTrustPhoneInfo *list, uint32_t num)

厂商可以获取当前和设备完成鉴权认证后的设备列表。

Parameters

展开

Name

Description

handle

厂商可以获取当前和设备完成鉴权认证后的设备列表。

list

完成鉴权认证的设备(手机)列表。

收起
自动换行
深色代码主题
复制
  1. typedef struct {
  2. /* 手机ID长度 */
  3. uint32_t phoneIdRealLen;
  4. /* 手机ID,最大长度128 */
  5. uint8_t phoneId[DVAGENT_PHONE_ID_MAX_LEN + 1];
  6. /* 手机名称长度 */
  7. uint8_t phoneNameRealLen;
  8. /* 手机名称,最大长度256 */
  9. uint8_t phoneName[DVAGENT_PHONE_NAME_MAX_LEN + 1];
  10. /* 最近一次连接的系统时间 */
  11. int64_t lastConnectTime;
  12. } DVAgentTrustPhoneInfo;

num

列表个数。

Return

展开

Type

Description

int32_t

0:成功,小于0失败。

DVAgentDeleteTrustDevice

展开

Method

int32_t DVAgentDeleteTrustDevice(DV_AGENT_HANDLE handle, const char *phoneId, uint32_t idLen)

删除指定可信设备,删除后需要重新建立鉴权认证。

Parameters

展开

Name

Description

handle

DVAgent句柄。

phoneId

手机唯一标识。

idLen

标识的长度。

Return

展开

Type

Description

int32_t

0:成功,小于0失败。