Skip to content

Commit

Permalink
FAQ at top of readme, link to FAQ and commissioning steps.
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmeijers committed Jun 2, 2017
1 parent c6486d8 commit 765d964
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 5 deletions.
29 changes: 29 additions & 0 deletions COMMISSION_AT_HOME.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Commissioning

During the E&A fair we had a couple of commissioning stations standing around where one could personalise, or commission, your KISS gadget. It is however also possible to commission the device without the commissioning stations. These stations did automate many steps, so at home the process is more complex.

## Prerequisites

* Follow the steps in the main README to install the latest version of the Arduino IDE.
* Also install the USB drivers, SparkFun AVR boards and TheThingsNetwork library.
* [A TTN account](https://account.thethingsnetwork.org/)

## Device info

In the Arduino IDE, go to **File->Examples->TheThingsNetwork->DeviceInfo**. This will open the Device Info example code. On line 7 replace `REPLACE_ME` by `TTN_FP_EU868`. Following the steps in the main readme, **upload** this firmware to the KISS gadget. After uploading the code, got to **Tools->Serial Monitor**. At the bottom of the newly opened serial monitor, change the baudrate to *9600 baud*.

Copy the 16 HEX characters following `EUI:` and use this to register a new device on The Things Network Console.

## Register a new device
[See the TTN documentation](https://www.thethingsnetwork.org/docs/devices/registration.html).

## SendOTAA example

Open the SendOTAA example from **File->Examples->TheThingsNetwork->SendOTAA**. Replace the keys at the top with the keys you got from the TTN Console. After uploading this example, check the console to see if you receive any data. If you don't, you do not have TTN coverage.

## Original Firmware

The previous example proved that we have a working KISS gadget, a working radio module, TTN coverage, and programmed valid keys into the KISS gadget. Now we can upload the original firmware back onto the KISS gadget. Follow the steps in the readme inside the *KISSLoRa-demo_app* directory.


> This readme describes the steps necessary to commission a KISS gadget. Many details still need to be added, but the important steps are already included.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# KISS LoRa

This repository includes example software to be used with the KISS LoRa gadget from the E&A fair.
> For common questions about the KISS gadget, see [the FAQ](faq.pdf).
>
> Voor veelgestelde vragen over de KISS gadget, zie [de FAQ](faq.pdf).

This repository contains example firmware to customise the KISS LoRa gadget from the E&A fair. If you do not want to customise your KISS gadget, but just want to get it to work with the original firmware, please see [the FAQ](faq.pdf) or the [Commission at Home](COMMISSION_AT_HOME.md) document.


![alt text](KISSLoRa.png)

Expand Down Expand Up @@ -95,7 +101,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.

## [Veelgestelde vragen / FAQ](faq.pdf)

Klik op de titel om te navigeren naar de veelgestelde vragen file.

0 comments on commit 765d964

Please sign in to comment.