Merge pull request #103 from ks6088ts-labs/feature/issue-102_iothub-api

add IoT Hub related APIs to backend

Author: ks6088ts

backend/fastapi.py

@@ -7,6 +7,7 @@
 from backend.routers import azure_ai_vision as azure_ai_vision_router
 from backend.routers import azure_cosmos_db as azure_cosmos_db_router
 from backend.routers import azure_event_grid as azure_event_grid_router
+from backend.routers import azure_iot_hub as azure_iot_hub_router
 from backend.routers import azure_openai as azure_openai_router
 from backend.routers import azure_storage_blob as azure_storage_blob_router
 from backend.routers import azure_storage_queue as azure_storage_queue_router
@@ -25,6 +26,7 @@
     azure_cosmos_db_router.router,
     azure_ai_speech_router.router,
     agents_router.router,
+    azure_iot_hub_router.router,
 ]:
     app.include_router(router)
 

backend/internals/azure_iot_hub.py

@@ -0,0 +1,40 @@
+from logging import getLogger
+
+from azure.iot.device.aio import IoTHubDeviceClient
+from azure.iot.hub import IoTHubRegistryManager
+from azure.iot.hub.models import CloudToDeviceMethod, CloudToDeviceMethodResult
+
+from backend.settings.azure_iot_hub import Settings
+
+logger = getLogger(__name__)
+
+
+class Client:
+    def __init__(self, settings: Settings) -> None:
+        self.settings = settings
+
+    async def get_device_twin(self) -> dict:
+        client = IoTHubDeviceClient.create_from_connection_string(self.settings.azure_iot_hub_device_connection_string)
+        # FIXME: to make it faster, connection should be established once and reused
+        await client.connect()
+        twin = await client.get_twin()
+        await client.shutdown()
+        return twin
+
+    def invoke_direct_method(
+        self,
+        method_name: str,
+        payload: str,
+        device_id: str,
+    ) -> dict:
+        registry_manager = IoTHubRegistryManager(self.settings.azure_iot_hub_connection_string)
+        # Call the direct method.
+        deviceMethod = CloudToDeviceMethod(
+            method_name=method_name,
+            payload=payload,
+        )
+        response: CloudToDeviceMethodResult = registry_manager.invoke_device_method(
+            device_id=device_id,
+            direct_method_request=deviceMethod,
+        )
+        return response.as_dict()

backend/routers/azure_iot_hub.py

@@ -0,0 +1,51 @@
+from logging import getLogger
+
+from fastapi import APIRouter, status
+from fastapi.responses import JSONResponse
+
+from backend.internals.azure_iot_hub import Client
+from backend.settings.azure_iot_hub import Settings
+
+logger = getLogger(__name__)
+
+client = Client(
+    settings=Settings(),
+)
+
+router = APIRouter(
+    prefix="/azure_iot_hub",
+    tags=["azure_iot_hub"],
+    responses={404: {"description": "Not found"}},
+)
+
+
+@router.get(
+    "/device_twin",
+    status_code=200,
+)
+async def get_device_twin():
+    device_twin = await client.get_device_twin()
+    return JSONResponse(
+        status_code=status.HTTP_200_OK,
+        content=device_twin,
+    )
+
+
+@router.post(
+    "/event_grid_event",
+    status_code=200,
+)
+async def invoke_direct_method(
+    device_id="device001",
+    method_name="method1",
+    payload={"hello": "world"},
+):
+    response = client.invoke_direct_method(
+        device_id=device_id,
+        method_name=method_name,
+        payload=payload,
+    )
+    return JSONResponse(
+        status_code=status.HTTP_200_OK,
+        content=response,
+    )

backend/settings/azure_iot_hub.py

@@ -0,0 +1,15 @@
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class Settings(BaseSettings):
+    azure_iot_hub_device_connection_string: str = (
+        "HostName=<iot-hub-name>.azure-devices.net;DeviceId=<device-name>;SharedAccessKey=<shared-access-key>"
+    )
+    azure_iot_hub_connection_string: str = (
+        "HostName=<iot-hub-name>.azure-devices.net;SharedAccessKeyName=service;SharedAccessKey=<shared-access-key>"
+    )
+
+    model_config = SettingsConfigDict(
+        env_file="settings/azure_iot_hub.env",
+        env_file_encoding="utf-8",
+    )

docs/README.md

@@ -102,6 +102,8 @@
 
 - [Create and monitor a device](https://learn.microsoft.com/en-us/azure/iot-hub/quickstart-send-telemetry-cli#create-and-monitor-a-device)
 - [Connect Raspberry Pi to Azure IoT Hub](https://learn.microsoft.com/en-us/azure/iot-hub/raspberry-pi-get-started)
+- [Samples for the Azure IoT Hub Device SDK](https://github.com/Azure/azure-iot-sdk-python/blob/main/samples/README.md)
+- [Get started with device management (Python) > Create a service app to trigger a reboot](https://learn.microsoft.com/en-us/azure/iot-hub/device-management-python#create-a-service-app-to-trigger-a-reboot)
 
 ```shell
 IOT_HUB_NAME=""