Welcome to the HeadSpin Documentation

Welcome to the HeadSpin documentation, the following sections will guide you through the setup process and get you started using the HeadSpin platform. Whatever stage you're in with your app development, we're ready to help you start testing on cell networks all over the world. Scroll down to read more about our platform, or click on a product or section link below to jump straight to the relevant documentation.

Changes

Recent changes to UI, tools, data, APIs, and capabilities

Getting Started

UI Master Guide

A high-level overview of our proprietary UI, its uses, and how to navigate it.

A document containing links to external resources for additional educational information.

Additional Reference Links

A document containing links to external resources for additional educational information.

User Roles and Access Permissions

A overview of the roles and associated permissions available to users within the UI.

A guide covering components and procedures to use Android's Espresso framework with our UI and API.

A guide covering components and procedures for use with Apple's XCTest framework with our UI and API.

Supported Devices and OS Versions

A general list of popular device models/manufacturers and OS versions supported by our platform.

Integrations

Katalon Studio - Using Katalon with HeadSpin Devices

Helpful tips for using Appium capabilities and HeadSpin devices with Katalon Studio.

Tosca - Using Tricentis' Tosca with HeadSpin

A beginner's guide to using Tosca with HeadSpin devices, including the creation of modules and test cases.

Using ACCELQ and HeadSpin

A guide to installing ACCELQ's local agent and configuring it to work with HeadSpin devices.

IOS 17 COMPATIBILITY AND SUPPORT

This document provides information regarding the compatibility of iOS 17 with a variety of our product features.

Platform

UNLOCKING DEVICES WITH PINTAP

How to use the Pintap feature to remotely unlock a device.

USING THE COOKIE TOOL

How to use the Cookie Tool to upload cookies to a Remote Control session.

Using the HS Tunnel Tool

Information and steps to help users with using the HS Tunnel Tool.

Remote Functional Testing

This is an overview of Remote Testing.

Configuring Single Sign-On

Configure and manage organization settings for logging in our Platform.

Remote Debugging

An overview of connecting remote devices to the local host, to use with local tools.

platform Command Line Interface

Command line interface binary.

Bring Your Own Device

How to use our CLI to connect your own devices to the platform.

API Reference

API for Automation Configuration

API endpoints for assisting with Appium setup.

Basic Device API

Listing, locking and unlocking devices.

This is some text inside of a div block.

Android Device API

An overview of the Android device API, including adb commands over HTTP.

An overview of the iOS device API, including idevice* commands over HTTP.

Using Reservation API

An overview of the Reservation API.

Device Cleaning API

Requesting device cleaning and listing the cleaning state.

Data Lifecycle Policy API

API for managing automatic data deletion.

Instrumentation API

An overview of our Instrumentation API.

APIs for creating sessions and getting data about sessions.

Session Annotation API

APIs for annotating sessions.

Session Analysis API

APIs for running custom analytics for sessions.

Measuring Visual Load Time in Sessions

An overview of the visual loading metrics available on our platform.

Performance Monitoring API

An overview of the Performance Monitoring API.

Regression Intelligence API

An overview of the Regression Intelligence API.

Providing Feedback

How to provide feedback to us using the Session Annotation API.

Device Selectors API

An overview of selectors language used in the API.

Session Status Reliability API

Monitoring and reporting of session stability.

Generate a usage report of device usage.

API for managing team device allocation.

NETWORK CONFIG API

API for configureing device network shaping and routing.

API for managing auth tokens.

analysis config api

API for managing analysis configs.

API for Hardware and Grafana

Using the bluetooth API

An overview of ourbluetooth API.

Using Audio API

An overview of our Audio API.

Using A/V Box API

An overview of ourA/V Box API.

Replica Database API

An overview of the Replica DB API for exporting Performance Monitoring data to an external database.

How to manage Grafana login credentials.

API for Biometric Testing

API endpoints for use in biometric testing with Android and iOS.

PBox Enclosure API

API for sensing temperature and netbooting hosts inside PBox environment.

Mini Remote

Using Mini Remote

How to set up and use miniremote on any browser.

Automation

Getting Started with Appium

Getting up and running with Appium on our platform.

Creating, retrieving and deleting your API tokens.

Browser Automation

An overview of the Browser Automation feature.

Chrome DevTools

An overview of running Chrome Devtools on our platform.

Recommended network_security_config.xml for network capture

The res/xml/network_security_config.xml recommended for network capture with Android apps.

Appium Load Balancer

A single webdriver endpoint that distributes sessions evenly across all devices.

Appium Capabilities

A list of custom appium capabilities we support.

Migrating to Appium 2 ON

A list of custom appium capabilities we support.

Selenium Capabilities

A list of custom selenium capabilities we support for browser automation.

Appium Inspector Integration

A guide for using the Appium Inspector Integration tool and associated deep links.

Audio

Audio Setup - Bluetooth Setup and Limitations

Understanding Bluetooth audio setup, profiles, and limitations.

Audio Use Cases and Troubleshooting with HeadSpin

Understanding the different use cases for Bluetooth audio testing in the HeadSpin platform, as well as some audio test troubleshooting tips.

Biometrics SDK

Testing biometric authentication in Android

Getting up and running with Android biometric testing on HeadSpin.

Testing Touch and Face ID in iOS

How to start with testing iOS Touch ID and Face ID using Biometrics SDK.

Performance Analysis

Overview of the waterfall UI and session data analysis.

Overview of the burst UI and performance issue analysis.

AI-based Issue Detection Engine

Philosophy and explanations of Issue Detection Engine.

AI-based Quality of Experience Monitoring

Explanation of our approach to monitoring the Quality of Experience.

VIDEO QUALITY MOS

Overview of the Video Quality MOS metric.

Providing Feedback on Performance Sessions

How to provide feedback on Performance Session data.

Annotating Your Session

Adding value to your session through custom annotations.

Image Matching Methods Explained

Explanation of the image matching methods available on our platform.

Performance Monitoring

Performance Monitoring UI

Overview of the Performance Monitoring UI for tracking performance across sessions.

Overview of the Replica DB

Overview of the Replica DB UI for exporting Performance Monitoring data to an external database.

Grafana

Grafana Dashboards

Overview of Grafana Dashboards

Grafana UI Overview

Overview of Grafana UI

On-Premise Deployments

User Management

Overview of users and permissions.

A description of the on-premise environment architecture v1.

PBox Data Sheet

Dimension, power, temperature specs for the HeadSpin device enclosure.

PBox Rack Installation

Guide to install the latest PBox in a standard 19" server rack

On-Premise Deployment Options

Deployment options for on-premise.

On-Premise Fully Managed Network Admin

Admin tasks for the isolated network and user LAN.

iOS Provisioning

Managing iOS provisioning profiles.

Setup guide to be done one per device for new devices.

Delivering software upgrades to an on-premise environment.

Details on running pusher locally and its options.

Layout of service and key files on the file system.

Android Network Capture Setup

How to setup network capture on ubuntu pboxes and android devices.

Network Requirements and Audio Configuration Options

Network configuration options and requirements information for PBox audio and video streaming services.

Deprecated Documentation

An overview of the APK and IPA API for managing apps on HeadSpin.

iOS and Android Device API

An overview of the API for iOS/iPadOS/tvOS and Android devices.

An overview of the desktop Appium IDE UI.

TestProject - Using Tricentis' TestProject with HeadSpin

Understanding the configuration and use of TestProject Agent with HeadSpin devices.

Legal Matters

Downloadable Components License Agreement

License agreement for downloadable components.