An Internet of Things Agent for the Sigfox callbacks protocol 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 |
🐳 Docker Hub | 🎯 Roadmap |
|---|
This IoT Agent is designed to be a bridge between the Sigfox callbacks protocol and the OMA NGSI protocol used by the Orion Context Broker as well as by other components of the FIWARE ecosystem.
For each device, the Sigfox backend can provide a callback mechanism that can be used to send two kinds of information:
- Attributes defined by the Sigfox backend itself (including id, timestamp, etc.).
- A free data format, whose structure can be defined in the device type.
The Agent provides the following features:
- IoT Agent North Bound functionalities, as defined in the IoT Agent Node.js library.
- A Sigfox endpoint listening for callbacks from the sigfox backend. Each piece of coming from the backend is considered as a sepparate active attribute (as defined in the IoT Agents specification).
- A Sigfox data parser that can be used to convert from the data format as defined in the callbacks to a Javascript array.
- A testing tool to simulate the date coming from the device.
Most of this functionality is just a prototype to this date, so use this software carefully.
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 Northbound APIs. Information about the IoTAgent's architecture can be found on that global repository. This documentation will only address those features and characteristics that are particular to the Sigfox IoTAgent.
Information about how to install the Sigfox IoT Agent 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
Information about how to use the IoT Agent can be found in the User & Programmers Manual.
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.
If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.
Before contributing, please check out contribution guidelines
Mocha Test Runner + Should.js Assertion Library.
The test environment is preconfigured to run BDD testing style.
Module mocking during testing can be done with proxyquire
To run tests, type
npm testThe IoT Agent for Sigfox is licensed under Affero General Public License (GPL) version 3.
© 2023 Telefonica Investigación y Desarrollo, S.A.U
Further information on the use of the AGPL open source license
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.