X-Git-Url: https://oss.titaniummirror.com/gitweb/?a=blobdiff_plain;f=doc%2Findex.html;h=8dbb0775bc889337ae5be84672e99e34f627d6c9;hb=8f518234a9b7b54aaec02810b7d5f5d071702a47;hp=e482e6cbae217d3a9b3289c23347f4428dec5c78;hpb=e375f4f25e4f47409d09d6a13f57aff159c20886;p=tinyos-2.x.git diff --git a/doc/index.html b/doc/index.html index e482e6cb..8dbb0775 100644 --- a/doc/index.html +++ b/doc/index.html @@ -1,135 +1,166 @@ - + + + +
+
+ TinyOS 2.0.2 Documentation + Last Modified: Jul 30 2007
+ |
+
+ + This is the documentation for the TinyOS 2.0.2 release. + There is also documentation for versions 2.0.1, 2.0.0 and 1.x. + ++ TinyOS 2.0 has three sets of documentation. The first + set is the release notes and high-level overviews of the + system. The second set is a series of tutorials and a + TinyOS programming manual, which explore different parts + of the system in order to help you get started. The third + set is detailed documentation of the system, including TEP + (TinyOS Enhancement Proposals), which describe the + structure, design goals, and implementation of parts of + the system as well as nesC and Java source code + documentation. + ++ If you're just getting started, the best place to start is with the + tutorials. + + |
+
- 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 | -
+ |
1. Release Notes | +
|
-
Tutorials | -
TinyOS 2.0 has a few tutorials to get a new user started with programming + |
2. 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.
- - + |
3A. TEPs and source code documentation | +
+ + 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. The following TEPs are Documentary and + BCP: they deal with TinyOS, its protocols, and its + programming interfaces: +
- |
-
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 | -
-
+ In addition, there are several TEPs which deal with issues besides TinyOS code, such + as the structure of the TinyOS Alliance and design considerations: + + |
+
3B. 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 for the following platforms: + eyesIFXv2, + mica2, + mica2dot, + micaz, + telosb and + telosb and + tinynode. + |
+
3C. TinyOS Java toolchain Code Documentation | +
There is similar - javadoc documentation for the Java toolchain, + javadoc documentation for the Java toolchain, which describes the Java classes and their functionality. This documentation is incomplete. - - - |
-
- |