|
|
| (3 intermediate revisions by the same user not shown) |
| Line 14: |
Line 14: |
| | ==Scale component== | | ==Scale component== |
| | Allows the values in a single buffer to be scaled uniformly. Functions include: Multiply, Divide, LeftShift, RightShift, Float Multiply, Float Divide | | Allows the values in a single buffer to be scaled uniformly. Functions include: Multiply, Divide, LeftShift, RightShift, Float Multiply, Float Divide |
| | + | |
| | + | ==Component Pack== |
| | + | |
| | + | DSP |
| | | | |
| | ==Detailed description== | | ==Detailed description== |
| | + | |
| | + | |
| | + | |
| | + | |
| | + | |
| | + | |
| | + | |
| | + | |
| | | | |
| | | | |
| Line 22: |
Line 34: |
| | | | |
| | ==Examples== | | ==Examples== |
| | + | |
| | + | |
| | + | |
| | + | |
| | + | |
| | + | |
| | + | |
| | + | |
| | | | |
| | | | |
| Line 58: |
Line 78: |
| | |- | | |- |
| | |- | | |- |
| − | | width="10%" align="center" | [[File:]] - | + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT |
| | | width="90%" | Scaler | | | width="90%" | Scaler |
| | |- | | |- |
| Line 76: |
Line 96: |
| | |- | | |- |
| | |- | | |- |
| − | | width="10%" align="center" | [[File:]] - | + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT |
| | | width="90%" | Scaler | | | width="90%" | Scaler |
| | |- | | |- |
| Line 105: |
Line 125: |
| | |- | | |- |
| | | colspan="2" | Performs the selected scaling on an entire buffer. | | | colspan="2" | Performs the selected scaling on an entire buffer. |
| − | |-
| |
| − | |-
| |
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| |
| − | | width="90%" style="border-top: 2px solid #000;" | ''Return''
| |
| − | |}
| |
| − |
| |
| − |
| |
| − | {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
| |
| − | |-
| |
| − | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| |
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ResetRecords'''
| |
| − | |-
| |
| − | | colspan="2" | Allows the peak and trough to be reset back to default values.
| |
| − | |-
| |
| − | |-
| |
| − | | width="10%" align="center" | [[File:]] -
| |
| − | | width="90%" | ResetPeak
| |
| − | |-
| |
| − | | colspan="2" |
| |
| − | |-
| |
| − | | width="10%" align="center" | [[File:]] -
| |
| − | | width="90%" | ResetTrough
| |
| − | |-
| |
| − | | colspan="2" |
| |
| − | |-
| |
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| |
| − | | width="90%" style="border-top: 2px solid #000;" | ''Return''
| |
| − | |}
| |
| − |
| |
| − |
| |
| − | {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
| |
| − | |-
| |
| − | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| |
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveString'''
| |
| − | |-
| |
| − | | colspan="2" | Gets a string from the receive buffer
| |
| − | |-
| |
| − | |-
| |
| − | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| |
| − | | width="90%" | MaxChars
| |
| − | |-
| |
| − | | colspan="2" |
| |
| − | |-
| |
| − | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| |
| − | | width="90%" | Timeout
| |
| − | |-
| |
| − | | colspan="2" | Time in milliseconds to wait for data
| |
| − | |-
| |
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| |
| − | | width="90%" style="border-top: 2px solid #000;" | ''Return''
| |
| − | |}
| |
| − |
| |
| − |
| |
| − | {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
| |
| − | |-
| |
| − | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| |
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
| |
| − | |-
| |
| − | | colspan="2" | Initialises the UART component pins ready to send and receive data
| |
| − | |-
| |
| − | |-
| |
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| |
| − | | width="90%" style="border-top: 2px solid #000;" | ''Return''
| |
| − | |}
| |
| − |
| |
| − |
| |
| − | {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
| |
| − | |-
| |
| − | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| |
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveString'''
| |
| − | |-
| |
| − | | colspan="2" | Receives a string of bytes and returns the number of bytes received.
| |
| − | |-
| |
| − | |-
| |
| − | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| |
| − | | width="90%" | StringData
| |
| − | |-
| |
| − | | colspan="2" |
| |
| − | |-
| |
| − | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| |
| − | | width="90%" | NumBytes
| |
| − | |-
| |
| − | | colspan="2" | Maximum number of bytes to try and receive
| |
| − | |-
| |
| − | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| |
| − | | width="90%" | Timeout
| |
| − | |-
| |
| − | | colspan="2" | Max amount of time in ms to wait between bytes
| |
| − | |-
| |
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| |
| − | | width="90%" style="border-top: 2px solid #000;" | ''Return''
| |
| − | |}
| |
| − |
| |
| − |
| |
| − | {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
| |
| − | |-
| |
| − | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| |
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Start'''
| |
| − | |-
| |
| − | | colspan="2" | Startup routine required by the hardware device. Automatically clears the display after initialising.
| |
| − | |-
| |
| − | |-
| |
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| |
| − | | width="90%" style="border-top: 2px solid #000;" | ''Return''
| |
| − | |}
| |
| − |
| |
| − |
| |
| − | {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
| |
| − | |-
| |
| − | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| |
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLEDState'''
| |
| − | |-
| |
| − | | colspan="2" | Sets the state of a single LED
| |
| − | |-
| |
| − | |-
| |
| − | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| |
| − | | width="90%" | Port
| |
| − | |-
| |
| − | | colspan="2" | 0 = PortA, 1 = PortB
| |
| − | |-
| |
| − | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| |
| − | | width="90%" | LED
| |
| − | |-
| |
| − | | colspan="2" | 0 = LED0, 7 = LED7
| |
| − | |-
| |
| − | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| |
| − | | width="90%" | State
| |
| − | |-
| |
| − | | colspan="2" |
| |
| − | |-
| |
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| |
| − | | width="90%" style="border-top: 2px solid #000;" | ''Return''
| |
| − | |}
| |
| − |
| |
| − |
| |
| − | {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
| |
| − | |-
| |
| − | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| |
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRxIdent'''
| |
| − | |-
| |
| − | | colspan="2" | Gets the Rx ID as a Integer Standard and Extended IDs.
| |
| − | |-
| |
| − | |-
| |
| − | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| |
| − | | width="90%" | Buffer
| |
| − | |-
| |
| − | | colspan="2" |
| |
| − | |-
| |
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
| |
| − | | width="90%" style="border-top: 2px solid #000;" | ''Return''
| |
| − | |}
| |
| − |
| |
| − |
| |
| − | {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
| |
| − | |-
| |
| − | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| |
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
| |
| − | |-
| |
| − | | colspan="2" | Must be called before any other CAN component macros to enable and initialise the CAN peripheral.
| |
| | |- | | |- |
| | |- | | |- |
| Line 281: |
Line 142: |
| | |- | | |- |
| | |- | | |- |
| − | | width="10%" align="center" | [[File:Fc9-type-17-icon.png]] | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] |
| | | width="90%" | Connect To | | | width="90%" | Connect To |
| | |- | | |- |
| Line 295: |
Line 156: |
| | |- | | |- |
| | | colspan="2" | Sets the buffer data type. | | | colspan="2" | Sets the buffer data type. |
| | + | |- |
| | + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] |
| | + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Scaling |
| | + | |- |
| | |- | | |- |
| | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] |
| Line 310: |
Line 175: |
| | |- | | |- |
| | | colspan="2" | | | | colspan="2" | |
| − | |-
| |
| − | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
| |
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
| |
| − | |-
| |
| − | |-
| |
| − | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
| |
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
| |
| − | |-
| |
| | |} | | |} |
| Author
|
Matrix Ltd
|
| Version
|
1.1
|
| Category
|
DSP
|
Scale component
Allows the values in a single buffer to be scaled uniformly. Functions include: Multiply, Divide, LeftShift, RightShift, Float Multiply, Float Divide
Component Pack
DSP
Detailed description
No detailed description exists yet for this component
Examples
Here is an example which demonstrates variable scaling based on an analogue input.
Scale
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
Downloadable macro reference
|
SetScalerFloat
|
| Sets the Float scaler to be used when calling the calculate function.
|
 - FLOAT
|
Scaler
|
|
|
 - VOID
|
Return
|
|
|
SetScalerInteger
|
| Sets the Integer scaler to be used when calling the calculate function.
|
 - INT
|
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
|
Property reference
|
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.
|
|
Scaling
|
|
|
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
|
|
|
- FLOAT
- VOID
- INT
