Skip to content

Commit 7f9046a

Browse files
committed
Add ignore, AUTHORS, LICENSE and (updated) README
1 parent eb43159 commit 7f9046a

File tree

4 files changed

+83
-0
lines changed

4 files changed

+83
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.DS_Store

AUTHORS

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# This is the official list of The Things Network authors for copyright purposes.
2+
#
3+
# The copyright owners listed in this document agree to release their work under
4+
# the MIT license that can be found in the LICENSE file.
5+
#
6+
# Names should be added to this file as
7+
# Firstname Lastname <email@address>
8+
#
9+
# Please keep the list sorted.
10+
11+
Johan Stokking <johan@thethingsnetwork.org>
12+
Fokke Zandbergen <mail@fokkezb.nl>

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016 The Things Network
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# The Things Network Arduino Library
2+
3+
[![Slack Status](https://slack.thethingsnetwork.org/badge.svg)](https://slack.thethingsnetwork.org/)
4+
5+
## Introduction
6+
7+
This is an [Arduino Library](https://www.arduino.cc/en/Guide/Libraries) for Arduino-compatible devices like [The Things Uno](https://shop.thethingsnetwork.com/index.php/product/the-things-uno/) and [Node](https://shop.thethingsnetwork.com/index.php/product/the-things-node/) to communicate with [The Things Network](https://www.thethingsnetwork.org).
8+
9+
At the moment this library requires devices to feature a [Microchip RN2xx3 module](http://www.microchip.com/design-centers/wireless-connectivity/embedded-wireless/lora-technology).
10+
11+
## Installation
12+
13+
1. Download the ZIP file of the latest [release on GitHub](https://github.com/TheThingsNetwork/arduino-library/releases).
14+
2. Follow [Importing a .zip Library](https://www.arduino.cc/en/Guide/Libraries#toc4) to install the library using the ZIP file.
15+
3. Restart the Arduino IDE.
16+
17+
**NOTE:** Examples for the library will not be exposed in the *File > Examples > TheThingsNetwork* until after the IDE has restarted.
18+
19+
## Examples
20+
The library comes with several [examples](examples) that can be loaded via *File > Eamples > TheThingsNetwork* once you've installed the library and restarted the IDE.
21+
22+
## API
23+
24+
TheThingsNetwork class features the following [public methods](https://github.com/TheThingsNetwork/arduino-library/blob/master/src/TheThingsNetwork.h#L39):
25+
26+
```C++
27+
public:
28+
void init(Stream& modemStream, Stream& debugStream);
29+
void reset(bool adr = true, int sf = DEFAULT_SF, int fsb = DEFAULT_FSB);
30+
bool personalize(const byte devAddr[4], const byte nwkSKey[16], const byte appSKey[16]);
31+
bool join(const byte appEui[8], const byte appKey[16]);
32+
void sendBytes(const byte* buffer, int length, int port = 1, bool confirm = false);
33+
void sendString(String message, int port = 1, bool confirm = false);
34+
void showStatus();
35+
```
36+
37+
## Contributing
38+
39+
Source code for The Things Network is MIT licensed. We encourage users to make contributions on [Github](https://github.com/TheThingsNetwork/arduino-library) and to participate in discussions on [Slack](https://slack.thethingsnetwork.org).
40+
41+
If you find bugs or documentation mistakes, please check [open issues](https://github.com/TheThingsNetwork/arduino-library/issues) before [creating a new issue](https://github.com/TheThingsNetwork/arduino-library/issues/new). 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.
42+
43+
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.
44+
45+
If you want to contribute, but don't know where to start, you could have a look at issues with the label [*help wanted*](https://github.com/TheThingsNetwork/arduino-library/labels/help%20wanted) or [*difficulty/easy*](https://github.com/TheThingsNetwork/arduino-library/labels/difficulty%2Feasy).
46+
47+
## License
48+
49+
Source code for The Things Network is released under the MIT License, which can be found in the [LICENSE](LICENSE) file. A list of authors can be found in the [AUTHORS](AUTHORS) file.

0 commit comments

Comments
 (0)