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.

Can be used to communicate with an Arduino.

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.

Must be toggled twice.

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.

Array values must be in the range 0-255.

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.

Optional setting, does not appear on all objects.

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
Common Settings

info

show manual

Button. Opens the manual page of the selected object (or of its parent module for a control) in the web browser. If no page exists for this object, an error is traced in the trace panel.

For more details about information/help creation, see create-help-file.

description

Free multi-line text attached to the module, saved with the patch. It is only meant as an internal note for the patch designer: it is not displayed in the interface.

ID's

visible only in god mode, see setup-panel-tab-expert.

unique ID

Read-only, not saved. Current private numeric ID of the object, used internally to identify it (for example as the target of a bind ID).

preset ID

Read-only, not saved. Private ID used to store and recall the values of this control in presets.

recreate ID

Button. Generates a new unique ID, original ID and preset ID for the object. Use it if you experience difficulties in Polyphonic mode or if two objects share the same ID. Preset values and binds referring to the old IDs are lost.

Object Remote Address

absolute

Read-only, not saved. Absolute address of the object in the Usine objects tree, built from the workspace root. This is the address to use to reach the object from scripts, the objects panel or remote messages. Only shown for objects that are registered in the objects list. See objects-address.

local

Read-only, not saved. Address of the object relative to the current patch, valid inside that patch only. See objects-address.

user addr

Free user-defined address for the object (empty by default). When set, the object is also registered in the objects tree under this name, so it can be reached independently of its position in the workspace (the value is also reported in the mouse-over and mouse-down chunks). Changing it rebuilds the objects list. Only available on objects that support a user address. See objects-address.

See also

version 7.0.250121

Edit All Pages