The Serial DAT is used for serial communication through an external port, using the RS-232 protocol. These ports are usually a 9 pin connector, or a USB port on new machines. (Using a USB port requires a USB-to-serial adapter and driver.) All of a computer's available serial ports can be found in the Device Manager in the Windows operating system under Computer –> Manage -> Devices -> Serial… -> COM ports. Their names begin with 'COM'. Example: COM1, COM2, COM3.
To send bytes out this connection, see the send methods in the serialDAT_Class, or in Tscript the
Parameters - Connect Page
active - This check box enables the serial connection.
format - ⊞ - Interpret the incoming data as binary or ASCII data. If the format is Per Byte, one row is appended for each binary byte received. If the format is Per Line, one row is appended for each null or newline delimited message received.
- One Per Byte
perbyte- (formerly called 'binary').
- One Per Line
perline- (formerly called 'Ascii') null/newln delimited.
- One Per Message
permessage- Full incoming msg.
port - Selects the COM port that the serial connection will use. Default port names 1 through 8 are available in the popup menu, though any name can be manually entered in this field.
baudrate - ⊞ - The maximum number of bits of information, including "control" bits, that are transmitted per second. Check your input device's default baud rate and set accordingly.
databits - ⊞ - This parameter sets the number of data bits sent in each. Data bits are transmitted "backwards". Backwards refers to the order of transmission, which is from least significant bit (LSB) to most significant bit (MSB). To interpret the data bits, you must read from right to left.
parity - ⊞ - This parameter can be set to none, even, or odd. The optional parity bit follows the data bits and is included as a simple means of error checking. Parity bits work by specifying ahead of time whether the parity of the transmission is to be even or odd. If the parity is set to be odd, the transmitter will then set the parity bit in such a way as to make an odd number of 1's among the data bits and the parity bit.
stopbits - ⊞ - The last part of transmission packet consists of 1 or 2 Stop bits. The connection will now wait for the next Start bit.
dtr - ⊞ -
rts - ⊞ -
Parameters - Received Data Page
callbacks - The Callbacks DAT will execute once for each message received.
executeloc - ⊞ - Determines the location the script is run from.
- Current Node
current- The script is executed from the current node location.
- Callbacks DAT
callbacks- The script is executed from the location of the DAT specified in the Callbacks DAT parameter.
- Specified Operator
op- The script is executed from the component specified in the Component parameter below.
clamp - The DAT is limited to 100 messages by default but with Clamp Output, this can be set to anything including unlimited.
maxlines - Limits the number of messages, older messages are removed from the list first.
clear - Deletes all lines except the heading. To clear with a script command, here is an example:
opparm -c /serial1 clear
bytes - Outputs the raw bytes of the message in a separate column.
Parameters - Common Page
language - ⊞ - Select how the DAT decides which script language to operate on.
input- The DAT uses the inputs script language.
node- The DAT uses it's own script language.
extension - ⊞ - Select the file extension this DAT should expose to external editors.
dat- various common file extensions.
- From Language
language- pick extension from DATs script language.
- Custom Extension
custom- Specify a custom extension.
customext - Specifiy the custom extension.
wordwrap - ⊞ - Enable Word Wrap for Node Display.
input- The DAT uses the inputs setting.
on- Turn on Word Wrap.
off- Turn off Word Wrap.
|• • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • •|
Some operators have a DAT docked to them that contains some python functions. These functions, called "callbacks", get called when something in the operator changes.
Any of the procedural data operators. OPs do all the work in TouchDesigner. They "cook" and output data to other OPs, which ultimately result in new images, data and audio being generated. See Node.