[[TracNav(TOC)]]

= Documentation =
This page contains links to various online reference material for nano-RK.

'''Core Manuals'''
 * [wiki:nrk-api Nano-RK Online Kernel API]
  * Basic Kernel API.
 * [attachment:FireFly_datasheet.pdf?format=raw FireFly Datasheet]
  * FireFly datasheet with programming instructions
  * Best if printed 2-up
 
'''Drivers'''
 * [wiki:adc-driver ADC Driver]
  * Generic ADC device driver
 * [wiki:firefly-basic-sensor-driver FireFly Basic Sensor Driver]
  * FireFly Basic Sensor Board Driver
 
'''MAC Protocols'''
 * [wiki:bmac-api BMAC API]
  * Low-Power-Listen (LPL) CSMA protocol.  Useful for highly mobile devices, or as the link layer for a dynamic mesh networking environment.
  * For more information about the mechanics of the protocol, see the [wiki:b-mac b-mac wiki page].
 * [wiki:pcf-tdma PCF TDMA] 
  * Flexible, low-power, one-hop TDMA for both high and low data-rate collection
  * Use this for streaming data back with the energy bias on the gateway
 * [wiki:RT-Link RT-Link API]
  * RT-Link is a multi-hop TDMA protocol that provides highly energy-efficient mesh networking for predominantly static networks.  Support for 1-hop mobile device communication to infrastructure nodes.
 * [wiki:widom-api WiDom API]
  * Bit dominance collision free through priority-based arbitration MAC protocol

'''Software Tools'''
 * [wiki:eeprom-mac EEPROM MAC Configuration]
  * Example of storing the MAC in EEPROM for batch programming
 * [wiki:SLIPstream SLIPstream]
  * Simple UDP to serial SLIP protocol for computer to gateway communication

'''Additional Reference Materials'''
 * [wiki:coding-conventions Coding Conventions]
  * This page has the Nano-RK indent string as well as other general practices
 * [wiki:Tips-and-Tricks]
  * Put any tips for programming using Nano-RK here. 
 * Reference Documentation
  * [http://www.nongnu.org/avr-libc/user-manual/index.html AVR Libc Online Reference]
   * [http://www.nongnu.org/avr-libc/user-manual/group__avr__eeprom.html EEPROM Functions]
  * [http://www.avrfreaks.net/wiki/index.php/Documentation:AVR_GCC/AVR_GCC_Tool_Collection AVR GCC Toolchain]
  * [http://www.atmel.com/dyn/resources/prod_documents/doc2549.pdf ATmega1281] 
  * [http://focus.ti.com/docs/prod/folders/print/cc2420.html cc2420] 
  * [http://www.atmel.com/dyn/resources/prod_documents/doc0856.pdf ATmega ISA] 
 * [wiki:Eclipse] getting started guide



----



'''Installing the Toolchain'''

You can install the toolchain for either:
 - [wiki:linux-install Linux Install Guide]
 - [wiki:osx-install OS-X Install Guide] 
 - [wiki:windows-install Windows (under cygwin) Install Guide].

Once you have installed the toolchain from the above link, you can download the latest release snapshot of the source from our [wiki:Downloads] page.

To use the micaZ you will need to install uisp for the MIB510 or MIB520.  See [wiki:micaZ-quick-start] page for instructions.

----