TinyOS Documentation

From TinyWiki

This the TinyOS Documentation Wiki, the purpose of which is to produce a reference and user's manual for TinyOS. Hopefully an interactive mode will allow us to gradually build up a manual that's useful and current.

Contents

All of the following are forms of presentation, all of which could be useful -- but not all of which may be necessary. They need to be worked on and filled out.

1. Users' Manual
   1. Tutorial - How to get started in TinyOS
   2. How to use TinyOS
      1. Setup & Installation
      2. Platform specific issues
   3. FAQ
      • There should probably be several of these.
2. Developers' Manual
   • How to program/develop for TinyOS
   • NOT an API reference: an abstract design manual.
   1. Design
      1. Concepts - High level abstractions which are necessary to understand the system.
      2. Systems - Specific subsystems
      3. Applications - Applications bundled with the system
      4. Hardware - Descriptions of hardware.
   2. Cookbook
      • Common tasks in TinyOS and how to carry them out.
3. Reference Manual
   • Formal specifications
   • APIs
     • Specific interface and component breakdown. Reflects actual code.
   • Build system
   • Testing system
   • Glossary
     • A collection of TinyOS terms, in alphabetical order