Difference between revisions of "Serial CHOP"
(Serial CHOP Auto Create) |
Tag: 2021.10000 |
||
(12 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | + | {{Summary | |
− | {{Summary| | + | |opLicense=Non-Commercial |
− | + | |opFamily=CHOP | |
− | | | + | |short=The Serial CHOP is used for serial communication through an external port, using the RS-232 protocol. |
− | + | |opType=serial | |
− | | | + | |opFilter=True |
− | + | |opClass=serialCHOP_Class | |
− | + | |opLabel=Serial | |
− | + | |long=The Serial CHOP 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 adaptor and driver.) All of a computer's available serial ports can be found in the Device Manager under the Windows operating system. Their names begin with 'COM'. Example: COM1, COM2, COM3, etc. | |
− | |||
− | |||
− | | | ||
− | |||
− | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | This CHOP monitors changes in its input channels, and sends the corresponding script through the serial connection. | |
− | + | Any ASCII numeric digits '0'..'9' that are received, are stored and reflected in the output channel named 'return'. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | When you need to receive more complex data, other than simple ASCII numbers use the [[Serial DAT]]. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | See also [[Serial DAT]], [[serialDAT_Class]], [[Arduino]]. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
− | + | {{ParameterPage | |
− | + | |opFamily=CHOP | |
− | + | |pageName=Port | |
− | + | |pageSummary= | |
− | + | |items={{Parameter | |
− | + | |opFamily=CHOP | |
− | + | |parName=active | |
− | + | |opType=serial | |
− | + | |parSummary=This check box enables the serial connection. | |
− | + | |parOrder=0 | |
− | + | |parLabel=Active | |
− | + | |parType=Toggle | |
− | + | |parReadOnly= | |
− | + | |parItems= | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
− | + | {{Parameter | |
− | + | |opFamily=CHOP | |
− | + | |parName=state | |
− | + | |opType=serial | |
− | + | |parSummary=The type of input transition to monitor. | |
− | + | |parOrder=1 | |
− | + | |parLabel=State | |
− | + | |parItems={{ParameterItem | |
− | + | |opFamily=CHOP | |
− | + | |parName=state | |
− | + | |itemName=offtoon | |
− | + | |itemSummary= | |
− | + | |itemLabel=Off to On | |
− | + | }}<!-- | |
− | + | -->{{ParameterItem | |
− | + | |opFamily=CHOP | |
− | + | |parName=state | |
− | + | |itemName=on | |
− | + | |itemSummary= | |
− | + | |itemLabel=While On | |
− | + | }}<!-- | |
− | + | -->{{ParameterItem | |
− | + | |opFamily=CHOP | |
+ | |parName=state | ||
+ | |itemName=ontooff | ||
+ | |itemSummary= | ||
+ | |itemLabel=On to Off | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=state | ||
+ | |itemName=off | ||
+ | |itemSummary= | ||
+ | |itemLabel=While Off | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=state | ||
+ | |itemName=valuechange | ||
+ | |itemSummary= | ||
+ | |itemLabel=Value Change | ||
}} | }} | ||
− | + | |parType=Menu | |
− | + | |parReadOnly= | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
− | + | {{Parameter | |
− | + | |opFamily=CHOP | |
− | + | |parName=port | |
− | {{ | + | |opType=serial |
− | + | |parSummary=Selects the COM port that the serial connection will use. | |
− | | | + | |parOrder=2 |
− | + | |parLabel=Port | |
− | | | + | |parItems={{ParameterItem |
− | + | |opFamily=CHOP | |
− | + | |parName=port | |
− | {{ | + | |itemLabel=COM3 |
− | + | |itemName=com3 | |
− | + | |itemSummary= | |
− | |||
}} | }} | ||
− | + | |parType=StrMenu | |
− | + | |parReadOnly= | |
− | |||
− | |||
}} | }} | ||
− | + | {{Parameter | |
− | + | |opFamily=CHOP | |
− | + | |parName=baudrate | |
− | + | |opType=serial | |
+ | |parSummary=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. | ||
+ | |parOrder=3 | ||
+ | |parLabel=Baud Rate | ||
+ | |parItems= | ||
+ | |parType=Int | ||
+ | |parReadOnly= | ||
}} | }} | ||
− | {{ | + | {{Parameter |
− | + | |opFamily=CHOP | |
− | + | |opType=serialCHOP | |
− | + | |parLabel=Baud Rate Menu | |
+ | |parName=baudmenu | ||
+ | |parType=Pulse | ||
+ | |parReadOnly= | ||
+ | |parOrder=4 | ||
+ | |parSummary=Use this menu to select from some commonly used baud rates. | ||
+ | |parItems={{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=baudrate | ||
+ | |itemName=1200 | ||
+ | |itemSummary= | ||
+ | |itemLabel=1200 | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=baudrate | ||
+ | |itemName=2400 | ||
+ | |itemSummary= | ||
+ | |itemLabel=2400 | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=baudrate | ||
+ | |itemName=9600 | ||
+ | |itemSummary= | ||
+ | |itemLabel=9600 | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=baudrate | ||
+ | |itemName=19200 | ||
+ | |itemSummary= | ||
+ | |itemLabel=19200 | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=baudrate | ||
+ | |itemName=38400 | ||
+ | |itemSummary= | ||
+ | |itemLabel=38400 | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=baudrate | ||
+ | |itemName=57600 | ||
+ | |itemSummary= | ||
+ | |itemLabel=57600 | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=baudrate | ||
+ | |itemName=115200 | ||
+ | |itemSummary= | ||
+ | |itemLabel=115200 | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=baudrate | ||
+ | |itemName=230400 | ||
+ | |itemSummary= | ||
+ | |itemLabel=230400 | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=baudrate | ||
+ | |itemName=460800 | ||
+ | |itemSummary= | ||
+ | |itemLabel=460800 | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=baudrate | ||
+ | |itemName=921600 | ||
+ | |itemSummary= | ||
+ | |itemLabel=921600 | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=baudrate | ||
+ | |itemName=1382400 | ||
+ | |itemSummary= | ||
+ | |itemLabel=1382400 | ||
}} | }} | ||
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
− | + | {{Parameter | |
− | + | |opFamily=CHOP | |
− | + | |parName=databits | |
− | + | |opType=serial | |
+ | |parSummary=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. | ||
+ | |parOrder=5 | ||
+ | |parLabel=Data Bits | ||
+ | |parItems={{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=databits | ||
+ | |itemName=6 | ||
+ | |itemSummary= | ||
+ | |itemLabel=6 | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=databits | ||
+ | |itemName=7 | ||
+ | |itemSummary= | ||
+ | |itemLabel=7 | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=databits | ||
+ | |itemName=8 | ||
+ | |itemSummary= | ||
+ | |itemLabel=8 | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=databits | ||
+ | |itemName=9 | ||
+ | |itemSummary= | ||
+ | |itemLabel=9 | ||
}} | }} | ||
− | + | |parType=Menu | |
− | + | |parReadOnly= | |
− | |||
− | |||
}} | }} | ||
− | {{ | + | {{Parameter |
− | + | |opFamily=CHOP | |
− | + | |parName=parity | |
− | + | |opType=serial | |
+ | |parSummary=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. | ||
+ | |parOrder=6 | ||
+ | |parLabel=Parity | ||
+ | |parItems={{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=parity | ||
+ | |itemName=even | ||
+ | |itemSummary= | ||
+ | |itemLabel=Even | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=parity | ||
+ | |itemName=odd | ||
+ | |itemSummary= | ||
+ | |itemLabel=Odd | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=parity | ||
+ | |itemName=none | ||
+ | |itemSummary= | ||
+ | |itemLabel=None | ||
}} | }} | ||
− | + | |parType=Menu | |
− | + | |parReadOnly= | |
− | |||
− | |||
− | |||
− | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
− | {{ | + | {{Parameter |
− | + | |opFamily=CHOP | |
− | + | |parName=stopbits | |
− | + | |opType=serial | |
+ | |parSummary=The last part of transmission packet consists of 1 or 2 Stop bits. The connection will now wait for the next Start bit. | ||
+ | |parOrder=7 | ||
+ | |parLabel=Stop Bits | ||
+ | |parItems={{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=stopbits | ||
+ | |itemName=1 | ||
+ | |itemSummary= | ||
+ | |itemLabel=1 | ||
+ | }}<!-- | ||
+ | -->{{ParameterItem | ||
+ | |opFamily=CHOP | ||
+ | |parName=stopbits | ||
+ | |itemName=2 | ||
+ | |itemSummary= | ||
+ | |itemLabel=2 | ||
}} | }} | ||
− | + | |parType=Menu | |
− | + | |parReadOnly= | |
− | |||
− | |||
}} | }} | ||
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
− | + | {{ParameterPage | |
− | + | |opFamily=CHOP | |
− | + | |pageName=Scripts | |
− | + | |pageSummary=Add more parameters as needed for additioanl scripts. These strings are sent out the serial port when the corresponding channel change is detected. For example, Script 2 is sent to the serial port when the third input channel goes from off to on. These scripts will also convert escape sequences like <CR> and \n for carriage returns and \r for line feed. | |
+ | |items={{Parameter | ||
+ | |opFamily=CHOP | ||
+ | |opType=serialCHOP | ||
+ | |parLabel=Script 0 | ||
+ | |parName=script0 | ||
+ | |parType=Str | ||
+ | |parReadOnly= | ||
+ | |parOrder=0 | ||
+ | |parSummary=Enter the script for Script 0 here. | ||
+ | |parItems= | ||
}} | }} | ||
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
− | + | {{:CHOP Filter Common Page}} | |
− | + | {{InputsPage | |
− | + | |opFamily=CHOP | |
− | + | |opInputs={{OPInput | |
+ | |opFamily=CHOP | ||
+ | |inputIndex=0 | ||
+ | |inputName= | ||
+ | |inputSummary= | ||
}} | }} | ||
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
− | |||
− | |||
− | |||
− | |||
{{History}} | {{History}} | ||
− | {{CHOPNavBox| | + | {{CHOPNavBox|opFamily=CHOP}} |
{{#invoke:Category|list|CHOPs}} | {{#invoke:Category|list|CHOPs}} |
Latest revision as of 04:47, 10 June 2020
Summary[edit]
The Serial CHOP 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 adaptor and driver.) All of a computer's available serial ports can be found in the Device Manager under the Windows operating system. Their names begin with 'COM'. Example: COM1, COM2, COM3, etc.
This CHOP monitors changes in its input channels, and sends the corresponding script through the serial connection. Any ASCII numeric digits '0'..'9' that are received, are stored and reflected in the output channel named 'return'.
When you need to receive more complex data, other than simple ASCII numbers use the Serial DAT.
See also Serial DAT, serialDAT_Class, Arduino.
Parameters - Port Page
Active active
- This check box enables the serial connection.
State state
- ⊞ - The type of input transition to monitor.
- Off to On
offtoon
-
- While On
on
-
- On to Off
ontooff
-
- While Off
off
-
- Value Change
valuechange
-
Port port
- ⊞ - Selects the COM port that the serial connection will use.
- COM3
com3
-
Baud Rate 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.
Baud Rate Menu baudmenu
- - Use this menu to select from some commonly used baud rates.
Data Bits 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.
- 6
6
-
- 7
7
-
- 8
8
-
- 9
9
-
Parity 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.
- Even
even
-
- Odd
odd
-
- None
none
-
Stop Bits stopbits
- ⊞ - The last part of transmission packet consists of 1 or 2 Stop bits. The connection will now wait for the next Start bit.
- 1
1
-
- 2
2
-
Parameters - Scripts Page
Add more parameters as needed for additioanl scripts. These strings are sent out the serial port when the corresponding channel change is detected. For example, Script 2 is sent to the serial port when the third input channel goes from off to on. These scripts will also convert escape sequences like <CR> and \n for carriage returns and \r for line feed.
Script 0 script0
- Enter the script for Script 0 here.
Parameters - Common Page
Time Slice timeslice
- Turning this on forces the channels to be "Time Sliced". A Time Slice is the time between the last cook frame and the current cook frame.
Scope scope
- To determine which channels get affected, some CHOPs use a Scope string on the Common page.
Sample Rate Match srselect
- ⊞ - Handle cases where multiple input CHOPs' sample rates are different. When Resampling occurs, the curves are interpolated according to the Interpolation Method Option, or "Linear" if the Interpolate Options are not available.
- Resample At First Input's Rate
first
- Use rate of first input to resample others.
- Resample At Maximum Rate
max
- Resample to the highest sample rate.
- Resample At Minimum Rate
min
- Resample to the lowest sample rate.
- Error If Rates Differ
err
- Doesn't accept conflicting sample rates.
Export Method exportmethod
- ⊞ - This will determine how to connect the CHOP channel to the parameter. Refer to the Export article for more information.
- DAT Table by Index
datindex
- Uses the docked DAT table and references the channel via the index of the channel in the CHOP.
- DAT Table by Name
datname
- Uses the docked DAT table and references the channel via the name of the channel in the CHOP.
- Channel Name is Path:Parameter
autoname
- The channel is the full destination of where to export to, such hasgeo1/transform1:tx
.
Export Root autoexportroot
- This path points to the root node where all of the paths that exporting by Channel Name is Path:Parameter are relative to.
Export Table exporttable
- The DAT used to hold the export information when using the DAT Table Export Methods (See above).
Operator Inputs
- Input 0 -
TouchDesigner Build:
CHOPs |
---|
• • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • |