configurePin

R2026b

Set Arduino pin mode

Syntax

pinMode = configurePin(a,pin)

configurePin(a,pin,mode)

Description

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

pinMode = configurePin(a,pin) displays the mode of the specified pin on the Arduino^® hardware in connection a.

configurePin(a,pin,mode) sets the specified pin on the Arduino hardware in connection a to the specified mode.

Examples

Display Current Pin Mode

a = arduino('COM4','Uno');
configurePin(a,'A2')

ans = 
'Unset'

Configure Analog Pin to I2C Mode

a = arduino('COM4','Uno');
configurePin(a,'A4','I2C');

Display current pin mode.

pinMode = configurePin(a,'A4')

pinMode = 
'I2C'

Configure Digital Pin to Pullup Mode

a = arduino('COM4','Uno');
configurePin(a,'D3','pullup');

Display current pin mode.

pinmode = configurePin(a,'D3')

pinmode = 
'Pullup'

Clear Pin Mode

Display current pin mode and reset it to 'Unset'.

a = arduino('COM4','Uno');
configurePin(a,'D3','pullup');
pinMode = configurePin(a,'D3')

pinMode = 
'Pullup'

Change mode to 'Unset' and display the current mode.

configurePin(a,'D3','Unset');
pinMode = configurePin(a,'D3')

pinMode = 
'Unset'

Input Arguments

a — Arduino hardware connection

object

Arduino hardware connection created using arduino, specified as an object.

Example: a = arduino;

pin — Pin number

character vector

Pin number on the physical hardware, specified as a character vector.

Example: D3 or A1.

Note

If you connect to ESP32 board and the pin's mode is set to AnalogInput, the pin number must always correspond to a digital pin. For details, see Pin-mapping for ESP32 Boards.

mode — Pin mode

'unset' (default) | character vector

Pin mode specified as a character vector. Valid pin modes are:

• AnalogInput: acquire analog signals from pin

• DigitalInput: acquire digital signals from pin

• DigitalOutput: generate digital signals from pin

• I2C: specify a pin to use with I2C protocol

• Interrupt: specify pin in interrupt mode to be used in rotaryEncoder

• Pullup: specify pin to use a pullup switch

• PWM: specify pin to use a pulse width modulator

• CAN: specify pin to use a Controller Area Network bus

• Servo: specify pin to use a servo

• SPI: specify a pin to use with SPI protocol

• Tone: specify pin to use for playTone

• Ultrasonic: specify pin to use with ultrasonic sensor

• CAN: specify pin to use with CAN shield

• Unset: clears pin designation. The pin is no longer reserved and can be automatically set at the next operation.

Pins are configured on first usage. You can reset the pin mode to change the mode. If you want to use a pullup, you must set the mode to 'pullup'.

Output Arguments

pinMode — Current mode of Arduino pin

character vector

Current mode of pin, returned as a character vector.

More About

Pin-mapping for ESP32 Boards

If you connect to an ESP32 board, use the following table to map the analog pin number to the corresponding digital pin number, which must be entered as the pin's value.

Analog pin on ESP32-DevKitV1 and ESP32-DevKitC	Digital pin number to be useda
A0	D36
A3	D39
A4	D32
A5	D33
A6	D34
A7	D35
A10	D4
A12	D2
A13	D15
A14	D13
A15	D12
A16	D14
A17	D27
A18	D25
A19	D26
a If you connect to ESP32 board over WiFi from the MATLAB PC, transferring data through the following pins may not work properly: D2, D12, D13, D14, D15, D25, D26, and D27. For communication over WiFi, it is recommended that you use the other pins listed in this table.

Code Generation Using MATLAB Function Block

• Use configurePin in a MATLAB^® Function block with the Simulink^® Support Package for Arduino Hardware to generate code that can be deployed on Arduino Hardware.

• Configure the Arduino peripherals using configurePin before using it in the MATLAB Function block.

• The function does not return any output during code generation.

• The following modes are currently supported for code generation : AnalogInput, DigitalInput, DigitalOutput, Pullup, PWM, and Unset.

Alternative Functionality

App

Use the Pin Explorer pane and Pin Configuration panel in the Arduino Explorer to configure each pin to read and write data interactively in MATLAB and MATLAB Online™. In the Pin Explorer pane, click the row corresponding to the pin that you want to configure. The Pin Configuration panel displays the options you can use to configure the selected pin. In the Pin Configuration panel, select the Mode from the list, and if required specify a Label to uniquely identify the pin. For more information, see.

Version History

Introduced in R2015b