Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Engineering-Research-and-Development/iotagent-ui

Web User Interface for IoTAgents based on iotagent-node-lib
https://github.com/Engineering-Research-and-Development/iotagent-ui

Last synced: 3 months ago
JSON representation

Web User Interface for IoTAgents based on iotagent-node-lib

Host: GitHub
URL: https://github.com/Engineering-Research-and-Development/iotagent-ui
Owner: Engineering-Research-and-Development
Created: 2024-01-10T10:28:05.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-10-28T09:53:39.000Z (3 months ago)
Last Synced: 2024-10-28T12:57:33.585Z (3 months ago)
Language: TypeScript
Homepage:
Size: 220 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

awesome - IoTagent UI - A graphical user interface for provisioning devices and services based on IoT Agents. (Open-Source FIWARE from third parties / Processing)

README

        # IoT Agent UI: the FIWARE IoT Agent Web UI for IoT Agents

[![FIWARE IoT Agents](https://nexus.lab.fiware.org/static/badges/chapters/iot-agents.svg)](https://www.fiware.org/developers/catalogue/)

[![License: AGPL](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://opensource.org/licenses/AGPL-3.0)

[![Docker badge](https://img.shields.io/badge/quay.io-fiware%2Fiotagent--ui-grey?logo=red%20hat&labelColor=EE0000)](https://quay.io/repository/fiware/iotagent-ui)

[![Support badge](https://img.shields.io/badge/support-stackoverflow-orange)](https://stackoverflow.com/questions/tagged/fiware+iot)


[![Documentation badge](https://img.shields.io/readthedocs/iotagent-ui.svg)](https://iotagent-ui.rtfd.io/)

[![CI](https://github.com/Engineering-Research-and-Development/iotagent-ui/workflows/CI/badge.svg)](https://github.com/Engineering-Research-and-Development/iotagent-ui/actions?query=workflow%3ACI)

[![Coverage Status](https://coveralls.io/repos/github/Engineering-Research-and-Development/iotagent-ui/badge.svg?branch=main)](https://coveralls.io/github/Engineering-Research-and-Development/iotagent-ui?branch=main)

[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4612/badge)](https://bestpractices.coreinfrastructure.org/projects/4612)

![Status](https://nexus.lab.fiware.org/static/badges/statuses/incubating.svg)

[![Join the chat at https://gitter.im/iotagent-ui/community](https://badges.gitter.im/iotagent-ui/community.svg)](https://gitter.im/iotagent-ui/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)


 

An Internet of Things Agent that communicates and monitors any IoT Agent built on top of [IoT Agent Node.js Library](https://github.com/telefonicaid/iotagent-node-lib).

Further general

information about the FIWARE IoT Agents framework, its architecture and the common interaction model can be found in the

library's GitHub repository.

This project is part of [FIWARE](https://www.fiware.org/). For more information check the

[FIWARE Catalogue entry for the IoT Agents](https://github.com/Fiware/catalogue/tree/main/iot-agents).

| :books: [Documentation](https://iotagent-ui.rtfd.io) |  [quay.io](https://quay.io/repository/fiware/iotagent-ui) | :mortar_board: [Academy](https://fiware-academy.readthedocs.io/en/latest/iot-agents/idas) | :dart: [Roadmap](https://github.com/Engineering-Research-and-Development/iotagent-ui/blob/main/roadmap.md) |

| ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |

## Contents

-   [Background](#background)

-   [Install](#getting-started---install)

    -   [Docker install](#docker---recommended)

    -   [NPM Install](#npm)

-   [Usage](#usage)

-   [API](#api)

-   [License](#license)

## Background

### Positioning in the overall F4I Reference Architecture

The growind need of managing serveral IoT Agents installed at industrial plants led to the development of this asset which is a Web User Interface to monitor and control with ease what's happening under the hood. IoT Agent UI is fully compliant with FIWARE iotagent-node-lib thus every agent built on top of this library is supported out-of-the-box. 

## Getting Started - Install

Currently two options are available to install the IoT Agent UI:

### Docker - Recommended

We suggest using a **Docker-first** approach in order to avoid issues related to your environment configuration.

Moreover, using this approach you will be provided with all the needed components: Mongo instance

A step-by-step tutorial is available

[here](https://github.com/Engineering-Research-and-Development/iotagent-ui/blob/main/docs/iot_agent_ui_tutorial.md)

### npm

Follow the two READMEs in the proper project sub-folders:

[iotagent-ui-spa](https://github.com/Engineering-Research-and-Development/iotagent-ui/blob/main/iotagent-ui-spa/README.md) 

[iotagent-ui-bff](https://github.com/Engineering-Research-and-Development/iotagent-ui/blob/main/iotagent-ui-bff/README.md) 

## Usage


 

## API

Apiary reference for the Configuration API can be found

[here](http://docs.telefonicaiotiotagents.apiary.io/#reference/configuration-api) More information about IoT Agents and

their APIs can be found in the IoT Agent Library [documentation](https://iotagent-node-lib.rtfd.io/).

## License

The IoT Agent UI is licensed under [Affero General Public License (GPL) version 3](./LICENSE).

© 2024 Engineering Ingegneria Informatica S.p.A.

The following third-party libraries are used under license

1.  [iotagent-node-lib](https://github.com/telefonicaid/iotagent-node-lib) - **AGPL** © 2014-2021 Telefonica

    Investigación y Desarrollo