From 5c593edf83bd7b91743c5200144ff72f0860e2b7 Mon Sep 17 00:00:00 2001
From: scipio 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 TinyOS 2.0 has four 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.<.p>
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. 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. In addition, there are several TEPs which deal with issues besides TinyOS code, such
+ as the structure of the TinyOS Alliance and design considerations: In addition to TEPs, which document the organization and design
- behind important parts of TinyOS, there is also source code
+ In addition to TEPs, which document the organization and design
+ behind important parts of TinyOS, there is also source code
documentation.
TinyOS 2.0 Documentation
-
-
-
Release Notes
+ 1. Release Notes
@@ -43,34 +49,38 @@
-
Tutorials
+ 2. Tutorials
-
TEPs
+ 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.
+ 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:
@@ -94,18 +104,31 @@
+
+
-
TinyOS Source Code Documentation
+ 3B. TinyOS Source Code Documentation
@@ -125,9 +148,6 @@
-