README
¶
The Things Network
The Things Network is a global open crowdsourced Internet of Things data network.
Status
This repository will become version 1.0 of The Things Network. It is under heavy development and currently it's APIs and code are not yet stable (pre 1.0).
Getting Started With The Things Network
When you get started with The Things Network, you'll probably have some questions. Here are some things you can do to find the answer to them:
- Register on the forum
- Join Slack
- Sign up for the newsletter (click the button that says Join our team)
- Read background information on the wiki
- Send an email to @johanstokking (johan@thethingsnetwork.org)
Running the Network
We are working hard on building a working version of the v1.0 backend. Currently, we have the following components working:
- Router
- Broker
- Handler
Contributing
Source code for The Things Network is MIT licensed. We encourage users to make contributions on Github and to participate in discussions on Slack.
If you find bugs or documentation mistakes, please check open issues before creating a new issue. Please be specific and give a detailed description of the issue. Explain the steps to reproduce the problem. If you're able to fix the issue yourself, please help the community by forking the repository and submitting a pull request with your fix.
For contributing a feature, please open an issue that explains what you're working on. Work in your own fork of the repository and submit a pull request when you're done.
If you want to contribute, but don't know where to start, you could have a look at issues with the label help wanted or difficulty/easy.
License
Source code for The Things Network is released under the MIT License, which can be found in the LICENSE file. A list of authors can be found in the AUTHORS file.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package core is a generated protocol buffer package.
|
Package core is a generated protocol buffer package. |
|
adapters/http
Package http provides adapter implementations which run on top of http.
|
Package http provides adapter implementations which run on top of http. |
|
mocks
Package mocks offers dedicated mocking interface / structures for testing
|
Package mocks offers dedicated mocking interface / structures for testing |
|
Package semtech provides useful methods and types to handle communications with a gateway.
|
Package semtech provides useful methods and types to handle communications with a gateway. |
|
utils
|
|
|
pointer
Package pointer provides helper method to quickly define pointer from basic go types
|
Package pointer provides helper method to quickly define pointer from basic go types |
|
stats
Package stats supports the collection of metrics from a running component.
|
Package stats supports the collection of metrics from a running component. |
|
testing
Package testing offers some handy methods to display check and cross symbols with colors in test logs.
|
Package testing offers some handy methods to display check and cross symbols with colors in test logs. |