screenshot: Area or full screen screenshots

Function Description:

Area or full screen screenshots.

Corresponding JS API:
screenshot(filePath, imageType, topLeftX, topLeftY, bottomRightX, bottomRightY)
screenshot(location,filePath, imageType, topLeftX, topLeftY, bottomRightX, bottomRightY)
Whether to support multiple devices:

No

Resource Information:

Method GET
URL .../devices/:device/screen/images?file=:file&type=:type&location=:location&rect=:rect
Requires authentication? Yes


Method Parameters:

Parameter Type Required Description
device String Yes ID value of the device
file String No The path where the screenshot file is saved.
Note:
This parameter must be filled when the screenshot is saved to the device;
When the screenshot is saved to the computer, do not fill in this parameter;
type String Yes The type of screenshot file saved, which can be one of three types: "bmp/png/jpg"
rect String No Coordinate value, the coordinate format is "[topLeftX, topLeftY, bottomRightX, bottomRightY]".
topLeftX: X coordinate of the upper left corner of the screen
topLeftY: Y coordinate of the upper left corner of the screen
bottomRightX: X coordinate of the lower right corner of the screen
bottomRightY: Y coordinate of the lower left corner of the screen
location Int No The screenshot is saved to the device or computer, .the default is to save the screenshot to the device.
pc: It means save to computer;
device: It means save to device;


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 String If the value of status is true and the screenshot is saved to the device, an empty string is returned.
If the value of status is true and the screenshot is saved to the computer, the request address of the server image is returned.
If the value of status is a null object, an error message is returned.


Request Example:
//The screenshot is saved to the computer
http:/localhost:8090/TotalControl/v1/devices/device@-1303598987/screen/images?token=270eq7lXQK8bXYsJ&type=bmp&rect=[100,100,300,300]
http://localhost:8090/TotalControl/v1/devices/device@-1303598987/screen/images?token=270eq7lXQK8bXYsJ&type=bmp&location=pc&rect=[100,100,300,300]

//The screenshot is saved to the device
http://localhost:8090/TotalControl/v1/devices/device@-1303598987/screen/images?token=270eq7lXQK8bXYsJ&file=sdcard/ca7.png&type=png&location=device
http://localhost:8090/TotalControl/v1/devices/device@-1303598987/screen/images?token=270eq7lXQK8bXYsJ&file=sdcard/ca7.png&type=png&location=device&rect=[100,100,300,300]
Response Example:

If this API executes successfully, it returns:

//The screenshot is saved to the computer
{
    "status": true,
    "value": "http://127.0.0.1:8090/868146021323359/1547040694949.png"
}

//The screenshot is saved to the device
{
    "status": true,
    "value": ""
}

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: {
		"file": "sdcard/ca7.png",
		"type": "png",
		"location": "device",
		"rect": "[100, 100, 300, 300]",
		"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:39D3DX3sRfak7Dls
//The value of device ID is:device@33254183
//Executed successfully,Return value: 
{"value":"","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 = {
            "file": "sdcard/ca7.png",
            "type": "png",
            "location": "device",
            "rect": "[100, 100, 300, 300]",
            "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': '', 'status': True}