Serial port

This module allows you to open a serial port on your machine to communicate with hardware devices over RS-232 (serial communication). Lets you receive in a text string format ( ASCII ) and send values (text strings, array and MIDI/firmdata) .

Several Arduino examples are included (See serial module examples page for more infos.):

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 here the port used by your serial device.

baudrate

Data transmission rate (bits/second), must be the same as your serial device (in your arduino code for example).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 buffer 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

Connect the module to the serial port (must be switched twice)

connected

Confirm the connection

tx data (string)

Used to send 8-bit character strings data to the serial port, see send switch command to arduino example.

tx data (array)

Used to send array data to the serial port.Values cell values must be in the range of 0-255.

tx data (midi/firmdata)

Used to send MIDI/Firmdata to the serial port.Takes an incoming MIDI message and send 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

Clear the buffer, useful, for example when you turn the module OFF, then ON again

rx data

Data output

rx buffer overflow

Indicates a data overflow

protocol

Experts: serial protocol used:

  • Parity
  • Char size
  • Stop bits

trace

Trace in the Usine console for debugging:

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