azure-iothub package

الفصول

Client

يتم استخدام عميل خدمة IoT Hub للاتصال بالأجهزة من خلال مركز Azure IoT. يتيح لمستخدم SDK:

  • إرسال السحابة إلى الجهاز (المعروفة أيضا بالأوامر) إلى الأجهزة: يتم وضع الأوامر في قائمة الانتظار على IoT Hub ويتم تسليمها بشكل غير متزامن فقط عند توصيل الجهاز. يمكن وضع 50 أمر فقط في قائمة الانتظار لكل جهاز.
  • استدعاء أساليب مباشرة على الأجهزة (والتي ستعمل فقط إذا كان الجهاز متصلا حاليا: إنها طريقة متزامنة للتواصل مع الجهاز)
  • استمع إلى رسائل الملاحظات المرسلة بواسطة الأجهزة للأوامر السابقة.
  • استمع إلى إعلامات تحميل الملفات من الأجهزة.

يجب على المستخدمين إنشاء مثيلات جديدة Client عن طريق استدعاء إحدى أساليب المصنع، منConnectionString أو منSharedAccessSignature، لإنشاء عميل خدمة IoT Hub.

Device

إنشاء تمثيل لجهاز للاستخدام مع واجهات برمجة تطبيقات سجل هوية الجهاز .

يتم إهمال هذه الفئة لأن سجل هوية الجهاز يمكن أن يعمل مباشرة مع كائنات JSON التي تحتوي على وصف جزئي للجهاز، وليس بالضرورة العنصر الكامل. علاوة على ذلك في البداية تم شحن هذه الفئة مع خطأ إملائي على symmetricKey اسم الخاصية (كان pascal-cased بدلا من camel-cased). يحتفظ SDK بهذه الفئة من أجل عدم كسر التعليمات البرمجية الموجودة ولكن ستتم إزالة هذا في تحديث إصدار رئيسي مستقبلي ويجب على العملاء بدلا من ذلك استخدام كائنات JSON العادية.

JobClient

يوفر أساليب لإنشاء وتحديث ومراقبة وإلغاء المهام طويلة الأمد على مثيل IoT Hub، بالإضافة إلى الاستعلام عن الوظائف الموجودة. تسمح واجهة برمجة تطبيقات الوظائف في Azure IoT Hub بجدولة استدعاءات الأسلوب المباشر والتحديثات المزدوجة على أجهزة متعددة.

من المتوقع أن يقوم مستخدمو SDK بإنشاء JobClient مثيلات باستخدام أساليب fromConnectionString(string) المصنع و fromSharedAccessSignature(string).

Registry

توفر فئة التسجيل الوصول إلى خدمة هوية جهاز IoT Hub. يجب على مستخدمي SDK إنشاء مثيل لهذه الفئة باستخدام إحدى أساليب المصنع: منConnectionString أو fromSharedAccessSignature.

البروتوكول المستخدم لعمليات تسجيل هوية الجهاز هو HTTPS.

Amqp

فئة النقل المستخدمة من قبل عميل الخدمة للاتصال بمركز Azure IoT باستخدام بروتوكول AMQP عبر مأخذ توصيل آمن (TLS). يجب عدم استخدام هذه الفئة مباشرة وبدلا من ذلك يتم تمريرها إلى إحدى Client أساليب المصنع: منConnectionString أو fromSharedAccessSignature.

AmqpWs

فئة النقل المستخدمة من قبل عميل الخدمة للاتصال بمركز Azure IoT باستخدام بروتوكول AMQP عبر websockets الآمنة. يجب عدم استخدام هذه الفئة مباشرة وبدلا من ذلك يتم تمريرها إلى إحدى Client أساليب المصنع: منConnectionString أو fromSharedAccessSignature.

DigitalTwinClient
IoTHubTokenCredentials

إنشاء توقيعات وصول مشتركة استنادا إلى سلسلة الاتصال التي تم تمريرها إلى الدالة الإنشائية. يتم استخدام هذه الفئة بواسطة طبقة البروتوكول الخاصة ب SDK لإضافة عناوين المصادقة إلى كل طلب.

Twin

يعد Device Twin مستندا يصف حالة الجهاز المخزن بواسطة مركز Azure IoT وهو متوفر حتى إذا كان الجهاز غير متصل بالإنترنت. وهو مبني حول 3 أقسام:

  • العلامات: أزواج المفاتيح/القيمة التي يمكن الوصول إليها فقط من جانب الخدمة
  • الخصائص المطلوبة: يتم تحديثها بواسطة خدمة وتلقيها من قبل الجهاز
  • الخصائص المبلغ عنها: تم تحديثها بواسطة الجهاز وتلقيها بواسطة الخدمة.

لاحظ أنه على الرغم من أنه احتمال، فإن الخصائص المطلوبة والمبلغ عنها لا يجب أن تتطابق وأن منطق مزامنة هاتين المجموعتين، إذا لزم الأمر، يترك لمستخدم SDK.

لمزيد من المعلومات، راجع فهم توائم الجهاز.

الطريقة الموصى بها للحصول على Twin لجهاز معين هي استخدام getTwin(string, HttpResponseCallback<Twin>) الأسلوب .

الواجهات

ServiceReceiver
Transport
TransportConfigOptions
Authentication
Capabilities
X509Thumbprints
BulkRegistryOperationResult
DeviceDescription
DeviceRegistryOperationError
JobStatus
QueryDescription
RegistryStatistics
TransportConfig
Configuration

يمثل كائن التكوين تكوين جهاز واحد أو يمكن أن يمثل توزيعا يمكن تطبيقه كتكوين على الأجهزة استنادا إلى targetCondition.

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

يصف المعلمات المتوفرة للاستخدام مع الأساليب المباشرة (تسمى أيضا أساليب الجهاز)

Module

النوع أسماء مستعارة

TransportCtor
ConnectionState
DeviceStatus
JobCallback
BulkRegistryOperationType
JobCallback
ResponseCallback