npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ux4iot-react

v4.1.5

Published

React Hooks for ux4iot

Downloads

25

Readme

ux4iot-react

ux4iot is a tool for directly communicating with your IoT devices from your web frontend. Your React frontend gets access to Azure IoT Hub's communication primitives without having a custom-built backend middleware translating between IoT Hub and your user interface. No need to design a REST API so that your UI can offer IoT functionality.

Use the hooks in this library to implement your use cases for live data and for controlling devices.

As an example: Using live data in your React application is as easy as writing

const temperature = useTelemetry('myDevice', 'temperature');

in your React components.

This library provides hooks for:

  • useTelemetry - Subscribe to a single telemetry key of a device
  • useMultiTelemetry - Subscribe to telemetry of multiple devices
  • useDeviceTwin - Subscribe to device twin changes
  • useConnectionState - Subscribe to connection state updates of a device
  • useMultiConnectionState - Subscribe to connection states of multiple devices
  • useDirectMethod - Execute a direct method on a device
  • usePatchDesiredProperties - Update the desired properties of the device twin
  • useD2CMessages - Use the raw messages sent by your devices

Prerequisites

In order to use this library you need to have an ux4iot instance deployed in your Azure subscription. Here is a link to a quickstart that explains how to deploy one. Here is the link to the Azure Marketplace offering.

Installation

Install ux4iot-react in your frontend application:

npm install ux4iot-react

Documentation

Check out the Documentation for

  • Additional options
  • Hook API
  • ux4iot Admin SDKs
  • ux4iot Admin API
  • Reference to other related libraries of the ux4iot service

Tests

  • As ux4iot-react does not provide a lot of tests, the main features in this library are tested via integration tests in an internal repository.

Releasing

If you want to release a new version

  • git checkout master
  • Increase the version based on your changed in package.json (usually minor)
  • git commit -m 'Release VERSION'
  • git tag VERSION -m 'Release VERSION'
  • git push
  • git push --tags

The tag pipeline of github actions will build the package and publish it to npm.