Component: Scale (DSP)

Scale component

Allows the values in a single buffer to be scaled uniformly. Functions include: Multiply, Divide, LeftShift, RightShift, Float Multiply, Float Divide

No detailed description exists yet for this component

Here is an example which demonstrates variable scaling based on an analogue input.

Here are the traces as seen on the data recorder window.

The RightShift macro is a very efficient means of performing a division but only for values which are a power of 2.

The LeftShift macro is a very efficient means of performing a multiplication but only for values which are a power of 2.

LeftShift(1) = Multiply by 2 / RightShift(1) = Divide by 2

LeftShift(2) = Multiply by 4 / RightShift(2) = Divide by 4

LeftShift(3) = Multiply by 8 / RightShift(3) = Divide by 8

LeftShift(4) = Multiply by 16 / RightShift(4) = Divide by 16

	SetScalerFloat
Sets the Float scaler to be used when calling the calculate function.
[[File:]] -	Scaler

- VOID	Return

	SetScalerInteger
Sets the Integer scaler to be used when calling the calculate function.
[[File:]] -	Scaler

- VOID	Return

	Calculate
Performs the selected scaling on a value from the input buffer and passes to the output buffer.
- VOID	Return

	CalculateArray
Performs the selected scaling on an entire buffer.
- VOID	Return

	ResetRecords
Allows the peak and trough to be reset back to default values.
[[File:]] -	ResetPeak

[[File:]] -	ResetTrough

- VOID	Return

	ReceiveString
Gets a string from the receive buffer
- UINT	MaxChars

- UINT	Timeout
Time in milliseconds to wait for data
- STRING	Return

	Initialise
Initialises the UART component pins ready to send and receive data
- VOID	Return

	ReceiveString
Receives a string of bytes and returns the number of bytes received.
- STRING	StringData

- UINT	NumBytes
Maximum number of bytes to try and receive
- UINT	Timeout
Max amount of time in ms to wait between bytes
- BYTE	Return

	Start
Startup routine required by the hardware device. Automatically clears the display after initialising.
- VOID	Return

	GetRxIdent
Gets the Rx ID as a Integer Standard and Extended IDs.
- BYTE	Buffer

- ULONG	Return

	Initialise
Must be called before any other CAN component macros to enable and initialise the CAN peripheral.
- VOID	Return

	Properties
	Connect To
DSP component with output buffer to collect our data from.
	Buffer Size
Number of individual elements the buffer can store, default 1.
	Buffer Type
Sets the buffer data type.
	Scale Type
Defines the type of calculation performed on the input buffer to obtain the output value. A left shift is essentially an optimised multiply with the multiplier being the 2^scaler A right shift is essentially an optimised divide with the divider being the 2^scaler
	Rollover
Allow the output buffer to rollover. For example 128 * 2 = 256 which would equate to 0 using an 8-bit buffer with rollover enabled. With rollover disabled the output would be set to 255 which is the max representable value.
	Initial Integer Scaler

	Connections
	Simulations