analyzeText: Analyze text

Function Description:

Optical Character Recognition(OCR), tesseract is used for text detection on mobile devices, Non-English language texts are supported.

General steps:
1. Download [lang].traineddata file,download address.
If you want to parse English text, you can download "eng.traineddata" file;
If you want to parse Chinese text, you can download "chi_sim.traineddata" file;
2. Upload the "*.traineddata" file.
Upload this file using the JS API "uploadTessData(fileName)".
For example:

var device = Device.getMain();
var ret = device.uploadTessData("E:\\File\\ocr\\eng.traineddata"); 
3. Using this interface, analyze text.

Corresponding JS API:
analyzeText(x1, y1, x2, y2, lang, mode)
Whether to support multiple devices:

No

Resource Information:

Method GET
URL .../devices/:device/screen/texts?rect=:rect&lang=:lang&mode=:mode
Requires authentication? Yes


Method Parameters:

Parameter Type Required Description
device String Yes ID value of the master device
rect String Yes Screen coordinates, For example: [0,100,500,600]
lang String Yes Text detection on mobile devices, choose the corresponding language as needed;
For example, [lang].traineddata, if you use the eng.traineddata file, The value of this lang is eng.
mode String Yes Analyze text mode:
singleline: A single-line text in the same line
multiline: The multi-line text
singlechar: Single char
singleword: Single word
singlecolumn: The text of the same size in the same column
multicolumn: The text are spread multiple column
number: number
noorder: The text has no order.


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,it returns <analyze text>;
If the value of status is a null object, an error message is returned.


Request Example:
http://localhost:8090/TotalControl/v1/devices/device@1116106541/screen/texts?token=270eq7lXQK8bXYsJ&rect=[100,200,300,400]&lang=eng&mode=singleline
Response Example:

If this API executes successfully, it returns:

{
    "status": true,
    "value": "<Analyze text>"
}

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:

Analyze text in the screen coordinate area (7,355,680,622)

The screen content is as shown below:

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/texts",
	data: {
		"rect": "[7,355,680,622]",
		"lang": "eng",
		"mode": "multiline",
		"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: 
{"status":true,"value":"RSTA offers elite competitive\ntennis training integrated With\nRoss School’s unique academic\ncurriculum."}
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/texts"
        data = {
            "rect": "[7,355,680,622]",
            "lang": "eng",
            "mode": "multiline",
            "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': 'SPQxpZO2Qz79oFWG'}}
The value of token is:  SPQxpZO2Qz79oFWG
Get the device id,Return value:  {'id': 'device@33254183'}
The value of device id is:  device@33254183
Executed successfully,Return value:  {'status': True, 'value': 'RSTA offers elite competitive\ntennis training integrated With\nRoss School’s unique academic\ncurriculum.'}