samples

Samples for the Azure IoT service SDK for Node.js

This folder contains simple samples showing how to use the various features of the Microsoft Azure IoT Hub service from a device running C code.

List of samples

• Registry

  • registry_sample.js: Manage the device ID registry of IoT Hub.
  • registry_bulk_sample.js: Create a set of device IDs in the device ID registry of IoT Hub in bulk.
  • create_device_with_cert.js: Create a new device ID using an X-509 certificate.

• Messaging

  • send_c2d_message.js : Send C2D messages to a device through IoT Hub.

• Device services samples (Device Twins, Methods, and Device Management) (See device management patterns for instructions on running the device management patterns samples):

  • twin.js: Interact with the Device Twins from a back-end app.
  • twin_query.js: Interact with the Device Twins using queries from a back-end app.
  • device_method.js: Invoke a C2D Direct Method on a device through IoT Hub.
  • dmpatterns_reboot_service.js: Initiate a C2D method to reboot a device and view progress through the twin reported properties.
  • dmpatterns_fwupdate_service.js: Implement the service side of the firmware update DM pattern.
  • job_query.js: Use the jobs query feature of the service SDK.
  • schedule_job.js: Schedule device management jobs.

• Uploading blob to Azure:

  • receive_file_notifications.js: Track the progress of the file "upload to blob" by devices.

• Plug and Play

  • invoke_command.js invokes a command on a device interface instance.
  • invoke_component_command.js invokes a command that is defined by a specific component.
  • get_digital_twin.js gets the digital twin for a specific device.
  • update_digital_twin.js creates a patch to updates multiple writable properties on a digital twin, potentially on multiple interface instances.

How to run the samples

In order to run the device samples you will first need the following prerequisites:

• Node.js 10 or above on your target device. (Check out Nodejs.org for more info)
• Create an Azure IoT Hub instance

Get the following files from the current folder:

• package.json
• sample_file.js (where sample_file.js is one of the files listed above and available in this folder)

Place the files in the folder of your choice on the target machine/device then go through the following steps:

• Open the file sample_file.js in a text editor.
• Set the following environment variable:

set IOTHUB_CONNECTION_STRING=<your IoT Hub connection string>

use export instead of set if you're running MacOS or Linux.

• Depending on the samples you can also set the following environment variables:

set IOTHUB_DEVICE_ID=<device id>
set IOTHUB_PRIMARY_THUMBPRINT=<primary thumbprint>
set IOTHUB_SECONDARY_THUMBPRINT=<secondary thumbprint>
set IOTHUB_MODULE_ID=<module id>
set IOTHUB_METHOD_NAME=<method name>
set IOTHUB_METHOD_PAYLOAD=<method payload>
set STORAGE_CONNECTION_STRING=<storage connection string>
set IOTHUB_DEVICE_ID2=<second device id>

• additionally some Plug and Play samples take the following environment variables:

set IOTHUB_COMPONENT_NAME=<name of the component>
set IOTHUB_COMMAND_NAME=<command to execute>
set IOTHUB_COMMAND_PAYLOAD=<json payload for the above command>

• From a shell or Node.js command prompt, navigate to the folder where you placed the sample files. Run the sample application using the following commands:

  npm install
  node sample_file.js
  

To run the Device Management samples, follow our DM patterns documentation.

Read More

For more information on how to use this library refer to the documents below:

• Prepare your node.js development environment
• Setup IoT Hub
• Node API reference
• Debugging with Visual Studio Code
• Use the Azure IoT Explorer tool