Difference between revisions of "Component: Map Function (Calculation)"

Latest revision as of 10:28, 4 March 2024

Author	medelec35
Version	2.0
Category	Calculation

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

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Map-Function.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Map-Function.fcfx

Detailed description

No detailed description exists yet for this component

Examples

A simple example showing how to take a value from an adc input with the range 0-255 and mapping this to a predetermined range of 50-150 to drive a PWM output.

Mapping ADC to PWM

Macro reference

MapByte

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

MapFloat

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

MapInt

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

MapLong

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

MapUInt

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

MapUlong

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

Property reference

	Properties

Difference between revisions of "Component: Map Function (Calculation)"

Latest revision as of 10:28, 4 March 2024

Contents

Map Function component

Component Source Code

Detailed description

Examples

Macro reference

MapByte

MapFloat

MapInt

MapLong

MapUInt

MapUlong

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 16: / Line 16: @@
 ==Component Source Code==
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Map-Function.fcfx FC_Comp_Source_Map-Function.fcfx]
 Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Map-Function.fcfx FC_Comp_Source_Map-Function.fcfx]
@@ Line 25: / Line 27: @@
-''No detailed description exists yet for this component''
-==Examples==
@@ Line 33: / Line 33: @@
-''<span style="color:red;">No additional examples</span>''
+''No detailed description exists yet for this component''
-==Macro reference==
+==Examples==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+A simple example showing how to take a value from an adc input with the range 0-255 and mapping this to a predetermined range of 50-150 to drive a PWM output.
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MapUlong'''
-|-
-| colspan="2" | Map function for unsigned long type variables&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | Value
-|-
-| colspan="2" | Main variable used for map function&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | InMin
-|-
-| colspan="2" | Lowest input value&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | InMax
-|-
-| colspan="2" | Highest value input&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | OutMin
-|-
-| colspan="2" | Lowest value after conversion&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | OutMax
-|-
-| colspan="2" | highest value after conversion&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | ClampMinMax
-|-
-| colspan="2" | Clamp min & max so result does not go above or below set values. 0=No, 1=Yes&nbsp;
-|-
-| 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''
-|}
+{{Fcfile|MappingADCtoPWM.fcfx|Mapping ADC to PWM}}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+==Macro reference==
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MapInt'''
-|-
-| colspan="2" | Map function for signed int type variables&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
-| width="90%" | Value
-|-
-| colspan="2" | Main variable used for map function&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
-| width="90%" | InMin
-|-
-| colspan="2" | Lowest input value&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
-| width="90%" | InMax
-|-
-| colspan="2" | Highest value input&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
-| width="90%" | OutMin
-|-
-| colspan="2" | Lowest value after conversion&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
-| width="90%" | OutMax
-|-
-| colspan="2" | highest value after conversion&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | ClampMinMax
-|-
-| colspan="2" | Clamp min & max so result does not go above or below set values. 0=No, 1=Yes&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
-| 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;" | '''MapFloat'''
-|-
-| colspan="2" | Map function for floating point type variables&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" | Value
-|-
-| colspan="2" | Main variable used for map function&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" | InMin
-|-
-| colspan="2" | Lowest input value&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" | InMax
-|-
-| colspan="2" | Highest value input&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" | OutMin
-|-
-| colspan="2" | Lowest value after conversion&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" | OutMax
-|-
-| colspan="2" | highest value after conversion&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | ClampMinMax
-|-
-| colspan="2" | Clamp min & max so result does not go above or below set values. 0=No, 1=Yes&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
-| 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;" | '''MapLong'''
-|-
-| colspan="2" | Map function for signed long type variables&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | Value
-|-
-| colspan="2" | Main variable used for map function&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | InMin
-|-
-| colspan="2" | Lowest input value&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | InMax
-|-
-| colspan="2" | Highest value input&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | OutMin
-|-
-| colspan="2" | Lowest value after conversion&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | OutMax
-|-
-| colspan="2" | highest value after conversion&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | ClampMinMax
-|-
-| colspan="2" | Clamp min & max so result does not go above or below set values. 0=No, 1=Yes&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
-| 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;" | '''MapUInt'''
-|-
-| colspan="2" | Map function for unsigned int type variables&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Value
-|-
-| colspan="2" | Main variable used for map function&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | InMin
-|-
-| colspan="2" | Lowest input value&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | InMax
-|-
-| colspan="2" | Highest value input&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | OutMin
-|-
-| colspan="2" | Lowest value after conversion&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | OutMax
-|-
-| colspan="2" | highest value after conversion&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | ClampMinMax
-|-
-| colspan="2" | Clamp min & max so result does not go above or below set values. 0=No, 1=Yes&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
+===MapByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 295: / Line 87: @@
+===MapFloat===
-==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
-|-
-|}==Macro reference==
 {| 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;" | '''MapUlong'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MapFloat'''
 |-
-| colspan="2" | Map function for unsigned long type variables&nbsp;
+| colspan="2" | Map function for floating point type variables&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 | width="90%" | Value
 |-
 | colspan="2" | Main variable used for map function&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 | width="90%" | InMin
 |-
 | colspan="2" | Lowest input value&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 | width="90%" | InMax
 |-
 | colspan="2" | Highest value input&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 | width="90%" | OutMin
 |-
 | colspan="2" | Lowest value after conversion&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 | width="90%" | OutMax
 |-
@@ Line 344: / Line 126: @@
 | colspan="2" | Clamp min & max so result does not go above or below set values. 0=No, 1=Yes&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===MapInt===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 392: / Line 175: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===MapLong===
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MapFloat'''
-|-
-| colspan="2" | Map function for floating point type variables&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" | Value
-|-
-| colspan="2" | Main variable used for map function&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" | InMin
-|-
-| colspan="2" | Lowest input value&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" | InMax
-|-
-| colspan="2" | Highest value input&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" | OutMin
-|-
-| colspan="2" | Lowest value after conversion&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" | OutMax
-|-
-| colspan="2" | highest value after conversion&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | ClampMinMax
-|-
-| colspan="2" | Clamp min & max so result does not go above or below set values. 0=No, 1=Yes&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 478: / Line 219: @@
+===MapUInt===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 521: / Line 263: @@
+===MapUlong===
 {| 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;" | '''MapByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MapUlong'''
 |-
-| colspan="2" | Map function for byte type variables&nbsp;
+| colspan="2" | Map function for unsigned long type variables&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 | width="90%" | Value
 |-
 | colspan="2" | Main variable used for map function&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 | width="90%" | InMin
 |-
 | colspan="2" | Lowest input value&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 | width="90%" | InMax
 |-
 | colspan="2" | Highest value input&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 | width="90%" | OutMin
 |-
 | colspan="2" | Lowest value after conversion&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 | width="90%" | OutMax
 |-
@@ Line 559: / Line 302: @@
 | colspan="2" | Clamp min & max so result does not go above or below set values. 0=No, 1=Yes&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| 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''
 |}