fsb::IncrementalEncoder Class Reference

Detailed Description

Incremental encoder.

#include <fsb_encoder.h>

Collaboration diagram for fsb::IncrementalEncoder:

Public Member Functions
EncoderStatus	set_parameters (uint8_t counter_resolution_bits, uint32_t counts_per_rev, Real value_per_rev)
	Set encoder parameters.
void	reset (int32_t count, Real value)
	Reset encoder to counts and associated value.
void	reset_value (Real value)
	Reset value at current count.
Real	decode (int32_t count)
	Get value in scaled units from counter update.
int32_t	encode (Real value)
	Encode value to number of counts.

Member Function Documentation

decode()

Real fsb::IncrementalEncoder::decode

(

int32_t

count

)

Get value in scaled units from counter update.

Parameters

count

New input from counter

Returns

Scaled value in user-defined units

encode()

int32_t fsb::IncrementalEncoder::encode

(

Real

value

)

Encode value to number of counts.

Parameters

value

Value to encode

Returns

Change in counts from last encode update

reset()

void fsb::IncrementalEncoder::reset	(	int32_t	count,
		Real	value
	)

Reset encoder to counts and associated value.

Parameters

count	Number of counts
value	Value to reset

reset_value()

void fsb::IncrementalEncoder::reset_value

(

Real

value

)

Reset value at current count.

Parameters

value

Value to reset

set_parameters()

EncoderStatus fsb::IncrementalEncoder::set_parameters	(	uint8_t	counter_resolution_bits,
		uint32_t	counts_per_rev,
		Real	value_per_rev
	)

Set encoder parameters.

Parameters

counter_resolution_bits	Bit depth of counter (max 64)
counts_per_rev	Number of counts per revolution
value_per_rev	scaled units per revolution

Returns

Encoder status

---

The documentation for this class was generated from the following files:

• fsb-core/include/fsb_encoder.h
• fsb-core/src/fsb_encoder.cpp