configurePin

Set Arduino pin mode

Syntax

pinMode = configurePin(a,pin)

configurePin(a,pin,mode)

Description

pinMode = configurePin(a,pin) displays the mode 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.

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

• 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 used with ultrasonic sensor

• 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

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.