nl::Weave::Profiles::DeviceDescription

Cet espace de noms inclut toutes les interfaces de Weave pour le profil de description de l'appareil Weave.

Résumé

Énumérations

@177 énum
@178 énum
Types de messages pour le profil de description de l'appareil.
@179{
  kTag_WeaveDeviceDescriptor = 1,
  kTag_VendorId = 0,
  kTag_ProductId = 1,
  kTag_ProductRevision = 2,
  kTag_ManufacturingDate = 3,
  kTag_SerialNumber = 4,
  kTag_Primary802154MACAddress = 5,
  kTag_PrimaryWiFiMACAddress = 6,
  kTag_RendezvousWiFiESSID = 7,
  kTag_PairingCode = 8,
  kTag_SoftwareVersion = 9,
  kTag_DeviceId = 10,
  kTag_FabricId = 11,
  kTag_PairingCompatibilityVersionMajor = 12,
  kTag_PairingCompatibilityVersionMinor = 13,
  kTag_RendezvousWiFiESSIDSuffix = 14,
  kTag_DeviceFeature_HomeAlarmLinkCapable = 100,
  kTag_DeviceFeature_LinePowered = 101
}
énum
Balises d'éléments de données pour le profil de description de l'appareil.
TargetDeviceModes{
  kTargetDeviceMode_Any = 0x00000000,
  kTargetDeviceMode_UserSelectedMode = 0x00000001
}
énum
Champ de bits (32 bits maximum) identifiant les appareils qui doivent répondre à un message de requête de localisation en fonction de leur mode actuel.
TargetFabricIds{
  kTargetFabricId_NotInFabric = kFabricIdNotSpecified,
  kTargetFabricId_AnyFabric = kReservedFabricIdStart,
  kTargetFabricId_Any = kMaxFabricId
}
énum
ID spéciaux des fabrics cibles.

Fonctions

MatchTargetFabricId(uint64_t fabricId, uint64_t targetFabricId)
NL_DLL_EXPORT bool
Comparez deux ID de tissu pour déterminer s'ils correspondent (en tenant compte des valeurs génériques).

Classes

nl::Weave::Profiles::DeviceDescription::DeviceDescriptionClient

Objet client pour l'émission des requêtes de description d'appareil.

nl::Weave::Profiles::DeviceDescription::DeviceDescriptionServer

Objet serveur permettant de répondre aux requêtes de description d'appareil.

nl::Weave::Profiles::DeviceDescription::IdentifyDeviceCriteria

Représente les critères à utiliser pour sélectionner des appareils dans le protocole IdentifierDevice.

nl::Weave::Profiles::DeviceDescription::IdentifyRequestMessage

Forme analysée d'un message d'IdentityRequest.

nl::Weave::Profiles::DeviceDescription::IdentifyResponseMessage

Forme analysée d'un message IdentifieResponse.

nl::Weave::Profiles::DeviceDescription::TextDescriptorReader
nl::Weave::Profiles::DeviceDescription::TextDescriptorWriter
nl::Weave::Profiles::DeviceDescription::WeaveDeviceDescriptor

Contient des informations descriptives sur un appareil Weave.

Énumérations

@177

 @177

@178

 @178

Types de messages pour le profil de description de l'appareil.

@179

 @179

Balises d'éléments de données pour le profil de description de l'appareil.

Propriétés
kTag_DeviceFeature_HomeAlarmLinkCapable

[ boolean ] Indique un détecteur Nest Protect compatible avec le panneau d'alarme de la maison.

Tag de fonctionnalité

kTag_DeviceFeature_LinePowered

[ boolean ] Indique un appareil qui nécessite une alimentation secteur.

Tag de fonctionnalité

kTag_DeviceId

[ uint, 2^64 max ] Identifiant de l'appareil Weave.

Balise spécifique au contexte

kTag_FabricId

[ uint, 2^64 max ] Identifiant du tissu tissé auquel l'appareil appartient.

Balise spécifique au contexte

kTag_ManufacturingDate

[ uint, range 1-65535 ] Date calendaire de fabrication, au format encodé

Balise spécifique au contexte

kTag_PairingCode

[ UTF-8 string, len 6-16 ] Code d'association de l'appareil.

Balise spécifique au contexte

kTag_PairingCompatibilityVersionMajor

[ uint, range 1-65535 ] Version majeure de compatibilité du logiciel d'association.

Balise spécifique au contexte

kTag_PairingCompatibilityVersionMinor

[ uint, range 1-65535 ] Version mineure de compatibilité du logiciel d'association.

Balise spécifique au contexte

kTag_Primary802154MACAddress

[ byte string, len = 8 ] Adresse MAC de l'interface 802.15.4 principale de l'appareil.

Balise spécifique au contexte

kTag_PrimaryWiFiMACAddress

[ byte string, len = 6 ] Adresse MAC de l'interface Wi-Fi principale de l'appareil.

Balise spécifique au contexte

kTag_ProductId

[ uint, range 1-65535 ] Code identifiant le produit.

Balise spécifique au contexte

kTag_ProductRevision

[ uint, range 1-65535 ] Code identifiant la révision du produit.

Balise spécifique au contexte

kTag_RendezvousWiFiESSID

[ UTF-8 string, len 1-32 ] ESSID du réseau de rendez-vous Wi-Fi de l'appareil.

Tag spécifique au contexte.

kTag_RendezvousWiFiESSIDSuffix

[ UTF-8 string, len 1-32 ] Suffixe ESSID du réseau de rendez-vous Wi-Fi de l'appareil.

Tag spécifique au contexte.

kTag_SerialNumber

[ UTF-8 string, len 1-32 ] Numéro de série de l'appareil.

Balise spécifique au contexte

kTag_SoftwareVersion

[ UTF-8 string, len 1-32 ] Version du logiciel installée sur l'appareil.

Balise spécifique au contexte

kTag_VendorId

[ uint, range 1-65535 ] Code identifiant le fournisseur du produit.

Balise spécifique au contexte

kTag_WeaveDeviceDescriptor

Structure contenant des informations décrivant un appareil Weave.

Tag de premier niveau

TargetDeviceModes

 TargetDeviceModes

Champ de bits (32 bits maximum) identifiant les appareils qui doivent répondre à un message de requête de localisation en fonction de leur mode actuel.

Notez que les modes définis ici sont destinés à être généraux, et qu'ils peuvent donc être appliqués à divers types d'appareils.

Propriétés
kTargetDeviceMode_Any

Localisez tous les appareils, quel que soit leur mode.

kTargetDeviceMode_UserSelectedMode

Repérer tous les appareils dans "Sélectionné par l'utilisateur" c'est-à-dire lorsque l'appareil a été directement identifié par un utilisateur en appuyant sur un bouton (ou équivalent).

TargetFabricIds

 TargetFabricIds

ID spéciaux des fabrics cibles.

Propriétés
kTargetFabricId_Any

Indique que tous les appareils doivent répondre, quel que soit leur type de tissu.

kTargetFabricId_AnyFabric

Indique que seuls les appareils appartenant à un tissu doivent répondre.

kTargetFabricId_NotInFabric

Indique que seuls les appareils qui ne sont pas membres d'un tissu doivent répondre.

Fonctions

MatchTargetFabricId

NL_DLL_EXPORT bool MatchTargetFabricId(
  uint64_t fabricId,
  uint64_t targetFabricId
)

Comparez deux ID de tissu pour déterminer s'ils correspondent (en tenant compte des valeurs génériques).

Détails
Paramètres
[in] fabricId
ID de la structure à tester.
[in] targetFabricId
ID de la structure à tester.
Valeurs renvoyées
TRUE
Si les ID de tissu correspondent.
FALSE
Si les identifiants du tissu ne correspondent pas,