From 80fceacc55bd95a4ed6f0ff869c72738953f8b4a Mon Sep 17 00:00:00 2001 From: janhauer Date: Thu, 29 Oct 2009 17:42:55 +0000 Subject: [PATCH] Updated all READMEs with an extra section that describes how a successful test is identified. Moved the TestPromiscuous application (it now uses the nonbeacon-enabled mode). --- .../beacon-enabled/TestAssociate/README.txt | 32 ++++++++----------- .../tkn154/beacon-enabled/TestData/README.txt | 16 +++++----- .../beacon-enabled/TestIndirect/README.txt | 13 ++++---- .../beacon-enabled/TestStartSync/README.txt | 15 ++++----- .../TestActiveScan/README.txt | 24 ++++++-------- .../TestAssociate/README.txt | 24 +++++++------- .../TestIndirectData/README.txt | 24 +++++--------- .../TestPromiscuous/Makefile | 0 .../TestPromiscuous/README.txt | 11 +++++++ .../TestPromiscuous/TestPromiscuousAppC.nc | 2 +- .../TestPromiscuous/TestPromiscuousC.nc | 0 11 files changed, 74 insertions(+), 87 deletions(-) rename apps/tests/tkn154/{beacon-enabled => nonbeacon-enabled}/TestPromiscuous/Makefile (100%) rename apps/tests/tkn154/{beacon-enabled => nonbeacon-enabled}/TestPromiscuous/README.txt (65%) rename apps/tests/tkn154/{beacon-enabled => nonbeacon-enabled}/TestPromiscuous/TestPromiscuousAppC.nc (97%) rename apps/tests/tkn154/{beacon-enabled => nonbeacon-enabled}/TestPromiscuous/TestPromiscuousC.nc (100%) diff --git a/apps/tests/tkn154/beacon-enabled/TestAssociate/README.txt b/apps/tests/tkn154/beacon-enabled/TestAssociate/README.txt index 94ad58ab..83cb0e68 100644 --- a/apps/tests/tkn154/beacon-enabled/TestAssociate/README.txt +++ b/apps/tests/tkn154/beacon-enabled/TestAssociate/README.txt @@ -4,25 +4,21 @@ Author/Contact: tinyos-help@millennium.berkeley.edu Description: In this application one node takes the role of a PAN coordinator in a -beacon-enabled 802.15.4 PAN; it transmits periodic beacons and waits for +beacon-enabled 802.15.4 PAN, it transmits periodic beacons and waits for devices to request association to its PAN. Whenever a device tries to -associate, the PAN coordinator allows association and assigns to the device a -unique short address (starting from zero, incremented for every device -requesting association). - -A second node acts as a device; it first scans the pre-defined channel for -beacons from the coordinator and once it finds a beacon it tries to associate -to the PAN and synchronize to and track all future beacons. A short time after -association the device then disassociates from the PAN. - -The third LED (Telos: blue) is toggled whenever the coordinator has transmitted -a beacon or whenever a device has received a beacon. On the coordinator the -second LED (Telos: green) is switched on whenever an association request was -successful and it is switched off, whenever a disassociation request was -received. On a device the second LED is switched on while the device is -associated to the PAN, i.e. it is switched off after disassociation. The first -LED (Telos: red) is used for debugging, it denotes an error in the protocol -stack and should never be on. +associate, the PAN coordinator accepts the association and assigns to the +device a unique short address (starting from zero, incremented for every device +new association). A second node acts as a device, it first scans the +pre-defined channel for beacons from the coordinator and once it finds a beacon +it tries to associate to the PAN and synchronize to and track all future +beacons. A short time after association the device then disassociates from the +PAN. + +Criteria for a successful test: + +Assuming one coordinator and one device has been installed, both should +simultaneously toggle (only) the second LED, about once every 5 seconds. + Tools: NONE diff --git a/apps/tests/tkn154/beacon-enabled/TestData/README.txt b/apps/tests/tkn154/beacon-enabled/TestData/README.txt index b767541b..50818c82 100644 --- a/apps/tests/tkn154/beacon-enabled/TestData/README.txt +++ b/apps/tests/tkn154/beacon-enabled/TestData/README.txt @@ -4,19 +4,19 @@ Author/Contact: tinyos-help@millennium.berkeley.edu Description: In this application one node takes the role of a PAN coordinator in a -beacon-enabled 802.15.4 PAN; it transmits periodic beacons and waits for -incoming DATA frames. A second node acts as a device; it first scans the +beacon-enabled 802.15.4 PAN, it transmits periodic beacons and waits for +incoming DATA frames. A second node acts as a device, it first scans the pre-defined channel for beacons from the coordinator and once it finds a beacon it tries to synchronize to and track all future beacons. It then starts to transmit DATA frames to the coordinator as fast as possible (direct transmission in the contention access period, CAP). -The third LED (Telos: blue) is toggled whenever the coordinator has transmitted -a beacon or whenever a device has received a beacon. On the coordinator the -second LED (Telos: green) is toggled for every 20 received DATA frames. On a -device the second LED is toggled for every 20 transmitted (and acknowledged) -DATA frames. The first LED (Telos: red) is used for debugging, it denotes an -error in the protocol stack and should never be on. +Criteria for a successful test: + +Assuming a clear channel and one coordinator and one device has been installed, +both should toggle (only) the second LED fast, about 5 times per second. They +don't have to toggle the LED simultaneously. + Tools: NONE diff --git a/apps/tests/tkn154/beacon-enabled/TestIndirect/README.txt b/apps/tests/tkn154/beacon-enabled/TestIndirect/README.txt index e25ab917..68122e6b 100644 --- a/apps/tests/tkn154/beacon-enabled/TestIndirect/README.txt +++ b/apps/tests/tkn154/beacon-enabled/TestIndirect/README.txt @@ -4,7 +4,7 @@ Author/Contact: tinyos-help@millennium.berkeley.edu Description: In this application one node takes the role of a PAN coordinator in a -beacon-enabled 802.15.4 PAN; it transmits periodic beacons and additionally in +beacon-enabled 802.15.4 PAN, it transmits periodic beacons and additionally in every beacon interval it tries to transmit one DATA frame to a device using indirect tranmission. A second node that takes the role of a device first scans the pre-defined channel for beacons from the coordinator and once it finds a @@ -12,12 +12,11 @@ beacon it tries to synchronize to and track all future beacons. Whenever the coordinator has data to send (indicated in the beacon), the device extracts the DATA frame from the coordinator. -The third LED (Telos: blue) is toggled whenever the coordinator has transmitted -a beacon, it is not used on the device. On the coordinator the second LED -(Telos: green) is toggled for every transmitted DATA frames. On a device the -second LED is toggled for every received DATA frame. The first LED (Telos: red) -is used for debugging, it denotes an error in the protocol stack and should -never be on. +Criteria for a successful test: + +Both nodes should simultaneously toggle (only) the second LED, about once every +half second. + Tools: NONE diff --git a/apps/tests/tkn154/beacon-enabled/TestStartSync/README.txt b/apps/tests/tkn154/beacon-enabled/TestStartSync/README.txt index 859c549b..3706469c 100644 --- a/apps/tests/tkn154/beacon-enabled/TestStartSync/README.txt +++ b/apps/tests/tkn154/beacon-enabled/TestStartSync/README.txt @@ -4,18 +4,15 @@ Author/Contact: tinyos-help@millennium.berkeley.edu Description: In this application one node takes the role of a PAN coordinator in a -beacon-enabled 802.15.4 PAN; it transmits periodic beacons with a frequency -defined in the app_profile.h file. A second node acts as a device; it first +beacon-enabled 802.15.4 PAN, it transmits periodic beacons with a frequency +defined in the app_profile.h file. A second node acts as a device, it first scans all available channels for beacons from the coordinator and once it finds a beacon it tries to synchronize to and track all future beacons. -The third LED (Telos: blue) is toggled whenever the coordinator has transmitted -a beacon or whenever a device has received a beacon. On the coordinator the -second LED (Telos: green) is switched on after it has started transmitting -beacons. On a device the second LED is switched on whenever the device is -synchronized to the coordinator's beacons. The first LED (Telos: red) is used -for debugging, it denotes an error in the protocol stack and should never be -on. +Criteria for a successful test: + +After a few seconds all nodes should have (only) their second LED turned on. + Tools: NONE diff --git a/apps/tests/tkn154/nonbeacon-enabled/TestActiveScan/README.txt b/apps/tests/tkn154/nonbeacon-enabled/TestActiveScan/README.txt index 588b609c..5990eae2 100644 --- a/apps/tests/tkn154/nonbeacon-enabled/TestActiveScan/README.txt +++ b/apps/tests/tkn154/nonbeacon-enabled/TestActiveScan/README.txt @@ -4,24 +4,18 @@ Author/Contact: tinyos-help@millennium.berkeley.edu Description: In this application one node takes the role of a PAN coordinator in a -nonbeacon-enabled 802.15.4 PAN; it switches its radio to receive mode. +nonbeacon-enabled 802.15.4 PAN, it switches its radio to receive mode. A +second node acts as a device, it switches to the pre-defined channel and +periodically performs active-scans (i.e. sends out beacon request frames) on +the predefined channel and expects beacon frames in return. -A second node acts as a device; it switches to the pre-defined channel and -performs active-scans on the predefined channel. +Criteria for a successful test: -A few basic parameters of this example can be adjusted through the -'app_profile.h' file. +On the coordinator node (only) the second LED should toggle once every 2 +seconds. On the device the second and third LED should toggle once every 2 +seconds, but with a small offset of half a second. On the device the first +LED may toggle, but this should happen very rarely. -Leds Coordinator: The first led (Telos: red) is used for debugging purposes -only and when switched on indicating an error in the protocol-stack. The -second led (Telos: green) flashes when an active scan, more exactly a -beacon-request, is received by the coordinator. - -Leds Device: The third led (Telos: blue) is activated for a second whenever an -active-scan is performed. Shortly after that the second or the first led -flashes. The second led (Telos: green), indicating that the coordinator -defined in the 'app_profile.h' where found in that scan. The first led if -either no devices or only no matching devices where found within the scan. Tools: NONE diff --git a/apps/tests/tkn154/nonbeacon-enabled/TestAssociate/README.txt b/apps/tests/tkn154/nonbeacon-enabled/TestAssociate/README.txt index 5a715ced..211fcf75 100644 --- a/apps/tests/tkn154/nonbeacon-enabled/TestAssociate/README.txt +++ b/apps/tests/tkn154/nonbeacon-enabled/TestAssociate/README.txt @@ -4,22 +4,20 @@ Author/Contact: tinyos-help@millennium.berkeley.edu Description: In this application one node takes the role of a PAN coordinator in a -nonbeacon-enabled 802.15.4 PAN; it switches its radio to receive mode and waits +nonbeacon-enabled 802.15.4 PAN, it switches its radio to receive mode and waits for devices to request association to its PAN. Whenever a device tries to associate, the PAN coordinator allows association and assigns to the device a unique short address (starting from zero, incremented for every device -requesting association). - -A second node acts as a device; it switches to the pre-defined channel and -tries to associate to the PAN. A short time after association the device then -disassociates from the PAN. - -On the coordinator the second LED (Telos: green) is switched on whenever an -association request was successful and it is switched off, whenever a -disassociation request was received. On a device the second LED is switched on -while the device is associated to the PAN, and it is switched off after -disassociation. The first LED (Telos: red) is used for debugging, it denotes an -error in the protocol stack and should never be on. +requesting association). A second node acts as a device, it switches to the +pre-defined channel and tries to associate to the PAN. A short time after +association the device then disassociates from the PAN. + +Criteria for a successful test: + +Assuming one coordinator and one device has been installed, both should +simultaneously switch on (only) the second LED. About 5 seconds later +both should switch off the second LED. + Tools: NONE diff --git a/apps/tests/tkn154/nonbeacon-enabled/TestIndirectData/README.txt b/apps/tests/tkn154/nonbeacon-enabled/TestIndirectData/README.txt index ab726cb3..b91a5808 100644 --- a/apps/tests/tkn154/nonbeacon-enabled/TestIndirectData/README.txt +++ b/apps/tests/tkn154/nonbeacon-enabled/TestIndirectData/README.txt @@ -4,25 +4,17 @@ Author/Contact: tinyos-help@millennium.berkeley.edu Description: In this application one node takes the role of a PAN coordinator in a -nonbeacon-enabled 802.15.4 PAN; it switches its radio to receive mode and -creates a packet which is addressed to the predefined address of the device. -This packet is marked as indirect transmissions, therefore queued and sent only -after explicit poll of the device. After a successful transmission another -packet is created after a definite time. - -A second node acts as the device; it switches to the pre-defined channel and -polls the coordinator in predefined intervals for outstanding indirect +nonbeacon-enabled 802.15.4 PAN, every 3 seconds it sends a packet to a device +using indirect transmission (i.e. the packet is buffered until it is polled by +the device). A second node acts as the device, it switches to the pre-defined +channel and polls the coordinator every 1 second for outstanding indirect transmissions. -A few basic parameters of this example can be adjusted through the -'app_profile.h' file. +Criteria for a successful test: -Leds: On the coordinator the second LED (Telos: green) flashes whenever a -packet for an indirect transmission is created and queued. When this packet -has not been polled by the device within the transaction time, the packet is -discarded which is displayed by the first led (Telos: red). On the device the -third LED (Telos: blue) flashes when after a poll of the coordinator an -indirect transmission arrives. +Assuming one coordinator and one device has been installed, the coordinator +should briefly flash the second LED every 3 seconds. The device should briefly +flash its third LED every 1 second. Tools: NONE diff --git a/apps/tests/tkn154/beacon-enabled/TestPromiscuous/Makefile b/apps/tests/tkn154/nonbeacon-enabled/TestPromiscuous/Makefile similarity index 100% rename from apps/tests/tkn154/beacon-enabled/TestPromiscuous/Makefile rename to apps/tests/tkn154/nonbeacon-enabled/TestPromiscuous/Makefile diff --git a/apps/tests/tkn154/beacon-enabled/TestPromiscuous/README.txt b/apps/tests/tkn154/nonbeacon-enabled/TestPromiscuous/README.txt similarity index 65% rename from apps/tests/tkn154/beacon-enabled/TestPromiscuous/README.txt rename to apps/tests/tkn154/nonbeacon-enabled/TestPromiscuous/README.txt index 777d18e1..9377938d 100644 --- a/apps/tests/tkn154/beacon-enabled/TestPromiscuous/README.txt +++ b/apps/tests/tkn154/nonbeacon-enabled/TestPromiscuous/README.txt @@ -10,6 +10,17 @@ signalled to the upper layer. The application uses the TinyOS printf library every received frame over the serial port. The second (TelosB: green) LED is toggled whenever a frame is received. +Criteria for a successful test: + +A successful test means that for every received frame the second LED is toggled +and the java application outputs some text. To see this effect you need a +second node sending a packet. The TestPromiscuous application does not send +packets, but you can, for example, use the +../../beacon-enabled/TestStartSync/coordinator application to send periodic +beacon packets. In this case you should see some new text and the second LED +should toggle every half second. + + Tools: The printf java client in $TOSDIR/../apps/tests/TestPrintf Usage: diff --git a/apps/tests/tkn154/beacon-enabled/TestPromiscuous/TestPromiscuousAppC.nc b/apps/tests/tkn154/nonbeacon-enabled/TestPromiscuous/TestPromiscuousAppC.nc similarity index 97% rename from apps/tests/tkn154/beacon-enabled/TestPromiscuous/TestPromiscuousAppC.nc rename to apps/tests/tkn154/nonbeacon-enabled/TestPromiscuous/TestPromiscuousAppC.nc index c771d29d..fd752f0d 100644 --- a/apps/tests/tkn154/beacon-enabled/TestPromiscuous/TestPromiscuousAppC.nc +++ b/apps/tests/tkn154/nonbeacon-enabled/TestPromiscuous/TestPromiscuousAppC.nc @@ -37,7 +37,7 @@ configuration TestPromiscuousAppC { } implementation { components MainC, TestPromiscuousC as App, LedsC, - Ieee802154BeaconEnabledC as MAC; + Ieee802154NonBeaconEnabledC as MAC; MainC.Boot <- App; App.Leds -> LedsC; diff --git a/apps/tests/tkn154/beacon-enabled/TestPromiscuous/TestPromiscuousC.nc b/apps/tests/tkn154/nonbeacon-enabled/TestPromiscuous/TestPromiscuousC.nc similarity index 100% rename from apps/tests/tkn154/beacon-enabled/TestPromiscuous/TestPromiscuousC.nc rename to apps/tests/tkn154/nonbeacon-enabled/TestPromiscuous/TestPromiscuousC.nc -- 2.39.2