Skip to content
This repository has been archived by the owner on Oct 8, 2021. It is now read-only.
/ ttn-finch Public archive

Extendable "store-and-action" integration, built for The Things Stack.

License

Notifications You must be signed in to change notification settings

NoticeMeDan/ttn-finch

Repository files navigation

Finch

TTN-Finch

TTN-Finch is an extendable "store-and-action" integration, built for The Things Stack setups in constrained network environments. It allows you to store all the incoming uplink traffic in a database, and do what you see fit with it, on a set schedule.

An example of use could be, that your The Things Stack setup resides in a remote location, where it is only possible to get an internet connection every other Friday. In order to facilitate automatic retrieval of the uplink data, you install the TTN-Finch integration and configure it to forward the data to your server via the HTTP Result with a schedule of every other Friday at 4 PM. When this has been configured, your incoming uplink data will be stored in a database, and forwarded to you on your wanted schedule. Nice and simple.

The integration has been built in such a way, that it is very easy to extend the system with another Result, such that the integration can better support the needs of the individual, through the support of the community.

Getting started

For information on how to get started with TTN-Finch, click here.

Result development

The TTN-Finch webservice is built with Spring Boot and Kotlin. For information on how to get started with developing your own Result, click here.

Building your own UI

If you do not wish to use the included webapp, you can build your own. The TTN-Finch webservice exposes an open REST API that you can consume in your UI. The webservice is documented with Swagger. The Swagger UI can be accessed at the /swagger-ui.html webservice path.

Releases

No releases published

Packages

No packages published