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: 17 days 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
- License: agpl-3.0
- Created: 2024-01-10T10:28:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-04T15:06:28.000Z (4 months ago)
- Last Synced: 2025-03-22T17:26:15.858Z (24 days ago)
- Language: TypeScript
- Homepage:
- Size: 191 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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
[](https://www.fiware.org/developers/catalogue/)
[](https://opensource.org/licenses/AGPL-3.0)
[](https://quay.io/repository/fiware/iotagent-ui)
[](https://stackoverflow.com/questions/tagged/fiware+iot)
[](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-2024 Telefonica
Investigación y Desarrollo
Are there any legal issues with AGPL 3.0? Is it safe for me to use?
There is absolutely no problem in using a product licensed under AGPL 3.0. Issues with GPL (or AGPL) licenses are mostly
related with the fact that different people assign different interpretations on the meaning of the term “derivate work”
used in these licenses. Due to this, some people believe that there is a risk in just _using_ software under GPL or AGPL
licenses (even without _modifying_ it).
For the avoidance of doubt, the owners of this software licensed under an AGPL-3.0 license wish to make a clarifying
public statement as follows:
> Please note that software derived as a result of modifying the source code of this software in order to fix a bug or
> incorporate enhancements is considered a derivative work of the product. Software that merely uses or aggregates (i.e.
> links to) an otherwise unmodified version of existing software is not considered a derivative work, and therefore it
> does not need to be released as under the same license, or even released as open source.