{"id":13506032,"url":"https://github.com/telefonicaid/sigfox-iotagent","last_synced_at":"2025-04-19T12:10:24.763Z","repository":{"id":31582660,"uuid":"35147451","full_name":"telefonicaid/sigfox-iotagent","owner":"telefonicaid","description":"IoT Agent for the Sigfox protocol","archived":false,"fork":false,"pushed_at":"2024-01-15T11:44:45.000Z","size":424,"stargazers_count":11,"open_issues_count":13,"forks_count":12,"subscribers_count":19,"default_branch":"master","last_synced_at":"2024-11-01T04:34:59.991Z","etag":null,"topics":["fiware","iot","iot-agent"],"latest_commit_sha":null,"homepage":"https://iotagent-sigfox.rtfd.io/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/telefonicaid.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES_NEXT_RELEASE","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"docs/roadmap.md","authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-05-06T08:19:47.000Z","updated_at":"2023-12-12T08:55:40.000Z","dependencies_parsed_at":"2024-01-15T13:18:26.485Z","dependency_job_id":null,"html_url":"https://github.com/telefonicaid/sigfox-iotagent","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telefonicaid%2Fsigfox-iotagent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telefonicaid%2Fsigfox-iotagent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telefonicaid%2Fsigfox-iotagent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telefonicaid%2Fsigfox-iotagent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/telefonicaid","download_url":"https://codeload.github.com/telefonicaid/sigfox-iotagent/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235233242,"owners_count":18957066,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fiware","iot","iot-agent"],"created_at":"2024-08-01T01:00:33.367Z","updated_at":"2025-01-23T06:16:30.149Z","avatar_url":"https://github.com/telefonicaid.png","language":"JavaScript","funding_links":[],"categories":["FIWARE Catalogue"],"sub_categories":["IoT Agents"],"readme":"# FIWARE IoT Agent for Sigfox\n\n[![FIWARE IoT Agents](https://nexus.lab.fiware.org/static/badges/chapters/iot-agents.svg)](https://www.fiware.org/developers/catalogue/)\n[![License: APGL](https://img.shields.io/github/license/telefonicaid/sigfox-iotagent.svg)](https://opensource.org/licenses/AGPL-3.0)\n[![Support badge](https://img.shields.io/badge/tag-fiware+iot-orange.svg?logo=stackoverflow)](https://stackoverflow.com/questions/tagged/fiware+iot)\n\u003cbr/\u003e\n[![Quay badge](https://img.shields.io/badge/quay.io-fiware%2Fsigfox--iotagent-grey?logo=red%20hat\u0026labelColor=EE0000)](https://quay.io/repository/fiware/sigfox-iotagent)\n[![Docker badge](https://img.shields.io/badge/docker-telefonicaiot%2Ffiware--sigfox--iotagent-blue?logo=docker)](https://quay.io/repository/telefonicaiot/sigfox-iotagent)\n\u003cbr/\u003e [![Documentation badge](https://img.shields.io/readthedocs/iotagent-sigfox.svg)](https://iotagent-sigfox.readthedocs.io)\n[![CI](https://github.com/telefonicaid/sigfox-iotagent/workflows/CI/badge.svg)](https://github.com/telefonicaid/sigfox-iotagent/actions?query=workflow%3ACI)\n[![Coverage Status](https://coveralls.io/repos/github/telefonicaid/sigfox-iotagent/badge.svg?branch=master)](https://coveralls.io/github/telefonicaid/sigfox-iotagent?branch=master)\n![Status](https://nexus.lab.fiware.org/repository/raw/public/badges/statuses/incubating.svg)\n[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4698/badge)](https://bestpractices.coreinfrastructure.org/projects/4698)\n\nAn Internet of Things Agent for the [Sigfox](http://www.sigfox.com/en/) callbacks protocol and the\n[NGSI](https://swagger.lab.fiware.org/?url=https://raw.githubusercontent.com/Fiware/specifications/master/OpenAPI/ngsiv2/ngsiv2-openapi.json)\ninterface of a context broker.\n\nIt is based on the [IoT Agent Node.js Library](https://github.com/telefonicaid/iotagent-node-lib). Further general\ninformation about the FIWARE IoT Agents framework, its architecture and the common interaction model can be found in the\nlibrary's GitHub repository.\n\nThis project is part of [FIWARE](https://www.fiware.org/). For more information check the FIWARE Catalogue entry for the\n[IoT Agents](https://github.com/Fiware/catalogue/tree/master/iot-agents).\n\n| :books: [Documentation](https://iotagent-sigfox.readthedocs.io) | \u003cimg style=\"height:1em\" src=\"https://quay.io/static/img/quay_favicon.png\"/\u003e [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) |\n| -------------------------------------------------------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | --- |\n\n\n## Contents\n\n-   [Background](#background)\n-   [Install](#install)\n-   [Usage](#usage)\n-   [API](#api)\n-   [Contributing](#contributing)\n-   [Testing](#testing)\n-   [License](#license)\n\n## Background\n\nThis IoT Agent is designed to be a bridge between the [Sigfox](http://www.sigfox.com/en/) callbacks protocol and the OMA\nNGSI protocol used by the [Orion Context Broker](https://github.com/telefonicaid/fiware-orion) as well as by other\ncomponents of the FIWARE ecosystem.\n\nFor each device, the Sigfox backend can provide a callback mechanism that can be used to send two kinds of information:\n\n-   Attributes defined by the Sigfox backend itself (including id, timestamp, etc.).\n-   A free data format, whose structure can be defined in the device type.\n\nThe Agent provides the following features:\n\n-   IoT Agent North Bound functionalities, as defined in the\n    [IoT Agent Node.js library](https://github.com/telefonicaid/iotagent-node-lib).\n-   A Sigfox endpoint listening for callbacks from the sigfox backend. Each piece of coming from the backend is\n    considered as a sepparate active attribute (as defined in the IoT Agents specification).\n-   A Sigfox data parser that can be used to convert from the data format as defined in the callbacks to a Javascript\n    array.\n-   A testing tool to simulate the date coming from the device.\n\nMost of this functionality is just a prototype to this date, so use this software carefully.\n\nAs is the case in any IoT Agent, this one follows the interaction model defined in the\n[Node.js IoT Agent Library](https://github.com/telefonicaid/iotagent-node-lib), that is used for the implementation of\nthe Northbound APIs. Information about the IoTAgent's architecture can be found on that global repository. This\ndocumentation will only address those features and characteristics that are particular to the Sigfox IoTAgent.\n\n## Install\n\nInformation about how to install the Sigfox IoT Agent can be found at the corresponding section of the\n[Installation \u0026 Administration Guide](docs/installationguide.md).\n\nA `Dockerfile` is also available for your use - further information can be found [here](docker/README.md)\n\n## Usage\n\nInformation about how to use the IoT Agent can be found in the [User \u0026 Programmers Manual](docs/usermanual.md).\n\n## API\n\nApiary reference for the Configuration API can be found\n[here](https://telefonicaiotiotagents.docs.apiary.io/#reference/configuration-api) More information about IoT Agents and\ntheir APIs can be found in the IoT Agent Library [documentation](https://iotagent-node-lib.readthedocs.io/).\n\n## Contributing\n\nIf you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has \nraised a similar idea or question.\n\nBefore contributing, please check out [contribution guidelines](docs/contribution.md)\n\n## Testing\n\n[Mocha](https://mochajs.org/) Test Runner + [Should.js](https://shouldjs.github.io/) Assertion Library.\n\nThe test environment is preconfigured to run BDD testing style.\n\nModule mocking during testing can be done with [proxyquire](https://github.com/thlorenz/proxyquire)\n\nTo run tests, type\n\n```console\nnpm test\n```\n\n---\n\n## License\n\nThe IoT Agent for Sigfox is licensed under [Affero General Public License (GPL) version 3](./LICENSE).\n\n© 2023 Telefonica Investigación y Desarrollo, S.A.U\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eFurther information on the use of the AGPL open source license\u003c/strong\u003e\u003c/summary\u003e\n\n### Are there any legal issues with AGPL 3.0? Is it safe for me to use?\n\nThere is absolutely no problem in using a product licensed under AGPL 3.0. Issues with GPL (or AGPL) licenses are mostly\nrelated with the fact that different people assign different interpretations on the meaning of the term “derivate work”\nused in these licenses. Due to this, some people believe that there is a risk in just _using_ software under GPL or AGPL\nlicenses (even without _modifying_ it).\n\nFor the avoidance of doubt, the owners of this software licensed under an AGPL 3.0 license wish to make a clarifying\npublic statement as follows:\n\n\u003e Please note that software derived as a result of modifying the source code of this software in order to fix a bug or\n\u003e incorporate enhancements is considered a derivative work of the product. Software that merely uses or aggregates (i.e.\n\u003e links to) an otherwise unmodified version of existing software is not considered a derivative work, and therefore it\n\u003e does not need to be released as under the same license, or even released as open source.\n\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelefonicaid%2Fsigfox-iotagent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftelefonicaid%2Fsigfox-iotagent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelefonicaid%2Fsigfox-iotagent/lists"}