مشاركة عبر

azure-iot-device package

  • ‏‏المرجع

الفصول

Message

Message يتم استخدام الكائن لبيانات تتبع الاستخدام (من جهاز إلى سحابة) والأوامر (من السحابة إلى الجهاز) المراسلة غير المتزامنة بين الجهاز وخدمة IoT Hub. إنه غير محدد للنقل، ما يعني أنه يعمل بنفس الطريقة عبر AMQP وMQTT وHTTP.
Client

يستخدم عميل جهاز IoT Hub لتوصيل جهاز بمركز Azure IoT.

يجب على مستخدمي SDK استدعاء إحدى أساليب المصنع، منConnectionString أو منSharedAccessSignature لإنشاء عميل جهاز IoT Hub.
DeviceMethodRequest

يمثل البيانات التي تم تمريرها من الخدمة إلى الجهاز عند استدعاء أسلوب جهاز من السحابة. يتم تمرير مثيل من هذه الفئة إلى رد الاتصال المسجل عبر onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
DeviceMethodResponse

يتم توفير كائن DeviceMethodResponse للمستخدم مع كل DeviceMethodRequest مما يسمح للمستخدم بإنشاء وإرسال استجابة منسقة جيدا مرة أخرى إلى الخدمة لكل استدعاء أسلوب جهاز. يتم تمرير مثيل من هذه الفئة كمعلمة ثانية إلى رد الاتصال المسجل عبر onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
IotEdgeAuthenticationProvider

يوفر تنفيذا AuthenticationProvider يفوض إنشاء الرمز المميز إلى iotedged. من المفترض استخدام هذا التنفيذ عند استخدام عميل الوحدة النمطية مع Azure IoT Edge.

يرث هذا النوع من SharedAccessKeyAuthenticationProvider ويتطابق وظيفيا مع هذا النوع باستثناء جزء إنشاء الرمز المميز الذي يتجاوزه عن طريق تنفيذ _sign الأسلوب .
ModuleClient

يستخدم عميل جهاز IoT Hub لتوصيل جهاز بمركز Azure IoT.

يجب على مستخدمي SDK استدعاء إحدى أساليب المصنع، منConnectionString أو منSharedAccessSignature لإنشاء عميل جهاز IoT Hub.
SharedAccessKeyAuthenticationProvider

يوفر كائنا AuthenticationProvider يمكن إنشاؤه ببساطة باستخدام سلسلة اتصال ثم يستخدمه عميل الجهاز وينقل للمصادقة مع مثيل مركز Azure IoT.

SharedAccessKeyAuthenticationProvider يهتم الكائن بإنشاء رموز مميزة لتوقيع الوصول المشترك على إيقاع عادي ويبعث newTokenAvailable الحدث للنقلات لتجديد بيانات الاعتماد الخاصة بها باستخدام مثيل مركز Azure IoT والبقاء على اتصال.
SharedAccessSignatureAuthenticationProvider

يوفر كائنا AuthenticationProvider يمكن إنشاؤه ببساطة بتوقيع وصول مشترك ثم يستخدمه عميل الجهاز وينقل للمصادقة مع مثيل مركز Azure IoT.

SharedAccessSignatureAuthenticationProvider لا يجدد الكائن الرمز المميز لتوقيع الوصول المشترك تلقائيا، لذلك يحتاج المستخدم إلى تغذية رموز توقيع الوصول المشترك غير منتهية الصلاحية إليه باستخدام updateSharedAccessSignature الأسلوب . لكل استدعاء لهذا الأسلوب، SharedAccessSignatureAuthenticationProvider سيبعث newTokenAvailable حدثا سيستخدمه النقل للمصادقة مع مثيل مركز Azure IoT.
Twin

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

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

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

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

يوفر كائنا AuthenticationProvider يمكن إنشاؤه ببساطة باستخدام شهادة ومفتاح X509 ثم يستخدمه عميل الجهاز وينقل للمصادقة مع مثيل مركز Azure IoT.

على عكس الكائنين SharedAccessSignatureAuthenticationProvider و SharedAccessKeyAuthenticationProvider ، X509AuthenticationProvider لا يصدر حدثا newTokenAvailable نظرا لعدم وجود رمز مميز مضمن في مصادقة X509. ستحصل عمليات النقل على بيانات الاعتماد باستخدام getDeviceCredentials الأسلوب .

الواجهات

AmqpTransportOptions

الخيارات الخاصة بنقل AMQP.

يتم تمرير هذا إلى setOptions كخاصية تسمى http داخل كائن DeviceClientOptions .

راجع
DeviceClientOptions

خيارات لكائن العميل. تم تمريرها إلى الدالة setOptions .

مثال

 var options = {
   cert: myX509Certificate,
   key: myX509Key,
   http: {
     receivePolicy: {
       interval: 10
     }
   }
 }
 client.setOptions(options, callback);
DeviceTransport
HttpReceiverOptions

بنية الخيارات المستخدمة لتكوين عدد مرات استقصاءات مستقبل HTTP للرسائل. كل من هذه الخيارات حصري بشكل متبادل، باستثناء drain المنطقية. يجب أن يكون واحد intervalفقط أو atcron أو manualPolling موجودا في بنية الخيارات.

يتم تكوين هذا عن طريق استدعاء setOptions مع هذا كخاصية تسمى receivePolicy داخل كائن HttpTransportOptions الموجود داخل كائن DeviceClientOptions .

راجع
HttpTransportOptions

بنية الخيارات لتمرير معلمات التكوين الاختيارية في نقل Http.

يتم تمرير هذا إلى setOptions كخاصية تسمى http داخل كائن DeviceClientOptions .

راجع
MqttTransportOptions

الخيارات الخاصة بنقل MQTT

يتم تمرير هذا إلى setOptions كخاصية تسمى mqtt داخل كائن DeviceClientOptions .
TwinProperties

يحتوي على الخصائص المطلوبة والمبلغ عنها للتوائم.

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

BufferConvertible

الوظائف

getUserAgentString(NoErrorCallback<string>)
getUserAgentString()
getUserAgentString(string, NoErrorCallback<string>)
getUserAgentString(string)

تفاصيل الوظيفة

getUserAgentString(NoErrorCallback<string>) 

function getUserAgentString(done: NoErrorCallback<string>)

المعلمات

done

NoErrorCallback<string>

getUserAgentString() 

function getUserAgentString(): Promise<string>

المرتجعات

Promise<string>

getUserAgentString(string, NoErrorCallback<string>) 

function getUserAgentString(productInfo: string, done: NoErrorCallback<string>)

المعلمات

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string) 

function getUserAgentString(productInfo: string): Promise<string>

المعلمات

productInfo

string

المرتجعات

Promise<string>