Device Script API Overview

This section provides detailed API documentation for a device script, a script that powers up a script port virtual serial device.

Device Script API is fully asynchronous, most methods and some properties return promise objects. Promises are resolved when appropriate events happen, make sure your code properly work with asynchronous calls. It is recommended to mark your functions that call those methods with async keyword and use the await operator. A callback model is also supported, you can query continuations using the Promise.then method.

This script execution context is created after the port is opened and is destroyed as soon as it is closed. Any global variables you create will only live this long.

That is, you cannot store any state between port opening attempts. However, the execution context is guaranteed to exist until the port is closed by the application. Anyway, prefer storing any state in the created device script object, not on a global scope.

Global Object

Methods and properties defined on a Global object are described in the IGlobals topic.

port property returns a reference to a global Port API IPort object. It is used by a device script to communicate with a virtual serial port device driver.
fs property returns a reference to a global IFileManager object. Device script uses this object to access local file system.
net property returns a reference to a global INetworkManager object. Device script uses this object to create TCP and UDP sockets and communicate over the network.
http property returns a reference to a global IHttpClient object. Device script uses this object to make HTTP requests.
log method is used to perform a diagnostic output.
delay method produces a promise that is automatically resolved after a given amount of time.
async and cancelAsync methods allow device script to schedule delayed and optionally repetitive continuations.

File System Object

Global file system object (implemented as IFileManager interface) provides convenient access to the local file system, allowing the device script to read and store data in files, create or delete files and folders as well as enumerate the contents of a folder.

Create and delete folders using the IFileManager.createFolder and IFileManager.deleteFolder methods.
Create or open files using the IFileManager.createFile method.
Delete files with IFileManager.deleteFile method.
Copy or move(rename) files using the IFileManager.copyFile and IFileManager.moveFile methods.
Enumerate contents of a folder using the IFileManager.enumFiles method.
Load a text file with IFileManager.loadTextFile method.
Read/write data from/to a file using the IFile.read and IFile.write methods.

Network Object

The network object (implemented as INetworkManager interface) provides a way to create TCP and UDP sockets, connect or bind them and perform a data transfer over the network.

Create TCP and UDP sockets using the INetworkManager.createTcpSocket and INetworkManager.createUdpSocket methods.
Create TCP listener object using the INetworkManager.createTcpListener method.
Connect a socket using the ISocket.connect method, or bind it using the IUdpSocket.bind method.
Perform a data transfer using the ISocket.send and ISocket.receive methods.

HTTP Object

The Http object (implemented as IHttpClient interface) provides the ability for a device script to make HTTP requests to query and control remote HTTP resources.

Build and send an HTTP request using the IHttpClient.request method.
Alternatively, use the “shortcut” methods, such as IHttpClient.get, IHttpClient.post, IHttpClient.getString or IHttpClient.getBlob.