https://github.com/ridomin/iothub-webclient

Azure IoT Hub MQTT client for _modern_ browsers
https://github.com/ridomin/iothub-webclient

azure iothub mqtt

Last synced: about 1 month ago
JSON representation

Azure IoT Hub MQTT client for _modern_ browsers

• Host: GitHub
• URL: https://github.com/ridomin/iothub-webclient
• Owner: ridomin
• License: mit
• Created: 2020-07-06T06:39:08.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-04T07:38:39.000Z (about 1 year ago)
• Last Synced: 2023-12-04T08:27:34.005Z (about 1 year ago)
• Topics: azure, iothub, mqtt
• Language: JavaScript
• Homepage: https://mqtt.rido.dev/
• Size: 700 KB
• Stars: 14
• Watchers: 4
• Forks: 6
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# IoTHub WebClient

Web application to connect to Azure IoT Hub from the browser (no server code required), written completely in JavaScript ES6

[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)

## [https://mqtt.rido.dev](https://mqtt.rido.dev)

## MQTT in the browser

This app uses the [Eclipse Paho JavaScript Client](https://www.eclipse.org/paho/clients/js/) to communicate to Azure IoT Hub as described in [Communicate with your IoT hub using the MQTT protocol](https://docs.microsoft.com/azure/iot-hub/iot-hub-mqtt-support)

## Sample code

> requires paho to be added to the page using ``

```js

import { AzIoTHubClient, ackPayload } from './AzIoTHubClient.js'

const client = new AzIoTHubClient(host, deviceId, deviceKey, modelId)

client.setDirectMehodCallback((method, payload, rid) => {

  const response = JSON.stringify({ customResponse: 'cmdResponsePayload' })

  client.commandResponse(method, response, rid, 200)

})

client.setDesiredPropertyCallback((desired) => {

  const dco = JSON.parse(desired)

  const payload = ackPayload(dco, status, dco.$version)

  const updateResult = await client.updateTwin(JSON.stringify(payload))

})

await client.connect()

const twin = await client.getTwin()

await client.updateTwin('{}')

```

## Authentication

Azure IoT Hub uses an HMAC signature to produce a SaS token used to authenticate the MQTT client. This client uses the HMAC primitives avaiable on modern browsers.

## Features

- Connect using the PnP Convention (announce `model-id`) with SasKeys

- Read Device Twin reported and desired properties (D2C)

- Update reported properties (D2C)

- Receive desired properties updates (C2D)

- ACK desired properties updates following the PnP convention (D2C)

- Receive command request (C2D)

- Reply commands with custom responses (D2C)

- .d.ts typings

## Roadmap

- DPS client over MQTT

- DPS with master keys

- Suggest payloads from PnP models

- Create ES6 modules for paho js client