{"id":23286692,"url":"https://github.com/deviceinsight/ux4iot-react","last_synced_at":"2025-08-21T17:32:26.946Z","repository":{"id":39534876,"uuid":"410859724","full_name":"deviceinsight/ux4iot-react","owner":"deviceinsight","description":"React library for ux4iot for easily building IoT web applications","archived":false,"fork":false,"pushed_at":"2024-08-22T16:22:15.000Z","size":2176,"stargazers_count":15,"open_issues_count":0,"forks_count":1,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-11-15T22:15:27.877Z","etag":null,"topics":["azure","azure-iot","azure-iot-hub","device-twin","direct-method","iot","iot-hub","iot-platform","react","visualization","websockets"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deviceinsight.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-27T11:38:15.000Z","updated_at":"2024-08-22T16:22:18.000Z","dependencies_parsed_at":"2023-02-15T10:15:54.102Z","dependency_job_id":"32728aba-6a6e-43b2-9326-095a6f0eebc5","html_url":"https://github.com/deviceinsight/ux4iot-react","commit_stats":{"total_commits":112,"total_committers":4,"mean_commits":28.0,"dds":0.1875,"last_synced_commit":"2ed82deda6d6b23e9a88bab465d764f47da1e133"},"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deviceinsight%2Fux4iot-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deviceinsight%2Fux4iot-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deviceinsight%2Fux4iot-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deviceinsight%2Fux4iot-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deviceinsight","download_url":"https://codeload.github.com/deviceinsight/ux4iot-react/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230047897,"owners_count":18164658,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["azure","azure-iot","azure-iot-hub","device-twin","direct-method","iot","iot-hub","iot-platform","react","visualization","websockets"],"created_at":"2024-12-20T02:14:06.546Z","updated_at":"2024-12-20T02:14:07.136Z","avatar_url":"https://github.com/deviceinsight.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ux4iot-react\n\nux4iot is a tool for directly communicating with your IoT devices from your web frontend. Your React frontend gets access to Azure IoT Hub's \ncommunication primitives without having a custom-built backend middleware translating between IoT Hub and your user interface. \nNo need to design a REST API so that your UI can offer IoT functionality.\n\nUse the hooks in this library to implement your use cases for live data and for controlling devices. \n\nAs an example: Using live data in your React application is as easy as writing\n\n```js\nconst temperature = useTelemetry('myDevice', 'temperature');\n```\n\nin your React components.\n\nThis library provides hooks for:\n\n- `useTelemetry` - Subscribe to a single telemetry key of a device\n- `useMultiTelemetry` - Subscribe to telemetry of multiple devices\n- `useDeviceTwin` - Subscribe to device twin changes\n- `useConnectionState` - Subscribe to connection state updates of a device\n- `useMultiConnectionState` - Subscribe to connection states of multiple devices\n- `useDirectMethod` - Execute a direct method on a device\n- `usePatchDesiredProperties` - Update the desired properties of the device twin\n- `useD2CMessages` - Use the raw messages sent by your devices\n\n## Prerequisites\n\nIn order to use this library you need to have an ux4iot instance deployed in your Azure subscription. [Here](https://docs.ux4iot.com/quickstart) \nis a link to a quickstart that explains how to deploy one. [Here](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/deviceinsightgmbh-4961725.ux4iot)\nis the link to the Azure Marketplace offering.\n\n## Installation\n\nInstall `ux4iot-react` in your frontend application:\n\n```\nnpm install ux4iot-react\n```\n\n## Documentation\n\nCheck out the [Documentation](https://docs.ux4iot.com/using-react/introduction) for\n\n- Additional options\n- Hook API\n- ux4iot Admin SDKs\n- ux4iot Admin API\n- Reference to other related libraries of the ux4iot service\n\n## Tests\n- 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.\n\n## Releasing\n\nIf you want to release a new version\n- `git checkout master`\n- Increase the version based on your changed in package.json (usually minor)\n- `git commit -m 'Release VERSION'`\n- `git tag VERSION -m 'Release VERSION'`\n- `git push`\n- `git push --tags`\n\nThe tag pipeline of github actions will build the package and publish it to npm.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeviceinsight%2Fux4iot-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeviceinsight%2Fux4iot-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeviceinsight%2Fux4iot-react/lists"}