Serial Port (USER MODULE)

This module allows you to open a serial port on your machine to communicate with hardware devices over a serial protocol.

Lets you receive in a text string format (ASCII ) and send values (text strings, arrays, and MIDI/Firmata).

how to know my serial port number

If you need to know your device serial port number to use this module:

• Windows: Check the device manager/port(COM & LPT)/

  You'll see something like: COM1, COM2,... This is the address of your serial port

• Mac OSX: Open a terminal and type: ls /dev/tty copy the line you'll see, example: dev/tty.usbmodem1a1341

port

Sets the port used by your serial device.

baudrate

Data transmission rate (bits/second). Must match the setting of your serial device (for example, in your Arduino code). Tested with standard baudrates 9600, 57600, 115200.

rx buffer size

2 modes:

• When > 0: Data Buffer size, up to 64 bytes (Each byte is composed of 8 bit character string).
• When 0, switch to delimiter mode.

rx byte delimiter

Determines the delimiter value: when this value is reached your buffer is stored (in a circular loop similar to the circular record mode of the sampler)

on

Connects the module to the serial port.

connected

Confirms the connection.

tx data (string)

Sends 8-bit character string data to the serial port.

tx data (array)

Sends array data to the serial port.

tx data (MIDI firmata)

Sends MIDI/Firmata data to the serial port. Takes an incoming MIDI message and sends it as a 3 bytes message without the channel information over the serial port. The channel information is ignored. This is a special format for the FIRMATA protocol.

clear rx buffer

Clears the buffer. Useful, for example, when you turn the module OFF, then ON again

rx data

Data output.

rx buffer overflow

Indicates a data buffer overflow.

saved in preset

Determines if parameters of this object are saved in the preset-panel.

fade preset

Parameters of the this object can cross faded when you recall a preset in the grid.

Protocol

For experts: serial protocol used.

• Parity
• Char size
• Stop bits

Trace

level

Trace in the Usine panel for debugging:

• info: show only last action
• debug: show only errors
• verbose: show all

See also

• External Device
• External Device HID
• Leap Motion (USER MODULE)
• External Device Joystick
• External Device Keyboard
• External Device Get Mouse
• Serial Port (USER MODULE)
• Wiimote (USER MODULE)
• External Wacom Tablet
• UltraLeap (USER MODULE)
• External Device Set Mouse
• External Device Sensors