Documentation

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

Core Manuals

• Nano-RK Online Kernel API
  • Basic Kernel API.
• FireFly Datasheet
  • FireFly datasheet with programming instructions
  • Best if printed 2-up

Drivers

• ADC Driver
  • Generic ADC device driver
• FireFly Basic Sensor Driver
  • FireFly Basic Sensor Board Driver

MAC Protocols

• 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 b-mac wiki page.
• 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
• 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.
• WiDom API
  • Bit dominance collision free through priority-based arbitration MAC protocol

Software Tools

• EEPROM MAC Configuration
  • Example of storing the MAC in EEPROM for batch programming
• SLIPstream
  • Simple UDP to serial SLIP protocol for computer to gateway communication

Additional Reference Materials

• Coding Conventions
  • This page has the Nano-RK indent string as well as other general practices
• Tips-and-Tricks
  • Put any tips for programming using Nano-RK here.
• Reference Documentation
  •  AVR Libc Online Reference
    •  EEPROM Functions
  •  AVR GCC Toolchain
  •  ATmega1281
  •  cc2420
  •  ATmega ISA
• Eclipse getting started guide

---

Installing the Toolchain

You can install the toolchain for either:

• Linux Install Guide
• OS-X Install Guide
• 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 Downloads page.

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

---