Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deviceinsight/ux4iot-react
React library for ux4iot for easily building IoT web applications
https://github.com/deviceinsight/ux4iot-react
azure azure-iot azure-iot-hub device-twin direct-method iot iot-hub iot-platform react visualization websockets
Last synced: 19 days ago
JSON representation
React library for ux4iot for easily building IoT web applications
- Host: GitHub
- URL: https://github.com/deviceinsight/ux4iot-react
- Owner: deviceinsight
- License: mit
- Created: 2021-09-27T11:38:15.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-22T16:22:15.000Z (5 months ago)
- Last Synced: 2024-11-15T22:15:27.877Z (about 2 months ago)
- Topics: azure, azure-iot, azure-iot-hub, device-twin, direct-method, iot, iot-hub, iot-platform, react, visualization, websockets
- Language: TypeScript
- Homepage:
- Size: 2.08 MB
- Stars: 15
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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
```js
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](https://docs.ux4iot.com/quickstart)
is a link to a quickstart that explains how to deploy one. [Here](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/deviceinsightgmbh-4961725.ux4iot)
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](https://docs.ux4iot.com/using-react/introduction) 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.