영어로 읽기

다음을 통해 공유


azure-iothub package

클래스

Client

IoT Hub 서비스 클라이언트는 Azure IoT Hub를 통해 디바이스와 통신하는 데 사용됩니다. 이를 통해 SDK 사용자는 다음을 수행할 수 있습니다.

  • 디바이스에 클라우드-디바이스(명령이라고도 함)를 보냅니다. 명령은 IoT Hub 큐에 대기되고 디바이스가 연결된 경우에만 비동기적으로 전달됩니다. 디바이스당 50개의 명령만 큐에 대기할 수 있습니다.
  • 디바이스에서 직접 메서드 호출(디바이스가 현재 연결된 경우에만 작동합니다. 디바이스와 통신하는 동기식 방법)
  • 이전 명령에 대해 디바이스에서 보낸 피드백 메시지를 수신 대기합니다.
  • 디바이스에서 파일 업로드 알림을 수신 대기합니다.

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

Device

디바이스 ID 레지스트리 API와 함께 사용할 디바이스의 표현을 만듭니다.

디바이스 ID 레지스트리가 전체 개체가 아니라 디바이스에 대한 부분 설명을 포함하는 JSON 개체에서 직접 작동할 수 있으므로 이 클래스는 더 이상 사용되지 않습니다. 그 위에 처음에이 클래스는 속성 이름에 symmetricKey 오타와 함께 제공 되었다 (그것은 낙타 대/소문자 대신 파스칼 대/소문자). SDK는 기존 코드를 중단하지 않도록 이 클래스를 유지하지만 향후 주 버전 업데이트에서 제거되며 고객은 대신 일반 JSON 개체를 사용해야 합니다.

JobClient

IoT Hub 인스턴스에서 장기 실행 작업을 만들고, 업데이트하고, 모니터링하고, 취소하고, 기존 작업을 쿼리하는 메서드를 제공합니다. Azure IoT Hub 작업 API를 사용하면 여러 디바이스에서 직접 메서드 호출 및 쌍 업데이트를 예약할 수 있습니다.

SDK 사용자는 팩터리 메서드 fromConnectionString(string)fromSharedAccessSignature(string)를 사용하여 인스턴스를 만들어야 JobClient 합니다.

Registry

레지스트리 클래스는 IoT Hub 디바이스 ID 서비스에 대한 액세스를 제공합니다. SDK 사용자는 팩터리 메서드인 fromConnectionString 또는 SharedAccessSignature 중 하나를 사용하여 이 클래스를 인스턴스화해야 합니다.

디바이스 ID 레지스트리 작업에 사용되는 프로토콜은 HTTPS입니다.

Amqp

서비스 클라이언트가 보안(TLS) 소켓을 통해 AMQP 프로토콜을 사용하여 Azure IoT Hub에 연결하는 데 사용하는 전송 클래스입니다. 이 클래스는 직접 사용해서는 안 되며 대신 팩터리 메서드 중 Client 하나인 FromConnectionString 또는 fromSharedAccessSignature에 전달되어야 합니다.

AmqpWs

서비스 클라이언트가 보안 websocket을 통해 AMQP 프로토콜을 사용하여 Azure IoT Hub에 연결하는 데 사용하는 전송 클래스입니다. 이 클래스는 직접 사용해서는 안 되며 대신 팩터리 메서드 중 Client 하나인 FromConnectionString 또는 fromSharedAccessSignature에 전달되어야 합니다.

DigitalTwinClient
IoTHubTokenCredentials

생성자에 전달된 연결 문자열을 기반으로 공유 액세스 서명을 만듭니다. 이 클래스는 SDK의 프로토콜 계층에서 각 요청에 인증 헤더를 추가하는 데 사용됩니다.

Twin

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

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

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

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

특정 디바이스에 대한 를 Twin 가져오는 권장 방법은 메서드를 getTwin(string, HttpResponseCallback<Twin>) 사용하는 것입니다.

인터페이스

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

Configuration 개체는 단일 디바이스의 구성을 나타내거나 targetCondition을 기반으로 디바이스에 구성으로 적용할 수 있는 배포를 나타낼 수 있습니다.

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

직접 메서드(디바이스 메서드라고도 함)에서 사용할 수 있는 매개 변수에 대해 설명합니다.

Module

형식 별칭