Device & USB

iOS Device → Lightning Cable → USB Hub → iClick Hardware → Computer
                                                        ↓
                                            WebSocket API Call

// Device ID example
"P72578581E07"

// Get all devices
const devices = await apiInvoke('getDevices');

// Iterate devices
for (const deviceId in devices) {
    const device = devices[deviceId];
    console.log(`Device: ${device.info.deviceName}`);
    console.log(`  ID: ${deviceId}`);
    console.log(`  Resolution: ${device.info.screenWidth}x${device.info.screenHeight}`);
    console.log(`  Status: ${device.plugged ? 'Ready' : 'Not Ready'}`);
}

// Get first available device
async function getFirstDevice() {
    const devices = await apiInvoke('getDevices');
    
    for (const deviceId in devices) {
        if (devices[deviceId].plugged) {
            return deviceId;
        }
    }
    
    throw new Error('No available devices');
}

// Usage
const deviceId = await getFirstDevice();
console.log('Selected device:', deviceId);

{
    deviceName: "My iPhone",               // Device name
    deviceIdentifier: "iPhone15,2",        // Device model identifier
    deviceChip: "COM3",                    // USB chip ID
    screenWidth: 1179,                     // Screen width
    screenHeight: 2556,                    // Screen height
    orientation: 1,                        // Orientation (1=portrait, 2=landscape)
    screenScale: 3.0,                      // Screen scale ratio
    deviceVersion: "17.0",                 // iOS version
    deviceRounded: true                    // Whether rounded screen
}

getDevices

{
    "P72578581E07": {
        "info": {
            "deviceId": 'P72578581E07',
            "deviceName": "Device Name",
            "deviceIdentifier": "Device Identifier",
            "deviceChip": "USB Chip ID",
            "screenWidth": 750,
            "screenHeight": 1334,
            "orientation": 0,
            "screenScale": 2,
            "deviceVersion": "iOS Version",
            "deviceRounded": false
        },
        "plugged": true  // Whether USB is plugged in,
        "online": true   // Online
    },
    //...
}

renameDevice

true  // Returns true on successful operation

// Rename device
await apiInvoke('renameDevice', {
    deviceId: 'P72578581E07',
    deviceName: 'Test Device 1'
});

removeDevice

true  // Returns true on successful operation

// Remove device (device must be offline)
await apiInvoke('removeDevice', {
    deviceId: 'P72578581E07'
});

stopReplay

true  // Returns true on successful operation

// Stop device replay
await apiInvoke('stopReplay', {
    deviceId: 'P72578581E07'
});

console.log('Replay stopped');

setDeviceBusy

true  // Returns true on successful operation

// Set device to busy state
await apiInvoke('setDeviceBusy', {
    deviceId: 'P72578581E07',
    state: true
});

// Execute tasks...

// Set to idle state after task completion
await apiInvoke('setDeviceBusy', {
    deviceId: 'P72578581E07',
    state: false
});

autoReplay

true  // Returns true on successful operation

// Start device auto screen mirroring
await apiInvoke('autoReplay', {
    deviceId: 'P72578581E07'
});

console.log('Device is automatically coming online for screen mirroring...');

rebootDevice

true  // Returns true on successful operation

// Reboot specified device
await apiInvoke('rebootDevice', {
    deviceId: 'P72578581E07'
});

getChipboards

[
    "Serial Number",
    "Serial Number",
    "Serial Number"
]

// Get list of connected chips
const chipboards = await apiInvoke('getChipboards');

console.log(`${chipboards.length} chips connected:`);
chipboards.forEach((serialId, index) => {
    console.log(`${index + 1}. ${serialId}`);
});

bindChipboard

true  // Returns true on successful binding

// Bind device to specified chip
await apiInvoke('bindChipboard', {
    deviceId: 'P72578581E07',
    serialId: 'TEST_SERIALID'
});

console.log('Device successfully bound to chip');

setChipboardLed

true  // Returns true on successful setting