arduinolist

R2026b

List available Arduino hardware

Since R2024a

collapse all in page

    Syntax

    hwtable = arduinolist
    hwtable = arduinolist(Timeout=tlimit)

    Description

    Add-On Required: This feature requires the MATLAB Support Package for Arduino Hardware add-on.

    hwtable = arduinolist returns a table of Arduino® boards connected via USB.

    hwtable = arduinolist(Timeout=tlimit) limits the time to wait for hardware queries to tlimit seconds. The default Timeout value is 20 seconds.

    example

    Examples

    collapse all

    Get a table of available hardware.

    hwtable = arduinolist
    hwtable =

  3×4 table

     Port       Board             Status                    Libraries          
    ______    __________    __________________    _____________________________

    "COM3"    "Mega2560"    "Upgrade required"    {["I2C"    "Servo"    "SPI"]}
    "COM5"    "Uno"         "Setup required"      {["Not available"          ]}
    "COM8"    "MKR1000"     "Ready to connect"    {["I2C"    "SPI"    "Servo"]}

    Output Arguments

    collapse all

    Available Arduino hardware, returned as a table. The table has one row for each board, with the following columns:

    Column NameDescription
    PortSerial port device is connected to.
    BoardDevice model name.
    StatusIndication if device is ready to connect, or requires an upgrade or setup.
    LibrariesNames of the libraries being loaded to the IO server running on the board.

    Limitations

    This function does not list the names of the following boards in the output as these boards does not support auto COM port detection:

    • ESP32-DevKitV1

    • ESP32-DevKitC

    • ESP32-S3-DevKitC

    • ESP32-S3-DevKitM

    • Arduino Nano 3.1

    • Arduino Pro Mini.

    This function does not list the NanoESP32, Raspberry Pi Pico and Raspberry Pi Pico W boards in the output in MATLAB® Online environment.

    Alternative Functionality

    App

    Arduino Explorer lists all the available Arduino and Arduino-compatible hardware under the All Hardware section. The app is available in the installed version of MATLAB and MATLAB Online™. For more information, see Set Up and Connect to Arduino and Arduino-compatible Boards Using Arduino Explorer.

    For a complete list of hardware supported in the installed version of MATLAB, see Supported Hardware. For more information regarding supported boards, workflows, and platforms supported on MATLAB Online, see Get Started with MATLAB Online for Arduino.

    Version History

    Introduced in R2024a

    See Also

    |

    Topics