azure-iot-device package

  • Odwołanie

Klasy

Message

Obiekt Message jest używany do telemetrii (urządzenie-chmura) i poleceń (chmura-urządzenie) asynchronicznych komunikatów między urządzeniem a usługą IoT Hub. Jest ona niezależna od transportu, co oznacza, że działa tak samo w przypadku protokołu AMQP, MQTT i HTTP.
Client

IoT Hub klienta urządzenia używanego do łączenia urządzenia z usługą Azure IoT Hub.

Użytkownicy zestawu SDK powinni wywołać jedną z metod fabrycznych z obszaruConnectionString lub zsharedAccessSignature w celu utworzenia klienta urządzenia IoT Hub.
DeviceMethodRequest

Reprezentuje dane przekazywane z usługi do urządzenia, gdy metoda urządzenia jest wywoływana z chmury. Wystąpienie tej klasy jest przekazywane do wywołania zwrotnego zarejestrowanego za pośrednictwem metody onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
DeviceMethodResponse

DeviceMethodResponse obiekt jest dostarczany użytkownikowi z każdymDeviceMethodRequest, co umożliwia użytkownikowi konstruowanie i wysyłanie dobrze sformatowanej odpowiedzi z powrotem do usługi dla każdego wywołania metody urządzenia. Wystąpienie tej klasy jest przekazywane jako drugi parametr do wywołania zwrotnego zarejestrowanego za pośrednictwem metody onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
IotEdgeAuthenticationProvider

Zapewnia implementację AuthenticationProvider , która deleguje generowanie tokenów do elementu iotedged. Ta implementacja ma być używana podczas korzystania z klienta modułu z usługą Azure IoT Edge.

Ten typ dziedziczy z SharedAccessKeyAuthenticationProvider i jest funkcjonalnie identyczny z tym typem, z wyjątkiem części generowania tokenu, którą zastępuje przez zaimplementowanie _sign metody.
ModuleClient

IoT Hub klienta urządzenia używanego do łączenia urządzenia z usługą Azure IoT Hub.

Użytkownicy zestawu SDK powinni wywołać jedną z metod fabrycznych z obszaruConnectionString lub zsharedAccessSignature w celu utworzenia klienta urządzenia IoT Hub.
SharedAccessKeyAuthenticationProvider

AuthenticationProvider Udostępnia obiekt, który można utworzyć po prostu za pomocą parametrów połączenia, a następnie jest używany przez klienta urządzenia i transportu do uwierzytelniania za pomocą wystąpienia usługi Azure IoT Hub.

Obiekt SharedAccessKeyAuthenticationProvider zajmuje się tworzeniem tokenów sygnatury dostępu współdzielonego w regularnych odstępach czasu i emituje newTokenAvailable zdarzenie dla transportu w celu odnowienia swoich poświadczeń za pomocą wystąpienia usługi Azure IoT Hub i pozostania na bieżąco.
SharedAccessSignatureAuthenticationProvider

AuthenticationProvider Udostępnia obiekt, który można utworzyć po prostu za pomocą sygnatury dostępu współdzielonego, a następnie jest używany przez klienta urządzenia i transportu do uwierzytelniania za pomocą wystąpienia usługi Azure IoT Hub.

Obiekt SharedAccessSignatureAuthenticationProvider nie odnawia tokenu sygnatury dostępu współdzielonego automatycznie, dlatego użytkownik musi posunąć do niego tokeny sygnatury dostępu współdzielonego, które nie wygasły, przy użyciu updateSharedAccessSignature metody . Dla każdego wywołania tej metody program emituje newTokenAvailable zdarzenie, SharedAccessSignatureAuthenticationProvider które będzie używane do uwierzytelniania za pomocą wystąpienia usługi Azure IoT Hub.
Twin

Bliźniaczą reprezentacją urządzenia jest dokument opisujący stan urządzenia przechowywanego przez centrum Azure IoT Hub i jest dostępny nawet wtedy, gdy urządzenie jest w trybie offline. Jest on tworzony w około 3 sekcjach:

  • Tagi: pary klucz/wartość są dostępne tylko po stronie usługi
  • Żądane właściwości: zaktualizowane przez usługę i odebrane przez urządzenie
  • Zgłaszane właściwości: zaktualizowane przez urządzenie i odebrane przez usługę.

Należy pamiętać, że chociaż jest to możliwe, żądane i zgłoszone właściwości nie muszą być zgodne i że logika synchronizacji tych dwóch kolekcji, w razie potrzeby, jest pozostawiona użytkownikowi zestawu SDK.

Aby uzyskać więcej informacji, zobacz Understanding Device Twins (Opis bliźniaczych reprezentacji urządzeń).
X509AuthenticationProvider

AuthenticationProvider Udostępnia obiekt, który można utworzyć po prostu za pomocą certyfikatu i klucza X509, a następnie jest używany przez klienta urządzenia i transportu do uwierzytelniania za pomocą wystąpienia usługi Azure IoT Hub.

SharedAccessSignatureAuthenticationProvider W przeciwieństwie do obiektów i SharedAccessKeyAuthenticationProvider obiekt nie emituje newTokenAvailable zdarzenia, X509AuthenticationProvider ponieważ nie ma tokenu związanego z uwierzytelnianiem X509. Transporty otrzymają poświadczenia przy użyciu getDeviceCredentials metody .

Interfejsy

AmqpTransportOptions

Opcje specyficzne dla transportu AMQP.

Jest to przekazywane do właściwości setOptions o nazwie http wewnątrz obiektu DeviceClientOptions .

Zobacz
DeviceClientOptions

Opcje obiektu Client. Przekazano do funkcji setOptions .

Przykład

 var options = {
   cert: myX509Certificate,
   key: myX509Key,
   http: {
     receivePolicy: {
       interval: 10
     }
   }
 }
 client.setOptions(options, callback);
DeviceTransport
HttpReceiverOptions

Struktura opcji używana do konfigurowania częstotliwości sondowania odbiornika HTTP pod kątem komunikatów. Każda z tych opcji wzajemnie się wyklucza, z wyjątkiem wartości logicznej drain . W strukturze opcji znajduje się tylko jeden intervalelement , atcron lub manualPolling .

Jest to konfigurowane przez wywołanie metody setOptions za pomocą tej właściwości o nazwie receivePolicy wewnątrz obiektu HttpTransportOptions , który znajduje się wewnątrz obiektu DeviceClientOptions .

Zobacz
HttpTransportOptions

Struktura opcji przekazywania opcjonalnych parametrów konfiguracji do transportu HTTP.

Jest to przekazywane do właściwości setOptions o nazwie http wewnątrz obiektu DeviceClientOptions .

Zobacz
MqttTransportOptions

Opcje specyficzne dla transportu MQTT

Jest to przekazywane do właściwości setOptions o nazwie mqtt wewnątrz obiektu DeviceClientOptions .
TwinProperties

Zawiera żądane i zgłoszone właściwości bliźniaczej reprezentacji bliźniaczej.

Aliasy typu

BufferConvertible

Funkcje

getUserAgentString(NoErrorCallback<string>)
getUserAgentString()
getUserAgentString(string, NoErrorCallback<string>)
getUserAgentString(string)

Szczegóły funkcji

getUserAgentString(NoErrorCallback<string>) 

function getUserAgentString(done: NoErrorCallback<string>)

Parametry

done

NoErrorCallback<string>

getUserAgentString() 

function getUserAgentString(): Promise<string>

Zwraca

Promise<string>

getUserAgentString(string, NoErrorCallback<string>) 

function getUserAgentString(productInfo: string, done: NoErrorCallback<string>)

Parametry

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string) 

function getUserAgentString(productInfo: string): Promise<string>

Parametry

productInfo

string

Zwraca

Promise<string>