nl::Weave::Profiles::Vendor::Nestlabs::DropcamLegacyPairing

摘要

枚举

@328{
  kMsgType_CameraAuthDataRequest = 1,
  kMsgType_CameraAuthDataResponse = 2
}
枚举
Dropcam 旧版配对消息类型。

变量

CAMERA_AUTH_DATA_LEN = (EUI48_LEN + CAMERA_NONCE_LEN + CAMERA_HMAC_LEN)
const uint8_t
转换 base64 字符串之前二进制相机身份验证数据参数的长度。
CAMERA_HMAC_LEN = 4
const uint8_t
附加到 auth_data API 参数的相机身份验证数据 HMAC 字节数。
CAMERA_NONCE_LEN = 64
const uint8_t
相机 Nonce 字符串的长度(以字节为单位),不包括 NULL 终止符。
CAMERA_SECRET_LEN = 32
const uint8_t
相机密钥的长度(以字节为单位)。
EUI48_LEN = 6
const uint8_t
EUI-48 原始字节表示法的长度(以字节为单位)。
EUI48_STR_LEN = 13
const uint8_t
EUI-48 的长度(以字节为单位),表示为由 12 个十六进制数字无冒号分隔符的字符串加 NULL 终止符组成。
HMAC_BUF_LEN = 32
const uint8_t
表示相机生成的配对信息 HMAC 的长度(以字节为单位),表示为原始字节。
sDropcamLegacyPairingProfileStringContext = { NULL, sDropcamLegacyPairingProfileStringInfo }
用于注册和取消注册与 相关联的回调,以返回与配置文件相关联的人类可读支持字符串的上下文。
sDropcamLegacyPairingProfileStringInfo = { kWeaveProfile_DropcamLegacyPairing, GetDropcamLegacyPairingMessageName, GetDropcamLegacyPairingProfileName, NULL }
此结构为关联的回调提供存储空间,用于返回与配置文件相关联的人类可读的支持字符串。

函数

DecodeCameraAuthDataResponse(PacketBuffer *buf, uint8_t(&) macAddress[EUI48_LEN], uint8_t(&) hmac[HMAC_BUF_LEN])
用于解码 CameraAuthDataResponse 消息载荷的实用函数。
EncodeCameraAuthDataRequest(PacketBuffer *buf, const char *nonce)
用于对 CameraAuthDataRequest 消息载荷进行编码的实用函数。
GetDropcamLegacyPairingMessageName(uint32_t inProfileId, uint8_t inMsgType)
const char *
回调函数,用于返回人类可读、以 NULL 结尾的 C 字符串,用于描述与此配置文件相关联的消息类型。
GetDropcamLegacyPairingProfileName(uint32_t inProfileId)
const char *
回调函数,该函数返回人类可读、以 NULL 结尾的 C 字符串,用于描述具有此配置文件的配置文件。
_DropcamLegacyPairingProfileStringDestroy(void)
void
一次性但可重入的反初始化器,用于取消注册 Weave Dropcam 旧版配对配置文件回调,以返回与配置文件相关联的人类可读支持字符串。
_DropcamLegacyPairingProfileStringInit(void)
void
一次性但可重入的初始化程序,用于注册 Weave Dropcam 旧版配对配置文件回调,以返回与配置文件相关联的人类可读支持字符串。

nl::Weave::Profiles::Vendor::Nestlabs::DropcamLegacyPairing::DropcamLegacyPairingDelegate

用于在服务器设备上实现传入的 Dropcam 旧版配对操作的委托类。

nl::Weave::Profiles::Vendor::Nestlabs::DropcamLegacyPairing::DropcamLegacyPairingServer

用于实现 Dropcam 旧版配对配置文件的服务器类。

枚举

@328

 @328

Dropcam 旧版配对消息类型。

属性
kMsgType_CameraAuthDataRequest

检索旧版 Dropcam 配对 Web API 调用的参数。

kMsgType_CameraAuthDataResponse

包含旧版 Dropcam 配对网络 API 调用的参数。

变量

CAMERA_AUTH_DATA_LEN

const uint8_t CAMERA_AUTH_DATA_LEN = (EUI48_LEN + CAMERA_NONCE_LEN + CAMERA_HMAC_LEN)

转换 base64 字符串之前二进制相机身份验证数据参数的长度。

CAMERA_HMAC_LEN

const uint8_t CAMERA_HMAC_LEN = 4

附加到 auth_data API 参数的相机身份验证数据 HMAC 字节数。

CAMERA_NONCE_LEN

const uint8_t CAMERA_NONCE_LEN = 64

相机 Nonce 字符串的长度(以字节为单位),不包括 NULL 终止符。

CAMERA_SECRET_LEN

const uint8_t CAMERA_SECRET_LEN = 32

相机密钥的长度(以字节为单位)。

EUI48_LEN

const uint8_t EUI48_LEN = 6

EUI-48 原始字节表示法的长度(以字节为单位)。

EUI48_STR_LEN

const uint8_t EUI48_STR_LEN = 13

EUI-48 的长度(以字节为单位),表示为由 12 个十六进制数字无冒号分隔符的字符串加 NULL 终止符组成。

HMAC_BUF_LEN

const uint8_t HMAC_BUF_LEN = 32

表示相机生成的配对信息 HMAC 的长度(以字节为单位),表示为原始字节。

sDropcamLegacyPairingProfileStringContext

Weave::Support::ProfileStringContext sDropcamLegacyPairingProfileStringContext = {
    NULL,
    sDropcamLegacyPairingProfileStringInfo
}

用于注册和取消注册与 相关联的回调,以返回与配置文件相关联的人类可读支持字符串的上下文。

sDropcamLegacyPairingProfileStringInfo

const Weave::Support::ProfileStringInfo sDropcamLegacyPairingProfileStringInfo = {
    kWeaveProfile_DropcamLegacyPairing,

    GetDropcamLegacyPairingMessageName,
    GetDropcamLegacyPairingProfileName,
    NULL
}

此结构为关联的回调提供存储空间,用于返回与配置文件相关联的人类可读的支持字符串。

函数

DecodeCameraAuthDataResponse

WEAVE_ERROR DecodeCameraAuthDataResponse(
  PacketBuffer *buf,
  uint8_t(&) macAddress[EUI48_LEN],
  uint8_t(&) hmac[HMAC_BUF_LEN]
)

用于解码 CameraAuthDataResponse 消息载荷的实用函数。

详细信息
参数
[in] buf
指向相机身份验证数据响应消息载荷缓冲区的指针。
[in] macAddress
相机的 EUI-48 Wi-Fi MAC 地址的字节数组缓冲区。
[in] hmac
对提供的 HMAC 返回缓冲区的引用。HMAC 以原始字节数组的形式返回,该数组可能包含非 ASCII/Unicode 字符。
返回值
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定的错误代码,表示发生错误,无法解码消息载荷。

EncodeCameraAuthDataRequest

WEAVE_ERROR EncodeCameraAuthDataRequest(
  PacketBuffer *buf,
  const char *nonce
)

用于对 CameraAuthDataRequest 消息载荷进行编码的实用函数。

用于对 Dropcam 旧版配对配置文件消息载荷进行编码和解码的实用函数。

详细信息
参数
[in] buf
指向相机身份验证数据请求消息载荷缓冲区的指针。
[in] nonce
指向相机配对 Nonce 的指针,格式为以 NULL 结尾的 UTF-8 字符串。
返回值
WEAVE_NO_ERROR
成功时。
other
其他 Weave 或平台特定的错误代码,表示发生错误,无法对消息载荷进行编码。

GetDropcamLegacyPairingMessageName

const char * GetDropcamLegacyPairingMessageName(
  uint32_t inProfileId,
  uint8_t inMsgType
)

回调函数,用于返回人类可读、以 NULL 结尾的 C 字符串,用于描述与此配置文件相关联的消息类型。

注册此回调函数后,当需要使用人类可读的以 NULL 结尾的 C 字符串来描述与此配置文件相关联的消息类型时,系统会调用此回调函数。

详细信息
参数
[in] inProfileId
与指定消息类型相关联的个人资料标识符。
[in] inMsgType
要寻找直观易懂的描述性字符串的消息类型。
返回值
指向以 NULL 结尾的 C 字符串(如果找到匹配项)的指针;否则为 NULL。

GetDropcamLegacyPairingProfileName

const char * GetDropcamLegacyPairingProfileName(
  uint32_t inProfileId
)

回调函数,用于返回人类可读、以 NULL 结尾的 C 字符串,用于描述具有此配置文件的配置文件。

注册此回调后,当需要使用人类可读的以 NULL 结尾的 C 字符串来描述此配置文件时,系统会调用此回调。

详细信息
参数
[in] inProfileId
要为其寻找直观易懂的描述性字符串的配置文件标识符。
返回值
指向以 NULL 结尾的 C 字符串(如果找到匹配项)的指针;否则为 NULL。

_DropcamLegacyPairingProfileStringDestroy

void _DropcamLegacyPairingProfileStringDestroy(
  void
)

一次性但可重入的反初始化器,用于取消注册 Weave Dropcam 旧版配对配置文件回调,以返回与配置文件相关联的人类可读支持字符串。

_DropcamLegacyPairingProfileStringInit

void _DropcamLegacyPairingProfileStringInit(
  void
)

一次性但可重入的初始化程序,用于注册 Weave Dropcam 旧版配对配置文件回调,以返回与配置文件相关联的人类可读支持字符串。