Component: Map Function (Storage)

From Flowcode Help
Revision as of 20:35, 16 November 2021 by Wiki bot (talk | contribs) (Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | medelec35 |- | width="20%" style="color:gray;" | Version | 2.0 |- | width="20%" style="color:gray;...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search
Author medelec35
Version 2.0
Category Storage


Map Function component

The map function is intended to change one range of values into another range of values. For example. Output from a temperature sensor is in centigrade. you can map it to give the result in Fahrenheit. To do that set: InMin to 0, InMax 100, OutMin to 32 & OutMax to 212

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

Fc9-comp-macro.png MapUlong
Map function for unsigned long type variables 
Fc9-u32-icon.png - ULONG Value
Main variable used for map function 
Fc9-u32-icon.png - ULONG InMin
Lowest input value 
Fc9-u32-icon.png - ULONG InMax
Highest value input 
Fc9-u32-icon.png - ULONG OutMin
Lowest value after conversion 
Fc9-u32-icon.png - ULONG OutMax
highest value after conversion 
[[File:]] - ClampMinMax
Clamp min & max so result does not go above or below set values. 0=No, 1=Yes 
Fc9-u32-icon.png - ULONG Return


Fc9-comp-macro.png MapInt
Map function for signed int type variables 
[[File:]] - Value
Main variable used for map function 
[[File:]] - InMin
Lowest input value 
[[File:]] - InMax
Highest value input 
[[File:]] - OutMin
Lowest value after conversion 
[[File:]] - OutMax
highest value after conversion 
[[File:]] - ClampMinMax
Clamp min & max so result does not go above or below set values. 0=No, 1=Yes 
[[File:]] - Return


Fc9-comp-macro.png MapFloat
Map function for floating point type variables 
[[File:]] - Value
Main variable used for map function 
[[File:]] - InMin
Lowest input value 
[[File:]] - InMax
Highest value input 
[[File:]] - OutMin
Lowest value after conversion 
[[File:]] - OutMax
highest value after conversion 
[[File:]] - ClampMinMax
Clamp min & max so result does not go above or below set values. 0=No, 1=Yes 
[[File:]] - Return


Fc9-comp-macro.png MapLong
Map function for signed long type variables 
[[File:]] - Value
Main variable used for map function 
[[File:]] - InMin
Lowest input value 
[[File:]] - InMax
Highest value input 
[[File:]] - OutMin
Lowest value after conversion 
[[File:]] - OutMax
highest value after conversion 
[[File:]] - ClampMinMax
Clamp min & max so result does not go above or below set values. 0=No, 1=Yes 
[[File:]] - Return


Fc9-comp-macro.png MapUInt
Map function for unsigned int type variables 
Fc9-u16-icon.png - UINT Value
Main variable used for map function 
Fc9-u16-icon.png - UINT InMin
Lowest input value 
Fc9-u16-icon.png - UINT InMax
Highest value input 
Fc9-u16-icon.png - UINT OutMin
Lowest value after conversion 
Fc9-u16-icon.png - UINT OutMax
highest value after conversion 
[[File:]] - ClampMinMax
Clamp min & max so result does not go above or below set values. 0=No, 1=Yes 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png MapByte
Map function for byte type variables 
Fc9-u8-icon.png - BYTE Value
Main variable used for map function 
Fc9-u8-icon.png - BYTE InMin
Lowest input value 
Fc9-u8-icon.png - BYTE InMax
Highest value input 
Fc9-u8-icon.png - BYTE OutMin
Lowest value after conversion 
Fc9-u8-icon.png - BYTE OutMax
highest value after conversion 
[[File:]] - ClampMinMax
Clamp min & max so result does not go above or below set values. 0=No, 1=Yes 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png SendPolyPressure
Sends a note press with an associated polyphonic pressure value. 
Fc9-u8-icon.png - BYTE Channel
 
Fc9-u8-icon.png - BYTE Note
 
Fc9-u8-icon.png - BYTE Pressure
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadData
 
Fc9-u8-icon.png - BYTE Idx
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png SendPatch
 
Fc9-u8-icon.png - BYTE Channel
 
Fc9-u8-icon.png - BYTE Instrument
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SendChannelPressure
 
Fc9-u8-icon.png - BYTE Channel
 
Fc9-u8-icon.png - BYTE Pressure
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
Initialises the MIDI component and sets up the UART. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png CommsBaud
Sets the Baud rate of the alt communications channel 
Fc9-u8-icon.png - BYTE Baud
Range: 0-7 : 0=1200 / 7=115200 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png LCDOptions
Controls some of the LCD options 
Fc9-u8-icon.png - BYTE Foreground
Range: 0-1 
Fc9-u8-icon.png - BYTE Background
Range: 0-1 
Fc9-u8-icon.png - BYTE Transparent
Range: 0-1 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png LCDVerbose
Controls the Verbose mode. When enabled the LCD automatically displays an account of the incoming API commands and parameters. When switched off the LCD is free for the user to control as required. 
Fc9-u8-icon.png - BYTE Mode
Range: 0-1 : 0=Off or User Mode / 1=API Verbose Mode 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadDigitalInput
Reads a single digital input. 
Fc9-u8-icon.png - BYTE Channel
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png PWMConfig
Sets the PWM configuration. Channel = 0 - 1 : 0 = EN_AB, A, B / 1 = EN_CD, C, D Period = 0 - 65535 Scaler = 0 - 3 : 0=1:1 1=1:8 2=1:64 3=1:256 
Fc9-u8-icon.png - BYTE Channel
Range 0-1 
Fc9-u16-icon.png - UINT Period
Range: 0-65535 
Fc9-u8-icon.png - BYTE Scaler
Range: 0-3 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png PWMEnable
Allows pulse width modulated transistor outputs to be switched on or off. Bit 0 = Enable AB Bit 1 = A / Bit 2 = B Bit 3 = C / Bit 4 = D Bit 5 = Enable CD 
Fc9-u8-icon.png - BYTE EnableMask
Range 0-63 or 0b00000 to 0b111111 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png PWMDuty
Sets a single PWM channel duty. Channel = 0 - 5 : 0=EN_AB, 1=A, 2=B, 3=C, 4=D, 5=EN_CD Duty = 0 - 65535 
Fc9-u8-icon.png - BYTE Channel
Range 0-5 
Fc9-u16-icon.png - UINT Duty
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png LCDCursor
Sets the cursor position for the MIAC display 
Fc9-u8-icon.png - BYTE X
Range: 0-21 
Fc9-u8-icon.png - BYTE Y
Range: 0-4 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteTran
Allows a single transistor output to be switched on or off. 
Fc9-u8-icon.png - BYTE Channel
Range 1-4 
Fc9-u8-icon.png - BYTE Value
0 = Off, 1 = On 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png LCDClear
Clears the MIAC display 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations