Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.29 KB

readme.md

File metadata and controls

34 lines (23 loc) · 1.29 KB

#azure-iot-device The core components of the Azure IoT device SDK.

npm version

Install

npm install -g azure-iot-device@latest to get the latest (pre-release) version.

Getting Started

This package contains the core components of the Azure IoT device SDK, but is lacking a transport over which to send events and receive messages. Your application must require a transport package in addition to the core package to do something useful.

For example, if you want to send an event from your device to an IoT Hub using the AMQP protocol:

var connectionString = '[IoT Hub device connection string]';

// use factory function from AMQP-specific package
var clientFromConnectionString = require('azure-iot-device-amqp').clientFromConnectionString;
// AMQP-specific factory function returns Client object from core package
var client = clientFromConnectionString(connectionString);

// use Message object from core package
var Message = require('azure-iot-device').Message;
var msg = new Message('some data from my device');

// send the event
client.sendEvent(msg, function (err) {
  if (err) console.log(err.toString());
});

See the azure-iot-device-* transport-specific packages for more information.