azure-iot-device package

  • リファレンス

クラス

Message

オブジェクトはMessage、デバイスとIoT Hub サービスの間のテレメトリ (device-to-cloud) とコマンド (cloud-to-device) の非同期メッセージングに使用されます。 トランスポートに依存しません。つまり、AMQP、MQTT、HTTP で同じように動作します。
Client

デバイスを Azure IoT ハブに接続するために使用するデバイス クライアントをIoT Hubします。

SDK のユーザーは、ファクトリ メソッド (fromConnectionString または fromSharedAccessSignature) のいずれかを呼び出して、IoT Hubデバイス クライアントを作成する必要があります。
DeviceMethodRequest

クラウドからデバイス メソッドが呼び出されたときに、サービスからデバイスに渡されるデータを表します。 このクラスのインスタンスは、 を介して onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)登録されたコールバックに渡されます。
DeviceMethodResponse

DeviceMethodResponseオブジェクトがユーザーに提供され、各DeviceMethodRequestデバイス メソッド呼び出しに対して適切な形式の応答を構築してサービスに送り返せるようにします。 このクラスのインスタンスは、 を介して onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)登録されたコールバックに 2 番目のパラメーターとして渡されます。
IotEdgeAuthenticationProvider

トークン生成を AuthenticationProvider iotedged に委任する実装を提供します。 この実装は、Azure IoT Edgeでモジュール クライアントを使用する場合に使用するためのものです。

この型は から SharedAccessKeyAuthenticationProvider 継承され、メソッドを実装してオーバーライドするトークン生成部分を除き、その型と機能的に _sign 同じです。
ModuleClient

デバイスを Azure IoT ハブに接続するために使用するデバイス クライアントをIoT Hubします。

SDK のユーザーは、ファクトリ メソッド (fromConnectionString または fromSharedAccessSignature) のいずれかを呼び出して、IoT Hubデバイス クライアントを作成する必要があります。
SharedAccessKeyAuthenticationProvider

接続文字列を AuthenticationProvider 使用して単純に作成できる オブジェクトを提供し、デバイス クライアントとトランスポートが Azure IoT ハブ インスタンスで認証するために使用します。

オブジェクトは SharedAccessKeyAuthenticationProvider 、共有アクセス署名トークンを定期的に作成する処理を行い、トランスポートが Azure IoT Hub インスタンスで資格情報を更新し、接続を維持するためのイベントを生成 newTokenAvailable します。
SharedAccessSignatureAuthenticationProvider

共有アクセス署名を AuthenticationProvider 使用して単純に作成できるオブジェクトを提供し、デバイス クライアントとトランスポートが Azure IoT ハブ インスタンスで認証するために使用します。

オブジェクトは共有アクセス署名トークンを自動的に更新しないため、ユーザーは SharedAccessSignatureAuthenticationProvider メソッドを使用して updateSharedAccessSignature 、期限切れでない共有アクセス署名トークンをそれにフィードする必要があります。 このメソッドの呼び出しごとに、 は、 SharedAccessSignatureAuthenticationProvider トランスポートが Azure IoT ハブ インスタンスで認証するために使用するイベントを生成 newTokenAvailable します。
Twin

Device Twin は、Azure IoT ハブによって格納され、デバイスがオフラインの場合でも使用できるデバイスの状態を説明するドキュメントです。 これは、3つのセクションの周りに構築されています:

  • タグ: サービス側からのみアクセスできるキーと値のペア
  • 必要なプロパティ: サービスによって更新され、デバイスによって受信されます
  • 報告されたプロパティ: デバイスによって更新され、サービスによって受信されます。

可能性はありますが、必要なプロパティと報告されたプロパティは一致する必要はありません。また、必要に応じて、これら 2 つのコレクションを同期するロジックが SDK のユーザーに任されていることに注意してください。

詳細については、「 デバイス ツインについて」を参照してください。
X509AuthenticationProvider

AuthenticationProvider X509 証明書とキーを使用して簡単に作成できるオブジェクトを提供し、デバイス クライアントとトランスポートによって Azure IoT ハブ インスタンスで認証するために使用されます。

SharedAccessSignatureAuthenticationProviderオブジェクトと SharedAccessKeyAuthenticationProvider オブジェクトとは異なり、 X509AuthenticationProvider は X509 認証にnewTokenAvailable関係するトークンがないため、イベントを生成しません。 トランスポートは、 メソッドを使用して資格情報を getDeviceCredentials 取得します。

インターフェイス

AmqpTransportOptions

AMQP トランスポートに固有のオプション。

これは、 DeviceClientOptions オブジェクト内の という名前 http のプロパティとして setOptions に渡されます。

解決方法については、
DeviceClientOptions

Client オブジェクトのオプション。 setOptions 関数に渡されます。

例

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

HTTP 受信者がメッセージをポーリングする頻度を構成するために使用されるオプション構造。 これらの各オプションは、ブール値を除き、相互に drain 排他的です。 オプション構造には、1 つの interval、 at、 cron または manualPolling のみが存在する必要があります。

これは、DeviceClientOptions オブジェクト内にある HttpTransportOptions オブジェクト内の という名前receivePolicyのプロパティとして setOptions を呼び出すことによって構成されます。

解決方法については、
HttpTransportOptions

オプションの構成パラメーターを Http トランスポートに渡すための Options 構造体。

これは、 DeviceClientOptions オブジェクト内の という名前 http のプロパティとして setOptions に渡されます。

解決方法については、
MqttTransportOptions

MQTT トランスポートに固有のオプション

これは、 DeviceClientOptions オブジェクト内の という名前 mqtt のプロパティとして setOptions に渡されます。
TwinProperties

Twin の必要なプロパティと報告されるプロパティが含まれます。

型エイリアス

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>