Running the CETK

CETK Setup

On your development workstation, you can run the Windows Embedded CE 6.0 Test Kit (CETK) tool at any time. For more information, see Running the CETK Tool on the Development Workstation.
To connect the CETK tool to a target device, and then run CETK tests, the target device must support the CETK. A target device that supports the CETK has a copy of the CETK client software, Clientside.exe. You must also configure a connection between the CETK tool and the target device.
You can use Platform Manager to copy Clientside.exe to the target device, and then connect the CETK to the target device. For more information, see Connecting the CETK to a Target Device by Using Platform Manager. Alternatively, you can manually run Clientside.exe on the target device. For more information, see Manual Connection of the CETK to a Target Device.

Running the CETK Tool on the Development Workstation

On the development workstation, you can run the Windows Embedded CE 6.0 Test Kit (CETK) tool at any time. When you run the CETK tool, a window for the CETK opens. In the window for the CETK, a tree-view control displays the target devices with which you have established a connection. The tree-view control is empty if you have not established a connection with a target device.
For information about establishing a connection to a target device, see Connecting the CETK to a Target Device by Using Platform Manager.
To run the CETK tool on the development workstation:
* Choose Start, and then choose All Programs.
* Choose Microsoft Windows Embedded CE 6.0, and then choose Windows Embedded CE 6.0 Test Kit.

Connecting the CETK to a Target Device by Using Platform Manager

Using Platform Manager, you can download to a target device the appropriate Clientside.exe file for the CPU. You can specify whether the Windows Embedded CE 6.0 Test Kit (CETK) uses Platform Manager or Winsock to communicate with the target device after Platform Manager downloads Clientside.exe.
Alternatively, you can connect the CETK to a target device manually. For information about manually establishing a connection, see Running the CETK Tool without the CETK Client in the Run-Time Image.

To connect the CETK to a target device by using Platform Manager:
* In the CETK window, from the Connection menu, choose Start client.
* To instruct the CETK to communicate with the target device by using Platform Manager, clear the Use Windows Sockets for the client/server communication check box.
- or -
To instruct the CETK to communicate with the target device by using Winsock, select the Use Windows Sockets for the client/server communication check box.
"Note: Regardless of the state of the Use Windows Sockets for the client/server communication check box, when you choose Connect, the CETK downloads Clientside.exe to the target device by using Platform Manager. "
* Choose Settings to configure Platform Manager.
* In the Windows Embedded CE Platform Manager Configuration dialog box, you can configure Platform Manager to communicate with the target device. For information about configuring this connection, see Configuring a Core Connection to a Target Device.
* Choose OK to close the Windows Embedded CE Platform Manager Configuration dialog box.
* Choose Connect.
* Select a target device, and then choose OK.

Manual Connection of the CETK to a Target Device

Adding Support for the CETK to an OS Design in Platform Builder

Before you use the Windows Embedded CE 6.0 Test Kit (CETK), the run-time image for the target device that you want to test must support the CETK. In Platform Builder, you can add support for the CETK to an operating system (OS) design before you build the run-time image.

To add support for the CETK to an OS design in Platform Builder:
* In the Catalog, select the checkboxes next to the items you wish to add, or right-click on the item and select Add.
* From the Build menu under Global Build Settings, verify that Copy Files to Release Directory after Build and Make Run-Time Image after Build are selected.
* From the Build OS menu, choose Build Solution to build the run-time image.
* After the run-time image builds, download the run-time image to a target device.
You can dynamically add support for the CETK to a target device that has a run-time image built without support for the CETK. For more information, see Running the CETK Tool without the CETK Client in the Run-Time Image.

After you download the run-time image to the target device, you can run the CETK client software on the downloaded run-time image. For more information, see Running the CETK Client on a Target Device Connected to Platform Builder.

Configuring the CETK to Communicate with a Target Device

For the Windows Embedded CE 6.0 Test Kit (CETK) to communicate successfully with a target device, the port number specified in the CETK application on the development workstation must match the port number specified for the target device. After you configure the port number settings, you can start the Clientside.exe application on the target device and establish a connection.

For information about supporting the CETK on your Windows Embedded CE–based device, see Manual Connection of the CETK to a Target Device.

To configure the CETK to communicate with a target device:
1. In the CETK window, from the Server menu, choose Server Settings, and then choose the Communications tab.
2. In the Port to use to connect to a target device box, type the number of a port for the CETK to use to communicate with the target device.
- or -
Leave the default value in the Port to use to connect to a target device box.
Port 5555 is the default port over which the CETK communicates. If you build support for the CETK into a run-time image, the target device is also configured by default to use port 5555.
3. To close the Server Settings dialog box and save your changes, choose OK.
4. If you do not plan to specify a command line parameter when you run Clientside.exe, configure Clientside.exe by editing the Wcetk.txt file in the release directory for your platform.

"Note: If you add support for the CETK to the target device by manually copying Clientside.exe to the target device, no Wcetk.txt file exists in the release directory. If you want to use Wcetk.txt, you must create a Wcetk.txt file in the release directory. For information about the contents of Wcetk.txt and to view the contents of a sample Wcetk.txt file, see Wcetk.txt and Clientside.exe Settings for the CETK. "

In Wcetk.txt, add a PORTNUMBER=XXX line, where XXX is the number of the port that you specified in the Server Settings dialog box. If there is an existing PORTNUMBER line, delete it, and then save Wcetk.txt.
- or -
Specify settings in the registry for the target device. In the
""HKEYLOCALMACHINE\SOFTWARE\Microsoft\CETT"" registry key, create a PortNumber entry with a value that matches the number of the port that you specified in the Server Settings dialog box.

For more information, see Wcetk.txt and Clientside.exe Settings for the CETK.
5. If a Windows Embedded CE OS is not already running on the target device, download your run-time image to the target device. Boot the run-time image on the target device.
6. On the target device, run Clientside.exe. If you did not specify a port number in Wcetk.txt or in the registry for the target device, run the command Clientside /p XXX, where XXX is the number of the port that you specified in the Server Settings dialog box.
- or -
In Platform Builder, from the Target menu, choose Run Programs, select Clientside.exe, and then choose Run.
7. To confirm that you have established communication with the target device, view the CETK window, and then, under Windows Embedded CE Test Server, view the target device.
It might take a few seconds for communication to be established with the target device.

Running the CETK Client on a Target Device Connected to Platform Builder

After you download a run-time image built from an operating system (OS) design that supports the Windows Embedded CE 6.0 Test Kit (CETK), you can run the CETK client software on the downloaded run-time image. For information about adding support for the CETK to an OS design, see Adding Support for the CETK to an OS Design in Platform Builder.
To run the CETK client software on a target device connected to a development workstation running Platform Builder:
1. In the Platform Builder integrated development environment (IDE), from the Target menu, choose Run Programs.
2. Select Clientside.exe, and then choose Run.
For information about running the CETK tool when the CETK client software is not already in included in the run-time image, see Running the CETK Tool without the CETK Client in the Run-Time Image.

Running the CETK Tool without the CETK Client in the Run-Time Image

You can dynamically add support for the Windows Embedded CE 6.0 Test Kit (CETK) to a target device that has a run-time image built without support for the CETK.

To run the CETK tool with a run-time image that does not already include the CETK client software:
1. Run the CETK tool on the development workstation.
For more information, see Running the CETK Tool on the Development Workstation.
2. Copy the Clientside.exe file to your Windows Embedded CE-based device.
On the development workstation, Clientside.exe is located at %_WINCEROOT%\Others\Wcetk\<CPU>.
3. On your Windows Embedded CE-based device, from the Start menu, choose Run, and then type the location of Clientside.exe followed by the name and port number of the development workstation running the CETK tool.
For example, by typing clientside /n=machine1 /p=5555, you can run Clientside.exe and connect to machine1 using port number 5555. If you edit the command line for Clientside.exe in this fashion, you must specify at least a server name or address and a port number. For more information about command-line options for Clientside.exe, see Wcetk.txt and Clientside.exe Settings for the CETK.
- or -
Edit the Wcetk.txt file located in the directory in which Clientside.exe resides. Platform Builder creates a Wcetk.txt file in the release directory for your operating system (OS) design if you add support for the CETK to the OS design prior to building the run-time image. For more information about settings in the Wcetk.txt file, see Wcetk.txt and Clientside.exe Settings for the CETK.
- or -
Create a HKEYLOCALMACHINE\SOFTWARE\Microsoft\CETT registry key on the target device, or modify this registry key, if it already exists. Clientside.exe reads settings from this registry key only if both command line options and Wcetk.txt are not found.
On the development workstation, you can modify the registry of the target device by editing the Common.reg file or Platform.reg file, or by editing the Project.reg file for your OS design. Because the settings in Project.reg are specific to the OS design, you can edit Project.reg without affecting the overall behavior of Platform Builder. The settings in Common.reg and Platform.reg affect all OS designs on the development workstation.
When you build a run-time image, the information from the .reg file is built into the run-time image. Alternatively, you can use the Remote Registry Editor tool to modify the registry of a target device while the target device runs.
For information about registry keys for Clientside.exe, see Wcetk.txt and Clientside.exe Settings for the CETK.

Wcetk.txt and Clientside.exe Settings for the CETK

The Windows Embedded CE 6.0 Test Kit (CETK) requires a minimal number of SYSGENs to be present in the operating system of the Windows Embedded CE-based device in order for Clientside.exe to run properly. The following table shows the minimal required SYSGENs and their location in the catalog.

SYSGEN Name: Common name	Location in the catalog
SYSGEN_SHELL: Target Control Support	%OSDesignName%\Core OS\CEBASE\Core OS Services\Kernel Functionality
SYSGEN_DEVICE: Device Manager	%OSDesignName%\Core OS\CEBASE\Core OS Services\
SYSGEN_LOCUSA: English (US) National Language Support only	%OSDesignName%\Core OS\CEBASE\International\Locale Services

The Windows Embedded CE 6.0 Test Kit (CETK) searches for a Wcetk.txt file when you specify no command line options for Clientside.exe. The CETK searches first for Wcetk.txt in the root directory and the Windows directory on the target device. If the CETK does not find Wcetk.txt in either of these locations, it searches for the file in the release directory on the development workstation.
The following table shows the settings that you can specify in a Wcetk.txt file. For each setting, the table also shows the equivalent command line option for Clientside.exe and the equivalent registry entry on the target device. The registry location for these is HKLM/Software/Microsoft/CETT.

Wcetk.txt setting	Equivalent Clientside.exe option	Equivalent target device registry entry	Description
SERVERNAME	/n	ServerName, with REG_SZ data type.	Computer name of the CETK server. The computer name must resolve to an Internet Protocol (IP) address. You cannot specify both SERVERNAME and SERVERIP for the CETK server.
SERVERIP	/i	ServerIP, with REG_SZ data type.	IP address of the CETK server. You cannot specify both SERVERNAME and SERVERIP for the CETK server.
PORTNUMBER	/p	PortNumber, with REG_DWORD data type.	Number of the port over which the CETK server communicates with the target device. You can find the port number in the Server Settings dialog box. For more information, see Configuring the CETK to Communicate with a Target Device.
AUTORUN	/a	Autorun="1", with REG_SZ data type.	When this setting in Wcetk.txt is assigned a value of 1, the target device automatically starts running tests after the connection to the CETK server is established and detection of peripheral devices completes. If you specify in Wcetk.txt any value not equal to 1, the target device connects and peripheral devices are detected, but tests do not launch without manual input. Use the /a option in the command line for Clientside.exe to specify that the target device should automatically run tests after the connection to the CETK server is established and detection of peripheral devices completes. Do not specify a value for the /a option in the command line.
DEFAULTSUITE	/s	DefaultSuite, with REG_SZ data type.	Name of a test suite. If you do not specify a test suite, the default tests are selected. For more information about test suites, see Creating a Suite of Tests.
AUTOEXIT=1	/x	Autorun="1", with REG_SZ data type.	Automatically exits after tests are complete.
DRIVERDETECT=0	/d	DriverDetect="0"	This setting turns off automatic driver detection, which is on by default. For the Wcetk.txt and registry settings, any value other than 0 indicates that the driver autodetect remains on.

The following text shows the contents of a sample Wcetk.txt file.

		 [SERVERNAME=MyWorkstation]
		 PORTNUMBER=5555
		 AUTORUN=0
		 DEFAULTSUITE=My Suite
		 ; Add comment here

Specifying a Directory to Store Files Required by CETK Tests

You can specify which directory on the target device stores files required by a Windows Embedded CE 6.0 Test Kit (CETK) test or tool. The CETK also stores in this directory the file that contains the results of each test.

By default, the CETK stores files in the root directory of the target device. You might want to specify a different location, if there is insufficient free space at the default location.

You can specify a path to be used by all target devices that connect to the CETK. You can also specify a path for a single target device. If you specify a path for a single target device, the path that you specify for the target device overrides the path specified for all target devices.

Prior to starting a CETK test or tool, on the target device, create the directory that you specified. If you do not create the directory and the directory does not already exist, the CETK test or tool cannot run.

To specify a directory for all target devices to store files required by CETK tests:
1. From the Server menu, choose Server Settings.
2. Choose the Device-Side Files tab.
3. In the Folder on target device in which to store files for tests box, type a path.
4. Choose OK.

To specify a directory for a single target device to store files required by CETK tests:
1. Right-click on the target device name, and then choose Device-Side Files.
2. Choose On this target device only, store files for tests in this folder, and then in the box, type a path.
3. Choose OK.

Note: The CETK temporarily stores the path that you specify for a single target device. You must specify the path again, if you close and then open the CETK window, disconnect the target device from the CETK server, or choose Redetect Peripherals for the target device.

Choosing a Way to Store Test Results

You can encrypt the results of a Windows Embedded CE 6.0 Test Kit (CETK) test. With encryption, you can prepare the results of a test for submission to the Driver Validation Program. For more information about the Driver Validation Program, see this Microsoft Web site. You can also group the results of multiple tests into a single cabinet (.cab) file. The following procedures show how to enable encryption and enable the creation of a .cab file.

To encrypt the results of a test:
1. From the Server menu, choose Server Settings.
2. Choose the Test Results tab.
3. Select the Encrypt test results check box, and then choose OK.

To group the results of one or more tests into a .cab file:
1. From the Server menu, choose Server Settings.
2. Choose the Test Results tab.
3. Select the Consolidate test results into a cabinet (.cab) file after tests complete check box, and then choose OK.

Selecting a Directory to Store Test Results

You can specify a directory on your development workstation where you can store the results of tests that you run with the Windows Embedded CE 6.0 Test Kit (CETK).

To select a directory to store test results:
1. In the CETK window, from the Server menu, choose Server Settings, and then choose the Test Results tab.
2. In the Folder in which to store the results of a test box, type the path of the directory where you want the CETK to store test results.
- or -
Choose Browse, select a directory, and then choose OK.
3. Choose OK to close the Server Settings dialog box and save your changes.

Running CETK Tests

After you select the tests that you want to run on a target device in the Windows Embedded CE 6.0 Test Kit (CETK) window, you are ready to launch the tests on the target device.

When you run a test, the CETK copies files to the root directory of the target device. The size of the files copied to the target device varies by test. To run a test, you must allocate sufficient free space in the root directory of the target device to accommodate the files that are copied to the target device. For more information about the size of the files copied to the target device by each test, see the test-specific information for each of the CETK Tests.

The following procedure shows how to run the tests that you selected. After you launch the tests, the tests run automatically and sequentially.

To run selected tests on your target device:
1. Right-click on the test kit that is active for the target device, and then choose Start Tests.
- or –
From the Tests menu, choose Start/Stop tests, and then choose the target device.

You can also run a single test on a target device without running other tests that are selected for the target device. The following procedure shows how to run a single test.

To run a test on a target device without running other selected tests:
1. Right-click on the test, and then choose Quick Start.

Many of the tests prompt you to complete an action on the target device. Follow the instructions on the display of the target device to complete the tests. For more information about each test, see CETK Tests.

Running a Single Test in the CETK

After you connect to a target device with the Windows Embedded CE 6.0 Test Kit (CETK), you can individually run a CETK test from the active test kit on the target device.

To run a single test in the CETK:
1. In the CETK window, in the tree-view control, expand the node for the target device on which you want to run a test.
2. Under the node for the target device, choose a test kit.
3. In the tree-view control for the chosen test kit, expand a category.
4. Right-click on the test, and then choose Quick Start.
For information about viewing the results of the test, see Viewing the Results of a Test.

Viewing the Results of a Test

After you finish running tests, you can view the results of a test. You cannot view the results of a test for a particular target device while tests run on the same target device.

To view the results of a specific test after all tests have completed:
1. Right-click on the test whose results you want to view, and then choose View Results.
- or -
From the Tests menu, choose View Results, choose a target device, choose a peripheral device, and then choose the test whose results you want to view.

Editing the Command Line for a Test

You can edit the command line for a test to modify the behavior of the test. For information about the command line options for each test, see CETK Tests. For more information about the command line options that Tux supports, see Tux Command Line Parameters.

To edit the command line for a test :
1. In the Windows Embedded CE 6.0 Test Kit (CETK) window, right-click the test for which you want to modify the command line, and then choose Edit Command Line.
2. In the Command line box, add any options that the test supports to the command line.
3. Choose Temporarily, to this target device to temporarily apply the change only to the target device with which you are working.
- or -
Choose Permanently, to all devices to permanently apply the change to all instances of the test in the CETK window.
4. Choose OK.

Note: The CETK tool automatically appends the -f logfile option to the command line when a test runs. This command line entry stores the results of the test in a log file. You should not add your own –f switch to the command line.

If you decide that you want to undo the changes that you made to the command line for a test, you can revert to the default command line for the test.

To revert to the default command line for a test:
1. In the CETK window, right-click the test for which you want to revert the command line to the default command line, and then choose Edit Command Line.
2. Choose Restore.
3. Choose OK.

Go up to BSP Exit Criteria
Go up to Big Book of BSP