Skip to main content
Glama

rotate

Set device orientation to portrait or landscape for Android or iOS platforms during mobile automation testing.

Instructions

Rotate the device to a specific orientation

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
orientationYesThe orientation to set
platformYesPlatform of the device

Implementation Reference

  • The main handler function for the 'rotate' tool. It instantiates the Rotate class and calls its execute method with the desired orientation.
    // Rotate handler const rotateHandler = async (device: BootedDevice, args: RotateArgs, progress?: ProgressCallback) => { try { const rotate = new Rotate(device); const result = await rotate.execute(args.orientation, progress); return createJSONToolResponse({ message: `Rotated device to ${args.orientation} orientation`, observation: result.observation, ...result }); } catch (error) { throw new ActionableError(`Failed to rotate device: ${error}`); } };
  • Zod schema defining the input parameters for the rotate tool: orientation (portrait/landscape) and platform.
    export const rotateSchema = z.object({ orientation: z.enum(["portrait", "landscape"]).describe("The orientation to set"), platform: z.enum(["android", "ios"]).describe("Platform of the device") });
  • Registers the 'rotate' tool with the ToolRegistry, providing name, description, schema, and handler.
    // Register the new rotate tool ToolRegistry.registerDeviceAware( "rotate", "Rotate the device to a specific orientation", rotateSchema, rotateHandler, true // Supports progress notifications );
  • Core implementation class for rotating the device. Handles current orientation detection, orientation lock, ADB commands to set rotation, verification, and returns RotateResult. Extends BaseVisualChange for observation.
    export class Rotate extends BaseVisualChange { constructor( device: BootedDevice, adb: AdbUtils | null = null, axe: Axe | null = null ) { super(device, adb, axe); } /** * Get the current device orientation * @returns Promise with current orientation ("portrait" or "landscape") */ async getCurrentOrientation(): Promise<string> { try { // Get current user_rotation setting const result = await this.adb.executeCommand("shell settings get system user_rotation"); const userRotationStr = result.stdout.trim(); // Check if the result is a valid number if (!/^\d+$/.test(userRotationStr)) { logger.warn(`Invalid user_rotation value: ${userRotationStr}, defaulting to portrait`); return "portrait"; } const userRotation = parseInt(userRotationStr, 10); // Convert numeric value to orientation string // 0 = portrait, 1 = landscape (90°), 2 = reverse portrait (180°), 3 = reverse landscape (270°) // For simplicity, we'll treat 0,2 as portrait and 1,3 as landscape return (userRotation === 0 || userRotation === 2) ? "portrait" : "landscape"; } catch (error) { logger.warn(`Failed to get current orientation: ${error}`); // If we can't detect current orientation, assume portrait as default return "portrait"; } } /** * Check if orientation is locked * @returns Promise with boolean indicating if auto-rotation is disabled */ async isOrientationLocked(): Promise<boolean> { try { const result = await this.adb.executeCommand("shell settings get system accelerometer_rotation"); const autoRotate = parseInt(result.stdout.trim(), 10); // 0 = locked (auto-rotation disabled), 1 = unlocked (auto-rotation enabled) return autoRotate === 0; } catch (error) { logger.warn(`Failed to check orientation lock status: ${error}`); // If we can't check, assume it's not locked return false; } } async execute( orientation: "portrait" | "landscape", progress?: ProgressCallback ): Promise<RotateResult> { return this.observedInteraction( async () => { const value = orientation === "portrait" ? 0 : 1; // Get current orientation const currentOrientation = await this.getCurrentOrientation(); // Check if device is already in the desired orientation if (currentOrientation === orientation) { return { success: true, orientation, value, currentOrientation, previousOrientation: currentOrientation, rotationPerformed: false, orientationLockHandled: false, message: `Device is already in ${orientation} orientation` }; } // Check if orientation is locked const isLocked = await this.isOrientationLocked(); let orientationUnlocked = false; try { // If orientation is locked, unlock it temporarily if (isLocked) { logger.info("Orientation is locked, temporarily unlocking for rotation"); await this.adb.executeCommand("shell settings put system accelerometer_rotation 1"); orientationUnlocked = true; } // Disable accelerometer rotation and set user rotation await this.adb.executeCommand("shell settings put system accelerometer_rotation 0"); await this.adb.executeCommand(`shell settings put system user_rotation ${value}`); // Wait for rotation to complete await this.awaitIdle.waitForRotation(value); // If orientation was originally locked, restore the lock if (orientationUnlocked) { await this.adb.executeCommand("shell settings put system accelerometer_rotation 0"); logger.info("Restored orientation lock"); } // Verify the rotation was successful const newOrientation = await this.getCurrentOrientation(); const rotationSuccessful = newOrientation === orientation; return { success: rotationSuccessful, orientation, value, currentOrientation, previousOrientation: currentOrientation, rotationPerformed: true, orientationLockHandled: orientationUnlocked, message: rotationSuccessful ? `Successfully rotated from ${currentOrientation} to ${orientation}` : `Failed to rotate to ${orientation}, current orientation is ${newOrientation}` }; } catch (error) { // Restore orientation lock if we unlocked it if (orientationUnlocked) { try { await this.adb.executeCommand("shell settings put system accelerometer_rotation 0"); logger.info("Restored orientation lock after error"); } catch (restoreError) { logger.warn(`Failed to restore orientation lock: ${restoreError}`); } } return { success: false, orientation, value, currentOrientation, previousOrientation: currentOrientation, rotationPerformed: false, orientationLockHandled: orientationUnlocked, error: `Failed to change device orientation: ${error}` }; } }, { changeExpected: true, timeoutMs: 5000, progress } ); } }
  • TypeScript interface defining the structure of the result returned by the rotate operation, including success status, orientations, and observation.
    /** * Result of a rotate operation */ export interface RotateResult { success: boolean; orientation: string; value: number; observation?: ObserveResult; error?: string; // Enhanced fields for intelligent rotation currentOrientation?: string; previousOrientation?: string; rotationPerformed?: boolean; orientationLockHandled?: boolean; message?: string; }

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/zillow/auto-mobile'

If you have feedback or need assistance with the MCP directory API, please join our Discord server