appium-ios-device

What is appium-ios-device?

The appium-ios-device npm package provides a set of utilities for interacting with iOS devices. It is primarily used in the context of Appium, a popular automation framework for mobile applications, to facilitate communication with iOS devices for tasks such as file management, process control, and device information retrieval.

What are appium-ios-device's main functionalities?

File Management

This feature allows you to manage files on the iOS device. The code sample demonstrates how to list files in the Documents directory of a specific app on the device.

const { services } = require('appium-ios-device');
(async () => {
  const udid = 'your-device-udid';
  const service = await services.startHouseArrestService(udid, 'your-app-bundle-id');
  const files = await service.listDirectory('/Documents');
  console.log(files);
})();

Process Control

This feature allows you to control and monitor processes running on the iOS device. The code sample shows how to list all running processes on the device.

const { services } = require('appium-ios-device');
(async () => {
  const udid = 'your-device-udid';
  const service = await services.startLockdownService(udid);
  const processes = await service.listProcesses();
  console.log(processes);
})();

Device Information

This feature allows you to retrieve various pieces of information about the iOS device. The code sample demonstrates how to get the iOS version of the device.

const { services } = require('appium-ios-device');
(async () => {
  const udid = 'your-device-udid';
  const service = await services.startLockdownService(udid);
  const info = await service.getValue('ProductVersion');
  console.log(info);
})();

Other packages similar to appium-ios-device

node-ios-device

The node-ios-device package provides similar functionalities for interacting with iOS devices, such as listing connected devices and retrieving device information. However, it is more focused on basic device management and lacks some of the advanced features provided by appium-ios-device, such as file management and process control.

ios-deploy

The ios-deploy package is primarily used for deploying iOS apps to devices from the command line. While it offers some device interaction capabilities, its main focus is on app deployment rather than the broader range of device management features provided by appium-ios-device.

README

appium-ios-device

Appium API for dealing with iOS devices. This is mainly a rewrite of libimobiledevice in nodejs. The APIs allow Appium to talk directly to the phone over usbmuxd

More information can be found at the links below:

• libimobiledevice
• iPhone Wiki

Note: Issue tracking for this repo has been disabled. Please use the main Appium issue tracker instead.

Methods

• utilities.getConnectedDevices
• utilities.getOSVersion
• utilities.getDeviceTime
• utilities.getDeviceName
• utilities.startLockdownSession
• utilities.connectPort
• utilities.connectPortSSL
• services.startSyslogService
• services.startWebInspectorService
• services.startInstallationProxyService
• services.startSimulateLocationService
• services.startAfcService
• services.startNotificationProxyService
• services.startHouseArrestService

Usage

This module should be used over the utilities and services modules due to the complexity of iOS communication. When a new services is implemented, it should be added and made available over the services module

Watch

npm run watch

Test

npm test