Digital Port Read

Read GPIO pin status

Since R2021b

• 

Libraries:
STM32 Microcontroller Blockset / STM32F1xx Based Boards
STM32 Microcontroller Blockset / STM32F2xx Based Boards
STM32 Microcontroller Blockset / STM32F3xx Based Boards
STM32 Microcontroller Blockset / STM32F4xx Based Boards
STM32 Microcontroller Blockset / STM32F7xx Based Boards
STM32 Microcontroller Blockset / STM32G0xx Based Boards
STM32 Microcontroller Blockset / STM32G4xx Based Boards
STM32 Microcontroller Blockset / STM32H5xx Based Boards
STM32 Microcontroller Blockset / STM32H7xx Based Boards
STM32 Microcontroller Blockset / STM32L4xx Based Boards
STM32 Microcontroller Blockset / STM32L5xx Based Boards
STM32 Microcontroller Blockset / STM32U5xx Based Boards
STM32 Microcontroller Blockset / STM32WBxx Based Boards

Description

Read the logical status of a GPIO port pins for STM32 processors.

Note

You can run a Simulink^® model containing Digital Port Read block in Connected IO mode on STM32 Processor Based Boards. For more information, see Communicate with Hardware Using Connected IO.

Examples

Get Started with STMicroelectronics STM32 Processor Based Boards

Run a Simulink model on STM32 processor.

• Open Model

Ports

Input

Pin n msg — SoC Blockset™ simulation message

scalar

The simulation-only message input port, when connected to an Digital IO Interface (SoC Blockset) block, acts as pass-through with the input to the Digital IO Interface block emitted on the output of the Digital Port Read block during simulation. When the Access port pins as array parameter is not selected, a simulation port is generated for each pin in the Pin number parameter, otherwise the pin array must be treated as a scalar.

Dependencies

To enable this port, check the Enable simulation port parameter.

Data Types: SoCData

Output

Pin(s) — Output port containing the logical value

scalar | vector

The port outputs the logical state of the digital pin on the board that you specify in the Pin number parameter.

Dependencies

To output multiple port values, select Access port pins as array parameter.

Data Types: Boolean

Parameters

Port name — Port to read GPIO pin status

GPIOA (default) | GPIOB | GPIOC | GPIOD | GPIOE | GPIOF | GPIOG | GPIOH | GPIOI | GPIOJ | GPIOK

Select one of GPIOA to GPIOK ports to get a GPIO pin status of a specified GPIO port.

Programmatic Use

Block Parameter: PortName

Pin number — GPIO pin to read logical status

0 (default) | scalar | vector

Specify a GPIO pin to read the logical status.

When you specify a GPIO pin number and Access port pins as array parameter is enabled, the output is always in the incremental order of pin number.

Programmatic Use

Block Parameter: PinNumber

Access port pins as array — Output multiple pin values

on (default) | off

Select this parameter to output multiple port pin values.

Programmatic Use

Block Parameter: IOAsArray

Sample time — Frequency at which block reads input pin value

-1 (default) | scalar | vector

Specify in seconds how often this block reads the pin value.

When you specify this parameter as -1, Simulink determines the best sample time for the block based on the block context within the model.

Programmatic Use

Block Parameter: SampleTime

Enable simulation port — Enable simulation ports to block

off (default) | on

Select this parameter to add an SoC Blockset compatible simulation input port.

Programmatic Use

Block Parameter: EnableSimPort

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.

Version History

Introduced in R2021b