Skip to content

Latest commit

 

History

History
100 lines (69 loc) · 6.16 KB

README.md

File metadata and controls

100 lines (69 loc) · 6.16 KB

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

FIWARE IoT Agents License: AGPL Docker badge Support badge
Status Join the chat at https://gitter.im/iotagent-ui/community

An Internet of Things Agent that communicates and monitors any IoT Agent built on top of IoT Agent Node.js Library.

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. For more information check the FIWARE Catalogue entry for the IoT Agents.

📚 Documentation quay.io 🎓 Academy 🎯 Roadmap

Contents

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

npm

Follow the two READMEs in the proper project sub-folders: iotagent-ui-spa iotagent-ui-bff

Usage


API

Apiary reference for the Configuration API can be found here More information about IoT Agents and their APIs can be found in the IoT Agent Library documentation.

License

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

© 2024 Engineering Ingegneria Informatica S.p.A.

The following third-party libraries are used under license

  1. 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.