ts.so 触动精灵高级扩展库使用手册

已不更新，最新版请查看：http://helpdoc.touchsprite.com/
开发手册

Windows 平台按 Ctrl + F 打开快捷搜索

Mac 平台按 command + F 打开快捷搜索

※右侧文本列表可以找到全部手册

目录

更新日志

iOS v1.3.6

更新日期： 2018-07-31
更新日志：

• 修复二值化函数导致手机内存增加的问题

iOS v1.3.9

更新日期： 2019-03-26
更新日志：

• 支持 iOS12 系统

Android v1.1.1

更新日期： 2018-07-17
更新日志：

• 新增 ts.ftp.setFTPTimeOut 超时时间函数
• 新增查询数据库返回 table 的功能
• 修复 http 请求无法上传包含字符串格式参数的 table 的问题
• 修复 httpsGet 返回值格式不正确的问题
• 修复请求参数不支持数组的问题
• 修复 ts.httpPost 在模拟器上 post 会失败的问题
• 修复 ftp 获取列表为空的问题
• 修复 ts.qrDecode 识别二维码识别微信收款码会导致服务崩溃的问题

使用方法

请在脚本开头插入 local ts = require("ts") 即可调用扩展库中所有函数。
iOS 版 ts.so 需要放到如下路径：/var/mobile/Media/TouchSprite/plugin
iOS 11 系统的设备，原 TouchSprite 文件夹下新增 plugin_ios11 快捷方式，连接到 usr/bin/tsplugin
如果系统是 iOS 11 则 tsp 自带 so 文件释放到该路径但 lua 文件释放路径保持不变
如果开发者想要手动导入 so 文件，也需要放到 usr/bin/tsplugin 目录
安卓版和模拟器版 ts.so > 需要放到如下路径：data/data/com.touchsprite.android/files/plugin
安卓设备找不到该目录时需要使用第三方文件管理器，推荐 RE文件管理器

注意事项

• 模拟器版部分功能不支持，请自行尝试
• 安卓和 iOS 部分函数调用方法不同，请仔细参考
• 下载新的扩展库后需要重启触动服务才能生效

函数扩展库下载

函数： ts.version 获取扩展库版本号

函数名称：获取扩展库版本号
函数功能：获取 ts.so 扩展库版本号

脚本实例：

local ts = require("ts")
dialog(ts.version())

网络相关模块

FTP

FTP 是File Transfer Protocol（文件传输协议）的英文简称，而中文简称为“文传协议”。用于Internet上的控制文件的双向传输。

函数： ts.ftp.connect 连接FTP服务器

函数名称：连接FTP服务器

函数功能：连接FTP服务器，使用FTP功能前必须先连接

函数方法：

status = ts.ftp.connect(ftppath,username,password)

函数： ts.ftp.close 断开FTP连接

函数名称：断开FTP连接

函数功能：断开FTP连接，FTP功能使用结束后必须调用

函数方法：

ts.ftp.close()

函数： ts.ftp.setFTPTimeOut 设置FTP超时时间

函数名称：设置 FTP 超时时间

函数功能：设置 FTP 超时时间，超时后执行下一步防止阻塞

函数方法：

ts.ftp.setFTPTimeOut(sec)

函数： ts.ftp.mkdir 创建文件夹

函数名称：创建文件夹

函数功能：在服务器指定目录下创建文件夹

函数方法：

status = ts.ftp.mkdir(filePath)

脚本示例

--脚本仅供参考不可直接使用
local ts = require("ts")--使用官方库前一定要在开头插入这一句
status = ts.ftp.connect("111.111.11.111","username","password") --此处应填入真实的地址及账号密码
--FTP 操作第一步，连接 FT P服务器，连接成功后才可进行FTP相关操作
if status then
    dialog("连接成功", 0)
else
    dialog("连接失败", 0)
end
mkStatus = ts.ftp.mkdir("firstFile/childFile")   --在 FTP 上的 firstFile 文件夹内创建一个 childFile 文件夹，如果没有 firstFile 文件夹则先创建 firstFile 文件夹
ts.ftp.close()  --操作完成后，断开 FTP 服务器连接

函数： ts.ftp.rmdir 删除文件夹

函数名称：删除文件夹

函数功能：在服务器指定目录下删除文件夹

函数方法：

ts.ftp.rmdir(filepath)

脚本示例

--脚本仅供参考不可直接使用
local ts = require("ts")--使用官方库前一定要在开头插入这一句
status = ts.ftp.connect("111.111.11.111","username","password") 
--FTP 操作第一步，连 接FTP 服务器，连接成功后才可进行 FTP 相关操作
if status then
    dialog("连接成功", 0)
else
    dialog("连接失败", 0)
end
 ts.ftp.rmdir("firstfile/ChildFile")--删除目录下的文件夹
ts.ftp.close()  --操作完成后，断开 FTP 服务器连接

函数： ts.ftp.list 获取文件列表文件

函数名称：获取文件列表文件

函数功能：获取服务器指定目录下的文件列表

函数方法：

ts.ftp.list(filepath)

脚本示例

--脚本仅供参考不可直接使用
local ts = require("ts")--使用官方库前一定要在开头插入这一句
status = ts.ftp.connect("111.111.11.111","username","password") 
--FTP 操作第一步，连接 FTP 服务器，连接成功后才可进行 FTP 相关操作
if status then
    dialog("连接成功", 0)
else
    dialog("连接失败", 0)
end
mkStatus = ts.ftp.mkdir("/hehe123/test")   --创建文件夹
allFile = ts.ftp.list("/hehe123/test")   --列出文件夹里所有文件
if allFile then
    allFilestr=""
    for i,v in pairs(allFile) do
        allFilestr=v.."\n"..allFilestr;
    end
    dialog(allFilestr, time)--打印文件夹内所有文件列表
else
    dialog("error",0)
end
ts.ftp.close()  --操作完成后，断开 FTP 服务器连接

函数： ts.ftp.rename 重命名文件

函数名称：重命名文件

函数功能：重命名服务器上指定目录的文件

函数方法：

ts.ftp.rename(oldfilepath,newfilepath)

脚本示例

--脚本仅供参考不可直接使用
local ts = require("ts")--使用官方库前一定要在开头插入这一句
status = ts.ftp.connect("111.111.11.151","username","password") 
if status then
    dialog("连接成功", 0)
else
    dialog("连接失败", 0)
end
ts.ftp.rename("/haha/test1","/haha/test2")
ts.ftp.close()  --操作完成后，断开FTP服务器连接

注意事项：

1. 新、旧文件路径层级数必须相同
2. 新、旧文件夹路径必须是同一目录

函数： ts.ftp.delete 删除文件

函数名称：删除文件

函数功能：删除指定文件

函数方法：

ts.ftp.delete(fileName)

脚本示例

--脚本仅供参考不可直接使用
local ts = require("ts")--使用官方库前一定要在开头插入这一句
status = ts.ftp.connect("111.111.11.151","username","password") 
if status then
    dialog("连接成功", 0)
else
    dialog("连接失败", 0)
end
xstatus = ts.ftp.delete("C38K7L77DTWF.txt") --删除某个文件
ts.ftp.close()  --操作完成后，断开 FTP 服务器连接

函数： ts.ftp.upload 上传文件

函数名称：上传文件

函数功能：上传本地文件到服务器

函数方法：

status = ts.ftp.upload(localfilepath,severfilepath,type)

脚本示例

--脚本仅供参考不可直接使用
local ts = require("ts")--使用官方库前一定要在开头插入这一句
status = ts.ftp.connect("111.111.11.151","username","password") 
if status then
    dialog("连接成功", 0)
else
    dialog("连接失败", 0)
end
path = userPath()
upStatus = ts.ftp.upload(path.."/lua/main.txt","/haha/main.txt") 
--上传本地 lua 文件夹下的 main.lua 文件到服务器的 haha 文件夹里
if upStatus then
    toast("上传完成", 1)
else
    toast("上传失败", 1)
end
ts.ftp.close()  --操作完成后，断开 FTP 服务器连接

函数： ts.ftp.download 下载文件

函数名称：下载文件

函数功能：下载服务器文件到本地

函数方法：

ts.ftp.download(localfilepath,severfilepath,type)

脚本示例

--脚本仅供参考不可直接使用
local ts = require("ts")--使用官方库前一定要在开头插入这一句
status = ts.ftp.connect("111.111.11.151","username","password") 
if status then
    dialog("连接成功", 0)
else
    dialog("连接失败", 0)
end
path = userPath()
dwStatus = ts.ftp.download(path.."/res/me.png","/love.png",0)
--下载服务器上的 love.png 文件到本地 res 文件夹
if dwStatus then
    toast("下载完成", 1)
else
    toast("下载失败", 1)
end
ts.ftp.close()  --操作完成后，断开 FTP 服务器连接

完整示例

local ts = require("ts")--使用官方库前一定要在开头插入这一句
status = ts.ftp.connect("111.111.11.151","username","password") 
--FTP 操作第一步，连接 FTP 服务器，连接成功后才可进行 FTP 相关操作
if status then
    dialog("连接成功", 0)
else
    dialog("连接失败", 0)
end
mkStatus = ts.ftp.mkdir("tsnewfolder")   --创建文件夹
rmStatus=ts.ftp.rmdir("/haha") --删除文件夹
allFile = ts.ftp.list("/tsnewfolder")   --列出文件夹里所有文件
if allFile then
    allFilestr=""
    for i,v in pairs(allFile) do
    --dialog(string.format("%s = %s",i,v),1)
    --mSleep(3000)
    allFilestr=v.."\n"..allFilestr;
    end
dialog(allFilestr, time)
else
dialog("error",0)
end 
renameStatus =  ts.ftp.rename("/haha","/hehe123")  --重命名文件夹或文件，第一个参数为旧名，第二个参数为新名   
xstatus = ts.ftp.delete("C38K7L77DTWF.txt") --删除某个文件
path = userPath(）
upStatus = ts.ftp.upload(path.."/lua/main.txt","/haha/main.txt") 
--上传本地 lua 文件夹下的 main.lua 文件到服务器的 haha 文件夹里
dwStatus = ts.ftp.download(path.."/res/me.png","/love.png",0)
--下载服务器上的 love.png 文件到本地 res 文件夹
ts.ftp.close()  --操作完成后，断开FTP服务器连接

注意事项：

1. 使用本模块时填写的文件路径中，文件名不能使用中文字符
2. 文件路径必须填写完整路径

HTTP 模块

函数： ts.httpGet 发送 httpGET 请求

函数名称：发送httpGET请求

函数功能：发送 http GET类型 请求

函数方法：

status_resp, body_resp = ts.httpGet(url, header_send, body_send)

脚本实例：

local ts = require("ts")
header_send = {typeget = "ios"}
ts.setHttpsTimeOut(60)--安卓不支持设置超时时间
status_resp, header_resp,body_resp = ts.httpGet("http://baidu.com", header_send, body_send)
dialog(status_resp,0)
dialog(header_resp,0)
dialog(body_resp,0)

函数： ts.httpPost 发送httpPOST请求

函数名称：ts.httpPost

函数功能：发送 http POST类型 请求

函数方法：

status_resp, body_resp = ts.httpPost("http://dev.touchsprite.com/site/login", header_send, body_send)

脚本实例：

local ts = require("ts")
header_send = {typeget = "ios"}
body_send = {msg = "hello"}
ts.setHttpsTimeOut(60)--安卓不支持设置超时时间 
status_resp,header_resp,body_resp = ts.httpPost("http://dev.touchsprite.com/site/login",header_send, body_send)
dialog(status_resp,0)
dialog(header_resp,0)
dialog(body_resp,0)

HTTPS

函数： ts.setHttpsTimeOut 设置请求超时时间(仅支持iOS)

函数名称：设置请求超时时间

函数功能：发送 https GET类型 请求、发送 https POST类型 请求、设置请求超时时间

函数方法：

ts.setHttpsTimeOut(sec)

• 此函数方法HTTP请求通用

函数： ts.httpsGet 发送httpsGET请求

函数名称：发送httpsGET请求

函数功能：发送 https GET类型 请求

函数方法：

code, header_resp, body_resp = ts.httpsGet("https://www.baidu.com", header_send, body_send)

函数： ts.httpsPost 发送httpsPOST请求

函数名称：发送httpsPOST请求

函数功能：发送 https POST类型 请求

函数方法：

code ,header_resp, body_resp = ts.httpsPost("https://www.baidu.com", header_send, body_send)

脚本实例：

local ts = require("ts")
header_send = {
["Content-Type"] = "application/x-www-form-urlencoded",
["Accept-Encoding"] = "gzip",
["typeget"] = "ios"
}
body_send = {["msg"] = "hello"}
ts.setHttpsTimeOut(60)--安卓不支持设置超时时间 
code,header_resp, body_resp = ts.httpsGet("https://www.baidu.com", header_send,body_send)
dialog(code,0)
dialog(header_resp,0)
dialog(body_resp,0)

local ts = require("ts")
header_send = {typeget = "ios"}
body_send = {
["username"] = "aa",
["password"] = "1234"
}
-- body : username=aa&password=1234
ts.setHttpsTimeOut(60) --安卓不支持设置超时时间
code,status_resp, body_resp = ts.httpsPost("https://www.baidu.com", header_send, body_send)
dialog(code,0)
dialog(header_resp,0)
dialog(body_resp,0)

Socket

函数功能：发送tcp/udp请求

脚本实例：

local ts = require("ts")
local socket = require("socket")
local host = "www.baidu.com"
local file = "/"
local sock = assert(socket.connect(host, 80))  -- 创建一个 TCP 连接，连接到 HTTP 连接的标准 80 端口上
sock:send("GET " .. file .. " HTTP/1.0\r\n\r\n")
repeat
    local chunk, status, partial = sock:receive(1024) -- 以 1K 的字节块来接收数据，并把接收到字节块输出来
    dialog(chunk or partial, 0)
until status ~= "closed"
sock:close()  -- 关闭 TCP 连接

local ts = require("ts")
local socket = require("socket")
local host = host or "127.0.0.1"
local port = port or 8080
print("Binding to host '" ..host.. "' and port " ..port.. "...")
--创建udp对象
udp = assert(socket.udp())
--绑定到指定的端口
assert(udp:setsockname(host, port))
--设置超时时间
assert(udp:settimeout(5))
--获取绑定IP和端口
ip, port = udp:getsockname()
assert(ip, port)
print("Waiting packets on " .. ip .. ":" .. port .. "...")
local recvmaxbyte =20
--单线程无限循环
while 1 do
    --接收udp packet
    dgram, ip, port = udp:receivefrom(recvmaxbyte)
    if(dgram=="终止")then
        nlog("终止")
        break
    end
    if dgram then
        nlog("Echoing '" .. dgram .. "' to " .. ip .. ":" .. port)
        --发送数据
        udp:sendto(dgram, ip, port)
    else
        nlog(ip)
    end
end
udp=nil
collectgarbage("collect")

函数： ts.ping 测试网络连接情况

函数名称：测试网络连接情况

函数功能：测试设备网络连接情况

函数方法：

ts.ping(IP/Domain Name,time)

脚本实例：

local ts = require("ts")
status = ts.ping("www.baidu.com",3)  --也可以是 ip 地址
if status then
    for i,v in pairs(status) do
    dialog(string.format("%s = %s",i,v))
    mSleep(3000)
    end
else
    dialog(status, 0)
end

注意事项

• 1.2.1 以上版本新增了超时时间，时间为 3 秒
• ping 的次数只支持大于 0 的整数，次数超过 16 次返回值只显示 16 次的内容

函数： ts.setHttpProxy 设置 http 代理服务器（仅支持 iOS）

函数名称：设置 http 代理服务器

函数功能：设置 http 代理服务器，iOS v1.2.4及以上版本支持

函数方法：

ts.setHttpProxy(IP,status)

脚本实例：

local ts = require("ts")
IP = "123.43.123.1"
ts.setHttpProxy(IP,"port") --—开启
ts.setHttpProxy("127.0.0.1","80") --— 关闭

注意事项：

此函数只针对 ts.so 中 httpget 和 httppost 函数生效,并不是设置手机设置中的代理。

SMTP

函数： ts.smtp 通过 smtp 发送邮件

函数名称：通过 smtp 发送邮件

函数功能：通过 smtp 方式发送邮件

函数方法：

status = ts.smtp("收件人邮箱","邮件主题","邮件正文","smtp 服务器","smtp 邮箱账号","smtp 邮箱授权码")

脚本实例：

local ts = require("ts")
--smtp 服务器，QQ 邮箱为 smtp.qq.com，163 邮箱为 smtp.163.com，其他邮箱请自行百度
status = ts.smtp("10879433@qq.com","紧急通知","今天不上班","smtp.163.com","test@163.com","testpassword")
if (status) then           
    dialog("Success", 0) --发送成功
else
    dialog("False", 0) --发送失败
end

注意事项：

1. 邮箱需先开启 SMTP 服务功能，例如 163 邮箱，在登录邮箱后-设置-POP3/SMTP/IMAP 中开启 SMTP 服务。
2. SMTP 服务器和 SMTP 授权码请以邮箱后台提供的为准，一般与邮箱登录密码不同。常用邮箱授权码使用方法：QQ 邮箱、163邮箱，其他邮箱请自行百度。
3. 邮件有可能会被归入垃圾箱，请自行检查邮件内容。

图像处理模块

二维码

函数： ts.qrEncode 二维码图片生成

函数名称：二维码图片生成

函数功能：将文本编译成二维码图片

函数方法：

ts.qrEncode(path,string,size)

脚本实例：

local ts = require("ts")
status = ts.qrEncode("/var/1.png","我只是比别人帅了一点而已","288")    
--"1.jpg"（如只填文件名，默认为图片在触动res目录下)
dialog(status,0)

函数： ts.qrDecode 二维码图片解析

函数名称：二维码图片解析

函数功能：将二维码图片解析为字符串

支持版本：仅 ts.so v1.2.1 以上版本支持

函数方法：

str = ts.qrDecode(path)

※仅支持 iOS 8 及以上系统及触动精灵 Android v2.3.5.4 及其以上版本支持

脚本实例：

local ts = require("ts")
str = ts.qrDecode(userPath().."/res/1.png")    
--"1.jpg"（如只填文件名，默认为图片在触动 res 目录下)
dialog(str,0)

• 此函数为系统方法，可能因为机型原因导致解析失败，如果出现解析失败或服务重启等问题，请尝试使用第三方扩展库→ tsqr.so
• 暂不支持iPhone5s设备
• 不支持微信面对面红包的二维码解析

二值化

函数： ts.binaryzation 屏幕二值化（仅支持 iOS）

函数名称：ts.binaryzation

函数功能：屏幕二值化，将指定区域保存为黑白图，仅支持 1.2.4 及以上版本

函数方法：

ts.binaryzation(x1,y1,x2,y2,value)

脚本实例：

local ts = require("ts")
degree = 150
ts.binaryzation(0,0,100,100,degree)

注意事项

• 调用本函数将会从当前屏幕截取一部分保存，保存路径为触动的 res 目录下 tmp.jpg 文件

函数： ts.imgFindColor 二值化图片区域多点找色（仅支持iOS）

※此功能为测试版功能，正式版将做调整

函数名称：二值化多点找色，图片多点找色

函数功能：在图片的指定区域，根据颜色以及其周边点的颜色，寻找符合条件的点的坐标，仅支持 1.2.4 及以上版本

函数方法：

point = ts.imgFindColor(path,color,posandcolor,x1, y1, x2, y2)

返回的 table 为以下形式：

table = {
    {x = 100,y = 110},
}

脚本实例：

local ts = require("ts")
point = ts.imgFindColor(userPath().."/res/tmp.jpg",255,"0|1|0,0|2|255",60, 239, 127, 501)
if #point ~=0 then
    dialog(point[1].x)
end

函数：ts.img.binaryzationImg 图片二值化（仅支持 iOS）

函数名称：图片二值化

函数功能：将指定图片进行二值化处理

函数方法：

ts.img.binaryzationImg(imgPath,posandcolor)
返回值:无

脚本示例

local ts = require("ts")
snapshot("test_3.jpg", 101, 101, 200, 200)
ts.img.binaryzationImg(userPath().."/res/test_3.jpg",100)--不支持相对路径
dialog("输出图片保存在"..userPath().."/res/tmp.jpg")

函数：ts.img.binaryzation 指定区域二值化（仅支持 iOS）

函数名称：指定区域二值化

函数功能：将指定区域的图片进行二值化处理

函数方法：

ts.img.binaryzation(x1,y1,x2,y2,posandcolor)
返回值:无

脚本示例

local ts = require("ts")
ts.img.binaryzation(101,101,200,200,100)
dialog("输出图片保存在"..userPath().."/res/tmp.jpg")

颜色表

函数：ts.img.loadFile 从图片创建颜色表（仅支持 iOS）

函数名称：创建颜色表

函数功能：从图片文件创建颜色表

函数方法：

ts.img.loadFile(imgPath)
返回值:table 类型 color

脚本示例

local ts = require("ts")
snapshot("test_1.jpg", 101, 101, 200, 200)
ss = ts.img.loadFile(userPath().."/res/test_1.jpg")--不支持相对路径
dialog(ss[1][7].color)

函数：ts.img.screen 从屏幕创建颜色表（仅支持 iOS）

函数名称：从屏幕创建颜色表

函数功能：从屏幕创建颜色表

函数方法：

ts.img.screen(x1,y1,x2,y2)
返回值:table 类型 color

脚本示例

local ts = require("ts")
ss = ts.img.screen(101, 101, 200, 200)--不支持相对路径
dialog(ss[1][8].color)

函数：ts.img.save 保存颜色表为图片文件（仅支持 iOS）

函数名称：保存颜色表为图片文件

函数功能：保存颜色表为图片文件

函数方法：

ts.img.save(table,imgPath)
返回值:无

脚本示例

local ts = require("ts")
ss = ts.img.screen(101, 101, 200, 200)
ts.img.save(ss,userPath().."/res/test_2.jpg")--不支持相对路径

图片操作

函数： ts.imgSize 图片缩放（仅支持 iOS）

函数名称：图片缩放

函数功能：对指定图片进行缩放

支持版本：仅 ts.so v1.2.1 以上版本支持

函数方法：

ts.imgSize(path1,path2,w,h)

脚本实例：

local ts = require("ts")
path = userPath()
ts.imgSize(path.."/res/1.png",path.."/res/2.png",400,400)
--图片后缀可写jpg或png

注意事项：

缩放函数可能导致图片变模糊

字符串处理模块

函数：ts.json.encode json 串编码

函数名称：ts.json.encode

函数功能：对 json 串进行编码

函数方法：

ts.json.encode(tb)

脚本实例：

local ts = require("ts")--使用扩展库前必须插入这一句
local json = ts.json--使用 JSON 模块前必须插入这一句
local tb = {
    ["我"] = "五毛",
    ["爱"] = "六块",
    meme = {
        isArray = true,
        1,0,0,4,6,9,5,1,0,0,
    },
    nullvalue = null,
}
local jsonstring = json.encode(tb);--把 table 转换成 json 字符串
dialog(jsonstring, 0);

函数：ts.json.decode json 串解码

函数名称：json 串解码

函数功能：对 json 串进行解码

函数方法：

ts.json.encode(tb)

脚本实例：

local ts = require("ts")--使用扩展库前必须插入这一句
local json = ts.json--使用 JSON 模块前必须插入这一句
local tb = {
    ["我"] = "五毛",
    ["爱"] = "六块",
    meme = {
        isArray = true,
        1,0,0,4,6,9,5,1,0,0,
    },
    nullvalue = null,
}
local jsonstring = json.encode(tb);--把 table 转换成 json 字符串
dialog(jsonstring, 0);
local tmp = json.decode(jsonstring);--把 json 字符串转换为 table 对象
dialog(tmp.meme[5], 0);
dialog(tostring(tmp.nullvalue), 0);

函数：tohex 字符串转码

函数名称：字符串转码

函数功能：转码，字符串转换为十六进制编码

函数方法：

string:tohex()

脚本实例：

local ts = require("ts")
local str = "触动精灵"
dialog('"'..str..'" 的 16 进制编码为: <'..str:tohex()..'>', 0) --“触动精灵”的 16 进制编码

函数：fromhex 十六进制转码

函数名称：十六进制转码

函数功能：转码，十六进制编码转换为字符串

函数方法：

tb:fromhex()

脚本实例：

local ts = require("ts")
local str = "触动精灵"
dialog('"'..str..'" 的 16 进制编码为: <'..str:tohex()..'>', 0) --“触动精灵”的 16 进制编码
dialog('<'..str:tohex()..'> 转换成明文为: "'..str:tohex():fromhex()..'"', 0)--将上一行的 16 进制编码转换为明文字符

函数：md5 计算 MD5

函数名称：计算 MD5
函数功能：字符串 MD5 计算

脚本实例：

local ts = require("ts")
local str = "触动精灵"
local binstr = "\0\1\2\3\4\5"
dialog('"'..str..'" 的 MD5 值是: '..str:md5(), 0)--计算"触动精灵"的 MD5 值
dialog('<'..binstr:tohex()..'> 的 MD5 值是: '..binstr:md5(), 0)--计算“000102030405”的 MD5 值

函数：sha1 计算 SHA1

函数名称：计算 SHA1
函数功能：字符串 SHA1 计算

脚本实例：

local ts = require("ts")
local str = "触动精灵的征程"
local binstr = "\0\1\2\3\4\5"
dialog('"'..str..'" 的 SHA1 值是: '..str:sha1(), 0)--计算"触动精灵"的 SHA1 值
dialog('<'..binstr:tohex()..'> 的 SHA1 值是: '..binstr:sha1(), 0)计算“000102030405”的 SHA1 值

函数：aes128_encrypt AES128 编码

函数名称：AES128、编码

函数功能：字符串 AES128编码

函数方法：

msg:aes128_encrypt(key)

脚本实例：

local ts = require("ts")
local msg = "\5\4\3\2\1\0"
local key = "触动精灵"
local emsg = msg:aes128_encrypt(key)
local emsgb64 = emsg:base64_encode()
dialog('二进制数据<'..msg:tohex()..'> \n AES128 编码为<'..emsg:tohex()..'>', 0)

函数：aes128_decrypt AES128 解码

函数名称：AES128 解码

函数功能：字符串 AES128 解码

函数方法：

tb:base64_decode()

脚本实例：

local ts = require("ts")
local msg = "\5\4\3\2\1\0"
local key = "触动精灵"
local emsg = msg:aes128_encrypt(key)
local emsgb64 = emsg:base64_encode()
local tmp = emsgb64:base64_decode()
msg = tmp:aes128_decrypt(key)
dialog('"'..emsgb64..'"  \n使用 AES128 算法 密钥 "'..key..'" 解码值是 <'..msg:tohex()..'>', 0)

函数：base64_encode BASE64 编码

函数名称：BASE64 编码
函数功能：字符串 BASE64 编码

脚本实例：

local ts = require("ts")
local msg = "\5\4\3\2\1\0"
local key = "触动精灵"
local emsg = msg:aes128_encrypt(key)
local emsgb64 = emsg:base64_encode()
dialog('二进制数据<'..msg:tohex()..'> \n BASE64 编码为<'..emsgb64..'>',0)

函数：base64_decode BASE64 解码

函数名称：BASE64 解码
函数功能：字符串 BASE64 解码

脚本实例：

local ts = require("ts")
local msg = "\5\4\3\2\1\0"
local key = "触动精灵"
local emsg = msg:aes128_encrypt(key)
local emsgb64 = emsg:base64_encode()
local tmp = emsgb64:base64_decode()
msg = tmp:aes128_decrypt(key)
dialog('"'..emsgb64..'" base64 解码后的数据为 '..tmp:tohex()..'"',0)

函数：split、rtrim、ltrim、trim、atrim 字符串分割过滤

函数名称：字符串分割过滤
函数功能：对字符串分割、过滤

脚本实例：
字符串分割及空白字符过滤

local ts = require("ts")
str = "  哈哈,he he,1,3,6  "
new = str:split(",") --将字符串str按照 `,` 分割并返回一个TABLE
dialog(new[2], 0)
dialog(str:rtrim(), 0) -- 结果 "  哈哈,he he,1,3,6" ,删除字符串尾部的空白字符
dialog(str:ltrim(), 0) -- 结果 "哈哈,he he,1,3,6  " ,删除字符串首部的空白字符
dialog(str:trim(), 0) -- 结果 "哈哈,he he,1,3,6"    ,删除字符串首尾的空白字符
dialog(str:atrim(), 0) -- 结果 "哈哈,hehe,1,3,6"    ,删除字符串所有的空白字符

名词解析：

空白字符包括：空格、制表符 \t 、换行符 \n 、\r。

函数：fromgbk GBK 转 UTF8

函数名称：GBK 转 UTF8
函数功能：转码，GBK 转 UTF8

脚本实例：
将字符串从 GBK 编码转换到 UTF8 编码（需引擎版本 iOS v2.2.6 以上版本）

require "ts"
f = io.open("/var/mobile/Media/TouchSprite/lua/a.txt", "r")
s = f:read("*a")
f:close()
dialog(s:fromgbk())

函数：toUTF8 unicode 转 utf8

函数名称：unicode 转 utf8
函数功能：转码，unicode 转 UTF8

脚本实例：

--unicode 转 utf8
local ts = require "ts"
local tmp = ts.json.totable([[{"toUTF8":"\u6211\u7231\u5a1c\u5a1c"}]])
dialog(tmp["toUTF8"],0)

系统相关模块

函数： ts.system.resetNetWork 还原网络设置 （仅支持 iOS）

函数名称：ts.system.resetNetWork

函数功能：还原网络设置，仅支持 1.2.1 以上版本

函数方法：

ts.system.resetNetWork()

※仅支持 iOS 8 及以上系统

脚本实例：

local ts = require("ts")
ts.system.resetNetWork()- 本函数仅支持 iOS 8 及以上系统，调用后会自动重启设备，请勿频繁调用

注意事项

• 本函数仅支持 iOS8 及以上系统
• 本函数调用后会自动重启设备，请勿频繁调用

函数： ts.system.udid 获取设备 UDID 码（仅支持 iOS）

函数名称：获取设备 UDID 码

函数功能：获取设备 UDID 码

函数方法

udid = ts.system.udid()
返回值：文本型 udid

脚本实例：

local ts = require("ts")
udid = ts.system.udid()            --获取设备的 UDID
dialog(udid, 0)

函数： ts.system.serialnumber 获取设备序列号

函数名称：获取设备序列号（安卓不同的手机可能返回空值）

函数功能：获取设备序列号

函数方法

serialnumber = ts.system.serialnumber()
返回值：文本型 serialnumber

脚本实例：

local ts = require("ts")
serialnumber = ts.system.serialnumber()--获取设备的序列号，安卓不同的手机可能返回空值
dialog(serialnumber, 0)

注意事项：

安卓不同的手机可能返回空值

函数： ts.system.space 获取设备存储空间（仅支持 iOS）

函数名称：获取设备存储空间

函数功能：获取设备存储空间

函数方法

string = ts.system.space()

脚本实例：

local ts = require("ts")
string = ts.system.space()         
dialog(string, 0)

函数： ts.system.wifimac 获取设备 WiFi MAC 地址

函数名称：获取设备 WiFi MAC地址

函数功能：获取设备 WiFi MAC地址

函数方法

wifimac = ts.system.wifimac()
返回值：文本型 wifimac

脚本实例：

local ts = require("ts")
wifimac = ts.system.wifimac()         --获取设备的 WiFi MAC 地址，安卓不同的手机可能返回空值
dialog(wifimac, 0)

注意事项：

安卓不同的手机可能返回空值

函数： ts.system.btmac 获取蓝牙 MAC 地址

函数名称：获取蓝牙 MAC 地址

函数功能：获取设备蓝牙 MAC 地址

函数方法

btmac = ts.system.btmac()
返回值： btmac

脚本实例：

local ts = require("ts")
btmac = ts.system.btmac()           --获取设备的蓝牙 MAC 地址，安卓不同的手机可能返回空值
dialog(btmac, 0)

注意事项：

安卓不同的手机可能返回空值

函数： ts.system.osversion 获取系统版本号

函数名称：获取系统版本号

函数功能：获取设备系统版本号

函数方法

osversion = ts.system.osversion()
返回值： osversion

脚本实例：

local ts = require("ts")
osversion = ts.system.osversion()       --获取设备的系统版本号，安卓不同的手机可能返回空值
dialog(osversion, 0)

注意事项：

安卓不同的手机可能返回空值

函数： ts.system.devicetype 获取详细型号

函数名称：获取详细型号

函数功能：获取设备详细型号

函数方法

producttype = ts.system.devicetype()

脚本实例：

local ts = require("ts")
producttype = ts.system.devicetype()--获取设备详细型号，安卓不同的手机可能返回空值
dialog(producttype,0) 
--安卓返回的是手机型号
--iOS 机型见附录对照表

注意事项：

安卓不同的手机可能返回空值

函数： ts.system.imei 获取 IMEI

函数名称：获取 IMEI

函数功能：获取设备 IMEI

函数方法

imei = ts.system.imei()

脚本实例：

local ts = require("ts")
imei = ts.system.imei() --获取设备 IMEI，安卓不同的手机可能返回空值
dialog(imei,0) 

注意事项：

安卓不同的手机可能返回空值

函数： ts.system.localwifiaddr 获取本地网络地址（仅支持 iOS）

函数名称：获取本地网络地址

函数功能：获取本地网络地址

函数方法

tab = ts.system.localwifiaddr()

脚本实例：

local ts = require("ts")
local ret = ""
for i,v in ipairs(ts.system.localwifiaddr()) do --获取本地网络地址
    ret = ret..(v[1]).."="..(v[2]).."\n"
end
dialog(ret,0)

注意事项：

ts.system.localwifiaddr() 将返回一个 TABLE，TABLE 中包含本地内部环回地址、蜂窝地址、本地 WiFi 地址。

函数： ts.getNetType 获取网络类型（仅支持 iOS）

函数名称：获取网络类型

函数功能：用于判断设备网络类型

函数方法：

ts.getNetType()

脚本实例：

local ts = require("ts")
nettype = ts.getNetType()  
dialog(nettype, 0) 

函数： ts.ms 毫秒级时间戳

函数名称：毫秒级时间戳

函数功能：返回毫秒级时间戳，用于精确计算时间

函数方法：

ts.ms()

脚本实例：

local ts = require("ts")
time =ts.ms() 
dialog(time, 0)  --Unix时间戳
--如需转换为标准时间格式
print(os.date("%c",time))

文件操作类模块

函数：ts.hlfs.getFileEncoding 获取文本格式

函数名称：获取文本格式

函数功能：获取文本格式

函数方法：

ts.hlfs.getFileEncoding(filePath)
返回值：string form

脚本示例

local ts = require("ts")
dialog(ts.hlfs.getFileEncoding(userPath().."/res/test3.txt"))--不支持相对路径

函数：ts.hlfs.codeConvert 转换文本格式

函数名称：转换文本格式

函数功能：转换文本格式

函数方法：

ts.hlfs.codeConvert(srcPath,dstPath,mode)
返回值:无

脚本示例

local ts = require("ts")
ts.hlfs.codeConvert(userPath().."/res/test.txt",userPath().."/res/test3.txt",1)--不支持相对路径

函数：ts.zip 文件压缩（仅支持 iOS）

函数名称：文件压缩

函数功能：文件压缩，生成压缩包

支持版本：仅 ts.so v1.2.1 以上版本支持

函数方法：

local fileList = {
{path1,bakpath1},
{path2,bakpath2},
{path3,bakpath3},
...
}
flag = ts.zip(zipPath,fileList)

脚本实例：

local ts = require("ts")
local root = userPath()
io.open(root .. "/res/1.txt","w"):write("测试"):close()
io.open(root .. "/res/2.txt","w"):write("测试"):close()
io.open(root .. "/res/3.txt","w"):write("还是测试"):close()
local fileList = {
    {root .. "/res/1.txt","1.txt"},
    {root .. "/res/2.txt","/file/2.txt"},
    {root .. "/res/3.txt","3.txt"}
}
flag = ts.zip(root .. "/res/测试.zip",fileList)
if flag then
dialog("压缩成功", time)
else
dialog("压缩失败", time)
end

注意事项：

• 添加到压缩包的文件名是中文的情况下会导致文件名乱码，请使用英文文件名

函数：ts.unzip 文件解压（仅支持 iOS）

函数名称：文件解压

函数功能：文件解压，解压压缩包

支持版本：仅 ts.so v1.2.1 以上版本支持

函数方法：

flag = ts.unzip(zipPath,filePath)

脚本实例：

local ts = require("ts")
ocal root = userPath()
io.open(root .. "/res/1.txt","w"):write("测试"):close()
io.open(root .. "/res/2.txt","w"):write("测试"):close()
io.open(root .. "/res/3.txt","w"):write("还是测试"):close()
local fileList = {
    {root .. "/res/1.txt","1.txt"},
    {root .. "/res/2.txt","/file/2.txt"},
    {root .. "/res/3.txt","3.txt"}
}
ts.zip(root .. "/res/测试.zip",fileList)
zipPath = root .. "/res/测试.zip"
filePath = root .. "/res/解压"
flag = ts.unzip(zipPath,filePath)
if flag then
dialog("解压成功", time)
else
dialog("解压失败", time)
end

注意事项：

• 添加到压缩包的文件名是中文的情况下会导致文件名乱码，请使用英文文件名

函数：ts.tsDownload 下载文件

函数名称：下载文件

函数功能：下载文件到设备，支持 http 和 ftp

函数方法：

code,msg = ts.tsDownload(path,url)

脚本实例：

local ts = require("ts")
code,msg = ts.tsDownload(userPath().."/res/1.jpg","http://p0.so.qhmsg.com/sdr/720_1080_/t01f0c2107148464d50.jpg")  
--同样支持ftp地址
--"1.jpg"（如只填文件名，默认保存到触动 res 目录下）
dialog(code,0)
dialog(msg,0)

函数：ts.hlfs.getFileList 列出所有文件

函数名称：列出所有文件

函数功能：获取目录下所有文件列表，返回一个表

函数方法：

tableGet =ts.hlfs.getFileList(filePath)

脚本实例：

local ts = require("ts")
creatflag= ts.hlfs.makeDir("/var/mobile/hello") --新建文件夹
io.open("/var/mobile/hello/test.txt","w"):write("测试"):close()--在 /var/mobile/hello 目录下创建一个 test.txt 的文件夹并写入“测试”这个字符串
io.open("/var/mobile/hello/test2.txt","w"):write("测试2"):close()
tableGet = ts.hlfs.getFileList("/var/mobile/hello")   --列出 hello 文件夹下所有文件
if tableGet then
    for i,v in pairs(tableGet) do
    dialog(string.format("%s = %s",i,v),1)
    mSleep(3000)
    end
else
    dialog("没有此文件夹")
end

函数：ts.hlfs.removeEntryDir 删除空文件夹

函数名称：删除空文件夹

函数功能：删除空文件夹

函数方法：

status = ts.hlfs.removeEntryDir(filePath)

脚本实例：

 local ts = require("ts")
 creatflag= ts.hlfs.makeDir("/var/mobile/hello") --新建文件夹
 status = ts.hlfs.removeEntryDir("/var/mobile/hello")--删除 hello 文件夹
 if status then
 dialog("删除成功")
 else
 dialog("删除失败或没有此文件夹")
 end

函数：ts.hlfs.removeDir 删除文件夹及所有的文件

函数名称：删除文件夹及所有的文件

函数功能：删除文件夹及里面的文件

函数方法：

status = ts.hlfs.removeDir(filePath)

脚本实例：

 local ts = require("ts")
 creatflag= ts.hlfs.makeDir("/var/mobile/hello") --新建文件夹
 io.open("/var/mobile/hello/test.txt","w"):write("测试"):close()--在 /var/mobile/hello 目录下创建一个 test.txt 的文件夹并写入“测试”这个字符串
 status = ts.hlfs.removeDir("/var/mobile/hello")--删除 hello 文件夹及所有文件
 if status then
 dialog("删除成功")
 else
 dialog("删除失败或没有此文件夹")
 end

函数：ts.hlfs.isDir 判断是否是文件夹

函数名称：判断是否是文件夹

函数功能：判断是否是文件夹

函数方法：

status = ts.hlfs.isDir(filePath)

脚本实例：

 local ts = require("ts")
 creatflag= ts.hlfs.makeDir("/var/mobile/hello") --新建文件夹
 status = ts.hlfs.isDir("/var/mobile/hello")--判断 hello 是否是文件夹
 if status then
 dialog("这是一个文件夹")
 else
 dialog("这不是一个文件夹或没有此文件夹")
 end

函数：ts.hlfs.makeDir 新建文件夹

函数名称：新建文件夹

函数功能：新建文件夹

函数方法：

status = ts.hlfs.makeDir(filePath)

脚本实例：

 local ts = require("ts")
 status = ts.hlfs.makeDir("/var/mobile/hello") --新建文件夹
 if status then
 dialog("创建成功")
 else
 dialog("创建失败")
 end

函数：ts.hlfs.copyDir 复制文件夹及所有文件

函数名称：复制文件夹及所有文件

函数功能：复制文件夹及所有文件，并把数据拷贝到新的文件夹路径下

函数方法：

status = ts.hlfs.copyDir(oldpath,newpath)

脚本实例：

local ts = require("ts")
creatflag= ts.hlfs.makeDir("/var/mobile/hello") --新建文件夹
io.open("/var/mobile/hello/test.txt","w"):write("测试"):close()--在 /var/mobile/hello 目录下创建一个 test.tx t的文件夹并写入“测试”这个字符串
status = ts.hlfs.copyDir("/var/mobile/hello","/var/hello") --复制文件夹及里面所有文件
if status then
dialog("复制成功")
else
dialog("复制失败")
end

函数：ts.hlfs.copyFile 复制文件

函数名称：复制文件

函数功能：复制单个文件,并把拷贝到新的目录下

函数方法：

status = ts.hlfs.copyFile(oldpath,newpath)

脚本实例：

local ts = require("ts")
io.open("/var/mobile/hello/test.txt","w"):write("测试"):close()--在 /var/mobile/hello 目录下创建一个 test.txt 的文件夹并写入“测试”这个字符串
creatflag= ts.hlfs.makeDir("/var/mobile/hello") --新建文件夹
status = ts.hlfs.copyFile("/var/mobile/hello/test.txt","/1.txt")  --复制文件
if status then
dialog("复制成功")
else
dialog("复制失败")
end

函数：PLIST 文件操作（仅支持 iOS）

函数名称：plist.read、plist.write

函数功能：PLIST文件读取、写入

函数方法：

tmp2 = plist.read(plfilename)
返回值 TABLE
plist.write(plfilename, tmp2)

脚本实例：

--读取键值
local ts = require("ts")
local plist = ts.plist
local plfilename = "/var/mobile/Library/Caches/com.apple.mobile.installation.plist" --设置plist路径
local tmp2 = plist.read(plfilename)           --读取 PLIST 文件内容并返回一个 TABLE
dialog(tmp2.Metadata.ProductBuildVersion, 0)  --显示 ProductBuildVersion 的键值

--写入键值
local ts = require("ts")
local plist = ts.plist
local plfilename = "/var/mobile/Library/Caches/com.apple.mobile.installation.plist" --设置plist路径
local tmp2 = plist.read(plfilename)                --读取 PLIST 文件内容并返回一个 TABLE
tmp2["Metadata"]["ProductBuildVersion"] = "havonz" --将表中ProductBuildVersion键值改为havonz
plist.write(plfilename, tmp2)                      --将修改后的表写入 PLIST 文件

注意事项：

1. 实例代码仅做为参考，实际调试中请将文件路径替换为实际存在的文件路径。
2. 对于个别重要的 PLIST 文件，请谨慎使用写入功能或在运行脚本前进行备份。
3. 需要注意的是，nib 文件作为一种特殊的 PLIST 文件格式，不能被正确的读取。

数据操作类

注意事项：

1.数据操作 config 类，所有的数据操作，必须以 open 开始，以 close 结束。

函数： ts.config.open 打开数据存储文件（仅支持 iOS）

函数名称：打开数据存储文件

函数功能：创建并初始化数据流

函数方法：

ts.config.open(path)

函数： ts.config.close 关闭数据流（仅支持 iOS）

函数名称：关闭数据流

函数功能：完成数据操作，必须执行此的函数

函数方法：

ts.config.close(flag)

函数： ts.config.save 数据存储（仅支持 iOS）

函数名称：数据存储

函数功能：通过指定索引和索引值存储数据

函数方法：

ts.config.save(key,value)

脚本实例：

local ts = require("ts")
ts.config.open("/var/coc.plist")
 --打开一个plist文件,如果文件不存在，将自动创建该文件，同时只允许打开一个
 --此函数为初始化函数，所有 config 操作第一步必须以 open 开始并且以 close 结尾
ts.config.save("金币数",999) 
--存储lua中的number string  nil boolean table类型（不允许嵌套 table） 
--ps:键值对（key-value）是一种存储格式，一个 key 对应一个 value
--此处代表“金币数”是 key，999 是 value，将存入此键值对
ts.config.close(true)
--必要函数，参数为true，操作结束后必须以此函数结尾，
dialog(coin,0)
--结尾后，此处才可输出 coin 值或删除“金币数”对应的值