azure-iot-device package

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	Klient urządzenia usługi IoT Hub używany do łączenia urządzenia z centrum Azure IoT Hub. Użytkownicy zestawu SDK powinni wywołać jedną z metod fabrycznych, z ConnectionString lub zsharedAccessSignature w celu utworzenia klienta urządzenia usługi 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 onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
DeviceMethodResponse	obiekt DeviceMethodResponse jest udostępniany użytkownikowi z każdym DeviceMethodRequest umożliwiającym 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 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 metody _sign.
ModuleClient	Klient urządzenia usługi IoT Hub używany do łączenia urządzenia z centrum Azure IoT Hub. Użytkownicy zestawu SDK powinni wywołać jedną z metod fabrycznych, z ConnectionString lub zsharedAccessSignature w celu utworzenia klienta urządzenia usługi IoT Hub.
SharedAccessKeyAuthenticationProvider	Udostępnia obiekt AuthenticationProvider, 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 okresach i emituje zdarzenie newTokenAvailable dla transportu w celu odnowienia poświadczeń za pomocą wystąpienia usługi Azure IoT Hub i pozostania na bieżąco.
SharedAccessSignatureAuthenticationProvider	Udostępnia obiekt AuthenticationProvider, 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 podawać do niego nie wygasłe tokeny sygnatury dostępu współdzielonego przy użyciu metody updateSharedAccessSignature. Dla każdego wywołania tej metody SharedAccessSignatureAuthenticationProvider wyemituje zdarzenie newTokenAvailable, które będzie używane do uwierzytelniania w wystąpieniu usługi Azure IoT Hub.
Twin	Bliźniacze reprezentacje urządzenia to 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 zbudowany 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łoszone 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 do synchronizacji tych dwóch kolekcji, w razie potrzeby, jest pozostawiona użytkownikowi zestawu SDK. Aby uzyskać więcej informacji, zobacz Understanding Device Twins.
X509AuthenticationProvider	Udostępnia obiekt AuthenticationProvider, który można utworzyć po prostu przy użyciu certyfikatu i klucza X509, a następnie jest używany przez klienta urządzenia i transportuje do uwierzytelniania za pomocą wystąpienia usługi Azure IoT Hub. W przeciwieństwie do obiektów SharedAccessSignatureAuthenticationProvider i SharedAccessKeyAuthenticationProviderX509AuthenticationProvider nie emituje zdarzenia newTokenAvailable, ponieważ nie ma tokenu związanego z uwierzytelnianiem X509. Transporty otrzymają poświadczenia przy użyciu metody getDeviceCredentials.

Interfejsy

AmqpTransportOptions	Opcje specyficzne dla transportu AMQP. Jest on przekazywany do setOptions jako właściwości o nazwie http wewnątrz obiektu DeviceClientOptions. Widzieć
DeviceClientOptions	Opcje obiektu Klient. 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 dla komunikatów. Każda z tych opcji wzajemnie się wyklucza, z wyjątkiem wartości logicznej drain. W strukturze opcji znajduje się tylko jeden interval, at, cron lub manualPolling. Jest to konfigurowane przez wywołanie setOptions z tą właściwością o nazwie receivePolicy wewnątrz obiektu HttpTransportOptions, który znajduje się wewnątrz obiektu DeviceClientOptions. Widzieć
HttpTransportOptions	Struktura opcji przekazywania opcjonalnych parametrów konfiguracji do transportu HTTP. Jest on przekazywany do setOptions jako właściwości o nazwie http wewnątrz obiektu DeviceClientOptions. Widzieć
MqttTransportOptions	Opcje specyficzne dla transportu MQTT Jest on przekazywany do setOptions jako właściwości 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>