Sdílet prostřednictvím


IoTHubDeviceClient Třída

Synchronní klient zařízení, který se připojuje k instanci Azure IoT Hub.

Inicializátor pro IoTHubDeviceClient.

Tento inicializátor by se neměl volat přímo. Místo toho použijte k vytvoření instance jednu z>> metod třídy create_from_<<.

Dědičnost
azure.iot.device.iothub.sync_clients.GenericIoTHubClient
IoTHubDeviceClient
azure.iot.device.iothub.abstract_clients.AbstractIoTHubDeviceClient
IoTHubDeviceClient

Konstruktor

IoTHubDeviceClient(mqtt_pipeline, http_pipeline)

Parametry

mqtt_pipeline
<xref:azure.iot.device.iothub.pipeline.MQTTPipeline>
Vyžadováno

Kanál použitý k připojení ke koncovému bodu IoTHubu

http_pipeline
Vyžadováno

Metody

connect

Připojí klienta k instanci Azure IoT Hub nebo azure IoT Edge Hub.

Cíl je zvolen na základě přihlašovacích údajů předaných prostřednictvím parametru auth_provider, který byl poskytnut při inicializaci tohoto objektu.

Jedná se o synchronní volání, což znamená, že tato funkce se nevrátí, dokud nebude připojení ke službě zcela navázáno.

create_from_connection_string

Vytvořte instanci klienta ze zařízení IoTHub nebo připojovacího řetězce modulu.

create_from_sastoken

Vytvoření instance klienta z předem vytvořeného řetězce tokenu SAS

create_from_symmetric_key

Vytvořte instanci klienta pomocí ověřování symetrickým klíčem.

create_from_x509_certificate

Vytvořte instanci klienta pomocí ověřování certifikátu X509.

disconnect

Odpojte klienta od instance Azure IoT Hub nebo Azure IoT Edge Hub.

Po úplném dokončení práce s instancí klienta doporučujeme zajistit volání této funkce.

Jedná se o synchronní volání, což znamená, že tato funkce se nevrátí, dokud nebude připojení ke službě zcela ukončeno.

get_storage_info_for_blob

Odešle požadavek POST prostřednictvím protokolu HTTP do koncového bodu IoTHubu, který vrátí informace pro nahrání prostřednictvím účtu služby Azure Storage propojeného s IoTHubem, ke kterému je vaše zařízení připojené.

get_twin

Získá dvojče zařízení nebo modulu ze služby Azure IoT Hub nebo Azure IoT Edge Hub.

Jedná se o synchronní volání, což znamená, že tato funkce nevrátí, dokud se dvojče nenačte ze služby.

notify_blob_upload_status

Po dokončení nahrávání zařízení odešle do koncového bodu IoT Hub požadavek POST s informacemi o stavu pokusu o nahrání do objektu blob. Používají ho IoT Hub k upozornění naslouchajícím klientům.

patch_twin_reported_properties

Aktualizujte ohlášené vlastnosti pomocí služby Azure IoT Hub nebo Azure IoT Edge Hub.

Toto je synchronní volání, což znamená, že tato funkce nevrátí, dokud nebude oprava odeslána službě a potvrzena.

Pokud služba vrátí chybu při operaci opravy, vyvolá tato funkce příslušnou chybu.

receive_message

Přijmout zprávu, která byla odeslána z Azure IoT Hub.

Zastaralé od verze 2.3.0: K nastavení obslužné rutiny doporučujeme použít vlastnost .on_message_received.

receive_method_request

Prostřednictvím Azure IoT Hub nebo Azure IoT Edge Hubu obdržíte žádost o metodu.

Zastaralé od verze 2.3.0: K nastavení obslužné rutiny doporučujeme použít vlastnost .on_method_request_received.

receive_twin_desired_properties_patch

Získejte opravu požadované vlastnosti prostřednictvím Azure IoT Hub nebo Azure IoT Edge Hubu.

Toto je synchronní volání, což znamená následující:

  1. Pokud block=True, bude tato funkce blokovat, dokud nedojde k jedné z následujících situací:

    • z Azure IoT Hub nebo azure IoT Edge Hubu se obdrží požadovaná oprava vlastnosti.

    • časový limit, je-li zadán, uplynou. Pokud dojde k vypršení časového limitu, tato funkce vyvolá výjimku Doručená poštaEmpty.

  2. Pokud block=False, vrátí tato funkce všechny opravy požadovaných vlastností, které kanál mohl obdržet, ale ještě se nevrátily do aplikace. Pokud kanál nepřijal žádné opravy požadovaných vlastností, tato funkce vyvolá výjimku Doručená poštaEmpty.

Zastaralé od verze 2.3.0: K nastavení obslužné rutiny doporučujeme použít vlastnost .on_twin_desired_properties_patch_received.

send_message

Odešle zprávu do výchozího koncového bodu událostí v instanci Azure IoT Hub nebo Azure IoT Edge Hub.

Jedná se o synchronní událost, což znamená, že tato funkce se nevrátí, dokud nebude událost odeslána službě a služba nepotvrdí přijetí události.

Pokud připojení ke službě nebylo dříve otevřeno voláním connect, tato funkce otevře připojení před odesláním události.

send_method_response

Odeslání odpovědi na požadavek metody prostřednictvím Azure IoT Hub nebo Azure IoT Edge Hubu.

Jedná se o synchronní událost, což znamená, že tato funkce se nevrátí, dokud nebude událost odeslána službě a služba nepotvrdí přijetí události.

Pokud připojení ke službě nebylo dříve otevřeno voláním connect, tato funkce otevře připojení před odesláním události.

shutdown

Vypněte klienta pro řádné ukončení.

Po zavolání této metody budou mít všechny pokusy o další volání klientů za následek vyvolání ClientError.

update_sastoken

Aktualizujte token SAS klienta, který se používá k ověřování, a pak připojení znovu autorizuje.

Toto rozhraní API je možné použít pouze v případě, že byl klient původně vytvořen pomocí tokenu SAS.

connect

Připojí klienta k instanci Azure IoT Hub nebo azure IoT Edge Hub.

Cíl je zvolen na základě přihlašovacích údajů předaných prostřednictvím parametru auth_provider, který byl poskytnut při inicializaci tohoto objektu.

Jedná se o synchronní volání, což znamená, že tato funkce se nevrátí, dokud nebude připojení ke službě zcela navázáno.

connect()

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud vytvoření připojení způsobí selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit připojení.

pokud během provádění dojde k neočekávanému selhání.

create_from_connection_string

Vytvořte instanci klienta ze zařízení IoTHub nebo připojovacího řetězce modulu.

create_from_connection_string(connection_string, **kwargs)

Parametry

connection_string
str
Vyžadováno

Připojovací řetězec pro IoTHub, ke kterému se chcete připojit.

server_verification_cert
str
Vyžadováno

Možnost konfigurace. Řetěz důvěryhodných certifikátů. Je to nezbytné při připojování ke koncovému bodu, který má nestandardní kořen důvěryhodnosti, například bránu protokolu.

websockets
bool
Vyžadováno

Možnost konfigurace. Výchozí hodnota je False. Pokud používáte MQTT přes websockety, nastavte na hodnotu true.

cipher
str nebo list(str)
Vyžadováno

Možnost konfigurace. Šifrovací sady pro PROTOKOL TLS/SSL jako řetězec ve formátu seznamu šifer OpenSSL nebo jako seznam řetězců šifrovací sady.

product_info
str
Vyžadováno

Možnost konfigurace. Výchozí hodnota je prázdný řetězec. Řetězec obsahuje informace o libovolném produktu, které jsou připojeny k řetězci uživatelského agenta.

proxy_options
ProxyOptions
Vyžadováno

Možnosti odesílání provozu přes proxy servery

sastoken_ttl
int
Vyžadováno

Doba života (v sekundách) vytvořeného Objektu SasToken použitého k ověřování Výchozí hodnota je 3600 sekund (1 hodina).

keep_alive
int
Vyžadováno

Maximální doba v sekundách mezi komunikací se zprostředkovatelem. Pokud se nevyměňují žádné další zprávy, určuje rychlost, s jakou klient bude zprostředkovateli odesílat zprávy ping. Pokud nezadáte výchozí hodnotu 60 sekund, použije se.

auto_connect
bool
Vyžadováno

Automaticky připojit klienta k IoTHubu při vyvolání metody, která vyžaduje navázání připojení. (Výchozí: True)

connection_retry
bool
Vyžadováno

Pokus o opětovné navázání ukončeného připojení (výchozí: Pravda)

connection_retry_interval
int
Vyžadováno

Interval v sekundách mezi pokusy o opětovné navázání ukončeného připojení (výchozí hodnota: 10)

ensure_desired_properties
bool
Vyžadováno

Ujistěte se, že při opětovném připojení byla přijata nejnovější oprava požadovaných vlastností (Výchozí:Pravda).

Návraty

Instance klienta IoTHubu, který k ověřování používá připojovací řetězec.

Výjimky

ValueError if given an invalid connection_string.
TypeError if given an unsupported parameter.

create_from_sastoken

Vytvoření instance klienta z předem vytvořeného řetězce tokenu SAS

create_from_sastoken(sastoken, **kwargs)

Parametry

sastoken
str
Vyžadováno

Řetězec tokenu SAS

server_verification_cert
str
Vyžadováno

Možnost konfigurace. Řetěz důvěryhodných certifikátů. Je to nezbytné při připojování ke koncovému bodu, který má nestandardní kořen důvěryhodnosti, například bránu protokolu.

gateway_hostname
str
Vyžadováno

Možnost konfigurace. Název hostitele brány pro zařízení brány.

websockets
bool
Vyžadováno

Možnost konfigurace. Výchozí hodnota je False. Pokud používáte MQTT přes websockety, nastavte na hodnotu true.

cipher
str nebo list(str)
Vyžadováno

Možnost konfigurace. Šifrovací sady pro PROTOKOL TLS/SSL jako řetězec ve formátu seznamu šifer OpenSSL nebo jako seznam řetězců šifrovací sady.

product_info
str
Vyžadováno

Možnost konfigurace. Výchozí hodnota je prázdný řetězec. Řetězec obsahuje informace o libovolném produktu, které jsou připojeny k řetězci uživatelského agenta.

proxy_options
ProxyOptions
Vyžadováno

Možnosti odesílání provozu přes proxy servery

keep_alive
int
Vyžadováno

Maximální doba v sekundách mezi komunikací se zprostředkovatelem. Pokud se nevyměňují žádné další zprávy, určuje rychlost, s jakou klient bude zprostředkovateli odesílat zprávy ping. Pokud nezadáte výchozí hodnotu 60 sekund, použije se.

auto_connect
bool
Vyžadováno

Automaticky připojit klienta k IoTHubu při vyvolání metody, která vyžaduje navázání připojení. (Výchozí: True)

connection_retry
bool
Vyžadováno

Pokus o opětovné navázání ukončeného připojení (výchozí: Pravda)

connection_retry_interval
int
Vyžadováno

Interval v sekundách mezi pokusy o opětovné navázání ukončeného připojení (výchozí hodnota: 10)

ensure_desired_properties
bool
Vyžadováno

Ujistěte se, že při opětovném připojení byla přijata nejnovější oprava požadovaných vlastností (Výchozí:Pravda).

Výjimky

TypeError if given an unsupported parameter.
ValueError if the sastoken parameter is invalid.

create_from_symmetric_key

Vytvořte instanci klienta pomocí ověřování symetrickým klíčem.

create_from_symmetric_key(symmetric_key, hostname, device_id, **kwargs)

Parametry

symmetric_key
Vyžadováno

Symetrický klíč.

hostname
str
Vyžadováno

Hostitel, na kterém běží IotHub. Najdete ho v Azure Portal na kartě Přehled jako název hostitele řetězce.

device_id
Vyžadováno

ID zařízení

server_verification_cert
str
Vyžadováno

Možnost konfigurace. Řetěz důvěryhodných certifikátů. Je to nezbytné při připojování ke koncovému bodu, který má nestandardní kořen důvěryhodnosti, například bránu protokolu.

gateway_hostname
str
Vyžadováno

Možnost konfigurace. Název hostitele brány pro zařízení brány.

websockets
bool
Vyžadováno

Možnost konfigurace. Výchozí hodnota je False. Pokud používáte MQTT přes websockety, nastavte hodnotu true.

cipher
str nebo list(str)
Vyžadováno

Možnost konfigurace. Šifrovací sady pro TLS/SSL jako řetězec ve formátu seznamu šifer OpenSSL nebo jako seznam řetězců šifrovací sady.

product_info
str
Vyžadováno

Možnost konfigurace. Výchozí hodnota je prázdný řetězec. Řetězec obsahuje informace o libovolném produktu, které jsou připojeny k řetězci uživatelského agenta.

proxy_options
ProxyOptions
Vyžadováno

Možnosti pro odesílání provozu přes proxy servery.

sastoken_ttl
int
Vyžadováno

Hodnota TTL (v sekundách) vytvořeného tokenu SasToken použitého k ověřování. Výchozí hodnota je 3600 sekund (1 hodina)

keep_alive
int
Vyžadováno

Maximální doba v sekundách mezi komunikací se zprostředkovatelem. Pokud se nevyměňují žádné další zprávy, určuje se rychlost, s jakou klient bude zprostředkovateli odesílat zprávy ping. Pokud není zadána výchozí hodnota 60 sekund, použije se.

auto_connect
bool
Vyžadováno

Automaticky připojit klienta k IoTHubu při vyvolání metody, která vyžaduje navázání připojení. (Výchozí: True)

connection_retry
bool
Vyžadováno

Pokus o opětovné navázání ukončeného připojení (výchozí hodnota: Pravda)

connection_retry_interval
int
Vyžadováno

Interval v sekundách mezi pokusy o opětovné navázání ukončeného připojení (výchozí hodnota: 10)

ensure_desired_properties
bool
Vyžadováno

Ujistěte se, že při opětovném připojení byla přijata nejnovější oprava požadovaných vlastností (Výchozí:Pravda).

Návraty

Instance klienta IoTHub, který k ověřování používá symetrický klíč.

Výjimky

TypeError if given an unsupported parameter.
ValueError if the provided parameters are invalid.

create_from_x509_certificate

Vytvořte instanci klienta pomocí ověřování certifikátu X509.

create_from_x509_certificate(x509, hostname, device_id, **kwargs)

Parametry

hostname
str
Vyžadováno

Hostitel se spuštěným IotHubem Najdete ji v Azure Portal na kartě Přehled jako název hostitele řetězce.

x509
X509
Vyžadováno

Úplný objekt certifikátu x509. Pokud chcete použít certifikát, musí objekt zápisu obsahovat certifikát (buď kořenový certifikát, nebo jeden z certifikátů zprostředkující certifikační autority). Pokud certifikát pochází ze souboru CER, musí být zakódovaný jako base64.

device_id
str
Vyžadováno

ID použité k jednoznačné identifikaci zařízení v IoTHubu

server_verification_cert
str
Vyžadováno

Možnost konfigurace. Řetěz důvěryhodných certifikátů. Nezbytné při připojování ke koncovému bodu, který má nestandardní kořen důvěryhodnosti, například bránu protokolu.

gateway_hostname
str
Vyžadováno

Možnost konfigurace. Název hostitele brány pro zařízení brány.

websockets
bool
Vyžadováno

Možnost konfigurace. Výchozí hodnota je False. Pokud používáte MQTT přes websockety, nastavte hodnotu true.

cipher
str nebo list(str)
Vyžadováno

Možnost konfigurace. Šifrovací sady pro TLS/SSL jako řetězec ve formátu seznamu šifer OpenSSL nebo jako seznam řetězců šifrovací sady.

product_info
str
Vyžadováno

Možnost konfigurace. Výchozí hodnota je prázdný řetězec. Řetězec obsahuje informace o libovolném produktu, které jsou připojeny k řetězci uživatelského agenta.

proxy_options
ProxyOptions
Vyžadováno

Možnosti pro odesílání provozu přes proxy servery.

keep_alive
int
Vyžadováno

Maximální doba v sekundách mezi komunikací se zprostředkovatelem. Pokud se nevyměňují žádné další zprávy, určuje se rychlost, s jakou klient bude zprostředkovateli odesílat zprávy ping. Pokud není zadána výchozí hodnota 60 sekund, použije se.

auto_connect
bool
Vyžadováno

Automaticky připojit klienta k IoTHubu při vyvolání metody, která vyžaduje navázání připojení. (Výchozí: True)

connection_retry
bool
Vyžadováno

Pokus o opětovné navázání ukončeného připojení (výchozí hodnota: Pravda)

connection_retry_interval
int
Vyžadováno

Interval v sekundách mezi pokusy o opětovné navázání ukončeného připojení (výchozí hodnota: 10)

ensure_desired_properties
bool
Vyžadováno

Ujistěte se, že při opětovném připojení byla přijata nejnovější oprava požadovaných vlastností (Výchozí:Pravda).

Návraty

Instance klienta IoTHub, který k ověřování používá certifikát X509.

Výjimky

TypeError if given an unsupported parameter.

disconnect

Odpojte klienta od instance Azure IoT Hub nebo Azure IoT Edge Hub.

Po úplném dokončení práce s instancí klienta doporučujeme zajistit volání této funkce.

Jedná se o synchronní volání, což znamená, že tato funkce se nevrátí, dokud nebude připojení ke službě zcela ukončeno.

disconnect()

Výjimky

pokud během provádění dojde k neočekávanému selhání.

get_storage_info_for_blob

Odešle požadavek POST prostřednictvím protokolu HTTP do koncového bodu IoTHubu, který vrátí informace pro nahrání prostřednictvím účtu služby Azure Storage propojeného s IoTHubem, ke kterému je vaše zařízení připojené.

get_storage_info_for_blob(blob_name)

Parametry

blob_name
str
Vyžadováno

Název objektu blob v řetězcovém formátu, který se nahraje pomocí rozhraní API úložiště. Tento název se použije k vygenerování správných přihlašovacích údajů pro službu Storage a musí odpovídat tomu, co se použije se sadou SDK služby Azure Storage k nahrání objektu blob.

Návraty

Objekt podobný formátu JSON (slovník) z IoT Hub, který bude obsahovat relevantní informace, včetně: correlationId, hostName, containerName, blobName, sasToken.

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud vytvoření připojení způsobí selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit připojení.

pokud během provádění dojde k neočekávanému selhání.

get_twin

Získá dvojče zařízení nebo modulu ze služby Azure IoT Hub nebo Azure IoT Edge Hub.

Jedná se o synchronní volání, což znamená, že tato funkce nevrátí, dokud se dvojče nenačte ze služby.

get_twin()

Návraty

Kompletní dvojče jako diktování JSON

Návratový typ

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud při navazování připojení dojde k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit pokusu o připojení

pokud klient není připojený (a není povolené žádné automatické připojení),

pokud během provádění dojde k neočekávanému selhání.

notify_blob_upload_status

Po dokončení nahrávání zařízení odešle do koncového bodu IoT Hub požadavek POST s informacemi o stavu pokusu o nahrání do objektu blob. Používají ho IoT Hub k upozornění naslouchajícím klientům.

notify_blob_upload_status(correlation_id, is_success, status_code, status_description)

Parametry

correlation_id
str
Vyžadováno

Poskytuje IoT Hub na žádost get_storage_info_for_blob.

is_success
bool
Vyžadováno

Logická hodnota označující, jestli byl soubor úspěšně nahrán.

status_code
int
Vyžadováno

Číselný stavový kód, který je stavem pro nahrání souboru do úložiště.

status_description
str
Vyžadováno

Popis, který odpovídá status_code.

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud vytvoření připojení způsobí selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit připojení.

pokud během provádění dojde k neočekávanému selhání.

patch_twin_reported_properties

Aktualizujte ohlášené vlastnosti pomocí služby Azure IoT Hub nebo Azure IoT Edge Hub.

Toto je synchronní volání, což znamená, že tato funkce nevrátí, dokud nebude oprava odeslána službě a potvrzena.

Pokud služba vrátí chybu při operaci opravy, vyvolá tato funkce příslušnou chybu.

patch_twin_reported_properties(reported_properties_patch)

Parametry

reported_properties_patch
dict
Vyžadováno

Oprava ohlášených vlastností dvojčete jako diktování JSON

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud při navazování připojení dojde k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit pokusu o připojení

pokud klient není připojený (a není povolené žádné automatické připojení),

pokud během provádění dojde k neočekávanému selhání.

receive_message

Přijmout zprávu, která byla odeslána z Azure IoT Hub.

Zastaralé od verze 2.3.0: K nastavení obslužné rutiny doporučujeme použít vlastnost .on_message_received.

receive_message(block=True, timeout=None)

Parametry

block
bool
Vyžadováno

Určuje, jestli má operace blokovat, dokud není přijata zpráva.

timeout
int
Vyžadováno

Volitelně můžete zadat počet sekund, než vyprší časový limit blokování.

Návraty

Zpráva odeslaná z Azure IoT Hub nebo Žádná, pokud do konce období blokování nebyla přijata žádná žádost o metodu.

Návratový typ

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud vytvoření připojení způsobí selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit připojení.

pokud během provádění dojde k neočekávanému selhání.

receive_method_request

Prostřednictvím Azure IoT Hub nebo Azure IoT Edge Hubu obdržíte žádost o metodu.

Zastaralé od verze 2.3.0: K nastavení obslužné rutiny doporučujeme použít vlastnost .on_method_request_received.

receive_method_request(method_name=None, block=True, timeout=None)

Parametry

method_name
str
výchozí hodnota: None

Volitelně zadejte název metody, pro kterou se mají požadavky přijímat. Pokud tento parametr není zadaný, budou přijaty všechny metody, které ještě nejsou specificky zacíleny jiným požadavkem na receive_method.

block
bool
výchozí hodnota: True

Určuje, jestli se má operace blokovat, dokud se žádost neobdrží.

timeout
int
výchozí hodnota: None

Volitelně můžete zadat počet sekund, než vyprší časový limit blokování.

Návraty

MethodRequest Objekt představující přijatý požadavek metody nebo None, pokud do konce období blokování nebyl přijat žádný požadavek metody.

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud vytvoření připojení způsobí selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit připojení.

pokud během provádění dojde k neočekávanému selhání.

receive_twin_desired_properties_patch

Získejte opravu požadované vlastnosti prostřednictvím Azure IoT Hub nebo Azure IoT Edge Hubu.

Toto je synchronní volání, což znamená následující:

  1. Pokud block=True, bude tato funkce blokovat, dokud nedojde k jedné z následujících situací:

    • z Azure IoT Hub nebo azure IoT Edge Hubu se obdrží požadovaná oprava vlastnosti.

    • časový limit, je-li zadán, uplynou. Pokud dojde k vypršení časového limitu, tato funkce vyvolá výjimku Doručená poštaEmpty.

  2. Pokud block=False, vrátí tato funkce všechny opravy požadovaných vlastností, které kanál mohl obdržet, ale ještě se nevrátily do aplikace. Pokud kanál nepřijal žádné opravy požadovaných vlastností, tato funkce vyvolá výjimku Doručená poštaEmpty.

Zastaralé od verze 2.3.0: K nastavení obslužné rutiny doporučujeme použít vlastnost .on_twin_desired_properties_patch_received.

receive_twin_desired_properties_patch(block=True, timeout=None)

Parametry

block
bool
výchozí hodnota: True

Určuje, jestli se má operace blokovat, dokud se žádost neobdrží.

timeout
int
výchozí hodnota: None

Volitelně můžete zadat počet sekund, než vyprší časový limit blokování.

Návraty

Oprava požadovaných vlastností dvojčete jako diktování JSON nebo Žádná, pokud do konce období blokování nebyla přijata žádná oprava

Návratový typ

dict,

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud vytvoření připojení způsobí selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit připojení.

pokud během provádění dojde k neočekávanému selhání.

send_message

Odešle zprávu do výchozího koncového bodu událostí v instanci Azure IoT Hub nebo Azure IoT Edge Hub.

Jedná se o synchronní událost, což znamená, že tato funkce se nevrátí, dokud nebude událost odeslána službě a služba nepotvrdí přijetí události.

Pokud připojení ke službě nebylo dříve otevřeno voláním connect, tato funkce otevře připojení před odesláním události.

send_message(message)

Parametry

message
Message
Vyžadováno

Skutečná zpráva, která se má odeslat. Vše, co bylo předáno, které není instancí Třídy Message bude převedeno na message objekt.

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud při navazování připojení dojde k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit pokusu o připojení

pokud klient není připojený (a není povolené žádné automatické připojení),

pokud během provádění dojde k neočekávanému selhání.

ValueError if the message fails size validation.

send_method_response

Odeslání odpovědi na požadavek metody prostřednictvím Azure IoT Hub nebo Azure IoT Edge Hubu.

Jedná se o synchronní událost, což znamená, že tato funkce se nevrátí, dokud nebude událost odeslána službě a služba nepotvrdí přijetí události.

Pokud připojení ke službě nebylo dříve otevřeno voláním connect, tato funkce otevře připojení před odesláním události.

send_method_response(method_response)

Parametry

method_response
MethodResponse
Vyžadováno

MethodResponse k odeslání.

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud při navazování připojení dojde k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit pokusu o připojení

pokud klient není připojený (a není povolené žádné automatické připojení),

pokud během provádění dojde k neočekávanému selhání.

shutdown

Vypněte klienta pro řádné ukončení.

Po zavolání této metody budou mít všechny pokusy o další volání klientů za následek vyvolání ClientError.

shutdown()

Výjimky

pokud během provádění dojde k neočekávanému selhání.

update_sastoken

Aktualizujte token SAS klienta, který se používá k ověřování, a pak připojení znovu autorizuje.

Toto rozhraní API je možné použít pouze v případě, že byl klient původně vytvořen pomocí tokenu SAS.

update_sastoken(sastoken)

Parametry

sastoken
str
Vyžadováno

Nový řetězec tokenu SAS, který má klient použít

Výjimky

ValueError if the sastoken parameter is invalid

pokud jsou přihlašovací údaje neplatné a nelze znovu navázat připojení.

pokud opětovné navazování připojení vede k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit pokusu o opětovnou autorizaci.

pokud se klient původně nevytvořil s tokenem SAS.

pokud během provádění dojde k neočekávanému selhání.

Atributy

connected

Vlastnost jen pro čtení, která určuje, jestli je přenos připojený nebo ne.

on_background_exception

Funkce obslužné rutiny nebo korutin bude volána, když dojde k výjimce na pozadí.

Definice funkce nebo korutin by měla obsahovat jeden poziční argument (objekt výjimky).

on_connection_state_change

Funkce obslužné rutiny nebo korutin, která bude volána při změně stavu připojení.

Definice funkce nebo korutinu by neměla obsahovat žádné poziční argumenty.

on_message_received

Funkce obslužné rutiny nebo korutin, která bude volána při přijetí zprávy.

Definice funkce nebo korutinu by měla obsahovat jeden poziční argument ( Message objekt).

on_method_request_received

Funkce obslužné rutiny nebo korutin, která bude volána při přijetí požadavku metody.

Nezapomeňte potvrdit požadavek na metodu ve vaší funkci nebo korutin pomocí metody .send_method_response() klienta.

Definice funkce nebo korutinu by měla obsahovat jeden poziční argument ( MethodRequest objekt).

on_new_sastoken_required

Funkce obslužné rutiny nebo korutin, která bude volána, když klient vyžaduje nový token SAS. K tomu dojde přibližně 2 minuty před vypršením platnosti tokenu SAS. Pokud životnost na platformách Windows překročí přibližně 49 dnů, bude se po těchto 49 dnech vyžadovat nový token bez ohledu na to, jak dlouho je životnost SAS.

Všimněte si, že tato obslužná rutina je nutná POUZE při použití klienta vytvořeného prostřednictvím metody .create_from_sastoken().

Nový token lze poskytnout ve vaší funkci nebo korutin pomocí metody .update_sastoken() klienta.

Definice funkce nebo korutinu by neměla obsahovat žádné poziční argumenty.

on_twin_desired_properties_patch_received

Funkce obslužné rutiny nebo korutin, která bude volána při přijetí opravy požadovaných vlastností dvojčete.

Definice funkce nebo korutin by měla obsahovat jeden poziční argument (oprava dvojčete ve formě objektu slovníku JSON).