arduinoio.customLibrary.createLibraryTemplate

R2026b

Create custom library template

Since R2026b

Syntax

arduinoio.customLibrary.createLibraryTemplate(libraryName)

Description

arduinoio.customLibrary.createLibraryTemplate(libraryName) creates a template for developing a custom library for use with the MATLAB^® Support Package for Arduino^® Hardware. The function generates MATLAB and C++ source file templates that establish communication between MATLAB and Arduino hardware. The generated files provide a starter template that can be extended to implement the required device behavior. Modify the generated MATLAB and C++ files to implement hardware‑specific behavior. For more information about this template, see Generated MATLAB Class and Generated C++ Header File.

The function stores the generated files in +arduinoioaddons in a folder called +<LibraryName>Folder. You can rename this folder after creation. For more information about the file organization within <LibraryName>Folder, see Generated Folder Structure.

Examples

Create and Integrate Custom Arduino Library

Create a template for a custom library named MyLCD to communicate with an LCD display connected to the Arduino board.

arduinoio.customLibrary.createLibraryTemplate("MyLCD")

MATLAB creates a new folder named +LCDFolder that contains templates for the MATLAB and C++ files required for the custom library.

Connect to an Arduino board and send it the custom library.

a = arduino("COM5","uno","Libraries","MyLCDFolder/MyLCD");

MATLAB programs the Arduino board with the generated library and registers the library.

Connect to the LCD display using the custom library. To do so, create an addon object.

addonObject = addon(a,"MyLCDFolder/MyLCD");

To test the connection, call a method defined in the custom library. By default, the generated library template includes a testRead that returns Hello from Arduino from the Arduino.

addonObject.testRead

ans = 

    'Hello from Arduino'

You can modify the generated MATLAB and C++ files to implement your own custom functionalities.

Input Arguments

libraryName — Name of custom library

string | character vector

Name of custom library, specified as a string or character vector.

Example: arduinoio.customLibrary.createLibraryTemplate("MyLCD")

Data Types: string | char

More About

Generated Folder Structure

When you use this function, MATLAB creates an +arduinoioaddons folder, if one does not exist in the current working folder. Inside +arduinoioaddons, the function creates the folder <LibraryName>Folder. This folder contains:

• <LibraryName>.m - A MATLAB class file

• src - A folder containing .h, the C++ header file required for the custom library.

These files provide a starting point for implementing custom functionality in both MATLAB and Arduino code. You can modify these files as needed for your functionality.

When registering or accessing the custom Arduino library, use <LibraryName>Folder/<LibraryName> as the library name. You can rename <LibraryName>Folder after it is created. If you do so, use the new folder name when registering or accessing the custom Arduino library.

Generated MATLAB Class

The generated MATLAB class file, <LibraryName>.m, defines the MATLAB interface for the custom library. This class implements the methods that you can call from MATLAB to interact with the custom hardware.

The file includes:

• A constructor that associates the add‑on with an arduino object.

• Library metadata required for registering the add‑on with MATLAB.

• A sample method that demonstrates how to send a command to the Arduino hardware and receive a response.

You can add methods to support additional functionality implemented on the Arduino hardware.

Generated C++ Header File

The generated C++ header file, <LibraryName>.h, provides a reference implementation of the code that runs on the Arduino hardware. This file defines how the Arduino firmware processes commands sent from MATLAB.

The file includes:

• Code that registers the library with the Arduino firmware.

• A command handler that processes commands sent from MATLAB.

• A sample command case that sends a response message back to MATLAB.

The default implementation returns a static response message to illustrate how data is sent from the Arduino hardware to MATLAB. You can modify this header file to implement custom hardware logic.

Version History

Introduced in R2026b