Ecosyste.ms: Awesome

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

https://github.com/telefonicaid/sigfox-iotagent

IoT Agent for the Sigfox protocol
https://github.com/telefonicaid/sigfox-iotagent

fiware iot iot-agent

Last synced: about 1 month ago
JSON representation

IoT Agent for the Sigfox protocol

Lists

README 

        
# FIWARE IoT Agent for Sigfox



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

[![License: APGL](https://img.shields.io/github/license/telefonicaid/sigfox-iotagent.svg)](https://opensource.org/licenses/AGPL-3.0)

[![Support badge](https://img.shields.io/badge/tag-fiware+iot-orange.svg?logo=stackoverflow)](https://stackoverflow.com/questions/tagged/fiware+iot)




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

[![Docker badge](https://img.shields.io/badge/docker-telefonicaiot%2Ffiware--sigfox--iotagent-blue?logo=docker)](https://quay.io/repository/telefonicaiot/sigfox-iotagent)


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

[![CI](https://github.com/telefonicaid/sigfox-iotagent/workflows/CI/badge.svg)](https://github.com/telefonicaid/sigfox-iotagent/actions?query=workflow%3ACI)

[![Coverage Status](https://coveralls.io/repos/github/telefonicaid/sigfox-iotagent/badge.svg?branch=master)](https://coveralls.io/github/telefonicaid/sigfox-iotagent?branch=master)

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

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



An Internet of Things Agent for the [Sigfox](http://www.sigfox.com/en/) callbacks protocol and the

[NGSI](https://swagger.lab.fiware.org/?url=https://raw.githubusercontent.com/Fiware/specifications/master/OpenAPI/ngsiv2/ngsiv2-openapi.json)

interface of a context broker.



It is based on the [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/master/iot-agents).



| :books: [Documentation](https://iotagent-sigfox.readthedocs.io) |  [quay.io](https://quay.io/repository/fiware/sigfox-iotagent)| :whale: [Docker Hub](https://hub.docker.com/r/telefonicaiot/sigfox-iotagent) | :dart: [Roadmap](https://github.com/telefonicaid/sigfox-iotagent/blob/master/docs/roadmap.md) |

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



## Contents



-   [Background](#background)

-   [Install](#install)

-   [Usage](#usage)

-   [API](#api)

-   [Contributing](#contributing)

-   [Testing](#testing)

-   [License](#license)



## Background



This IoT Agent is designed to be a bridge between the [Sigfox](http://www.sigfox.com/en/) callbacks protocol and the OMA

NGSI protocol used by the [Orion Context Broker](https://github.com/telefonicaid/fiware-orion) 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](https://github.com/telefonicaid/iotagent-node-lib).

-   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](https://github.com/telefonicaid/iotagent-node-lib), 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.



## Install



Information about how to install the Sigfox IoT Agent can be found at the corresponding section of the

[Installation & Administration Guide](docs/installationguide.md).



A `Dockerfile` is also available for your use - further information can be found [here](docker/README.md)



## Usage



Information about how to use the IoT Agent can be found in the [User & Programmers Manual](docs/usermanual.md).



## API



Apiary reference for the Configuration API can be found

[here](https://telefonicaiotiotagents.docs.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.readthedocs.io/).



## Contributing



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](docs/contribution.md)



## Testing



[Mocha](https://mochajs.org/) Test Runner + [Should.js](https://shouldjs.github.io/) Assertion Library.



The test environment is preconfigured to run BDD testing style.



Module mocking during testing can be done with [proxyquire](https://github.com/thlorenz/proxyquire)



To run tests, type



```console

npm test

```



---



## License



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



© 2023 Telefonica Investigación y Desarrollo, S.A.U



Further information on the use of the AGPL open source license



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