seekImageByID: Seek image by ID

Function Description:

Find the specified image on the phone screen based on the imageID.

Corresponding JS API:
seekImageByID(imageID)
seekImageByID(imageID, sim)
Whether to support multiple devices:

No

Resource Information:

Method GET
URL .../devices/:device/screen/images?sim=:sim&id=:id
Requires authentication? Yes


Method Parameters:

Parameter Type Required Description
device String Yes ID value of the device
id String Yes Image id.
Set configuration file:
Prepare the file {Documents}\resources\images\image_mapping.json in "My Documents". The role of image_mapping.json is to pre-define the parameters in the configuration file.
The image_mapping.json file contains these fields.
  • ID: Image ID, user defined.
  • APP: Folder name.
    The value can be the application name, which is actually a folder for storing images created according to the application name. This folder is in the path "{Documents}\resources\images\".
  • REGION:
    x: X coordinate of the upper left corner of the screen
    y: Y coordinate of the upper left corner of the screen
    Width: the width of the screen
    Height: the height of the screen
    srcResolutionX: Get the image to be searched from the phone, this parameter is the width of the phone's resolution
    srcResolutionY: Get the image to be searched from the phone, this parameter is the height of the resolution of the phone
  • IMAGEFILENAME: Image name
The format of the image_mapping.json file:
{
	'IDMapImageFile':
	[
		{'ID':'juhuasuan', APP:'weixin', REGION: {x:0, y:0, width:719, height: 1279, srcResolutionX: 720, srcResolutionY: 1280}, IMAGEFILENAME:'jianghu.bmp'},
		{'ID':'AAA', APP:'weixin', REGION: {x:0, y:0, width:1440, height: 2560, srcResolutionX: 1440, srcResolutionY: 2560}, IMAGEFILENAME:'1440small.png'}
	]
}
sim Float No Similarity, the similarity range is [0.0, 1.0].


Response Parameters:

A JSON string representing an array of objects with the following fields:

Field Type Description
status Boolean Return true for success and null for failure
value Array/String Array, if the value of status is true,it returns the coordinates of the center point of the found image;
String, if the value of status is a null object, an error message or empty string is returned.


Request Example:
http://localhost:8090/TotalControl/v1/devices/device@1116106541/screen/images?token=270eq7lXQK8bXYsJ&id=AAA

http://localhost:8090/TotalControl/v1/devices/device@1116106541/screen/images?token=270eq7lXQK8bXYsJ&id=AAA&sim=0.9
Response Example:

If this API executes successfully, it returns:

{
    "status": true,
    "value": [272,371]
}

If the value of HTTP status code is 200, but the value of status is a null object, it returns:

{
    "status": null,
    "value": "<Error message>"
}


Example:

Warm tip:
Get the token needed for Total Control script development,see here.
Get the id value of the master device, see here.

RingoJS Example:
// Import the packages
var {request} = require("ringo/httpclient");
var base64 = require("ringo/base64");

// The username and password are separated by a single : and sent on the wire base64 encoded
var userpass = base64.encode("sigma:3D391497");

// First step: Get the API token
var gettoken = request({
	method: "GET",
	url: "http://localhost:8090/TotalControl/v1/login",
	headers: {
		"Authorization": userpass
	}
});
var ret_token = JSON.parse(gettoken.content); 
var token = ret_token.value.token; 
print("//The value of token is:" + token);

// Second step: Get the device id value of the master device
var getdevice = request({
	method: "GET",
	url: "http://localhost:8090/TotalControl/v1/devices/main?token=" + token
});
var device = JSON.parse(getdevice.content).id; 
print("//The value of device ID is:"+ device);

// Third step: Execute this REST API
var resp = request({
	method: "GET",
	url: "http://localhost:8090/TotalControl/v1/devices/" + device + "/screen/images",
	data: {
		"id": "AAA0",
		"sim": 0.8,
		"token": token
	}
});
var obj = JSON.parse(resp.content); 
var ret = obj.status;
if (ret == true) {
	print("//Executed successfully,Return value: \n"+resp.content);	
} else if (ret != true & resp.status == 200){
	print("An error message is returned: "+resp.content);
} else {
	print("This API failed to execute.");
}
The running result of the RingoJS:

If it executes successfully, it will return:

//The value of token is:7mXprTVH0q4DA3eN
//The value of device ID is:device@33254183
//Executed successfully,Return value: 
{"value":[622,520],"status":true}
Python Example:
#!/user/bin/python
#-*- coding:utf-8 -*-
import base64
import requests

# The username and password are separated by a single : and sent on the wire base64 encoded
user_pass = 'sigma:3D391497'
encodeStr = base64.b64encode(user_pass.encode("UTF-8"))

# First step: Get the API token
LoginUrl = "http://localhost:8090/TotalControl/v1/login"
response = requests.get(LoginUrl, headers={'Authorization':encodeStr})
print("Get the token,Return value: ",response.json())
token = response.json()['value']['token']
print("The value of token is: ",token)

# Second step: Get the device id value of the master device
if token is not None:
    GetDeviceUrl = "http://localhost:8090/TotalControl/v1/devices/main?token=" + token
    response = requests.get(url=GetDeviceUrl)
    print("Get the device id,Return value: ", response.json())
    device = response.json()['id']
    print("The value of device id is: ", device)
    if device is not None:
        # Third step: Execute this REST API
        APIUrl = "http://localhost:8090/TotalControl/v1/devices/" + device + "/screen/images"
        data = {
            "id": "AAA0",
            "sim": 0.9,
            "token": token
        }
        response = requests.get(url=APIUrl, params=data)
        ret = response.json()['status']
        # Determine if this REST API is executed successfully
        if ret is True:
            print("Executed successfully,Return value: ", response.json())
        elif response.status_code == 200 and ret is not True:
            print("An error message is returned: ",response.json())
        else:
            print("This API failed to execute.")
    else:
        print("Failed to get device id.")
else:
    print("Failed to get token.")
The running result of the python:

If it executes successfully, it will return:

Get the token,Return value:  {'status': True, 'value': {'token': '236NY20EUZF0cYQr'}}
The value of token is:  236NY20EUZF0cYQr
Get the device id,Return value:  {'id': 'device@33254183'}
The value of device id is:  device@33254183
Executed successfully,Return value:  {'value': [94, 520], 'status': True}