Difference between revisions of "TinyOS Documentation Wiki"

From TinyOS Wiki
Jump to: navigation, search
(Various TinyOS Tools)
(Restructure the page to make it more readable.)
Line 1: Line 1:
This is the new Wiki site for the TinyOS Documentation Working Group.
+
This is the TinyOS Documentation Wiki. 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''').<br>
Everyone is welcome to edit these pages and contribute TinyOS documentation.<br>
 
In order to edit, you must first create an account, using the link on the upper right ('''Login / create account''').<br>
 
 
Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.<br>
 
Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.<br>
 
<br>
 
<br>
= 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 [[Special:Allpages| 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 [http://meta.wikimedia.org/wiki/Help:Contents User's Guide].
+
= Documentation =
  
We prefer all documentation to live on this site, rather than having links to external sites, but external links are OK too.
+
[[Getting started]]: downloading and installing TinyOS<br>
 +
[[Using TinyOS]]: tutorials and programming guides<br>
 +
[[Platform Hardware]]: layouts, chips, and other details<br>
 +
[[Other]]: Other documentation<br>
 +
[[Special:Allpages|Index]]: all of the available pages on this site<br>
 +
[http://www.google.com/coop/cse?cx=000490616372089452102%3Ajdf9nzpy7se Search engine]: search TinyOS documentation and mailing lists
 +
[[WikiDoc]]: wiki documentation
  
== TinyOS Search Engine ==
+
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 [http://meta.wikimedia.org/wiki/Help:Contents User's Guide].
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.
 
  
[http://www.google.com/coop/cse?cx=000490616372089452102%3Ajdf9nzpy7se Click here for the TinyOS Custom Search Engine]
+
We prefer all documentation to live on this site, rather than having links to external sites, but external links are OK too.
 
 
== Installing TinyOS ==
 
 
 
* [[Windows_Installation| Linux / Windows]]
 
** [[java_cygwin | Common Java problems on Cygwin]]
 
** [http://www.isis.vanderbilt.edu/projects/NEST/tinyos-2.x-iris/doc/html/install-tinyos-iris.html Updating external tools to support the IRIS mote]
 
* [http://gentoo-wiki.com/TinyOS Installing TinyOS on Gentoo]
 
* [http://www.5secondfuse.com/tinyos/install.html Installing TinyOS on Ubuntu] [http://hi.baidu.com/vvfang/blog/item/e2dfa4126bd9adcdc3fd789c.html Chinese Version]
 
* [http://toilers.mines.edu/Public/XubunTOS Installing TinyOS on XubunTOS]
 
* [[Installing a XubunTOS Virtual Machine on VMWare Server]]
 
* [[Running a XubunTOS Virtual Machine Image in VMware Player]]
 
* [[Installing tinyos-2.x on Mac OS X (Tiger & Leopard) | Installing TinyOS on Mac OS (Tiger & Leopard)]]
 
 
 
== Programming Tutorials ==
 
 
 
* [[TinyOS_Tutorials|Tutorials on Getting Started with TinyOS Programming]]
 
* [[Boomerang|Boomerang and Tmote Resources from Moteiv]]
 
* [http://www.tinyos.net/tinyos-2.x/doc/pdf/tinyos-programming.pdf TinyOS Programming Manual]
 
* [[TUnit|TUnit TinyOS Unit Testing]]
 
* [[OpenOCD for IMote2 | Programming IMote2 with OpenOCD]]
 
 
 
== Hardware Platforms ==
 
 
 
* [[TMote Sky|TMote Sky, a.k.a. Telos Rev B]]
 
* [[Kmote|Kmote, a.k.a. Telos Rev B]]
 
* [[MicaZ]]
 
* [[Mica2]]
 
* [[Mica2dot]]
 
* [[NXTMOTE|NXTMOTE - TinyOS on LEGO MINDSTORMS NXT]]
 
* [[Intel SHIMMER]]
 
* [[Imote2]]
 
 
 
== Software Libraries and Drivers ==
 
 
 
* [[CC2420|CC2420 Radio Stack]]
 
* [[CC1100/CC2500|CC1100/CC2500 Radio Stack]]
 
 
 
== Sensorboards ==
 
 
 
* [[MTS420|MTS420 Sensorboard: Mica Family of Motes]]
 
 
 
== Various TinyOS Tools ==
 
* [[NESCDT- An editor for nesC in Eclipse]]
 
 
 
== Other Documents ==
 
* [[Contributing Code to TinyOS]]
 
* [[TinyOS 2.x index of contributed code]]
 
* [[TinyOS TODO List]]
 
* [[Frequently Asked Questions (FAQs)| Frequently Asked Questions (FAQs)]]
 
* [[Wishlist: Ports from TinyOS-1.x to TinyOS-2.x | Wishlist: Ports from TinyOS-1.x to TinyOS-2.x]]
 
* [http://www.cs.utah.edu/~regehr/tos_avrora.html Using TinyOS with the Avrora Simulator]
 
* [http://www.cs.utah.edu/~regehr/debugging_tinyos/ TinyOS Debugging Tutorial]
 
* [http://homepages.dcc.ufmg.br/~bpires/tutorials/tutorial/ Tutorial on setting up a complete TinyOS 2.x Network]
 
* [http://homepages.dcc.ufmg.br/~bpires/tutorials/manuals/ Some Datasheets]
 
* [http://homepages.dcc.ufmg.br/~bpires/tutorials/dossie Tutorial in Portuguese]
 
* [http://hi.baidu.com/vvfang/blog/category/Tinyos%20Related Study Notes in Chinese]
 
* [http://tinyos.cvs.sourceforge.net/*checkout*/tinyos/tinyos-2.x/doc/html/tep131.html Creating a New Platform for TinyOS 2.x]
 
* [http://www.btnode.ethz.ch/Projects/SensorNetworkMuseum Nice summarization and overview of various sensor network platforms and related components]
 
 
 
== 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 =
 
 
 
* [http://www.mediawiki.org/wiki/Help:Configuration_settings Configuration settings list]
 
* [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ]
 
* [http://mail.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
 

Revision as of 13:43, 27 June 2008

This is the TinyOS Documentation Wiki. 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.

Documentation

Getting started: downloading and installing TinyOS
Using TinyOS: tutorials and programming guides
Platform Hardware: layouts, chips, and other details
Other: Other documentation
Index: all of the available pages on this site
Search engine: search TinyOS documentation and mailing lists WikiDoc: wiki documentation

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.