jacdac.azure_iot_hub_health

Submodules

Package Contents

Classes

AzureIotHubHealthClient

Health and diagnostics information about the Azure Iot Hub connection.
class jacdac.azure_iot_hub_health.AzureIotHubHealthClient(bus: jacdac.bus.Bus, role: str)

Bases: jacdac.bus.Client

Health and diagnostics information about the Azure Iot Hub connection. Implements a client for the Azure IoT Hub Health service.

property hub_name: str | None

(Optional) Something like my-iot-hub.azure-devices.net if available.,

property hub_device_id: str | None

(Optional) Device identifier in Azure Iot Hub if available.,

property connection_status: jacdac.azure_iot_hub_health.constants.AzureIotHubHealthConnectionStatus | None

Indicates the status of connection. A message beyond the [0..3] range represents an HTTP error code.,

property push_period: int | None

How often to push data to the cloud., _: ms

property push_watchdog_period: int | None

If no message is published within given period, the device resets. This can be due to connectivity problems or due to the device having nothing to publish. Forced to be at least 2 * flush_period. Set to 0 to disable (default)., _: ms

on_connection_status_change(handler: jacdac.bus.EventHandlerFn) → jacdac.bus.UnsubscribeFn

Raised when the connection status changes

on_message_sent(handler: jacdac.bus.EventHandlerFn) → jacdac.bus.UnsubscribeFn

Raised when a message has been sent to the hub.