device Package

Azure IoT Device Library

This library provides clients and associated models for communicating with Azure IoT services from an IoT device.

Packages

aio

Azure IoT Device Library - Asynchronous

This library provides asynchronous clients for communicating with Azure IoT services from an IoT device.

Modules

exceptions

This module defines an exception surface, exposed as part of the azure.iot.device library API

patch_documentation

This module provides hard coded patches used to modify items from the libraries. Currently we have to do like this so that we don't use exec anywhere

user_agent

This module is for creating agent strings for all clients

Classes

IoTHubDeviceClient

A synchronous device client that connects to an Azure IoT Hub instance.

IoTHubModuleClient

A synchronous module client that connects to an Azure IoT Hub or Azure IoT Edge instance.

Message

Represents a message to or from IoTHub

MethodRequest

Represents a request to invoke a direct method.

MethodResponse

Represents a response to a direct method.

ProvisioningDeviceClient

Client which can be used to run the registration of a device with provisioning service using Symmetric Key or X509 authentication.

ProxyOptions

A class containing various options to send traffic through proxy servers by enabling proxying of MQTT connection.

RegistrationResult

The final result of a completed or failed registration attempt :ivar:request_id: The request id to which the response is being obtained :ivar:operation_id: The id of the operation as returned by the registration request. :ivar status: The status of the registration process as returned by the provisioning service. Values can be "unassigned", "assigning", "assigned", "failed", "disabled" :ivar registration_state : Details like device id, assigned hub , date times etc returned from the provisioning service.

X509

A class with references to the certificate, key, and optional pass-phrase used to authenticate a TLS connection using x509 certificates