Difference between revisions of "TinyOS Documentation Wiki"

From TinyOS Wiki
Jump to: navigation, search
Line 52: Line 52:
 
* Case Studies (Example applications)
 
* Case Studies (Example applications)
 
* NesC and TinyOS Programming (eg links to [http://www.tinyos.net/tinyos-2.x/doc/pdf/tinyos-programming.pdf TinyOS Programming Manual] and [http://www.tinyos.net/tinyos-2.x/doc/html/tutorial/index.html Tutorials], plus community added tips)
 
* NesC and TinyOS Programming (eg links to [http://www.tinyos.net/tinyos-2.x/doc/pdf/tinyos-programming.pdf TinyOS Programming Manual] and [http://www.tinyos.net/tinyos-2.x/doc/html/tutorial/index.html Tutorials], plus community added tips)
*
 
  
 
== Links ==
 
== Links ==
Line 64: Line 63:
 
* [http://homepages.dcc.ufmg.br/~bpires/tutorials/dossie Tutorial in Portugese]
 
* [http://homepages.dcc.ufmg.br/~bpires/tutorials/dossie Tutorial in Portugese]
  
== Getting started ==
+
== Meta-documentaiton for the Wiki site ==
  
 
* [http://www.mediawiki.org/wiki/Help:Configuration_settings Configuration settings list]
 
* [http://www.mediawiki.org/wiki/Help:Configuration_settings Configuration settings list]
 
* [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ]
 
* [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ]
 
* [http://mail.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
 
* [http://mail.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]

Revision as of 15:54, 6 November 2007

TinyOS Documentation Wiki

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.

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.

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 Documentation Index

Proposed topics for the TinyOS Wiki

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)
  • NesC and TinyOS Programming (eg links to TinyOS Programming Manual and Tutorials, plus community added tips)

Links

John Regehr says: To save myself from repeating information to students I wrote a very quick guide to getting started with TinyOS and Avrora, the UCLA Mica2 simulator. The point is not to provide any new information but rather to avoid extraneous information. [1]

John Regehr says: I have started to work on a TinyOS debugging tutorial. It is just a skeleton so far. I would be more than happy to integrate pieces of text that are submitted to me. [2]

Meta-documentaiton for the Wiki site