azure-iot-device package
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. |
Device |
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). |
Device |
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). |
Iot |
Zapewnia implementację Ten typ dziedziczy z |
Module |
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. |
Shared |
Obiekt |
Shared |
Obiekt |
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:
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ń). |
X509Authentication |
|
Amqp |
Opcje specyficzne dla transportu AMQP. Jest to przekazywane do właściwości setOptions o nazwie Zobacz |
Device |
Opcje obiektu Client. Przekazano do funkcji setOptions . Przykład
|
Device |
|
Http |
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 Jest to konfigurowane przez wywołanie metody setOptions za pomocą tej właściwości o nazwie Zobacz |
Http |
Struktura opcji przekazywania opcjonalnych parametrów konfiguracji do transportu HTTP. Jest to przekazywane do właściwości setOptions o nazwie Zobacz |
Mqtt |
Opcje specyficzne dla transportu MQTT Jest to przekazywane do właściwości setOptions o nazwie |
Twin |
Zawiera żądane i zgłoszone właściwości bliźniaczej reprezentacji bliźniaczej. |
get |
|
get |
|
get |
|
get |
function getUserAgentString(done: NoErrorCallback<string>)
Parametry
- done
-
NoErrorCallback<string>
function getUserAgentString(): Promise<string>
Zwraca
Promise<string>
function getUserAgentString(productInfo: string, done: NoErrorCallback<string>)
Parametry
- productInfo
-
string
- done
-
NoErrorCallback<string>
function getUserAgentString(productInfo: string): Promise<string>
Parametry
- productInfo
-
string
Zwraca
Promise<string>