TinyOS Documentation Wiki

From TinyOS Wiki
Revision as of 04:06, 24 May 2008 by Fangvv (talk | contribs) (Other Documents)
Jump to: navigation, search

This is the new Wiki site for the TinyOS Documentation Working Group. Everyone is welcome to edit these pages and contribute TinyOS documentation.
In order to edit, you must first create an account, using the link on the upper right (Login / create account).
Consult the User's Guide for information on using the wiki software.

TinyOS Documentation Index

Purpose of this Wiki Site: This site is part of a new effort (as of October 2007) to establish a single, common site for all TinyOS Documentation, akin to the Linux Documentation Project (but for TinyOS, of course). Right now, TinyOS documentation is scattered across many sites and is often poorly maintained. We hope that by using a Wiki - and making the site fairly open to edits from anyone - that it will be possible to create and maintain TinyOS documentation over a longer period of time. Click here to see an index of all the available pages.

So, you are encouraged to contribute documentation to this site simply by editing this page and adding a link to a new (empty) page. Come back and click on that link and start creating content for the new page. Don't worry too much about organization right now, since we can re-organize things later on if need be. If you are not familiar with the Wiki system, consult the User's Guide.

We prefer all documentation to live on this site, rather than having links to external sites, but external links are OK too.

TinyOS Search Engine

Using Google's custom search features, a search engine dedicated to TinyOS has been created. The advantage of using this search engine instead of a normal web search is that only specific sites are indexed. This means that any search results are highly relevant to TinyOS, and your search terms can be very general. For example, if you need help on installing TinyOS in Ubuntu, just search "Ubuntu" in the custom search engine and it will only return links to pages containing the word "Ubuntu" on known TinyOS sites.

Click here for the TinyOS Custom Search Engine

Installing TinyOS

Programming Tutorials

Hardware Platforms

Software Libraries and Drivers

Sensorboards

Various TinyOS Tools

Other Documents

Documents that need to be written

Please feel free to add additional topics or create pages for each of the topics below.

  • Platforms
    • Overview of commonly used platforms with software porting/compatibility issues
  • Sensors
    • Sensor boards
    • Which TinyOS modules to use for which sensor
    • How to convert the raw sensor values to commonly used formats
  • RSSI / LQI
    • How to obtain RSSI / LQI values for a received packet
    • How to measure RSSI values without receiving a packet (measuring noise)
    • Relationship between RSSI / LQI values and physical distance
  • TX power
    • How to reduce the TX power
      • For all transmissions
      • On a per-packet basis
  • How to debug the programmer
    • For Mica-based motes, how to ensure they are properly plugged in
    • For network based programmers, how to verify the communication
    • Common mistakes, common hardware errors
  • How to debug the serial communication
    • Which port to use for MIB520
    • How to configure network-based programmers
  • Case Studies (Example applications)
  • CVS CO & Update
  • Links or references to the TEP's

Meta-documentation for the Wiki site