Wolfram Language & System 11.0 (2016)|Legacy Documentation

This is documentation for an earlier version of the Wolfram Language.View current documentation (Version 11.2)

Serial (RS-232 / RS-422 serial protocol)
This feature is not supported on the Wolfram Cloud.

"Serial" provides a general interface for serial communication through RS-232 and RS-422 protocols.
Serial communication is typically available through /dev/ttyXX devices on Unix-based systems or COM ports on Windows-based systems.
Serial communication is often implemented in hardware using a UART.
Physical connectors for serial ports include D-subminiature 25-pin connectors and DE-9 9-pin connectors.
Serial communication is also often done through USB, Bluetooth, etc.

Device DiscoveryDevice Discovery

  • Serial connections are not usually automatically discoverable and can often only be determined from documentation.
  • On Unix-based systems, names of serial connections can sometimes be identified by comparing the list of /dev/tty* devices before and after a particular connection is plugged in.

Opening the DeviceOpening the Device

    DeviceOpen["Serial"]
    opens the default serial port.

    DeviceOpen["Serial",name]
    opens the serial port with the specified name. Typical names on Unix-based systems are "/dev/ttyXX" or "/dev/tty.usbserialXX" and under Windows are "COM1", "COM2", etc.

    DeviceOpen["Serial",opts]
    opens the default serial port with the specified options.

  • The following options can be given:
  • "BaudRate"9600data transfer rate in bits per second
    "DataBits"8number of data bits to use per frame
    "Handshake"Nonethe flow control handshake protocol
    "IgnoreBreak"Falsewhether to ignore breaks
    "Parity"Nonesetting for the parity bit
    "ReadBufferSize"4096size of the read buffer in bytes
    "StopBits"Nonenumber of stop bits to use
  • Typical baud rate values include: 4800, 9600, 19200, 38400, 57600, 115200, 230400.
  • "DataBits" gives the number of bits in each byte used to carry data. Possible values are: 5, 6, 7, 8, 9.
  • Possible settings for the flow control handshake protocol "Handshake" are: None, "RTS", "XOnXOff".
  • Possible values for "Parity", specifying how the parity bit should be set, are: None, "Even", "Odd", "Mark", "Space".
  • "StopBits" gives the number of bits used to separate data frames. Possible values are: None, 0, 1.5, 2.

Configuring the DeviceConfiguring the Device

  • Configuration is not required. Use DeviceOpen to set parameters for the serial connection.

Reading DataReading Data

    DeviceRead[dev]
    reads a single byte from the serial connection, returning an integer value.

    DeviceRead[dev,"String"]
    reads a single character from the serial connection, returning the character as a string.

    DeviceReadBuffer[dev]
    reads all available bytes in the serial connection buffer, returning a list of integers.

    DeviceReadBuffer[dev,n]
    reads the most recent n bytes in the serial connection buffer.

    DeviceReadBuffer[dev,"ReadTerminator"->term]
    reads bytes from the serial port buffer until a terminator term.

  • Wolfram Language functions such as DeviceReadLatest and DeviceReadTimeSeries are also supported.
  • Bytes are represented in the Wolfram Language by their integer values.
  • Lists of bytes can be converted to character strings using FromCharacterCode.
  • The setting for "ReadTerminator" can be a single byte or character.
  • If no data is available to be read, the read functions will time out after a preset time of 10 seconds.

Writing DataWriting Data

    DeviceWrite[dev,b]
    writes a byte b to the serial connection.

    DeviceWrite[dev,{b1,b2,}]
    writes a list of bytes bi to the serial connection.

    DeviceWrite[dev,"string"]
    writes the bytes in a string to the serial connection.

  • Wolfram Language functions such as DeviceWriteBuffer are also supported.
  • Bytes can be specified either as integers between 0 and 255 or as single-character ASCII strings.

Executing CommandsExecuting Commands

    DeviceExecute[dev,"ReadFlush"]
    flushes any data that has been read and buffered.

    DeviceExecute[dev,"SerialReadyQ"]
    gives True if there is any buffered data available for reading, and False otherwise.

  • The "SerialReadyQ" command can be used to check whether reading from the serial connection could block.

Closing and Releasing ResourcesClosing and Releasing Resources

    DeviceClose[dev]
    closes the serial connection and frees related resources.

ExamplesExamplesopen allclose all

Basic Examples  (1)Basic Examples  (1)

These examples were run on a Raspberry Pi with an Arduino connected by USB. The Arduino is running a custom program called a sketch.
  • Open a connection to an Arduino connected to a Raspberry Pi and read a string returned by the Arduino:
  • In[1]:=
    Click for copyable input
    In[2]:=
    Click for copyable input
    Out[2]=
  • Read the next byte sent from the Arduino:
  • In[3]:=
    Click for copyable input
    Out[3]=
  • Write a byte to the Arduino:
  • In[4]:=
    Click for copyable input
  • Write a string to the Arduino:
  • In[5]:=
    Click for copyable input
  • Close the connection to the Arduino:
  • In[6]:=
    Click for copyable input