readCount

Read current count value from encoder connected to MKR Motor Carrier or Nano Motor Carrier

Syntax

[count] = readCount(encoder)

[count,timestamp] = readCount(encoder)

[count] = readCount(encoder,'Reset',reset)

[count,timestamp] = readCount(encoder,'Reset',reset)

Description

[count] = readCount(encoder) returns the current count value from the encoder.

[count,timestamp] = readCount(encoder) returns the current count value from the encoder along with the timestamp in datetime format.

[count] = readCount(encoder,'Reset',reset) resets the count value from the encoder to zero when 'Reset' is set to 'true' .

[count,timestamp] = readCount(encoder,'Reset',reset) resets the count value from the encoder to zero when 'Reset' is set to 'true' and the timestamp in datetime format.

Examples

Read Current Absolute Count Value

Create a connection to the Nano Motor Carrier.

arduinoObj = arduino('/dev/ttyACM0','Nano33IoT','Libraries','MotorCarrier');
mcObj = motorCarrier(arduinoObj);

Create a connection to the rotary encoder.

encoder = rotaryEncoder(mcObj,1);

Read the current absolute count value of encoder register of Nano Motor Carrier.

count = readCount(encoder);

Read Current Absolute Count Value with Timestamp

Create a connection to the Nano Motor Carrier.

arduinoObj = arduino('/dev/ttyACM0','Nano33IoT','Libraries','MotorCarrier');
mcObj = motorCarrier(arduinoObj);

Create a connection to the rotary encoder.

encoder = rotaryEncoder(mcObj,1);

Read the current absolute count value of encoder register of Nano Motor Carrier.

[count,timestamp] = readCount(encoder);

Read Current Incremental Count Value

Create a connection to the Nano Motor Carrier.

arduinoObj = arduino('/dev/ttyACM0','Nano33IoT','Libraries','MotorCarrier');
mcObj = motorCarrier(arduinoObj);

Create a connection to the rotary encoder.

encoder = rotaryEncoder(mcObj,1);

Read the current absolute count value of encoder register of Nano Motor Carrier.

count = readCount(encoder,'Reset',true);

Read Current Incremental Count Value with Timestamp

Create a connection to the Nano Motor Carrier.

arduinoObj = arduino('/dev/ttyACM0','Nano33IoT','Libraries','MotorCarrier');
mcObj = motorCarrier(arduinoObj);

Create a connection to the rotary encoder.

encoder = rotaryEncoder(mcObj,1);

Read the current absolute count value of encoder register of Nano Motor Carrier.

[count,timestamp] = readCount(encoder,'Reset',true);

Input Arguments

encoder — Rotary encoder connection

object

Connection to the rotary encoder on MKR Motor Carrier or Nano Motor Carrier, specified as an object.

reset — Flag to reset count value to 0

false (default) | true

Flag to reset count value to 0 after each read operation, specified as the comma-separated pair consisting of 'Reset' and either false or true. This is an optional argument.

Data Types: logical

Output Arguments

count — Current count value of the encoder

double

Current count value of the encoder, returned as a number.

Data Types: int32

timestamp — Elapsed time

datetime

Time at which MATLAB^® reads the count, specified as datetime.

Data Types: datetime

Version History

Introduced in R2020a