Skip to content

Commit

Permalink
Merge branch 'master' of github.com:TheThingsIndustries/KISSLoRa-demo
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmeijers committed Jun 1, 2017
2 parents 77955fa + 118e7e9 commit 9979c5c
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This repository includes example software to be used with the KISS LoRa gadget f

### Download this repository

Download the contents of this repository to your computer by clicking [here](archive/master.zip) or by going to **Clone or download->Download ZIP**. On your computer unzip the downloaded file by following the correct procedure for your operating system.
Download the contents of this repository to your computer by clicking [here](https://github.com/TheThingsIndustries/KISSLoRa-demo/archive/master.zip) or by clicking on the green button on top of this page: **Clone or download->Download ZIP**. On your computer unzip the downloaded file by following the correct procedure for your operating system.

### Arduino IDE

Expand All @@ -21,6 +21,8 @@ Go to **File->Preferences** on the Settings tab, next to **Show verbose output d

### SparkFun AVR boards

Install the USB drivers for the SparkFun boards, following the steps [for Windows](https://learn.sparkfun.com/tutorials/pro-micro--fio-v3-hookup-guide/installing-windows) or [for Linux and Mac](https://learn.sparkfun.com/tutorials/pro-micro--fio-v3-hookup-guide/installing-mac--linux).

In the Arduino IDE go to **File->Preferences->Additional Boards Manager URLs** and add:
`https://raw.githubusercontent.com/sparkfun/Arduino_Boards/master/IDE_Board_Manager/package_sparkfun_index.json`

Expand All @@ -39,6 +41,19 @@ Search for **TheThingsNetwork** and click on **install**.

Search for **SoftPWM** and click on **install**.


### The Things Network Console

Applications and devices can be managed via [The Things Network Console](https://console.thethingsnetwork.org/). In the Console you can find your application which is registered via the Commissioning Terminal.

When uploading the new sketches, you need the `appEui` and `appKey`, you can find both in the Kiss-LoRa application which is registered under your personal account. Go to:
* [The Things Network Console](https://console.thethingsnetwork.org/)
* Click on *Applications* and select the `Kiss LoRa` application
* Click on *Devices* and select your `Kiss LoRa` device
* Go all the way to the bottom, under the `EXAMPLE CODE` you can find the keys you need later on



## Uploading Firmware

> The serial monitor must be closed before uploading code to the device.
Expand All @@ -48,7 +63,7 @@ Search for **SoftPWM** and click on **install**.
3. In the Arduino IDE make sure the correct **Tools->Board** (SparkFun Pro Micro) and **Tools->Processor** (ATmega 32U4, 8MHz) are selected.
4. Switch the device on and make sure the correct **Tools->Port** is selected.
5. Switch the device off again.
6. Press and hold the **Push Button** on the kiss device.
6. Press and hold the **Push Button** on the Kiss device.
6. In the Arduino IDE, choose **Sketch->Upload**.
7. As soon as you see `PORTS {} / {} => {}` printed in the output window turn KISSLoRa on.
8. When the upload process continue past showing `PORTS {} / {} => {}`, you can release the push button.
Expand All @@ -66,6 +81,11 @@ If you are using MAC OS, [read this](https://learn.sparkfun.com/tutorials/how-to

In the directory **KISSLoRa-demo_app** you will find the original firmware that was on the KISS LoRa device when you received it. If you ever want to flash this firmware back onto the device, have a look at the [README.md in this directory](KISSLoRa-demo_app/README.md).


## [Examples](Examples)

In the Examples directory you will find example firmware files to read the sensors on the board. Have a look at the README in each subdirectory to see an explanation of each example.

## [Bootloader](Bootloader)

In the Bootloader directory you will find the hex file for the bootloader that runs on your KISS LoRa device. In the most cases you will never need this, but if you manage to brick your device, this will be useful to recover.
Expand All @@ -75,7 +95,3 @@ In the Bootloader directory you will find the hex file for the bootloader that r
The Schematics directory contains the electronic design of the board. It specifically shows how everything is connected. This is useful to have when writing firmware for the KISS LoRa device, to know on which pins the sensors are connected.

The schematic uses the pin names and numbers from the [datasheet of the ATmega32u4](Schematics/Atmel-7766-8-bit-AVR-ATmega16U4-32U4_Datasheet.pdf). When programming this board from within Arduino IDE, we use the Arduino pin names and numbers. See the [PIN_MAPPING](Schematics/PIN_MAPPING.md) document for the translation between these pin numbers and names.

## [Examples](Examples)

In the Examples directory you will find example firmware files to read the sensors on the board. Have a look at the README in each subdirectory to see an explanation of each example.

0 comments on commit 9979c5c

Please sign in to comment.