Support Additional Peripherals Using Custom Arduino Libraries

R2026b

Create a custom Arduino library to integrate custom peripherals like LCD screens and NeoPixel LED strips

A custom Arduino^® library is a communication interface between custom C++ code executed on the Arduino hardware and MATLAB^® code executed on your development computer.

With custom Arduino libraries, you can access additional features of an Arduino directly from the MATLAB command line by including the libraries when creating an arduino connection object. For an example of a custom Arduino library, see Control Motors Using Adafruit Motor Shield V2.

The MATLAB Support Package for Arduino Hardware provides you with a framework of classes that you can use to create custom Arduino libraries to use with your Arduino device and attached hardware shields. The support package provides classes and functions to help you develop a custom Arduino library, collectively referred to as the custom Arduino library framework.

You can create a custom library using one of the following workflows:

Create and configure the custom Arduino library package folder, MATLAB class, and C++ header files. Follow the steps in Create Custom Arduino Library or watch Create a Custom Arduino Library Manually.
Use the function arduinoio.customLibrary.createLibraryTemplate to generate a starter custom Arduino library that includes the required folder structure, MATLAB class, and C++ header file. You can then modify the generated template to implement custom functionalities.

Before you start, see Custom Arduino Library Concepts.

Classes

matlabshared.addon.LibraryBase Abstract class for deriving custom Arduino libraries

Functions

expand all

General Functions

`sendCommand`	Send message to Arduino device from MATLAB
`listArduinoLibraries`	Display a list of installed Arduino libraries
`validatePin`	Validate that pin supports specific functionality
`getMCU`	Get microcontroller of Arduino board
`getPinAlias`	Get alias pin number

Custom Library Template Functions

`arduinoio.customLibrary.downloadLibrary`	Install Arduino compatible libraries (Since R2026b)
`arduinoio.customLibrary.createLibraryTemplate`	Create custom library template (Since R2026b)

Terminal Functions

`getTerminalsFromPins`	Get terminal numbers from pins
`getPinsFromTerminals`	Get pin numbers from terminal
`getTerminalMode`	Get current terminal mode
`isTerminalDigital`	Check if terminal can be used as a digital pin
`isTerminalAnalog`	Check if terminal can be used as an analog pin
`getServoTerminals`	Get terminals that have servo functionality
`getI2CTerminals`	Get terminals with I2C functionality
`getSPITerminals`	Get terminals that have SPI functionality
`getPWMTerminals`	Get terminals with PWM functionality
`getInterruptTerminals`	Get terminals with interrupt functionality

Resource Functions

`configurePinResource`	Set resource owner and mode of pin
`decrementResourceCount`	Decrement count of number of instances of resource
`incrementResourceCount`	Increment current resource count
`getResourceCount`	Number of instances of a resource
`getFreeResourceSlot`	Get first free slot of resource
`setSharedResourceProperty`	Set shared resource property
`getSharedResourceProperty`	Get shared resource property
`getResourceOwner`	Get terminal resource owner

Topics

Getting Started

Custom Arduino Library Concepts
Understand the components and communication workflow of a custom Arduino library.
Create Custom Arduino Library

Access unsupported hardware and peripherals connected to Arduino boards by creating custom Arduino libraries that enable communication between MATLAB and Arduino hardware.
- STEP 1: Create Custom Arduino Library Package Folder
- STEP 2: Create and Configure C++ Header File
- STEP 3: Create and Configure MATLAB Custom Arduino Library Class
- STEP 4: Register Custom Arduino Library
Create Custom Arduino Library Using Template
Use the arduinoio.customLibrary.createLibraryTemplate function to generate template files for a custom Arduino library.
Adapt Add-ons to New matlabshared.addon.LibraryBase Class
Learn how to configure your existing add-on class to the new matlabshared.addon.LibraryBase class.

Arduino Hardware Resources and Pin Diagram

Custom Arduino Library Resources
Manage hardware resources among custom Arduino libraries.
Physical Terminals and Pin Numbers
Understand the difference between terminal numbers and pin numbers on your Arduino board.

Additional Information

Send Data from Arduino to MATLAB Using Custom Library
Create your first custom Arduino library.
Enable Support for LCD Using Custom Arduino Library
Create a custom Arduino library for LCD support.