azure-iot-provisioning-device-mqtt

v1.8.1

MQTT transport for Azure Device Provisioning SDK For more information about how to use this package see README

Latest version published 2 years ago

License: MIT

NPM

GitHub

Package Health Score

57 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Active

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.8.1	\|	10/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.7.13	\|	04/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.6.2	\|	01/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.5.12	\|	09/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.3	\|	12/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (1,018)

GitHub Stars: 262
Forks: 226
Contributors: 80

Direct Usage Popularity

The npm package azure-iot-provisioning-device-mqtt receives a total of 1,018 downloads a week. As such, we scored azure-iot-provisioning-device-mqtt popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package azure-iot-provisioning-device-mqtt, we found that it has been starred 262 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 80
Funding: No

With more than 10 contributors for the azure-iot-provisioning-device-mqtt repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 10
Open PR: 3
Last Release: 2 years ago
Last Commit: 1 year ago

Further analysis of the maintenance status of azure-iot-provisioning-device-mqtt based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for azure-iot-provisioning-device-mqtt is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >= 14.0.0

Age: 7 years
Dependencies: 8 Direct
Versions: 68
Install Size: 32.5 kB
Dist-tags: 13
# of Files: 9
Maintainers: 5
TS Typings: Yes

azure-iot-provisioning-device-mqtt has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use azure-iot-provisioning-device-mqtt?

To help you get started, we've collected the most common ways that azure-iot-provisioning-device-mqtt is being used within popular public projects.

Azure / azure-iot-sdk-node / digitaltwins / samples / iot_central_device / sample_device.js View on Github

async function main() {
  const provisioningClient = ProvisioningDeviceClient.create(
    provisioningEndpoint,
    idScope,
    new ProvisioningTransport(),
    new SymmetricKeySecurityClient(registrationId, symmetricKey)
  );

  // IoT Central requires a special payload to be sent when the device is provisioned
  provisioningClient.setProvisioningPayload({
    '__iot:interfaces': {
      CapabilityModelId: capabilityModel
    }
  });

  const registrationResult = await provisioningClient.register();
  const deviceConnectionString = `HostName=${registrationResult.assignedHub};DeviceId=${registrationResult.deviceId};SharedAccessKey=${symmetricKey}`;

  const propertyUpdateHandler = (interfaceInstance, propertyName, reportedValue, desiredValue, version) => {
    console.log('Received an update for ' + propertyName + ': ' + JSON.stringify(desiredValue));
    interfaceInstance[propertyName].report(desiredValue, {

View more ways to use azure-iot-provisioning-device-mqtt

This package (azure-iot-provisioning-device-mqtt) provides the MQTT and MQTT over Websocket transports that can be used to communicate with the Azure IoT Hub Device Provisioning Service. Please note that the MQTT transport only supports X509 authentication.

Install

There are at least 3 different packages involved when writing code to take advantage of the Azure IoT Hub Device Provisioning Service:

The "client" package that will be used to create a provisioning client. This is the azure-iot-provisioning-device package.
the "transport" package that will decide which protocol will be used to communicate with the provisioning service. One of azure-iot-provisioning-device-amqp, azure-iot-provisioning-device-mqtt (this package), or azure-iot-provisioning-device-http. Please note that X509 authentication is supported with all protocols but TPM authentication is supported only with AMQP and HTTP.
The "security client" package that will be used to interface with whatever type of security (x509 or TPM) is used to authenticate the device.

For example:

npm install --save azure-iot-provisioning-device
npm install --save azure-iot-provisioning-device-amqp # Or -mqtt or -http
npm install --save azure-iot-security-x509 # Or -tpm

Getting Started

To get started please read our Overview of the Device Provisioning Service and visit our tutorials pages

azure-iot-provisioning-device-mqtt dependencies

async es5-ext azure-iot-common azure-iot-mqtt-base azure-iot-provisioning-device debug machina uuid

azure-iot-provisioning-device-mqtt development dependencies

@types/node chai mocha nyc sinon source-map-support ts-node tslint typescript

FAQs

What is azure-iot-provisioning-device-mqtt?

MQTT transport for Azure Device Provisioning SDK. Visit Snyk Advisor to see a full health score report for azure-iot-provisioning-device-mqtt, including popularity, security, maintenance & community analysis.

Is azure-iot-provisioning-device-mqtt popular?

The npm package azure-iot-provisioning-device-mqtt receives a total of 1,018 weekly downloads. As such, azure-iot-provisioning-device-mqtt popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is azure-iot-provisioning-device-mqtt well maintained?

We found indications that azure-iot-provisioning-device-mqtt is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is azure-iot-provisioning-device-mqtt safe to use?

While scanning the latest version of azure-iot-provisioning-device-mqtt, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 21 December-2024, at 12:52 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP