|
TinyOS 2.0 Documentation Last Modified: October 27 2006
|
|
There are three classes of TinyOS 2.0 documentation. The first class includes release notes and high-level overviews of the system. The second is a series of tutorials. The third is a set of TEPs (TinyOS Enhancement Proposals), which document and describe major OS abstractions and subsystems and source code documentation from the javadoc and nesdoc tools |
| Release Notes |
| Tutorials |
TinyOS 2.0 has a few tutorials to get a new user started with programming the system. These tutorials introduce nesC programming and some major TinyOS abstractions, such as timers and communication. Additionally, for more advanced programming, there is a TinyOS Programming Manual. The book describes nesC's features in greater detail, including generic components, concurrency, and common component design patterns. |
| TEPs |
TEPs are written in ReStructured Text, and so can be read
either as HTML or as a text document. TEP 1 describes the
different kinds of TEPs and their roles. TEPs 1-100 are
BCP (Best Current Practice) TEPs, while TEPS 101+ are
Informational, Documentary, or Experimental. Currently,
many TEPs are Drafts: comments and feedback to the
authors or the associated working group is welcome.
|
| TinyOS Source Code Documentation |
|
In addition to TEPs, which document the organization and design
behind important parts of TinyOS, there is also source code
documentation. |
| TinyOS Java toolchain Code Documentation |
|
There is similar javadoc documentation for the Java toolchain, which describes the Java classes and their functionality. This documentation is incomplete. |