Ta strona została przetłumaczona przez Cloud Translation API.

nl::Weave::Profiles::DeviceDescription::WeaveDeviceDescriptor

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

Zawiera opisowe informacje o urządzeniu Weave.

Podsumowanie

Konstruktorzy i niszczyciele
`WeaveDeviceDescriptor(void)`

Typy publiczne
`@180{ kMaxSerialNumberLength = 32, kMaxPairingCodeLength = 16, kMaxRendezvousWiFiESSID = 32, kMaxSoftwareVersionLength = WEAVE_CONFIG_MAX_SOFTWARE_VERSION_LENGTH }`	enum \| typ wyliczeniowy Określa maksymalną długość niektórych atrybutów.
`@181{ kFeature_HomeAlarmLinkCapable = 0x00000001, kFeature_LinePowered = 0x00000002 }`	enum \| typ wyliczeniowy Flagi funkcji wskazujące określone możliwości urządzenia.
`@182{ kFlag_IsRendezvousWiFiESSIDSuffix = 0x01 }`	enum \| typ wyliczeniowy Definicje pól flag.

Atrybuty publiczne
`Day`	`uint8_t` Dzień produkcji urządzenia (0 = brak)
`DeviceFeatures`	`uint32_t` Pole bitowe wskazujące obsługę określonych funkcji urządzenia.
`DeviceId`	`uint64_t` Identyfikator urządzenia Weave (0 = brak)
`FabricId`	`uint64_t` Identyfikator tkaniny Weave, do której należy urządzenie (0 = brak)
`Flags`	`uint8_t` Pole bitowe zawierające dodatkowe informacje o urządzeniu.
`ManufacturingDate`	`struct nl::Weave::Profiles::DeviceDescription::WeaveDeviceDescriptor::@183`
`Month`	`uint8_t` Miesiąc produkcji urządzenia (1 = styczeń)
`PairingCode[kMaxPairingCodeLength+1]`	`char` Kod parowania urządzenia (zakończony NUL, długość 0 = brak)
`PairingCompatibilityVersionMajor`	`uint16_t` Wersja zgodności głównego oprogramowania do parowania urządzeń.
`PairingCompatibilityVersionMinor`	`uint16_t` Niższa wersja zgodności oprogramowania do parowania urządzeń.
`Primary802154MACAddress[8]`	`uint8_t` Adres MAC głównego interfejsu 802.15.4 (big-endian, wszystkie zera = brak)
`PrimaryWiFiMACAddress[6]`	`uint8_t` Adres MAC głównego interfejsu Wi-Fi (big-endian, wszystkie zera = brak)
`ProductId`	`uint16_t` Kod produktu na urządzeniu (0 = brak)
`ProductRevision`	`uint16_t` Wersja produktu na urządzeniu (0 = brak)
`RendezvousWiFiESSID[kMaxRendezvousWiFiESSID+1]`	`char` Identyfikator ESSID dla sieci komórkowej Wi-Fi w pobliżu urządzenia (z zakończeniem NUL, długość 0 = brak)
`SerialNumber[kMaxSerialNumberLength+1]`	`char` Numer seryjny urządzenia (zakończony NUL, długość 0 = brak)
`SoftwareVersion[kMaxSoftwareVersionLength+1]`	`char` Aktywna wersja oprogramowania (zakończona NUL, długość 0 = brak)
`VendorId`	`uint16_t` Kod dostawcy urządzenia (0 = brak)
`Year`	`uint16_t` Rok produkcji urządzenia (obowiązujący zakres: 2001–2099)

Funkcje publiczne
`Clear(void)`	`void` Usuwa opis urządzenia.

Publiczne funkcje statyczne
`Decode(const uint8_t *data, uint32_t dataLen, WeaveDeviceDescriptor & outDesc)`	`WEAVE_ERROR` Dekoduje zawartość dostarczonego bufora danych do obiektu deskryptora urządzenia Weave.
`DecodeTLV(const uint8_t *data, uint32_t dataLen, WeaveDeviceDescriptor & outDesc)`	`WEAVE_ERROR` Dekoduje zawartość podanego bufora danych TLV do obiektu Weave Device Descriptor.
`DecodeTLV(nl::Weave::TLV::TLVReader & reader, WeaveDeviceDescriptor & outDesc)`	`WEAVE_ERROR` Dekoduje opis urządzenia za pomocą dostarczonego wstępnie zainicjowanego programu TLVReader.
`DecodeText(const char *data, uint32_t dataLen, WeaveDeviceDescriptor & outDesc)`	`WEAVE_ERROR` Dekoduje zawartość podanego bufora danych tekstowych do obiektu deskryptora urządzenia Weave.
`EncodeTLV(const WeaveDeviceDescriptor & desc, uint8_t *buf, uint32_t bufLen, uint32_t & outEncodedLen)`	`WEAVE_ERROR` Koduje podany deskryptor urządzenia jako Weave TLV zapisany w udostępnionym buforze.
`EncodeTLV(const WeaveDeviceDescriptor & desc, nl::Weave::TLV::TLVWriter & writer)`	`WEAVE_ERROR` Koduje podany deskryptor urządzenia jako Weave TLV zapisany przy użyciu dostarczonego wstępnie zainicjowanego obiektu TLVWriter.
`EncodeText(const WeaveDeviceDescriptor & desc, char *buf, uint32_t bufLen, uint32_t & outEncodedLen)`	`WEAVE_ERROR` Koduje podany deskryptor urządzenia jako tekst zapisany w udostępnionym buforze.
`IsZeroBytes(const uint8_t *buf, uint32_t len)`	`bool` Sprawdź, czy podany bufor zawiera tylko zera.

Typy publiczne

@180

 @180

Określa maksymalną długość niektórych atrybutów.

Właściwości
`kMaxPairingCodeLength`	Maksymalna długość kodu parowania.
`kMaxRendezvousWiFiESSID`	Maksymalny identyfikator ESSID sieci Wi-Fi dla czasu trwania Rendezvous.
`kMaxSerialNumberLength`	Maksymalna długość numeru seryjnego.
`kMaxSoftwareVersionLength`	Maksymalna długość wersji oprogramowania.

@181

 @181

Flagi funkcji wskazujące określone możliwości urządzenia.

Właściwości
`kFeature_HomeAlarmLinkCapable`	Oznacza urządzenie Nest Protect, które obsługuje podłączenie do panelu alarmu w domu.
`kFeature_LinePowered`	Wskazuje urządzenie, które wymaga zasilania sieciowego.

@182

 @182

Definicje pól flag.

Właściwości
`kFlag_IsRendezvousWiFiESSIDSuffix`	Wskazuje, że wartość RendezvousWiFiESSID jest ciągiem przyrostka na końcu identyfikatora ESSID sieci Wi-Fi na urządzeniu.

Atrybuty publiczne

Day

uint8_t Day

Dzień produkcji urządzenia (0 = brak)

DeviceFeatures

uint32_t DeviceFeatures

Pole bitowe wskazujące obsługę określonych funkcji urządzenia.

DeviceId

uint64_t DeviceId

Identyfikator urządzenia Weave (0 = brak)

FabricId

uint64_t FabricId

Identyfikator tkaniny Weave, do której należy urządzenie (0 = brak)

Flagi

uint8_t Flags

Pole bitowe zawierające dodatkowe informacje o urządzeniu.

ManufacturingDate

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

Miesiąc

uint8_t Month

Miesiąc produkcji urządzenia (1 = styczeń)

PairingCode

char PairingCode[kMaxPairingCodeLength+1]

Kod parowania urządzenia (zakończony NUL, długość 0 = brak)

PairingCompatibilityVersionMajor

uint16_t PairingCompatibilityVersionMajor

Wersja zgodności głównego oprogramowania do parowania urządzeń.

PairingCompatibilityVersionMinor

uint16_t PairingCompatibilityVersionMinor

Niższa wersja zgodności oprogramowania do parowania urządzeń.

Podstawowy adres 802154MAC

uint8_t Primary802154MACAddress[8]

Adres MAC głównego interfejsu 802.15.4 (big-endian, wszystkie zera = brak)

PrimaryWiFiMACAddress

uint8_t PrimaryWiFiMACAddress[6]

Adres MAC głównego interfejsu Wi-Fi (big-endian, wszystkie zera = brak)

ProductId

uint16_t ProductId

Kod produktu na urządzeniu (0 = brak)

ProductRevision

uint16_t ProductRevision

Wersja produktu na urządzeniu (0 = brak)

RendezvousWiFiESSID

char RendezvousWiFiESSID[kMaxRendezvousWiFiESSID+1]

Identyfikator ESSID dla sieci komórkowej Wi-Fi w pobliżu urządzenia (z zakończeniem NUL, długość 0 = brak)

SerialNumber

char SerialNumber[kMaxSerialNumberLength+1]

Numer seryjny urządzenia (zakończony NUL, długość 0 = brak)

SoftwareVersion

char SoftwareVersion[kMaxSoftwareVersionLength+1]

Aktywna wersja oprogramowania (zakończona NUL, długość 0 = brak)

VendorId

uint16_t VendorId

Kod dostawcy urządzenia (0 = brak)

Rok

uint16_t Year

Rok produkcji urządzenia (obowiązujący zakres: 2001–2099)

Funkcje publiczne

Wyczyść

void Clear(
  void
)

Usuwa opis urządzenia.

WeaveDeviceDescriptor

 WeaveDeviceDescriptor(
  void
)

Publiczne funkcje statyczne

Decode

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

Dekoduje zawartość dostarczonego bufora danych do obiektu deskryptora urządzenia Weave.

Szczegóły

Parametry

`[in] data`	Wskaźnik do bufora zawierającego tekst lub dane deskryptora urządzenia Weave zakodowane w formacie TLV.
`[in] dataLen`	Długość udostępnionego bufora.
`[out] outDesc`	Odwołanie do obiektu deskryptora urządzenia, który ma zostać wypełniony.

Zwracane wartości

`WEAVE_ERROR_INVALID_DEVICE_DESCRIPTOR`	Jeśli podany bufor jest nieprawidłowy.
`WEAVE_NO_ERROR`	Na sukces.
`other`	Inne kody błędów Weave lub dotyczące platformy wskazujące, że wystąpił błąd uniemożliwiający dekodowanie TLV.

DecodeTLV

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

Dekoduje zawartość podanego bufora danych TLV do obiektu Weave Device Descriptor.

Szczegóły

Parametry

`[in] data`	Wskaźnik do bufora zawierającego zakodowane w nim dane z deskryptora urządzenia Weave.
`[in] dataLen`	Długość udostępnionego bufora.
`[out] outDesc`	Odwołanie do obiektu deskryptora urządzenia, który ma zostać wypełniony.

Zwracane wartości

`WEAVE_ERROR_WRONG_TLV_TYPE`	Jeśli nie jest to Opis urządzenia, TLV.
`WEAVE_ERROR_UNEXPECTED_TLV_ELEMENT`	Jeśli po opisie urządzenia pojawi się więcej danych TLV.
`WEAVE_NO_ERROR`	Na sukces.
`other`	Inne kody błędów Weave lub dotyczące platformy wskazujące, że wystąpił błąd uniemożliwiający kodowanie TLV.

DecodeTLV

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

Dekoduje opis urządzenia za pomocą dostarczonego wstępnie zainicjowanego programu TLVReader.

Szczegóły

Parametry

`[in] reader`	Odwołanie do wstępnie zainicjowanego programu TLVReader.
`[out] outDesc`	Odwołanie do obiektu deskryptora urządzenia, który ma zostać wypełniony.

Zwracane wartości

`WEAVE_ERROR_INVALID_TLV_ELEMENT`	Jeśli w danych TLV znajdują się nieprawidłowe informacje o opisie urządzenia.
`WEAVE_NO_ERROR`	Na sukces.
`other`	Inne kody błędów Weave lub dotyczące platformy wskazujące, że wystąpił błąd, który uniemożliwił dekodowanie TLV.

DecodeText

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

Dekoduje zawartość podanego bufora danych tekstowych do obiektu deskryptora urządzenia Weave.

Szczegóły

Parametry

`[in] data`	Wskaźnik do bufora zawierającego zakodowane w nim dane z deskryptora urządzenia Weave.
`[in] dataLen`	Długość udostępnionego bufora.
`[out] outDesc`	Odwołanie do obiektu deskryptora urządzenia, który ma zostać wypełniony.

Zwracane wartości

`WEAVE_ERROR_UNSUPPORTED_DEVICE_DESCRIPTOR_VERSION`	Jeśli zakodowana wersja danych nie jest obsługiwana.
`WEAVE_ERROR_INVALID_DEVICE_DESCRIPTOR`	Jeśli zakodowane dane nie są poprawnie sformatowane.
`WEAVE_ERROR_INCORRECT_STATE`	Jeśli dekoder napotka niespójny stan.
`WEAVE_ERROR_BUFFER_TOO_SMALL`	Jeśli podczas dekodowania zostanie osiągnięty koniec bufora.
`WEAVE_NO_ERROR`	Na sukces.

EncodeTLV

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

Koduje podany deskryptor urządzenia jako Weave TLV zapisany w udostępnionym buforze.

Szczegóły

Parametry

`[in] desc`	Odwołanie do deskryptora urządzenia Weave do zakodowania.
`[out] buf`	Wskaźnik bufora, w którym zostanie zapisany zakodowany tekst.
`[in] bufLen`	Długość dostarczonego bufora.
`[out] outEncodedLen`	Odwołanie do zmiennej długości, które zostanie zastąpione liczbą znaków zapisanych w buforze.

Zwracane wartości

`WEAVE_NO_ERROR`	Na sukces.
`other`	Inne kody błędów Weave lub dotyczące platformy wskazujące, że wystąpił błąd uniemożliwiający kodowanie TLV.

EncodeTLV

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

Koduje podany deskryptor urządzenia jako Weave TLV zapisany przy użyciu dostarczonego wstępnie zainicjowanego obiektu TLVWriter.

Służy do dodawania opisu urządzenia do większego zbioru danych TLV.

Szczegóły

Parametry

`[in] desc`	Odwołanie do deskryptora urządzenia Weave do zakodowania.
`[in] writer`	Odwołanie do wstępnie zainicjowanego obiektu TLVWriter, który ma zostać użyty.

Zwracane wartości

`WEAVE_NO_ERROR`	Na sukces.
`other`	Inne kody błędów Weave lub dotyczące platformy wskazujące, że wystąpił błąd uniemożliwiający kodowanie TLV.

EncodeText

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

Koduje podany deskryptor urządzenia jako tekst zapisany w udostępnionym buforze.

Szczegóły

Parametry

`[in] desc`	Odwołanie do deskryptora urządzenia Weave do zakodowania.
`[out] buf`	Wskaźnik bufora, w którym zostanie zapisany zakodowany tekst.
`[in] bufLen`	Długość dostarczonego bufora.
`[out] outEncodedLen`	Odwołanie do zmiennej długości, które zostanie zastąpione liczbą znaków zapisanych w buforze.

Zwracane wartości

`WEAVE_ERROR_BUFFER_TOO_SMALL`	Jeśli dostarczony bufor jest za mały dla wygenerowanego opisu tekstowego.
`WEAVE_ERROR_INVALID_ARGUMENT`	Jeśli pole deskryptora jest nieprawidłowe.
`WEAVE_NO_ERROR`	Na sukces.

IsZeroBytes

bool IsZeroBytes(
  const uint8_t *buf,
  uint32_t len
)

Sprawdź, czy podany bufor zawiera tylko zera.

Szczegóły

Parametry

`[in] buf`	Wskaźnik do bufora.
`[in] len`	Długość bufora.

Zwracane wartości

`TRUE`	Jeśli bufor zawiera tylko zera:
`FALSE`	Czy bufor zawiera wartości inne niż zero.

nl::Weave::Profiles::DeviceDescription::WeaveDeviceDescriptor

Podsumowanie

Konstruktorzy i niszczyciele

Typy publiczne

Atrybuty publiczne

Funkcje publiczne

Publiczne funkcje statyczne

Typy publiczne

@180

@181

@182

Atrybuty publiczne

Day

DeviceFeatures

DeviceId

FabricId

Flagi

ManufacturingDate

Miesiąc

PairingCode

PairingCompatibilityVersionMajor

PairingCompatibilityVersionMinor

Podstawowy adres 802154MAC

PrimaryWiFiMACAddress

ProductId

ProductRevision

RendezvousWiFiESSID

SerialNumber

SoftwareVersion

VendorId

Rok

Funkcje publiczne

Wyczyść

WeaveDeviceDescriptor

Publiczne funkcje statyczne

Decode

DecodeTLV

DecodeTLV

DecodeText

EncodeTLV

EncodeTLV

EncodeText

IsZeroBytes