Google is committed to advancing racial equity for Black communities. See how.

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

#include <src/lib/profiles/device-description/DeviceDescription.h>

Represents criteria use to select devices in the IdentifyDevice protocol.

Summary

Inheritance

Direct Known Subclasses: nl::Weave::Profiles::DeviceDescription::IdentifyRequestMessage

Constructors and Destructors

IdentifyDeviceCriteria(void)

Public attributes

TargetDeviceId
uint64_t
Specifies that only the device with the specified Weave Node ID should respond.
TargetFabricId
uint64_t
Specifies that only devices that are members of the specified Weave fabric should respond.
TargetModes
uint32_t
Specifies that only devices that are currently in the specified modes should respond.
TargetProductId
uint16_t
Specifies that only devices with the specified product ID should respond.
TargetVendorId
uint16_t
Specifies that only devices manufactured by the specified vendor should respond to the identify request.

Public functions

Reset(void)
void
Resets this Identify Device Criteria object to be least restrictive, that is, matching any.

Public attributes

TargetDeviceId

uint64_t TargetDeviceId

Specifies that only the device with the specified Weave Node ID should respond.

A value of kAnyNodeId specifies any device.

TargetFabricId

uint64_t TargetFabricId

Specifies that only devices that are members of the specified Weave fabric should respond.

Value can be an actual fabric ID, or one of the TargetFabricIds enum values.

TargetModes

uint32_t TargetModes

Specifies that only devices that are currently in the specified modes should respond.

Values are taken from the TargetDeviceModes enum.

TargetProductId

uint16_t TargetProductId

Specifies that only devices with the specified product ID should respond.

A value of 0xFFFF specifies any product. If the TargetProductId field is specified, then the TargetVendorId must also be specified.

TargetVendorId

uint16_t TargetVendorId

Specifies that only devices manufactured by the specified vendor should respond to the identify request.

A value of 0xFFFF specifies any vendor.

Public functions

IdentifyDeviceCriteria

 IdentifyDeviceCriteria(
  void
)

Reset

void Reset(
  void
)

Resets this Identify Device Criteria object to be least restrictive, that is, matching any.