Partager via

azure-iot-device package

Classes

Message

L’objet Message est utilisé pour la télémétrie (appareil à cloud) et les commandes (cloud-à-appareil) de messagerie asynchrone 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

Client d’appareil IoT Hub 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, fromConnectionString ou fromSharedAccessSignature 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 objet DeviceMethodResponse est fourni à l’utilisateur avec chaque 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 implémentation AuthenticationProvider 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 substitue en implémentant la méthode _sign.
ModuleClient

Client d’appareil IoT Hub 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, fromConnectionString ou fromSharedAccessSignature pour créer un client d’appareil IoT Hub.
SharedAccessKeyAuthenticationProvider

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

L’objet SharedAccessKeyAuthenticationProvider s’occupe de la création de jetons de signature d’accès partagé à une cadence régulière et émet l’événement newTokenAvailable pour les transports afin de renouveler leurs informations d’identification avec l’instance azure IoT Hub et de rester connecté.
SharedAccessSignatureAuthenticationProvider

Fournit un objet AuthenticationProvider qui peut être créé simplement avec une signature d’accès partagé, puis utilisé par le client d’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é. Par conséquent, l’utilisateur doit lui fournir des jetons de signature d’accès partagé non expirés à l’aide de la méthode updateSharedAccessSignature. Pour chaque appel à cette méthode, l'SharedAccessSignatureAuthenticationProvider émettra un événement newTokenAvailable qui sera utilisé 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 :

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

Notez que bien qu’il soit possible, 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 Understanding Device Twins.
X509AuthenticationProvider

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

Contrairement aux objets SharedAccessSignatureAuthenticationProvider et SharedAccessKeyAuthenticationProvider, le X509AuthenticationProvider n’émet pas d’événement newTokenAvailable, car il n’existe aucun jeton impliqué dans l’authentification X509. Les transports obtiennent les informations d’identification à l’aide de la méthode getDeviceCredentials.

Interfaces

AmqpTransportOptions

Options spécifiques au transport AMQP.

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

Voir
DeviceClientOptions

Options de l’objet Client. Transmis à la fonction setOptions.

exemple de 

 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. Un seul interval, at, cron ou manualPolling doit être présent dans la structure des options.

Cela est configuré en appelant setOptions avec cette propriété sous la forme d’une propriété nommée receivePolicy à l’intérieur d’un objet HttpTransportOptions qui se trouve à l’intérieur d’un objet DeviceClientOptions.

Voir
HttpTransportOptions

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

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

Voir
MqttTransportOptions

Options spécifiques au transport MQTT

Cela est passé dans 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

Functions

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>