nl::Weave::Profiller::CihazAçıklaması::WeaveDeviceDescriptor

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

Weave cihaz hakkında açıklayıcı bilgiler içerir.

Özet

İnşaat Ustaları ve Yıkıcılar
WeaveDeviceDescriptor(void)

Herkese açık türler
@180{
  kMaxSerialNumberLength = 32,
  kMaxPairingCodeLength = 16,
  kMaxRendezvousWiFiESSID = 32,
  kMaxSoftwareVersionLength = WEAVE_CONFIG_MAX_SOFTWARE_VERSION_LENGTH
} 		enum
Bazı özelliklerin maksimum uzunluğunu tanımlar.
@181{
  kFeature_HomeAlarmLinkCapable = 0x00000001,
  kFeature_LinePowered = 0x00000002
} 		enum
Belirli cihaz özelliklerini gösteren özellik işaretleri.
@182{
  kFlag_IsRendezvousWiFiESSIDSuffix = 0x01
} 		enum
İşaretler alan tanımları.

Herkese açık özellikler
Day
uint8_t
Cihaz üreticisinin günü (0 = mevcut değil)
DeviceFeatures
uint32_t
Belirli cihaz özellikleri için desteği belirten bit alanı.
DeviceId
uint64_t
Ağ cihaz kimliği (0 = mevcut değil)
FabricId
uint64_t
Cihazın ait olduğu dokuma kumaşın kimliği (0 = mevcut değil)
Flags
uint8_t
Cihaz hakkında ek bilgiler içeren bit alanı.
ManufacturingDate
struct nl::Weave::Profiles::DeviceDescription::WeaveDeviceDescriptor::@183
Month
uint8_t
Cihazın üretim ayı (1 = Ocak)
PairingCode[kMaxPairingCodeLength+1]
char
Cihaz eşleme kodu (NUL sonlandırıldı, 0 uzunluk = mevcut değil)
PairingCompatibilityVersionMajor
uint16_t
Önemli cihaz eşleme yazılımı uyumluluğu sürümü.
PairingCompatibilityVersionMinor
uint16_t
Küçük cihaz eşleme yazılım uyumluluğu sürümü.
Primary802154MACAddress[8]
uint8_t
Birincil 802.15.4 arayüzü için MAC adresi (big-endian, tümü sıfır = mevcut değil)
PrimaryWiFiMACAddress[6]
uint8_t
Birincil WiFi arayüzü için MAC adresi (big-endian, tümü sıfır = mevcut değil)
ProductId
uint16_t
Cihaz ürün kodu (0 = mevcut değil)
ProductRevision
uint16_t
Cihaz ürünü düzeltmesi (0 = mevcut değil)
RendezvousWiFiESSID[kMaxRendezvousWiFiESSID+1]
char
Cihazın kablosuz ağ bağlantısı için eSSID (NUL feshedildi, 0 uzunluk = mevcut değil)
SerialNumber[kMaxSerialNumberLength+1]
char
Cihazın seri numarası (NUL sonlandırıldı, 0 uzunluk = mevcut değil)
SoftwareVersion[kMaxSoftwareVersionLength+1]
char
Etkin yazılım sürümü (NUL sonlandırıldı, 0 uzunluk = mevcut değil)
VendorId
uint16_t
Cihaz satıcı kodu (0 = mevcut değil)
Year
uint16_t
Cihaz üreticisinin yılı (geçerli aralık 2001-2099)

Herkese açık işlevler
Clear(void)
void
Cihaz açıklamasını temizler.

Herkese açık statik işlevler
Decode(const uint8_t *data, uint32_t dataLen, WeaveDeviceDescriptor & outDesc)
Sağlanan veri arabelleğinin içeriğini Weave Cihaz Açıklayıcı nesnesine dönüştürür.
DecodeTLV(const uint8_t *data, uint32_t dataLen, WeaveDeviceDescriptor & outDesc)
Sağlanan TLV veri arabelleğinin içeriğini Weave Cihaz Açıklayıcı nesnesine dönüştürür.
DecodeTLV(nl::Weave::TLV::TLVReader & reader, WeaveDeviceDescriptor & outDesc)
İlk kullanıma hazır TLVReader uygulamasını kullanarak Cihaz Açıklaması'nun kodunu çözer.
DecodeText(const char *data, uint32_t dataLen, WeaveDeviceDescriptor & outDesc)
Sağlanan metin verileri arabelleğinin içeriğini Weave Cihaz Açıklayıcı nesnesine dönüştürür.
EncodeTLV(const WeaveDeviceDescriptor & desc, uint8_t *buf, uint32_t bufLen, uint32_t & outEncodedLen)
Sağlanan cihaz tanımlayıcısını, sağlanan arabelleğe yazılan Weave TLV olarak kodlar.
EncodeTLV(const WeaveDeviceDescriptor & desc, nl::Weave::TLV::TLVWriter & writer)
Sağlanan cihaz tanımlayıcısını, önceden başlatılmış TLVWriter nesnesi kullanılarak yazılmış Weave TLV olarak kodlar.
EncodeText(const WeaveDeviceDescriptor & desc, char *buf, uint32_t bufLen, uint32_t & outEncodedLen)
Sağlanan cihaz tanımlayıcısını, sağlanan arabelleğe yazılan metin olarak kodlar.
IsZeroBytes(const uint8_t *buf, uint32_t len)
bool
Belirtilen arabelleğin yalnızca sıfır içerip içermediğini kontrol edin.

Herkese açık türler

@180

 @180

Bazı özelliklerin maksimum uzunluğunu tanımlar.

Özellikler
kMaxPairingCodeLength

Maksimum eşleme kodu uzunluğu.

kMaxRendezvousWiFiESSID

Oluşturulan uzunluk için maksimum WiFi ESSID'si.

kMaxSerialNumberLength

Maksimum seri numarası uzunluğu.

kMaxSoftwareVersionLength

Maksimum yazılım sürümü uzunluğu.

@181

 @181

Belirli cihaz özelliklerini gösteren özellik işaretleri.

Özellikler
kFeature_HomeAlarmLinkCapable

Ev alarm paneli ile bağlantıyı destekleyen bir Nest Protect belirtir.

kFeature_LinePowered

Hat gücü gerektiren bir cihazı belirtir.

@182

 @182

İşaretler alan tanımları.

Özellikler
kFlag_IsRendezvousWiFiESSIDSuffix

RendezvousWiFiESSID değerinin, cihazın kablosuz ağ ağının ESSID'sinin sonunda görünen bir son ek dizesi olduğunu belirtir.

Herkese açık özellikler

Gün

uint8_t Day

Cihaz üreticisinin günü (0 = mevcut değil)

Cihaz Özellikleri

uint32_t DeviceFeatures

Belirli cihaz özellikleri için desteği belirten bit alanı.

Cihaz Kimliği

uint64_t DeviceId

Ağ cihaz kimliği (0 = mevcut değil)

Kumaş Kimliği

uint64_t FabricId

Cihazın ait olduğu dokuma kumaşın kimliği (0 = mevcut değil)

İşaretler

uint8_t Flags

Cihaz hakkında ek bilgiler içeren bit alanı.

Üretim Tarihi

struct nl::Weave::Profiles::DeviceDescription::WeaveDeviceDescriptor::@183 ManufacturingDate

Ay

uint8_t Month

Cihazın üretim ayı (1 = Ocak)

Eşleme Kodu

char PairingCode[kMaxPairingCodeLength+1]

Cihaz eşleme kodu (NUL sonlandırıldı, 0 uzunluk = mevcut değil)

UyumlulukUyumlulukSürümü

uint16_t PairingCompatibilityVersionMajor

Önemli cihaz eşleme yazılımı uyumluluğu sürümü.

EşleştirmeUyumluluğuSürümMin.

uint16_t PairingCompatibilityVersionMinor

Küçük cihaz eşleme yazılım uyumluluğu sürümü.

Birincil802154MACAdres

uint8_t Primary802154MACAddress[8]

Birincil 802.15.4 arayüzü için MAC adresi (big-endian, tümü sıfır = mevcut değil)

Birincil WiFiMACAddress

uint8_t PrimaryWiFiMACAddress[6]

Birincil WiFi arayüzü için MAC adresi (big-endian, tümü sıfır = mevcut değil)

Ürün Kimliği

uint16_t ProductId

Cihaz ürün kodu (0 = mevcut değil)

Ürün Düzeltmesi

uint16_t ProductRevision

Cihaz ürünü düzeltmesi (0 = mevcut değil)

IzgaraWiFiESSID

char RendezvousWiFiESSID[kMaxRendezvousWiFiESSID+1]

Cihazın kablosuz ağ bağlantısı için eSSID (NUL feshedildi, 0 uzunluk = mevcut değil)

Seri Numarası

char SerialNumber[kMaxSerialNumberLength+1]

Cihazın seri numarası (NUL sonlandırıldı, 0 uzunluk = mevcut değil)

Yazılım Sürümü

char SoftwareVersion[kMaxSoftwareVersionLength+1]

Etkin yazılım sürümü (NUL sonlandırıldı, 0 uzunluk = mevcut değil)

Tedarikçi firma kimliği

uint16_t VendorId

Cihaz satıcı kodu (0 = mevcut değil)

Yıl

uint16_t Year

Cihaz üreticisinin yılı (geçerli aralık 2001-2099)

Herkese açık işlevler

Sil

void Clear(
  void
)

Cihaz açıklamasını temizler.

WeaveCihaz Tanımlayıcısı

 WeaveDeviceDescriptor(
  void
)

Herkese açık statik işlevler

Kod çöz

WEAVE_ERROR Decode(
  const uint8_t *data,
  uint32_t dataLen,
  WeaveDeviceDescriptor & outDesc
)

Sağlanan veri arabelleğinin içeriğini Weave Cihaz Açıklayıcı nesnesine dönüştürür.

Ayrıntılar
Parametreler
[in] data
Metin veya TLV olarak kodlanmış Weave Cihaz Tanımlayıcı verilerini içeren bir arabellek işaret eder.
[in] dataLen
Sağlanan arabelleğin uzunluğu.
[out] outDesc
Doldurulacak Cihaz Tanımlayıcı nesnesine referans.
Döndürülen Değerler
WEAVE_ERROR_INVALID_DEVICE_DESCRIPTOR
Sağlanan arabellek geçersizse.
WEAVE_NO_ERROR
Başarılı.
other
TLV'nin kodunun çözülmesini engelleyen bir hata oluştuğunu belirten diğer Weave veya platforma özgü hata kodları.

Kodu çöz

WEAVE_ERROR DecodeTLV(
  const uint8_t *data,
  uint32_t dataLen,
  WeaveDeviceDescriptor & outDesc
)

Sağlanan TLV veri arabelleğinin içeriğini Weave Cihaz Açıklayıcı nesnesine dönüştürür.

Ayrıntılar
Parametreler
[in] data
Metin kodlu Weave Cihaz Tanımlayıcı verilerini içeren bir arabellek için işaretçi.
[in] dataLen
Sağlanan arabelleğin uzunluğu.
[out] outDesc
Doldurulacak Cihaz Tanımlayıcı nesnesine referans.
Döndürülen Değerler
WEAVE_ERROR_WRONG_TLV_TYPE
Bu cihaz açıklaması TLV değilse.
WEAVE_ERROR_UNEXPECTED_TLV_ELEMENT
Cihaz Açıklamasından sonra daha fazla TLV verisi gösterilirse.
WEAVE_NO_ERROR
Başarılı.
other
TLV kodlamasını engelleyen bir hata oluştuğunu belirten diğer Weave veya platforma özgü hata kodları.

Kodu çöz

WEAVE_ERROR DecodeTLV(
  nl::Weave::TLV::TLVReader & reader,
  WeaveDeviceDescriptor & outDesc
)

İlk kullanıma hazır TLVReader uygulamasını kullanarak Cihaz Açıklaması'nun kodunu çözer.

Ayrıntılar
Parametreler
[in] reader
Önceden başlatılan TLVReader için referans.
[out] outDesc
Doldurulacak Cihaz Tanımlayıcı nesnesine referans.
Döndürülen Değerler
WEAVE_ERROR_INVALID_TLV_ELEMENT
TLV verilerinde geçersiz Cihaz Açıklama bilgileri bulunuyorsa.
WEAVE_NO_ERROR
Başarılı.
other
TLV'nin kodunu çözmeyi engelleyen bir hata olduğunu gösteren diğer Weave veya platforma özgü hata kodları.

Kod Çözme Metni

WEAVE_ERROR DecodeText(
  const char *data,
  uint32_t dataLen,
  WeaveDeviceDescriptor & outDesc
)

Sağlanan metin verileri arabelleğinin içeriğini Weave Cihaz Açıklayıcı nesnesine dönüştürür.

Ayrıntılar
Parametreler
[in] data
Metin kodlu Weave Cihaz Tanımlayıcı verilerini içeren bir arabellek için işaretçi.
[in] dataLen
Sağlanan arabelleğin uzunluğu.
[out] outDesc
Doldurulacak Cihaz Tanımlayıcı nesnesine referans.
Döndürülen Değerler
WEAVE_ERROR_UNSUPPORTED_DEVICE_DESCRIPTOR_VERSION
Kodlanmış verilerin sürümü desteklenmiyorsa.
WEAVE_ERROR_INVALID_DEVICE_DESCRIPTOR
Kodlanmış verilerin biçimi doğru değilse.
WEAVE_ERROR_INCORRECT_STATE
Kod çözücü tarafından tutarsız bir durumla karşılaşılırsa.
WEAVE_ERROR_BUFFER_TOO_SMALL
Kod çözme sırasında arabelleğin sonuna ulaşılırsa.
WEAVE_NO_ERROR
Başarılı.

KodlamaTLV

WEAVE_ERROR EncodeTLV(
  const WeaveDeviceDescriptor & desc,
  uint8_t *buf,
  uint32_t bufLen,
  uint32_t & outEncodedLen
)

Sağlanan cihaz tanımlayıcısını, sağlanan arabelleğe yazılan Weave TLV olarak kodlar.

Ayrıntılar
Parametreler
[in] desc
Kodlamak için Weave Cihaz Tanımlayıcısı'na referans.
[out] buf
Kodlanmış metnin yazılacağı bir arabellek işaretçisi.
[in] bufLen
Sağlanan arabelleğin uzunluğu.
[out] outEncodedLen
Tampona yazılan karakter sayısıyla üzerine yazılacak uzunluk değişkeni referansı.
Döndürülen Değerler
WEAVE_NO_ERROR
Başarılı.
other
TLV kodlamasını engelleyen bir hata oluştuğunu belirten diğer Weave veya platforma özgü hata kodları.

KodlamaTLV

WEAVE_ERROR EncodeTLV(
  const WeaveDeviceDescriptor & desc,
  nl::Weave::TLV::TLVWriter & writer
)

Sağlanan cihaz tanımlayıcısını, önceden başlatılmış TLVWriter nesnesi kullanılarak yazılmış Weave TLV olarak kodlar.

Bu parametre, cihaz açıklamasını daha büyük TLV çıkışına eklemek için kullanılır.

Ayrıntılar
Parametreler
[in] desc
Kodlamak için Weave Cihaz Tanımlayıcısı'na referans.
[in] writer
Kullanılacak önceden başlatılmış TLVWriter nesnesine referans.
Döndürülen Değerler
WEAVE_NO_ERROR
Başarılı.
other
TLV kodlamasını engelleyen bir hata oluştuğunu belirten diğer Weave veya platforma özgü hata kodları.

Kodlama Metni

WEAVE_ERROR EncodeText(
  const WeaveDeviceDescriptor & desc,
  char *buf,
  uint32_t bufLen,
  uint32_t & outEncodedLen
)

Sağlanan cihaz tanımlayıcısını, sağlanan arabelleğe yazılan metin olarak kodlar.

Ayrıntılar
Parametreler
[in] desc
Kodlamak için Weave Cihaz Tanımlayıcısı'na referans.
[out] buf
Kodlanmış metnin yazılacağı bir arabellek işaretçisi.
[in] bufLen
Sağlanan arabelleğin uzunluğu.
[out] outEncodedLen
Tampona yazılan karakter sayısıyla üzerine yazılacak uzunluk değişkeni referansı.
Döndürülen Değerler
WEAVE_ERROR_BUFFER_TOO_SMALL
Sağlanan arabelleği, oluşturulan metin açıklaması için çok küçükse.
WEAVE_ERROR_INVALID_ARGUMENT
Tanımlayıcı alanı geçersizse.
WEAVE_NO_ERROR
Başarılı.

IsZeroBytes

bool IsZeroBytes(
  const uint8_t *buf,
  uint32_t len
)

Belirtilen arabelleğin yalnızca sıfır içerip içermediğini kontrol edin.

Ayrıntılar
Parametreler
[in] buf
Tampon işaretçisi.
[in] len
Tampon uzunluğu.
Döndürülen Değerler
TRUE
Arabellek yalnızca sıfır içeriyorsa.
FALSE
Arabelleğe sıfır dışında bir değer varsa.