Skip to content

🚜. IoT Agent for the ISOXML/ADAPT protocol for agricultural machinery (over an HTTP transport)

License

Notifications You must be signed in to change notification settings

FIWARE/iotagent-isoxml

Repository files navigation

IoT Agent for the ISOXML/ADAPT protocol

FIWARE IoT Agents License: APGL Docker badge Support badge
Documentation badge CI Coverage Status Status

An Internet of Things Agent for the ISO 11783 protocol (with HTTP). This IoT Agent is designed to be a bridge between ISOXML/ADAPT and the NGSI interface of a context broker.

It is based on the 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 🎯 Roadmap

Contents

Background

ISO 11783 is a standard for electronics communications protocol for agricultural equipment. This Internet of Things Agent is a bridge that can be used to communicate devices using the ISO 11783 protocol and NGSI Context Brokers (like Orion). ISO 11783 is an XML file based protocol used to pass message data. This IoT Agent does not deal with ISO 11783 communications directly, it is assumed that a separate MICS (Mobile Implement control system) server is present which in turn sends files down to devices and receives uploaded files to be processed.

As is the case in any IoT Agent, this one follows the interaction model defined in the Node.js IoT Agent Library, that is used for the implementation of the APIs found on the IoT Agent's North Port. Information about the architecture of the IoT Agent can be found on that global repository. This documentation will only address those features and characteristics that are particular to ISO 11783

Additional information about operating the component can be found in the Operations: logs and alarms document.

Install

Information about how to install the IoT Agent for ISOXML/ADAPT can be found at the corresponding section of the Installation & Administration Guide.

A Dockerfile is also available for your use - further information can be found here

Usage

Information about how to use the IoT Agent can be found in the User & Programmers Manual.

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.

The latest IoT Agent for ISOXML/ADAPT documentation is also available on ReadtheDocs

Testing

Mocha Test Runner + Should.js Assertion Library.

To run tests, type

npm test

License

The IoT Agent for ISOXML/ADAPT is licensed under Affero General Public License (GPL) version 3.

© 2020-2023 FIWARE Foundation e.V.

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.