Connect to Device Dialog

If you use BitBar and there is no BitBar API key specified in the current TestComplete project, enter the API key you will use to run tests and click Apply.

Learn how to get the API Key

Learn how to get the API KeyLearn how to get the API Key

1. Log in to BitBar with your BitBar account.

   If you still do not have a BitBar account, you can sign up for a free trial.

2. Click  > My Account at the top right of the page.

3. In the My Integrations section, click API.

4. On the resulting page, click to copy your API key to the clipboard.

Click the image to enlarge it.

If you use a private mobile cloud, click Local Appium.

BitBar

Local Appium

1. Select the mobile device and a tested application for which you want to open a testing session:

   • If the selected device is not available, TestComplete will not be able to connect to it. To command TestComplete to search for a replacement device, select the Connect to another device when the selected one is not available check box. On the Device Cloud > Mobile page of your project, you can set the search criteria for the replacement devices.

   • In the Application drop-down list box, select a mobile application for which you want to open a testing session. The application file must be either stored in the BitBar Files Library or added to the Tested Applications of the current TestComplete project. In the latter case, click Upload to BitBar to upload the application file to the BitBar Files Library and then select it in the list.

     For iOS only: To be able to launch and stop the tested application from tests or by using the Mobile Device Screen window of TestComplete, specify the bundle ID of the application when connecting to the device. It is the bundle ID that was used to compile the specified .ipa file. Add the bundleId capability to the list of desired capabilities on the View more BitBar parameters > Custom Parameters tab.

2. To get more advanced options, click View more BitBar parameters:

   • On the Parameters tab, you can filter the device list by the device type, the version of the operating system running on the devices, their screen resolution, and their location.

   • By default, when a device is disconnected, the testing session on it is closed, and the device is restored to its initial state. Until the device is restored, it will remain unavailable. To keep the session alive to be able to reconnect to it, select the Keep the device available for quick reconnection check box. The session will be available for reconnection for up to 60 seconds.

   • If needed, on the Custom parameters tab, you can specify additional capabilities to be used for the testing session. Specify the capabilities in the JSON format. For example:

     JSON

     Copy Code

     JSON

     {
       "bitbar_project": "Automated tests",
       "bitbar_description": "Testing the Orders app"
     }

     The JSON code will be validated as you are typing it.

     Note: The capabilities you specify on the Custom capabilities tab can overwrite values specified on the Parameters tab.

     For the list of available capabilities, see the BitBar Documentation - Desired Capabilities.

To open the testing session and connect to it, click OK. To close the dialog without connecting any device, click Cancel.

Note: You must have your local Appium server running and available from your TestComplete workstation. For information on how to configure a local Appium server, see Set up Appium Server.

Improve device screen performance (optional)

By default, TestComplete shows the device screen in the Mobile Screen window by requesting screenshots from the Appium server. This can make the screen refresh slowly. To get a smoother screen, you can have TestComplete get the screen from the Appium MJPEG stream server instead.

To turn on MJPEG streaming, do the following:

1. In the Parameters editor, add the appium:mjpegServerPort capability and set it to a free port on the Appium server computer. For example:

   {

     "platformName": "Android",

     "deviceName": "Pixel API 24",

     "appium:automationName": "UIAutomator2",

     "appium:mjpegServerPort": "7810"

   }

2. Click OK.

TestComplete connects to the device and shows the MJPEG stream in the Mobile Screen window. This applies to live interaction, test recording, and test playback in TestComplete, and to test runs in TestExecute.

To go back to screenshot mode, remove the appium:mjpegServerPort capability from the connection parameters.

To open the testing session and connect to it, click OK. To close the dialog without connecting any device, click Cancel.