Scripting guide

HTTP API

1. Endpoints return JSON, for example {"version":"1.0.1","code":0}. A nonzero code indicates an error. Call the endpoint to inspect any returned data.
2. The HTTP service uses port 8080. Make sure no other local service is using that port.
3. For setcurrentrecordparam, first write the parameters to /var/mobile/ctwparams.txt.
4. For endpoints that require a record ID, use getbakidfromname to look up the ID from its name.

Use the client device's IP address. The examples below use http://127.0.0.1:8080.

OpenURL commands

Return codes

Read the return code from /var/mobile/ctwresult.txt.

Parameter file

/var/mobile/ctwparams.txt holds the current record's parameters. Write one parameter per line using chr(10) for line breaks and a colon between each name and value. Run getcurrentrecordparam and open the file to see the format.

TouchSprite examples

URL encoding

function encodeURI(s)
  s = string.gsub(s, "([^%w%.%- ])", function(c)
    return string.format("%%%02X", string.byte(c))
  end)
  return string.gsub(s, " ", "+")
end

Activate a record

recordId = encodeURI("1458774551");
url = string.format("CTW://?cmd=activerecord&ID=%s", recordId);
openURL(url);

Rename the current record

recordName = encodeURI("1458774551");
url = string.format("CTW://?cmd=renamecurrentrecord&name=%s", recordName);
openURL(url);

Launch the app

openURL("CTW://?cmd=open");