Commit 96bb0aa2 authored by Mark Wijzenbroek's avatar Mark Wijzenbroek
Browse files

Some fixes in the documentation

parent f827b856
How to: a practical guide
===
This document describes a high level description of how the whole system is used.
This document gives a high level description of how the whole system is used.
The different hardware components are described [here](whatswhat.md).
......@@ -11,7 +11,7 @@ You will need to create at least one checkin and checkout node per "badge statio
After you have determined how many sensors you want to use, you need to flash the firmware on the sensors with the software in the flash folder. For more details on how to connect the sensors to the computer, see the [What's what](whatswhat.md) document. Do not forget to put a battery in the development board and the node you are flashing (can be removed again once the flashing is completed). After flashing, check whether the pattern the flashing LEDs make is consistent with what you are expecting ([see here](whatswhat.md)).
For more details on how to use the wrapper script, see [the readme file](../flash/README.md). Usually using the firmware as indicated by the types is sensible. For the regular badge nodes and the anchors, we recommend using the 2018 firmware (type: node, file: km_node_2018.hex). The anchor firmware is older and there is little sense in using it. It is recommended to store the
For more details on how to use the wrapper script, see [the readme file](../flash/README.md). Usually using the firmware as indicated by the types is sensible. For the regular badge nodes and the anchors, we recommend using the 2018 firmware (type: node, file: km_node_2018.hex). The anchor firmware is older and there is little sense in using it. It is recommended to store the nodes without a battery when they're not in use to prevent battery drain.
## Step 2: prepare and hand out badges
......@@ -23,7 +23,9 @@ Once a new participant arrives, check in a badge and hand it out. Register any e
## Step 3: collect the badges and download the data
When the experiment is over, check out the badge and - if preferred and possible - begin the download. Please note - keep the download node several meters away from your badges to avoid interference! The download node is rather sensitive and will probably (try to) download well before you expect it to. It does on occasion happen that two nodes will try to download at the same time, causing their results to be garbled together. As the nodes are immediately wiped after download, this should be avoided to prevent data loss! The downloader will output several files including the system log and the detection log in json format.
When the experiment is over, check out the badge by holding it close to a checkout node. The badges can then be stored as is and downloaded later, or immediately.
Please note - keep the download node several meters away from your badges to avoid interference! Only bring a single badge to it at a time - the download node is rather sensitive and will probably (try to) download well before you expect it to. It does on occasion happen that two nodes will try to download at the same time, causing their results to be garbled together. As the nodes are immediately wiped after download, this should be avoided to prevent data loss! The downloader will output several files including the system log and the detection log in json format.
To avoid problems, we recommend first downloading only the raw logs (use the -J option of kumbhdownloader to prevent immediately making json files) and then separately process them (kumbhprocessor). This way, you can easily concatenate results from multiple dump files (e.g. if you have multiple badge stations or because something went wrong), but you can also manually edit the dumps to remove spurious interactions with the download node (i.e. incomplete downloads).
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment