Encoder

R2026b

Measure rotation of encoder in counts

Since R2022b

• 

Encoder block

To add a block to a model, double-click the canvas and start typing the block name. Then, select the block from the list.

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 / STM32H7RSxx 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

Measure the rotation of the encoder in counts.

The Count port outputs the timer counter value as uint32 data.

Examples

Signal Monitoring and Parameter Tuning of Generated PWM Output

Generate PWM signals on an STM32 processor-based board and tune parameters in real time using External mode.

• Open Model

Using Hardware Interrupt Block to Create an ISR on STMicroelectronics STM32 Processor Based Boards

Use a Hardware Interrupt block to create an interrupt service routine (ISR) in the generated code for STM32™ Microcontroller Blockset.

• Open Model

Get Started with STMicroelectronics STM32 Processor Based Boards

Run a Simulink model on STM32 processor.

• Open Model

Ports

Input

Reset — Input port to reset timer counter

scalar

Use this port to reset the timer counter.

Providing input as 1, it sets the counter value to:

• 0 - If the timer counter is counting upwards

• AutoReload Register (ARR) value - if the timer counter is counting downwards.

Dependencies

To enable this port, select the Enable timer counter reset input parameter.

Data Types: Boolean | uint16 | uint32 | int8 | uint8 | int16 | int32 | uint64 | int64 | single | double

Output

Count — Timer counter output

scalar

The Count port outputs the current timer counter value as uint32 data.

Data Types: uint32

Dir — Counter direction output

scalar

The block outputs the current direction of the counter as one of the following:

• 0 - Up counter

• 1 - Down counter

Dependencies

To enable this port, select the Enable timer counter direction output parameter.

Data Types: Boolean

Status — Status of encoder

scalar

The port outputs if any index or transition error are detected.

• 0 – No error is detected

• 1 – Transition error is detected

• 2 – Index error is detected

• 3 – Both Index and transition error are detected

Index error is detected when IERRF flag is set and transition error is detected when TERRF flag is set in the TIMx_SR status register. For more information, see Encoder error management section in the STM32G4xx reference manual.

Note

The Status port is available only for STM32G4xx based boards.

Dependencies

To enable this port, select the Output status parameter.

Data Types: uint8

Index Recvd — Status of index pulse

scalar

Outputs 0 till the first index pulse is received.

• 0 - Until the first index pulse is received

• 1 - After the first index pulse is received

Note

• The Index Recvd port is available only for STM32G4xx based boards.

• Enable this port only if Encoder Mode + index is set as Combined Channels mode in STM32CubeMX project (Timer > TIM# > Mode > Combined Channels).

Dependencies

To enable this port, select the Output if first index pulse is received parameter.

Data Types: Boolean

Parameters

Timer module — Select timer module

TIM1 (default) | TIM2 | TIM3 | TIM4 | TIM5 | TIM8 | TIM20

Select the timer module.

Note

• Ensure that Timer module is also configured in the STM32CubeMX project.

• Ensure the Combined channels mode in STM32CubeMX project (Timer > TIM# > Mode > Combined Channels) is:

  • Encoder Mode - for STM32H7xx, F7xx and F4xx boards

  • Encoder Mode or Encoder Mode + Index - for STM32G4xx board

Programmatic Use

Block Parameter: TimerModule

Enable timer counter reset input — Enable input to reset counter

off (default) | on

Enable the input to reset the counter.

Enabling this option adds an input port Reset, which can be used to reset the timer counter value.

Programmatic Use

Block Parameter: EnableResetInput

Enable timer counter direction output — Select output counter direction

off (default) | on

Enable this parameter to output the current direction of the counter.

Programmatic Use

Block Parameter: OutputDirection

Show encoder counts only after first index pulse is received — Select to show encoder counts only after first index pulse is received

off (default) | on

Enable this parameter to show encoder counts only after first index pulse is received.

If this parameter is selected, the counts port outputs 0 till the first index pulse is received. After receiving the first index pulse, counts port outputs the current timer counter value.

Note

• This parameter is available only for STM32G4xx based boards.

• Enable this port only if Encoder Mode + index is set as Combined Channels mode in STM32CubeMX project (Timer > TIM# > Mode > Combined Channels).

Programmatic Use

Block Parameter:OutputCountAfterFirstIndex

Output if first index pulse is received — Select to show first index pulse is received

off (default) | on

When you select the Output if first index pulse is received parameter, the block configures an output port, Index Recvd. This port outputs 0 till the first index pulse is received.

Note

• This parameter is available only for STM32G4xx based boards.

• Enable this port only if Encoder Mode + index is set as Combined Channels mode in STM32CubeMX project (Timer > TIM# > Mode > Combined Channels).

Programmatic Use

Block Parameter:OutputValidIndex

Output status — Enable to configure output status port

off (default) | on

Select this parameter to output status of read data. Status output 1 indicates overrun error.

When you select the Output Status parameter, the block configures an output port, Status. This port outputs if any Index or transition error is detected.

Programmatic Use

Block Parameter:OutputStatus

Sample time — Frequency at which enabled output ports are read

-1 (default) | non-negative real value

Specify how often (in seconds) the status of enabled output ports are read if no input ports are selected. Enter a value greater than zero. When you specify this parameter as -1, Simulink^® determines the best sample time for the block based on the block context within the model.

Dependencies

To enable this port, clear the Enable timer counter reset input parameter.

Programmatic Use

Block Parameter: SampleTime

Programmatic Use: Add Block

To add the block programmatically, use the add_block function with one of these library block paths as the source.

"stm32f1xxblockslib/Encoder"

"stm32f2xxblockslib/Encoder"

"stm32f3xxblockslib/Encoder"

"stm32f4xxblockslib/Encoder"

"stm32f7xxblockslib/Encoder"

"stm32g0xxblockslib/Encoder"

"stm32g4xxblockslib/Encoder"

"stm32h5xxblockslib/Encoder"

"stm32h7xxblockslib/Encoder"

"stm32h7rsxxblockslib/Encoder"

"stm32l4xxblockslib/Encoder"

"stm32l5xxblockslib/Encoder"

"stm32u5xxblockslib/Encoder"

"stm32wbxxblockslib/Encoder"

Example: add_block("stm32f1xxblockslib/Encoder","myModel/myBlock",MakeNameUnique="on")

Extended Capabilities

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

Version History

Introduced in R2022b