azure-iot-device package

  • 참조

클래스

Message

개체는 Message 디바이스와 IoT Hub 서비스 간의 원격 분석(디바이스-클라우드) 및 명령(클라우드-디바이스) 비동기 메시징에 사용됩니다. 전송에 구애받지 않으므로 AMQP, MQTT 및 HTTP에서 동일한 방식으로 작동합니다.
Client

디바이스를 Azure IoT Hub에 연결하는 데 사용되는 디바이스 클라이언트를 IoT Hub.

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

디바이스를 Azure IoT Hub에 연결하는 데 사용되는 디바이스 클라이언트를 IoT Hub.

SDK 사용자는 ConnectionString 또는SharedAccessSignature에서 팩터리 메서드 중 하나를 호출하여 IoT Hub 디바이스 클라이언트를 만들어야 합니다.
SharedAccessKeyAuthenticationProvider

연결 문자열로 AuthenticationProvider 간단하게 만들 수 있는 개체를 제공한 다음, 디바이스 클라이언트 및 전송에서 Azure IoT Hub 인스턴스로 인증하는 데 사용됩니다.

개체는 SharedAccessKeyAuthenticationProvider 일반 주기에 공유 액세스 서명 토큰을 만드는 작업을 처리하고 전송에 대한 이벤트를 내보내 newTokenAvailable 서 Azure IoT Hub 인스턴스를 사용하여 자격 증명을 갱신하고 연결 상태를 유지합니다.
SharedAccessSignatureAuthenticationProvider

AuthenticationProvider 공유 액세스 서명을 사용하여 간단하게 만들 수 있는 개체를 제공한 다음, 디바이스 클라이언트 및 전송에서 Azure IoT Hub 인스턴스로 인증하는 데 사용됩니다.

개체는 SharedAccessSignatureAuthenticationProvider 공유 액세스 서명 토큰을 자동으로 갱신하지 않으므로 사용자는 메서드를 사용하여 updateSharedAccessSignature 만료되지 않은 공유 액세스 서명 토큰을 피드해야 합니다. 이 메서드에 대한 각 호출에 대해 는 SharedAccessSignatureAuthenticationProvider 전송이 Azure IoT Hub 인스턴스로 인증하는 데 사용할 이벤트를 내보 newTokenAvailable 낸다.
Twin

디바이스 쌍은 Azure IoT Hub에 의해 저장되고 디바이스가 오프라인인 경우에도 사용할 수 있는 디바이스의 상태를 설명하는 문서입니다. 다음 3개 섹션을 중심으로 빌드됩니다.

  • 태그: 서비스 쪽에서만 액세스할 수 있는 키/값 쌍
  • 원하는 속성: 서비스에 의해 업데이트되고 디바이스에서 수신됨
  • Reported 속성: 디바이스에서 업데이트되고 서비스에서 수신합니다.

가능하지만 desired 및 reported 속성은 일치할 필요가 없으며 필요한 경우 이러한 두 컬렉션을 동기화하는 논리는 SDK 사용자에게 맡기게 됩니다.

자세한 내용은 Device Twins 이해를 참조하세요.
X509AuthenticationProvider

AuthenticationProvider X509 인증서 및 키를 사용하여 간단하게 만들 수 있는 개체를 제공한 다음, 디바이스 클라이언트 및 전송에서 Azure IoT Hub 인스턴스로 인증하는 데 사용됩니다.

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 제외하고 상호 배타적입니다. 옵션 구조에는 , intervalat또는 manualPollingcron 하나만 있어야 합니다.

이 속성은 DeviceClientOptions 개체 내에 있는 HttpTransportOptions 개체 내에 있는 receivePolicy 속성으로 setOptions를 호출하여 구성됩니다.

참조 항목
HttpTransportOptions

선택적 구성 매개 변수를 Http 전송에 전달하기 위한 옵션 구조입니다.

이 속성은 DeviceClientOptions 개체의 내부에 명명된 http 속성으로 setOptions에 전달됩니다.

참조 항목
MqttTransportOptions

MQTT 전송과 관련된 옵션

이 속성은 DeviceClientOptions 개체의 내부에 명명된 mqtt 속성으로 setOptions에 전달됩니다.
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>