Partager via

azure-iot-device package

  • Référence

Classes

Message

L’objet Message est utilisé pour la télémétrie (appareil à cloud) et les commandes (cloud à appareil) asynchrones entre l’appareil et le service IoT Hub. Il est indépendant du transport, ce qui signifie qu’il fonctionne de la même façon sur AMQP, MQTT et HTTP.
Client

IoT Hub client d’appareil utilisé pour connecter un appareil à un hub Azure IoT.

Les utilisateurs du KIT de développement logiciel (SDK) doivent appeler l’une des méthodes de fabrique, à partir deConnectionString ou deSharedAccessSignature pour créer un client d’appareil IoT Hub.
DeviceMethodRequest

Représente les données transmises du service à l’appareil lorsqu’une méthode d’appareil est appelée à partir du cloud. Une instance de cette classe est passée au rappel inscrit via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
DeviceMethodResponse

un DeviceMethodResponse objet est fourni à l’utilisateur, chacun DeviceMethodRequest permettant à l’utilisateur de construire et d’envoyer une réponse bien mise en forme au service pour chaque appel de méthode d’appareil. Une instance de cette classe est passée en tant que deuxième paramètre au rappel inscrit via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
IotEdgeAuthenticationProvider

Fournit une AuthenticationProvider implémentation qui délègue la génération de jetons à iotedged. Cette implémentation est destinée à être utilisée lors de l’utilisation du client de module avec Azure IoT Edge.

Ce type hérite de SharedAccessKeyAuthenticationProvider et est fonctionnellement identique à ce type, à l’exception de la partie de génération de jeton qu’il remplace en implémentant la _sign méthode.
ModuleClient

IoT Hub client d’appareil utilisé pour connecter un appareil à un hub Azure IoT.

Les utilisateurs du KIT de développement logiciel (SDK) doivent appeler l’une des méthodes de fabrique, à partir deConnectionString ou deSharedAccessSignature pour créer un client d’appareil IoT Hub.
SharedAccessKeyAuthenticationProvider

Fournit un AuthenticationProvider objet qui peut être créé simplement avec une chaîne de connexion et qui est ensuite utilisé par le client d’appareil et transporte pour s’authentifier auprès de l’instance Azure IoT Hub.

L’objet SharedAccessKeyAuthenticationProvider se charge de créer des jetons de signature d’accès partagé à une cadence régulière et émet l’événement newTokenAvailable pour que les transports renouvellent leurs informations d’identification avec l’instance Azure IoT Hub et restent connectés.
SharedAccessSignatureAuthenticationProvider

Fournit un AuthenticationProvider objet qui peut être créé simplement avec une signature d’accès partagé et qui est ensuite utilisé par le client de l’appareil et transporte pour s’authentifier auprès de l’instance Azure IoT Hub.

L’objet SharedAccessSignatureAuthenticationProvider ne renouvelle pas automatiquement le jeton de signature d’accès partagé. L’utilisateur doit donc lui envoyer des jetons de signature d’accès partagé non expirés à l’aide de la updateSharedAccessSignature méthode . Pour chaque appel à cette méthode, le SharedAccessSignatureAuthenticationProvider émet un newTokenAvailable événement que les transports utilisent pour s’authentifier auprès de l’instance Azure IoT Hub.
Twin

Un jumeau d’appareil est un document décrivant l’état d’un appareil stocké par un hub Azure IoT et disponible même si l’appareil est hors connexion. Il est construit autour de 3 sections :

  • Balises : paires clé/valeur accessibles uniquement du côté service
  • Propriétés souhaitées : mises à jour par un service et reçues par l’appareil
  • Propriétés signalées : mises à jour par l’appareil et reçues par le service.

Notez que bien qu’il s’agisse d’une possibilité, les propriétés souhaitées et signalées n’ont pas besoin de correspondre et que la logique de synchronisation de ces deux collections, si nécessaire, est laissée à l’utilisateur du KIT de développement logiciel (SDK).

Pour plus d’informations, consultez Présentation des jumeaux d’appareil.
X509AuthenticationProvider

Fournit un AuthenticationProvider objet qui peut être créé simplement avec un certificat et une clé X509, puis qui est utilisé par le client d’appareil et transporte pour s’authentifier auprès de l’instance Azure IoT Hub.

SharedAccessSignatureAuthenticationProvider Contrairement aux objets etSharedAccessKeyAuthenticationProvider, n’émet X509AuthenticationProvider pas d’événementnewTokenAvailable, car aucun jeton n’est impliqué dans l’authentification X509. Les transports obtiennent les informations d’identification à l’aide de la getDeviceCredentials méthode .

Interfaces

AmqpTransportOptions

Options spécifiques au transport AMQP.

Cette propriété est transmise à setOptions en tant que propriété nommée http à l’intérieur d’un objet DeviceClientOptions .

Consultez
DeviceClientOptions

Options de l’objet Client. Passé à la fonction setOptions .

Exemple

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

Structure d’options utilisée pour configurer la fréquence à laquelle le récepteur HTTP interroge les messages. Chacune de ces options s’exclue mutuellement, à l’exception du drain booléen. intervalUn seul , atcron ou manualPolling doit être présent dans la structure des options.

Pour cela, appelez setOptions avec cette propriété nommée receivePolicy à l’intérieur d’un objet HttpTransportOptions qui se trouve à l’intérieur d’un objet DeviceClientOptions .

Consultez
HttpTransportOptions

Structure d’options pour passer des paramètres de configuration facultatifs dans le transport Http.

Cette propriété est transmise à setOptions en tant que propriété nommée http à l’intérieur d’un objet DeviceClientOptions .

Consultez
MqttTransportOptions

Options spécifiques au transport MQTT

Cette propriété est transmise à setOptions en tant que propriété nommée mqtt à l’intérieur d’un objet DeviceClientOptions .
TwinProperties

Contient les propriétés souhaitées et signalées pour le jumeau.

Alias de type

BufferConvertible

Fonctions

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

Informations relatives à la fonction

getUserAgentString(NoErrorCallback<string>) 

function getUserAgentString(done: NoErrorCallback<string>)

Paramètres

done

NoErrorCallback<string>

getUserAgentString() 

function getUserAgentString(): Promise<string>

Retours

Promise<string>

getUserAgentString(string, NoErrorCallback<string>) 

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

Paramètres

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string) 

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

Paramètres

productInfo

string

Retours

Promise<string>