IoTHubModuleClient Classe

Connecte le client à un instance Azure IoT Hub ou Azure IoT Edge Hub.

La destination est choisie en fonction des informations d’identification transmises via le paramètre auth_provider fourni lors de l’initialisation de cet objet.

Il s’agit d’un appel synchrone, ce qui signifie que cette fonction ne sera pas retournée tant que la connexion au service n’aura pas été complètement établie.

connect()

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la connexion expire.

en cas d’échec inattendu pendant l’exécution.

Instanciez le client à partir d’un appareil IoTHub ou d’une chaîne de connexion de module.

create_from_connection_string(connection_string, **kwargs)

Paramètres

Retours

Instance d’un client IoTHub qui utilise une chaîne de connexion pour l’authentification.

Exceptions

Instanciez le client à partir de l’environnement IoT Edge.

Cette méthode ne peut être exécutée qu’à partir d’un conteneur IoT Edge ou dans un environnement de débogage configuré pour le développement Edge (par exemple, Visual Studio, Visual Studio Code)

create_from_edge_environment(**kwargs)

Paramètres

Retours

Instance d’un client IoTHub qui utilise l’environnement IoT Edge pour l’authentification.

Exceptions

Instancier le client à partir d’une chaîne de jeton SAS créée au préalable

create_from_sastoken(sastoken, **kwargs)

Paramètres

Exceptions

Instancier un client à l’aide de l’authentification par certificat X509.

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

Paramètres

Retours

Une instance d’un client IoTHub qui utilise un certificat X509 pour l’authentification.

Exceptions

Déconnectez le client du instance Azure IoT Hub ou Azure IoT Edge Hub.

Il est recommandé d’appeler cette fonction lorsque vous avez terminé avec le instance client.

Il s’agit d’un appel synchrone, ce qui signifie que cette fonction ne retourne pas tant que la connexion au service n’a pas été complètement fermée.

disconnect()

Exceptions

en cas de défaillance inattendue lors de l’exécution.

Obtient le jumeau d’appareil ou de module à partir du service Azure IoT Hub ou Azure IoT Edge Hub.

Il s’agit d’un appel synchrone, ce qui signifie que cette fonction ne retourne pas tant que le jumeau n’a pas été récupéré à partir du service.

get_twin()

Retours

Terminer le jumeau en tant que dictée JSON

Type de retour

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la tentative de connexion expire

si le client n’est pas connecté (et qu’aucune connexion automatique n’est activée)

en cas de défaillance inattendue lors de l’exécution.

Appelez une méthode de votre client sur un client d’appareil ou de module et recevez la réponse à l’appel de méthode.

invoke_method(method_params, device_id, module_id=None)

Paramètres

Retours

method_result doit contenir un status et une charge utile

Type de retour

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la connexion expire.

en cas d’échec inattendu pendant l’exécution.

Mettez à jour les propriétés signalées avec le service Azure IoT Hub ou Azure IoT Edge Hub.

Il s’agit d’un appel synchrone, ce qui signifie que cette fonction ne retourne pas tant que le correctif n’a pas été envoyé au service et reconnu.

Si le service retourne une erreur sur l’opération de correctif, cette fonction génère l’erreur appropriée.

patch_twin_reported_properties(reported_properties_patch)

Paramètres

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la tentative de connexion expire

si le client n’est pas connecté (et qu’aucune connexion automatique n’est activée)

en cas de défaillance inattendue lors de l’exécution.

Recevoir un message d’entrée qui a été envoyé à partir d’un autre module à une entrée spécifique.

Déconseillé depuis la version 2.3.0 : nous vous recommandons d’utiliser la propriété .on_message_received pour définir un gestionnaire à la place

receive_message_on_input(input_name, block=True, timeout=None)

Paramètres

Retours

Message envoyé à l’entrée spécifiée, ou Aucun si aucune demande de méthode n’a été reçue à la fin de la période de blocage.

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la connexion expire.

en cas d’échec inattendu pendant l’exécution.

Recevez une demande de méthode via le Azure IoT Hub ou Azure IoT Edge Hub.

Déconseillé depuis la version 2.3.0 : nous vous recommandons d’utiliser la propriété .on_method_request_received pour définir un gestionnaire à la place

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

Paramètres

Retours

Objet MethodRequest représentant la demande de méthode reçue, ou Aucun si aucune demande de méthode n’a été reçue à la fin de la période de blocage.

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la connexion expire.

en cas d’échec inattendu pendant l’exécution.

Recevez un correctif de propriété souhaité via le Azure IoT Hub ou Azure IoT Edge Hub.

Il s’agit d’un appel synchrone, ce qui signifie ce qui suit :

1. Si block=True, cette fonction se bloque jusqu’à ce que l’une des opérations suivantes se produise :

   • un correctif de propriété souhaité est reçu du Azure IoT Hub ou d’Azure IoT Edge Hub.

   • le délai d’expiration, s’il est fourni, s’écoule. Si un délai d’expiration se produit, cette fonction déclenche une exception InboxEmpty

2. Si block=False, cette fonction retourne tous les correctifs de propriété souhaités qui ont peut-être été reçus par le pipeline, mais qui ne sont pas encore retournés à l’application. Si aucun correctif de propriété souhaité n’a été reçu par le pipeline, cette fonction déclenche une exception InboxEmpty

Déconseillé depuis la version 2.3.0 : nous vous recommandons d’utiliser la propriété .on_twin_desired_properties_patch_received pour définir un gestionnaire à la place

receive_twin_desired_properties_patch(block=True, timeout=None)

Paramètres

Retours

Correctif des propriétés souhaitées du jumeau sous forme de dictée JSON, ou Aucun si aucun correctif n’a été reçu à la fin de la période de blocage

Type de retour

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la connexion expire.

en cas d’échec inattendu pendant l’exécution.

Envoie un message au point de terminaison d’événements par défaut sur le instance Azure IoT Hub ou Azure IoT Edge Hub.

Il s’agit d’un événement synchrone, ce qui signifie que cette fonction ne retourne pas tant que l’événement n’a pas été envoyé au service et que le service a accusé réception de l’événement.

Si la connexion au service n’a pas encore été ouverte par un appel à la connexion, cette fonction ouvre la connexion avant d’envoyer l’événement.

send_message(message)

Paramètres

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la tentative de connexion expire

si le client n’est pas connecté (et qu’aucune connexion automatique n’est activée)

en cas de défaillance inattendue lors de l’exécution.

Envoie un événement/message à la sortie du module donné.

Il s’agit d’événements sortants qui sont censés être des « événements de sortie ».

Il s’agit d’un événement synchrone, ce qui signifie que cette fonction ne retourne pas tant que l’événement n’a pas été envoyé au service et que le service a accusé réception de l’événement.

Si la connexion au service n’a pas encore été ouverte par un appel à la connexion, cette fonction ouvre la connexion avant d’envoyer l’événement.

send_message_to_output(message, output_name)

Paramètres

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la tentative de connexion expire

si le client n’est pas connecté (et qu’aucune connexion automatique n’est activée)

en cas de défaillance inattendue lors de l’exécution.

Envoyez une réponse à une demande de méthode via le Azure IoT Hub ou Azure IoT Edge Hub.

Il s’agit d’un événement synchrone, ce qui signifie que cette fonction ne retourne pas tant que l’événement n’a pas été envoyé au service et que le service a accusé réception de l’événement.

Si la connexion au service n’a pas encore été ouverte par un appel à la connexion, cette fonction ouvre la connexion avant d’envoyer l’événement.

send_method_response(method_response)

Paramètres

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la tentative de connexion expire

si le client n’est pas connecté (et qu’aucune connexion automatique n’est activée)

en cas de défaillance inattendue lors de l’exécution.

Arrêtez le client pour une sortie normale.

Une fois cette méthode appelée, toutes les tentatives d’appels clients supplémentaires entraînent le levée d’une erreur ClientError.

shutdown()

Exceptions

en cas de défaillance inattendue lors de l’exécution.

Mettez à jour le jeton SAS du client utilisé pour l’authentification, puis réautorise la connexion.

Cette API ne peut être utilisée que si le client a été initialement créé avec un jeton SAS.

update_sastoken(sastoken)

Paramètres

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être rétablie.

si un rétablissement de la connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la tentative de réautorisation expire.

si le client n’a pas été créé initialement avec un jeton SAS.

en cas de défaillance inattendue lors de l’exécution.

Propriété en lecture seule pour indiquer si le transport est connecté ou non.

La fonction de gestionnaire ou coroutine est appelée lorsqu’une exception en arrière-plan se produit.

La fonction ou la définition de coroutine doit prendre un argument positionnel (l’objet exception)

Fonction de gestionnaire ou coroutine qui sera appelée lorsque l’état de connexion change.

La fonction ou la définition de coroutine ne doit prendre aucun argument positionnel.

Fonction de gestionnaire ou coroutine qui sera appelée lors de la réception d’un message d’entrée.

La définition de fonction ou coroutine doit prendre un argument positionnel (l’objet Message )

Fonction de gestionnaire ou coroutine qui sera appelée lors de la réception d’une demande de méthode.

N’oubliez pas d’accepter la demande de méthode dans votre fonction ou coroutine via l’utilisation de la méthode .send_method_response() du client.

La fonction ou la définition de coroutine doit prendre un argument positionnel (l’objet MethodRequest )

Fonction de gestionnaire ou coroutine qui sera appelée lorsque le client a besoin d’un nouveau jeton SAP. Cela se produit environ 2 minutes avant l’expiration du jeton SAP. Sur les plateformes Windows, si la durée de vie dépasse environ 49 jours, un nouveau jeton est requis après ces 49 jours, quelle que soit la durée de vie de la SAP.

Notez que ce gestionnaire est uniquement nécessaire lors de l’utilisation d’un client créé via la méthode .create_from_sastoken().

Le nouveau jeton peut être fourni dans votre fonction ou coroutine via l’utilisation de la méthode .update_sastoken() du client.

La fonction ou la définition de coroutine ne doit prendre aucun argument positionnel.

Fonction de gestionnaire ou coroutine qui sera appelée lorsqu’un correctif des propriétés souhaitées de jumeau est reçu.

La fonction ou la définition de coroutine doit prendre un argument positionnel (le correctif de jumeau sous la forme d’un objet de dictionnaire JSON)