Flowcode Help - User contributions [en]

Mathematical Functions

2025-11-03T11:05:41Z

MartinW: /* Old Versions */

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/41807|Flowcode v10]]
|-
| [[Special:PermanentLink/39332|Flowcode v9]]
|-
| [[Special:PermanentLink/39332|Flowcode v8]]
|}

 
===Introduction===
:''See [[Calculation Icon Properties]]''

As well as the basic mathematical operators (+, -, *, /), the following mathematical functions can be used in calculations. All of these functions are now usable on each chip type.

===Functions===

Flowcode includes an additional set of mathematical functions:

{| class="wikitable" style="margin:auto; width:900px;"
|-
! scope="col" width="25%" | Function Prototype
! scope="col" width="45%" | Description
! scope="col" width="30%" | Example
|-
! colspan="3" style="background-color: #f0f0f0;" | Floating Point Arithmetic
|-
| align="center" | float = fadd(float, float)
| Add two floating point numbers together
| fadd(3.14, 2.86) = 6.0
|-
| align="center" | float = fsub(float, float)
| Subtract two floating point numbers
| fsub(10.5, 3.2) = 7.3
|-
| align="center" | float = fmul(float, float)
| Multiply two floating point numbers
| fmul(4.5, 2.0) = 9.0
|-
| align="center" | float = fdiv(float, float)
| Divide two floating point numbers
| fdiv(15.0, 3.0) = 5.0
|-
| align="center" | float = fmod(float, float)
| MOD function for floating point numbers
| fmod(7.5, 2.0) = 1.5
|-
| align="center" | byte = isinf(float)
| Checks to see if the floating point number is infinite
| isinf(1.0/0.0) = 1
|-
| align="center" | byte = isnan(float)
| Checks to see if the floating point is not a number
| isnan(0.0/0.0) = 1
|-
| align="center" | byte = float_eq(float, float)
| Compares two floating point numbers to see if they are equal
| float_eq(3.14, 3.14) = 1
|-
| align="center" | byte = float_ge(float, float)
| Compares two floating point numbers to see if they are greater then or equal   
| float_ge(5.0, 3.0) = 1
|-
| align="center" | byte = float_gt(float, float)
| Compares two floating point numbers to see if they are greater then
| float_gt(5.0, 3.0) = 1
|-
| align="center" | byte = float_le(float, float)
| Compares two floating point numbers to see if they are less then or equal
| float_le(3.0, 5.0) = 1
|-
| align="center" | byte = float_lt(float, float)
| Compares two floating point numbers to see if they are less then
| float_lt(3.0, 5.0) = 1
|-
| align="center" | int = random()
| Generates a random number (0-65535)
| (random() MOD 10) + 1 = 7 (range 1-10)
|-
! colspan="3" style="background-color: #f0f0f0;" | Mathematical Functions
|-
| align="center" | fabs( x ), floor( x ), ceil( x )
| Absolute value, floor and ceiling functions
| fabs(-5.7) = 5.7 floor(4.9) = 4 ceil(4.1) = 5
|-
| align="center" | fmod( x , y )
| Floating point modulus (remainder of x divided by y)
| fmod(25.5, 7.0) = 4.5
|-
| align="center" | sqrt( x ), cbrt( x )
| Square and cube roots
| sqrt(25) = 5.0 cbrt(27) = 3.0
|-
| align="center" | log( x ), log10( x )
| Logarithms (base e and base 10)
| log(2.718) ~ 1.0 log10(100) = 2.0
|-
| align="center" | exp( x ), pow( x , y )
| Exponential and power functions (x to the power of y)
| exp(1) ~ 2.718 pow(2, 8) = 256
|-
| align="center" | sin( x ), cos( x ), tan( x )
| Trigonometric functions where x is in radians
| sin(1.57) ~ 1.0 cos(0) = 1.0 tan(0.785) ~ 1.0
|-
| align="center" | asin( x ), acos( x ), atan( x )
| Inverse trigonometric functions where x is in radians
| asin(0.5) ~ 0.524 acos(0.707) ~ 0.785 atan(1) ~ 0.785
|-
| align="center" | atan2( y , x )
| Four-quadrant inverse tangent
| atan2(1, 1) = 0.785
|-
| align="center" | sinh( x ), cosh( x ), tanh( x )
| Hyperbolic functions
| sinh(1) ~ 1.175 cosh(0) = 1.0 tanh(1) ~ 0.762
|-
| align="center" | isnan( x ), isinf( x )
| Tests for not-a-number and infinity
| isnan(5.0) = 0 isinf(5.0) = 0
|-
| align="center" | round( x )
| Decimal rounding (x rounded to the nearest integer)
| round(3.7) = 4
|-
| align="center" | fround( x , y )
| Floating point rounding (x rounded to y decimal places)
| fround(3.14159, 2) = 3.14
|-
| align="center" | asinh( x ), acosh( x ), atanh( x )
| Inverse hyperbolic functions
| asinh(1) ~ 0.881 acosh(1) = 0 atanh(0.5) ~ 0.549
|-
| align="center" | fact( x )
| Factorial (multiply all numbers down to 1)
| fact(5) = 120 (5×4×3×2×1)
|-
! colspan="3" style="background-color: #f0f0f0;" | Integer Operations
|-
| align="center" | MOD
| Returns the remainder after division
| 17 MOD 5 = 2 (17÷5 = 3 remainder 2)
|-
! colspan="3" style="background-color: #f0f0f0;" | Bitwise Operations
|-
| align="center" | AND <also &>
| Bitwise AND operation
| 0b1100 AND 0b1010 = 0b1000
|-
| align="center" | OR <also |>
| Bitwise OR operation
| 0b1100 OR 0b1010 = 0b1110
|-
| align="center" | XOR
| Bitwise XOR (exclusive OR) operation
| 0b1100 XOR 0b1010 = 0b0110
|-
| align="center" | NOT <also ~>
| Bitwise NOT operation
| NOT 0b1100 = 0b0011
|-
| align="center" | <<
| Left shift operation (multiply by 2^n)
| 5 << 2 = 20 (5 × 4)
|-
| align="center" | >>
| Right shift operation (divide by 2^n)
| 20 >> 2 = 5 (20 ÷ 4)
|-
! colspan="3" style="background-color: #f0f0f0;" | Logical Operations (usually used in decision branches)
|-
| align="center" | == (also =)
| Equal to operation
| Value1 = 26, Value2 = 26 If Value1 == Value2 then True If Value1 = Value2 then True
|-
| align="center" | != (also <>)
| Not equal to operation
| Value1 = 10, Value2 = 20 If Value1 != Value2 then True If Value1 <> Value2 then True
|-
| align="center" | &&
| Logical AND operation
| Value = 10 If (Value > 2) && (Value < 15) then True
|-
| align="center" | ||
| Logical OR operation
| Value = 20 If (Value < 5) || (Value > 15) then True
|-
| align="center" | !
| Logical NOT operation
| Flag = 1 If ! Flag then False (inverts the value)
|-
! colspan="3" style="background-color: #f0f0f0;" | Array Functions
|-
| align="center" | arraydims( array )
| Get the number of dimensions in an array
| arraydims(data[5][3]) = 2
|-
| align="center" | arraysize( array )
| Get the total size of an array
| arraysize(data[5][3]) = 15
|-
! colspan="3" style="background-color: #f0f0f0;" | Hardware Functions
|-
| align="center" | SetPinNoDDR( PortPin, Output )
| Set output pin quickly without changing data direction state.
| SetPinNoDDR(PORTA.0, 1) = pin high
|-
| align="center" | Input = GetPinNoDDR( PortPin )
| Read input pin quickly without changing data direction state.
| GetPinNoDDR(PORTB.1) = 0 or 1
|-
! colspan="3" style="background-color: #f0f0f0;" | Type Conversion
|-
| align="center" | float2int( x )
| Convert floating point number to integer
| float2int(5.7) = 5 (truncates)
|-
| align="center" | int2float( x )
| Convert integer to floating point number
| int2float(42) = 42.0
|-
! colspan="3" style="background-color: #f0f0f0;" | Type Casting Operators (For more information see [[Typecasting]])
|-
| align="center" | STRING
| Convert numeric value to string type
| STRING 123 = "123"
|-
| align="center" | FLOAT
| Convert value to floating point type
| FLOAT 5 = 5.0
|-
| align="center" | SIGNED
| Convert value to signed integer type
| SIGNED -5 = -5 (as signed)
|-
| align="center" | UNSIGNED
| Convert value to unsigned integer type
| UNSIGNED -5 = 65531 (as unsigned)
|}

Internal Oscillator

2025-09-02T15:33:45Z

MartinW:

A lot of the devices have an inbuilt oscillator which can be used to reduce the number of devices required to drive the microcontroller.

The device datasheet should detail the type of oscillator available to the device.

To control the internal oscillator speed, a c code block will require adding at the very top of main, so its the first icon to be accessed.

Luckily, we don't need to dive into the datasheet to work out the code to set the internal oscillator to the correct speed.

The is an '''Internal Oscillator Helper''' component which is located in '''Components Libraries''' > '''Matrix Tools''' > '''IntOsc Helper'''
Alternatively, Use the search magnifying glass option.

This can be found on left of the '''Components Libraries''' and enter '''intos''' in the search bar.

[[file:InOscHelper1.png]]

'''Setting the hardware at the correct speed for PIC16F18877'''

1. '''Build''' > '''Project Options...''' '''Other options''' > Clock speed (MHZ) [defines delay-related timings] & enter desired speed, e.g. 16MHz. This does not set the hardware speed, but it's required step.
The '''Configure''' settings must also be correct.

E.g '''External Oscillator''' > '''Oscillator Off'''

'''Software Oscillator''' > '''HFINTOSC 32MHz'''

2. Add '''IntOsc Helper''' to the 2D panel, right-click on the IntOsc Helper component and select properties.

3. Enter the required speed in Hz e.g 1600000

4. Copy the full contents next to the code window (OSCFRQ = 0x05;)

5. add a C code command icon at the top of Main and paste the code that was copied in step 4

[[file:InOscHelper2.png]]

The internal osc should now be set at 16MHz, assuming all the configuration settings are correct.

You should be aware that other target device use OSCCON instead of OSCFRQ, but the IntOsc Helper allows for that.

A [[One second LED flasher]] test can be very useful to confirm if your device is actually running at the intended speed.

Supporting Third Party Programming Tools

2025-08-29T10:34:03Z

MartinW: /* mikroProg/Easypic */

[[File:Gen_Compiler_Options_Programmer_PIC.png|right|524x400px]]
Each version of Flowcode comes ready with a default programming tool. However it is fairly easy to change the settings in Flowcode to allow for third party programming tools to be used.

The programming tool that is invoked when the compile to chip button is pressed is configured in the '''Build menu''' under '''Compiler options''' then click on the '''Programmer tab''' page.

For help with third party programming tools the first port of call should be to check our [http://www.matrixmultimedia.com/mmforums/ forums] to see if anyone else has already tried the programming tool with Flowcode. If you are the first then if you wish you can post your findings for other users to benefit from.

==Warning==

Editing the Compiler or Linker tabs of the compiler options will likely stop Flowcode from being able to compile correctly unless you know what you are doing.

The settings below are for the '''Programmer''' tab of the compiler options. Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

If you do edit the values in the compiler or linker tab then you can simply revert back to the default settings and start again.

==Microchip PIC / PIC16 / PIC32==

===mLoader===

mLoader is the default programming software and can be used to talk to the various Matrix hardware including E-blocks, E-blocks2, Formula Flowcode, ECIO, MIAC, ProtoBoard, ProjectBoard...

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''$(appdir)tools\mLoader\mLoader.exe'''</code>

Parameters:

<code>'''-chip $(chip:u) "$(outdir)$(target).hex"'''</code>

===PPP===

PPP is the older programming software from Flowcode v5 and previous and can be used to talk to versions of the E-blocks EB006 up to and including version 8.

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''$(appdir)tools\PPP\PPPv3.exe'''</code>

Parameters:

<code>'''-cs 2 -chip PIC$(chip:u) -nogui "$(outdir)$(target).hex"'''</code>

===PICkit2===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''$(appdir)tools\PICkit2\pk2cmd.exe'''</code>

Parameters:

<code>'''-B$(appdir)tools\PICkit2\ -PPIC$(chip) -F$(target).hex -M -A5 -R'''</code>

Details on how to upgrade your PICkit 2 to work with new targets are available from [http://www.matrixtsl.com/mmforums/viewtopic.php?f=54&t=16843 here].

Please note that the PICkit 2 was never designed to work with the newer devices and although it is known to work, you may cause damage to your PIC devices by using incorrect VPP programming voltages etc as supplied by the PICkit 2.

===PICkit3 - PK3CMD (OLD)===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

There are two options for using the PICkit 3 depending on how you are powering your hardware:

'''Powered externally'''

Location:

<code>'''$(appdir)tools\PICkit3\PK3CMD.exe'''</code>

Parameters (8-bit PIC):

<code>'''-P$(chip) -F$(target).hex -E -M'''</code>

Parameters (16-bit PIC):

<code>'''-P$(chip) -F$(target).hex -E -M -L'''</code>

'''Powered via the PICkit'''

Location:

<code>'''$(appdir)tools\PICkit3\PK3CMD.exe'''</code>

Parameters (8-bit PIC):

<code>'''-P$(chip) -F$(target).hex -V5 -E -M'''</code>

Parameters (16-bit PIC):

<code>'''-P$(chip) -F$(target).hex -V3.3 -E -M -L'''</code>

Please note that the PICkit 3 will fail to program if you have spaces in your Flowcode project name, replacing spaces with underscores or removing them completely should resolve the issue.

Also note that if your using the PICkit 3 with MPLABX or have bought a new one recently then you will likely have to downgrade the firmware to allow Flowcode to work with the PICkit.

Full details on how to do this are available from [http://woodworkerb.com/pickit-3-and-flowcode-6/ here].

If your still having problems getting the PICkit 3 to fire up then this [http://www.matrixtsl.com/mmforums/viewtopic.php?f=54&t=12970&p=58454#p52318 forum topic] may be of help.

===PICkit3 - IPE (NEW)===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

First make sure you have the latest MPLAB X installed on your computer. We used version 4.20 which is used in the location path shown below. Make sure your path matches your installed location.

There are two options for using the PICkit 3 depending on how you are powering your hardware:

'''Powered externally'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK3 /M /OL'''</code>

'''Powered via the PICkit'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters - Powered at 3V3:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK3 /M /OL /W3.3'''</code>

Parameters - Powered at 5V:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK3 /M /OL /W5'''</code>

To use the Microchip Real ICE programmer instead of the PICkit 3 substitute the parameter /TPPK3 with /TPRICE

===PICkit4===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

First make sure you have the latest MPLAB X installed on your computer. We used version 4.20 which is used in the location path shown below. Make sure your path matches your installed location.

Version 4.20 is the minimum version that will work with the PICkit 4 hardware.

There are two options for using the PICkit 4 depending on how you are powering your hardware:

'''Powered externally'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK4 /M /OL'''</code>

'''Powered via the PICkit'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters - Powered at 3V3:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK4 /M /OL /W3.3'''</code>

Parameters - Powered at 5V:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK4 /M /OL /W5'''</code>

===SNAP===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

First make sure you have the latest MPLAB X installed on your computer. We used version 5.40 which is used in the location path shown below. Make sure your path matches your installed location.

Version 5.40 is the minimum version that will work with the Snap hardware.

There are two options for using the Snap depending on how you are powering your hardware:

'''Powered externally'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPSNAP /M /OL'''</code>

'''Powered via the PICkit'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters - Powered at 3V3:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPSNAP /M /OL /W3.3'''</code>

Parameters - Powered at 5V:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPSNAP /M /OL /W5'''</code>

===ICD3===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

First make sure you have the latest MPLAB X installed on your computer. We used version 4.20 which is used in the location path shown below. Make sure your path matches your installed location.

There are two options for using the ICD3 depending on how you are powering your hardware:

'''Powered externally'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPICD3 /M /OL'''</code>

'''Powered via the ICD3'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters - Powered at 3V3:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPICD3 /M /OL /W3.3'''</code>

Parameters - Powered at 5V:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPICD3 /M /OL /W5'''</code>

===FS USB===

Flowcode PIC comes with a example for using the free microchip USB bootloader. Changing your target to the MCHP_FSUSB will automatically configure the programmer to use the Microchip PDFSUSB programming tool. Note - The USB bootloader firmware must be present on the device to allow the programming tool to connect correctly to the device.

===TINY PIC Bootloader===

Support for the Serial TINY PIC Bootloader is documented [http://www.matrixmultimedia.com/mmforums/viewtopic.php?f=5&t=4647 here].

==AVR==

===AVRISP mkII===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''$(compileravr)batchfiles\avrc.bat'''</code>

Parameters:

<code>'''AVRDUDE $(chipalt) $(chip:l) "$(outdir)$(target).hex" "$(target).hex" 0 $(cfgb) $(cfg0) $(cfg1) $(cfg2) $(cfg3)'''</code>

===USB Tiny===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''$(compileravr)batchfiles\avrc_usbtiny.bat'''</code>

Parameters:

<code>'''AVRDUDE $(chipalt) $(chip:l) "$(outdir)$(target).hex" "$(target).hex" 0 $(cfgb) $(cfg0) $(cfg1) $(cfg2) $(cfg3)'''</code>

===AVR Dude===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

The AVRDUDE programming tool supports a number of third party programmers for more help and information please visit the [http://savannah.nongnu.org/projects/avrdude/ AVRDUDE home page].

[http://blog.zakkemble.co.uk/avrdudess-a-gui-for-avrdude/ AVRDUDESS] is a graphical user interface for AVRdude.

===Arduino===

Flowcode Arduino allows you to specify a COM port to connect to the Arduino hardware via the Flowcode Project options window. Once you have specified the COM port and selected the correct target board the compile to chip option should program the Arduino device automatically using AVR dude.

===Arduino Mega 2560 R1/R2===

Flowcode is currently unable to program early versions of the Arduino Mega hardware. To program these devices use the tool [http://russemotto.com/xloader/ Xloader] to manually load the Flowcode generated .hex file onto the device.

==ARM==

Flowcode ARM comes with a set of precompiled bootloader files. This allows the matrix mLoader USB reprogrammable operation to be used on any third party ARM hardware.

===mLoader===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

mLoader is the default programming software and can be used to talk to the various Matrix hardware including EB006, EB064, EB031, Formula Flowcode, ECIO, MIAC, ProtoBoard, ProjectBoard...

Location:

<code>'''$(appdir)tools\mLoader\mLoader.exe'''</code>

Parameters:

<code>'''-eb0310 "$(target).s19"'''</code>

===SAM-BA===

The SAM-BA tool is provided by Atmel and works with the default SAM7S bootloader which can be automatically restored to the device by powering up the ARM hardware for ten seconds using the TST jumper in the none default setting. Note this will delete the Matrix USB bootloader from the device.

==ST ARM==

===ST-LINK===

Flowcode by default is setup to use the ST-LINK programmer using the compile to chip option.

===Discovery===

Discovery boards are programmed by dropping the compiled binary firmware file onto a drive that appears under My Computer. Flowcode can automatically place the file onto the drive for you when using the compile to chip option with a discovery board selected as the target device.

===Nucleo===

Nucleo boards have a ST-LINK programmer built onto the board and so these work like standard ST ARM targets only without the additional requirement of a ST-LINK programmer.

==Raspberry Pi==

Raspberry Pi boards can be programmed over the network using Putty which is included with Flowcode. Enter the network details for the Pi into the Flowcode project options and this will allow the compile to chip to connect to the Pi using Putty via a SSH connection. SSH must be enabled on your Pi for this to function correctly but this should be enabled by default.

==AISX Presto/Forte==

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

First, make sure you have the latest UP installed on your computer.
Make sure your path matches your installed location.

Location:

<code>'''C:\Program Files (x86)\ASIX\UP\up.exe'''</code>

Parameters:

<code>'''/p /q "$(outdir)$(target).hex" /part PIC$(chip)'''</code>

The way the command line works is by using the last UP.exe settings.

If you want to use the programmer’s internal supply.

Open UP.exe and within the programmer settings window, select During programming check box.

I would also recommend changing Delay for VDD switching on/off when supplied from programmer from 10000 to 50000.

Close UP then all is ready for programming.

If you want to see a popup progress bar during programming, remove /q from the parameters.

Note:
Presto can only supply VDD 5.0V and VPP 13.0V
Forte can supply VDD 2.0V to 5.5V and VPP 6.5V to 17 Automatically, depending on the selected target device.

If you are looking for additional command line programming the manual is available from [https://asix.tech/_programmers/presto_en.pdf here] on page 63 at the time of writing

==mikroProg/Easypic==

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''C:\Users\Public\Documents\Mikroelektronika\mikroProg Suite For PIC\mikroProg Suite For PIC.exe'''</code>

Parameters:

<code>'''-e -w -pPIC$(chip) -v -f"$(outdir)$(target).hex" -q'''</code>

Note the -v is verify enabled.
Verification will increase overall programming time.
If you want to speed up programming then you can remove -v

-q quits the programming suite.
If you want the suit to remain after programming then -q can be removed.

Supporting Third Party Programming Tools

2025-08-29T10:28:02Z

MartinW: /* mikroProg */

Supporting Third Party Programming Tools

2025-08-29T09:59:26Z

MartinW:

[[File:Gen_Compiler_Options_Programmer_PIC.png|right|524x400px]]
Each version of Flowcode comes ready with a default programming tool. However it is fairly easy to change the settings in Flowcode to allow for third party programming tools to be used.

The programming tool that is invoked when the compile to chip button is pressed is configured in the '''Build menu''' under '''Compiler options''' then click on the '''Programmer tab''' page.

For help with third party programming tools the first port of call should be to check our [http://www.matrixmultimedia.com/mmforums/ forums] to see if anyone else has already tried the programming tool with Flowcode. If you are the first then if you wish you can post your findings for other users to benefit from.

==Warning==

Editing the Compiler or Linker tabs of the compiler options will likely stop Flowcode from being able to compile correctly unless you know what you are doing.

The settings below are for the '''Programmer''' tab of the compiler options. Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

If you do edit the values in the compiler or linker tab then you can simply revert back to the default settings and start again.

==Microchip PIC / PIC16 / PIC32==

===mLoader===

mLoader is the default programming software and can be used to talk to the various Matrix hardware including E-blocks, E-blocks2, Formula Flowcode, ECIO, MIAC, ProtoBoard, ProjectBoard...

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''$(appdir)tools\mLoader\mLoader.exe'''</code>

Parameters:

<code>'''-chip $(chip:u) "$(outdir)$(target).hex"'''</code>

===PPP===

PPP is the older programming software from Flowcode v5 and previous and can be used to talk to versions of the E-blocks EB006 up to and including version 8.

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''$(appdir)tools\PPP\PPPv3.exe'''</code>

Parameters:

<code>'''-cs 2 -chip PIC$(chip:u) -nogui "$(outdir)$(target).hex"'''</code>

===PICkit2===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''$(appdir)tools\PICkit2\pk2cmd.exe'''</code>

Parameters:

<code>'''-B$(appdir)tools\PICkit2\ -PPIC$(chip) -F$(target).hex -M -A5 -R'''</code>

Details on how to upgrade your PICkit 2 to work with new targets are available from [http://www.matrixtsl.com/mmforums/viewtopic.php?f=54&t=16843 here].

Please note that the PICkit 2 was never designed to work with the newer devices and although it is known to work, you may cause damage to your PIC devices by using incorrect VPP programming voltages etc as supplied by the PICkit 2.

===PICkit3 - PK3CMD (OLD)===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

There are two options for using the PICkit 3 depending on how you are powering your hardware:

'''Powered externally'''

Location:

<code>'''$(appdir)tools\PICkit3\PK3CMD.exe'''</code>

Parameters (8-bit PIC):

<code>'''-P$(chip) -F$(target).hex -E -M'''</code>

Parameters (16-bit PIC):

<code>'''-P$(chip) -F$(target).hex -E -M -L'''</code>

'''Powered via the PICkit'''

Location:

<code>'''$(appdir)tools\PICkit3\PK3CMD.exe'''</code>

Parameters (8-bit PIC):

<code>'''-P$(chip) -F$(target).hex -V5 -E -M'''</code>

Parameters (16-bit PIC):

<code>'''-P$(chip) -F$(target).hex -V3.3 -E -M -L'''</code>

Please note that the PICkit 3 will fail to program if you have spaces in your Flowcode project name, replacing spaces with underscores or removing them completely should resolve the issue.

Also note that if your using the PICkit 3 with MPLABX or have bought a new one recently then you will likely have to downgrade the firmware to allow Flowcode to work with the PICkit.

Full details on how to do this are available from [http://woodworkerb.com/pickit-3-and-flowcode-6/ here].

If your still having problems getting the PICkit 3 to fire up then this [http://www.matrixtsl.com/mmforums/viewtopic.php?f=54&t=12970&p=58454#p52318 forum topic] may be of help.

===PICkit3 - IPE (NEW)===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

First make sure you have the latest MPLAB X installed on your computer. We used version 4.20 which is used in the location path shown below. Make sure your path matches your installed location.

There are two options for using the PICkit 3 depending on how you are powering your hardware:

'''Powered externally'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK3 /M /OL'''</code>

'''Powered via the PICkit'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters - Powered at 3V3:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK3 /M /OL /W3.3'''</code>

Parameters - Powered at 5V:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK3 /M /OL /W5'''</code>

To use the Microchip Real ICE programmer instead of the PICkit 3 substitute the parameter /TPPK3 with /TPRICE

===PICkit4===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

First make sure you have the latest MPLAB X installed on your computer. We used version 4.20 which is used in the location path shown below. Make sure your path matches your installed location.

Version 4.20 is the minimum version that will work with the PICkit 4 hardware.

There are two options for using the PICkit 4 depending on how you are powering your hardware:

'''Powered externally'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK4 /M /OL'''</code>

'''Powered via the PICkit'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters - Powered at 3V3:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK4 /M /OL /W3.3'''</code>

Parameters - Powered at 5V:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK4 /M /OL /W5'''</code>

===SNAP===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

First make sure you have the latest MPLAB X installed on your computer. We used version 5.40 which is used in the location path shown below. Make sure your path matches your installed location.

Version 5.40 is the minimum version that will work with the Snap hardware.

There are two options for using the Snap depending on how you are powering your hardware:

'''Powered externally'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPSNAP /M /OL'''</code>

'''Powered via the PICkit'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters - Powered at 3V3:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPSNAP /M /OL /W3.3'''</code>

Parameters - Powered at 5V:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPSNAP /M /OL /W5'''</code>

===ICD3===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

First make sure you have the latest MPLAB X installed on your computer. We used version 4.20 which is used in the location path shown below. Make sure your path matches your installed location.

There are two options for using the ICD3 depending on how you are powering your hardware:

'''Powered externally'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPICD3 /M /OL'''</code>

'''Powered via the ICD3'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters - Powered at 3V3:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPICD3 /M /OL /W3.3'''</code>

Parameters - Powered at 5V:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPICD3 /M /OL /W5'''</code>

===FS USB===

Flowcode PIC comes with a example for using the free microchip USB bootloader. Changing your target to the MCHP_FSUSB will automatically configure the programmer to use the Microchip PDFSUSB programming tool. Note - The USB bootloader firmware must be present on the device to allow the programming tool to connect correctly to the device.

===TINY PIC Bootloader===

Support for the Serial TINY PIC Bootloader is documented [http://www.matrixmultimedia.com/mmforums/viewtopic.php?f=5&t=4647 here].

==AVR==

===AVRISP mkII===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''$(compileravr)batchfiles\avrc.bat'''</code>

Parameters:

<code>'''AVRDUDE $(chipalt) $(chip:l) "$(outdir)$(target).hex" "$(target).hex" 0 $(cfgb) $(cfg0) $(cfg1) $(cfg2) $(cfg3)'''</code>

===USB Tiny===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''$(compileravr)batchfiles\avrc_usbtiny.bat'''</code>

Parameters:

<code>'''AVRDUDE $(chipalt) $(chip:l) "$(outdir)$(target).hex" "$(target).hex" 0 $(cfgb) $(cfg0) $(cfg1) $(cfg2) $(cfg3)'''</code>

===AVR Dude===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

The AVRDUDE programming tool supports a number of third party programmers for more help and information please visit the [http://savannah.nongnu.org/projects/avrdude/ AVRDUDE home page].

[http://blog.zakkemble.co.uk/avrdudess-a-gui-for-avrdude/ AVRDUDESS] is a graphical user interface for AVRdude.

===Arduino===

Flowcode Arduino allows you to specify a COM port to connect to the Arduino hardware via the Flowcode Project options window. Once you have specified the COM port and selected the correct target board the compile to chip option should program the Arduino device automatically using AVR dude.

===Arduino Mega 2560 R1/R2===

Flowcode is currently unable to program early versions of the Arduino Mega hardware. To program these devices use the tool [http://russemotto.com/xloader/ Xloader] to manually load the Flowcode generated .hex file onto the device.

==ARM==

Flowcode ARM comes with a set of precompiled bootloader files. This allows the matrix mLoader USB reprogrammable operation to be used on any third party ARM hardware.

===mLoader===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

mLoader is the default programming software and can be used to talk to the various Matrix hardware including EB006, EB064, EB031, Formula Flowcode, ECIO, MIAC, ProtoBoard, ProjectBoard...

Location:

<code>'''$(appdir)tools\mLoader\mLoader.exe'''</code>

Parameters:

<code>'''-eb0310 "$(target).s19"'''</code>

===SAM-BA===

The SAM-BA tool is provided by Atmel and works with the default SAM7S bootloader which can be automatically restored to the device by powering up the ARM hardware for ten seconds using the TST jumper in the none default setting. Note this will delete the Matrix USB bootloader from the device.

==ST ARM==

===ST-LINK===

Flowcode by default is setup to use the ST-LINK programmer using the compile to chip option.

===Discovery===

Discovery boards are programmed by dropping the compiled binary firmware file onto a drive that appears under My Computer. Flowcode can automatically place the file onto the drive for you when using the compile to chip option with a discovery board selected as the target device.

===Nucleo===

Nucleo boards have a ST-LINK programmer built onto the board and so these work like standard ST ARM targets only without the additional requirement of a ST-LINK programmer.

==Raspberry Pi==

Raspberry Pi boards can be programmed over the network using Putty which is included with Flowcode. Enter the network details for the Pi into the Flowcode project options and this will allow the compile to chip to connect to the Pi using Putty via a SSH connection. SSH must be enabled on your Pi for this to function correctly but this should be enabled by default.

==AISX Presto/Forte==

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

First, make sure you have the latest UP installed on your computer.
Make sure your path matches your installed location.

Location:

<code>'''C:\Program Files (x86)\ASIX\UP\up.exe'''</code>

Parameters:

<code>'''/p /q "$(outdir)$(target).hex" /part PIC$(chip)'''</code>

The way the command line works is by using the last UP.exe settings.

If you want to use the programmer’s internal supply.

Open UP.exe and within the programmer settings window, select During programming check box.

I would also recommend changing Delay for VDD switching on/off when supplied from programmer from 10000 to 50000.

Close UP then all is ready for programming.

If you want to see a popup progress bar during programming, remove /q from the parameters.

Note:
Presto can only supply VDD 5.0V and VPP 13.0V
Forte can supply VDD 2.0V to 5.5V and VPP 6.5V to 17 Automatically, depending on the selected target device.

If you are looking for additional command line programming the manual is available from [https://asix.tech/_programmers/presto_en.pdf here] on page 63 at the time of writing

==mikroProg==

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''C:\Users\Public\Documents\Mikroelektronika\mikroProg Suite For PIC\mikroProg Suite For PIC.exe'''</code>

Parameters:

<code>'''-e -w -pPIC$(chip) -v -f"$(outdir)$(target).hex" -q'''</code>

Note the -v is verify enabled.
Verification will increase overall programming time.
If you want to speed up programming then you can remove -v

Replacing a Component

2025-08-14T10:11:35Z

MartinW:

The Component Replace function allows you to replace an existing component with another component with similar functionality, when replacing a component the properties are kept and copied over to the new component, e.g. the port and pin the component is connected to and even properties such as the Polarity etc.

There is also an option to 'Preserve current scale' which can be ticked to keep the size / scale of the component, this is especially useful when modifying and expanding existing programs so that the position and size of the component remain the same to adapt into the program as the position of the component is kept the same by default.

To replace a component,first add the component that you wish to have as a replacement, this will add the component to Flowcodes memory.
You can copy the handle of the new component at this point since the handle will remain the same on changed component.

You can now delete the component you just added as its served its purpose

right-click on a selected component on either the [[2d_Panels|2D panels]] or [[System_Panel|3D system panel]] and then select 'Replace' option in the context menu. This brings up the 'Component Replacement' window which contains a list of components to choose from to replace the component. This list consists of recently used components as well as components with similar functionality to adequately replace the selected component.
There will be times when the required replacement component won't be shown.
For example, the LED Mono is currently used and you want to replace it with an LED that will use your own images.

[[File:Component-Replace1.png]]

There are a lot of LED Mono macros to replace so it would be a lot quicker to use the replace option.
In this case, there are no alternative components as the 'Replace' option is grayed out.

[[File:Component-Replace2.png]]

Now the replace option is no longer greyed out so you can select the LED user images.

[[File:Component-Replace3.png]]

Finally, you might want to change the component title name as that will remain as the original components name, by clicking on the name next to Handle.

[[File:Component-Replace4.png]]

Using a new version of XC8

2025-05-14T07:49:24Z

MartinW: /* Keeping the original compiler and adding a new compiler */

__TOC__

==Replacing the original compiler with a new version==

Download compiler from [https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers here]

Find required compiler version to install then remember the compiler install path.

Within Flowcode, select '''File''' > '''Global Settings…''' > '''Locations tab'''

Under Override toolchain locations, enter the path where installed XC8 is located, e.g. for v2.50:
'''C:\Program Files\Microchip\xc8\v2.50'''
The end \ can be left off, Select OK.

You now be able to compile used the latest XC8 compiler.

To change back to the original compiler, replace the above path with:

'''C:\Program Files (x86)\Flowcode\Common\Compilers\picv2\'''

''Note. Currently XC8 v3.0 and above is not yet supported.''

==Keeping the original compiler and adding a new compiler==

Download compiler from [https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers here]

Find required compiler version to install then remember the compiler install path.

Copy '''pic_xc8_comp.bat''' '''from C:\ProgramData\MatrixTSL\FlowcodeV10\FCD\PIC\batch\'''

Give it a new name so you have two batch files, place it anywhere you won’t accidently delete it.

Edit the file and change '''"%MX_COMPILER%bin\xc8-cc.exe"''' to the path for the new XC8 location of xc8-cc.exe.
For example:
'''"C:\Program Files\Microchip\xc8\v2.50\bin\xc8-cc.exe"'''

Save the new batch file.

Within Flowcode Load a typical PIC xc8 target e.g. 16F18877via New project or Build > Project options.

Select '''Build''' > '''Compiler Options''' and if use Eblocks, select '''E-Blocks''' from PIC selection.

For the location select Browse then change '''Executable Files (*.exe)''' to '''Batch Files (*.bat)'''

Select the new batch file, then '''Open'''

Click on the save icon then enter a new name, then '''OK'''.

Finally make sure the new version is selected and click the '''Default compiler for the platform C for PIC''' ,then Click '''OK'''

Using a new version of XC8

2025-05-14T07:48:17Z

MartinW: /* Replacing the original compiler with a new version */

__TOC__

==Replacing the original compiler with a new version==

Download compiler from [https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers here]

Find required compiler version to install then remember the compiler install path.

Within Flowcode, select '''File''' > '''Global Settings…''' > '''Locations tab'''

Under Override toolchain locations, enter the path where installed XC8 is located, e.g. for v2.50:
'''C:\Program Files\Microchip\xc8\v2.50'''
The end \ can be left off, Select OK.

You now be able to compile used the latest XC8 compiler.

To change back to the original compiler, replace the above path with:

'''C:\Program Files (x86)\Flowcode\Common\Compilers\picv2\'''

''Note. Currently XC8 v3.0 and above is not yet supported.''

==Keeping the original compiler and adding a new compiler==

Download compiler from [https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers here]

Find required compiler version to install then remember the compiler install path.

Copy '''pic_xc8_comp.bat''' '''from C:\ProgramData\MatrixTSL\FlowcodeV10\FCD\PIC\batch\'''

Give it a new name so you have two batch files, place it anywhere you won’t accidently delete it.

Edit the file and change '''"%MX_COMPILER%bin\xc8-cc.exe"''' to the path for the new XC8 location of xc8-cc.exe.
For example:
'''"C:\Program Files\Microchip\xc8\v2.46\bin\xc8-cc.exe"'''

Save the new batch file0.

Within Flowcode Load a typical PIC xc8 target e.g. 16F18877via New project or Build > Project options.

Select '''Build''' > '''Compiler Options''' and if use Eblocks, select '''E-Blocks''' from PIC selection.

For the location select Browse then change '''Executable Files (*.exe)''' to '''Batch Files (*.bat)'''

Select the new batch file, then '''Open'''

Click on the save icon then enter a new name, then '''OK'''.

Finally make sure the new version is selected and click the '''Default compiler for the platform C for PIC''' ,then Click '''OK'''

Component: Switch (Controls)

2025-05-02T08:39:58Z

MartinW:

==Switch component==
A 2d switch component.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Here is an example Flowcode program to read the value of a switch.

{{Fcfile|Switch.fcfx|Switch}}

Here is a schematic of how to connect a basic switch to a microcontroller pin.

[[File:switchschematic.jpg]]

The polarity setting in switch properties determines how the corresponding bit in the input variable responds when the switch changes state.

This applies only when using switch functions and not when using input command icons.

*Active High Polarity

When the switch is closed, the voltage on the pin transitions from 0V to the positive supply voltage (either 3.3V or 5V, depending on the microcontroller).

As a result, the corresponding bit in the input variable changes from 0 to 1.

A pull-down resistor is required to ensure the pin stays at 0V when the switch is open.

If using two resistors (as shown in the image above), they provide protection in case the pin is mistakenly set as an output while the switch is pressed.

*Active Low Polarity

When the switch is closed, the voltage on the pin transitions from the positive supply voltage to 0V.

The corresponding bit in the input variable changes from 0 to 1.

A pull-up resistor is required to ensure the pin stays at the positive supply voltage when the switch is open.

If using two resistors(as shown in the image above), they provide protection if the pin is mistakenly set as an output while the switch is pressed.

There are some differences depending on the type of switch you have, the above states assume a generic push to make type switch, however a push to break type switch would have reversed logic and a toggle switch can work well with either setup.

The resistors are required for correct operation because when a microcontroller's input pin is essentially connected to nothing it will pick up noise in the environment and provide inconsistent readings.

This state is referred to as floating i.e. the pin is floating. To test this remove the resistors (if possible) and touch the unconnected pin with your finger the output LED from the example file above will toggle on and off at high speed.

Any values of resistor can be used but it is important to keep the smaller resistor at least 10X smaller then the larger resistor to ensure that the pressed state provides at least 0.91% of the required pressed state voltage.

For example a active high switch circuit using 1K and 10K resistors should pull up to about 4.54V when the switch is pressed.

(5V / 11K) * 10K = 4.54545V

==Downloadable 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;" | '''GetState'''
|-
| colspan="2" | Reads the state of the switch (true = on, false = off) 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| 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;" | '''SetState'''
|-
| colspan="2" | Sets the switch to be on or off. 
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | bState
|-
| colspan="2" | The new state of the switch (true=on, false=off) 
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | State
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Type
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | On Label
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Off Label
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background Colour
|-
| 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'''
|-
|}

Component: Switch (Controls)

2025-05-02T08:39:06Z

MartinW:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Steve Tandy & Martin Whitlock
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Controls
|}

==Switch component==
A 2d switch component.

==Component Pack==

FREE

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Here is an example Flowcode program to read the value of a switch.

{{Fcfile|Switch.fcfx|Switch}}

Here is a schematic of how to connect a basic switch to a microcontroller pin.

[[File:switchschematic.jpg]]

The polarity setting in switch properties determines how the corresponding bit in the input variable responds when the switch changes state.

This applies only when using switch functions and not when using input command icons.

*Active High Polarity

When the switch is closed, the voltage on the pin transitions from 0V to the positive supply voltage (either 3.3V or 5V, depending on the microcontroller).

As a result, the corresponding bit in the input variable changes from 0 to 1.

A pull-down resistor is required to ensure the pin stays at 0V when the switch is open.

If using two resistors (as shown in the image above), they provide protection in case the pin is mistakenly set as an output while the switch is pressed.

*Active Low Polarity

When the switch is closed, the voltage on the pin transitions from the positive supply voltage to 0V.

The corresponding bit in the input variable changes from 0 to 1.

A pull-up resistor is required to ensure the pin stays at the positive supply voltage when the switch is open.

If using two resistors(as shown in the image above), they provide protection if the pin is mistakenly set as an output while the switch is pressed.

There are some differences depending on the type of switch you have, the above states assume a generic push to make type switch, however a push to break type switch would have reversed logic and a toggle switch can work well with either setup.

The resistors are required for correct operation because when a microcontroller's input pin is essentially connected to nothing it will pick up noise in the environment and provide inconsistent readings.

This state is referred to as floating i.e. the pin is floating. To test this remove the resistors (if possible) and touch the unconnected pin with your finger the output LED from the example file above will toggle on and off at high speed.

Any values of resistor can be used but it is important to keep the smaller resistor at least 10X smaller then the larger resistor to ensure that the pressed state provides at least 0.91% of the required pressed state voltage.

For example a active high switch circuit using 1K and 10K resistors should pull up to about 4.54V when the switch is pressed.

(5V / 11K) * 10K = 4.54545V

==Downloadable 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;" | '''GetState'''
|-
| colspan="2" | Reads the state of the switch (true = on, false = off) 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| 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;" | '''SetState'''
|-
| colspan="2" | Sets the switch to be on or off. 
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | bState
|-
| colspan="2" | The new state of the switch (true=on, false=off) 
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | State
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Type
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | On Label
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Off Label
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background Colour
|-
| 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'''
|-
|}

Component: Switch (Controls)

2025-05-02T08:38:04Z

MartinW: /* Examples */

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Steve Tandy
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Controls
|}

==Switch component==
A 2d switch component.

==Component Pack==

FREE

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Here is an example Flowcode program to read the value of a switch.

{{Fcfile|Switch.fcfx|Switch}}

Here is a schematic of how to connect a basic switch to a microcontroller pin.

[[File:switchschematic.jpg]]

The polarity setting in switch properties determines how the corresponding bit in the input variable responds when the switch changes state.

This applies only when using switch functions and not when using input command icons.

*Active High Polarity

When the switch is closed, the voltage on the pin transitions from 0V to the positive supply voltage (either 3.3V or 5V, depending on the microcontroller).

As a result, the corresponding bit in the input variable changes from 0 to 1.

A pull-down resistor is required to ensure the pin stays at 0V when the switch is open.

If using two resistors (as shown in the image above), they provide protection in case the pin is mistakenly set as an output while the switch is pressed.

*Active Low Polarity

When the switch is closed, the voltage on the pin transitions from the positive supply voltage to 0V.

The corresponding bit in the input variable changes from 0 to 1.

A pull-up resistor is required to ensure the pin stays at the positive supply voltage when the switch is open.

If using two resistors(as shown in the image above), they provide protection if the pin is mistakenly set as an output while the switch is pressed.

There are some differences depending on the type of switch you have, the above states assume a generic push to make type switch, however a push to break type switch would have reversed logic and a toggle switch can work well with either setup.

The resistors are required for correct operation because when a microcontroller's input pin is essentially connected to nothing it will pick up noise in the environment and provide inconsistent readings.

This state is referred to as floating i.e. the pin is floating. To test this remove the resistors (if possible) and touch the unconnected pin with your finger the output LED from the example file above will toggle on and off at high speed.

Any values of resistor can be used but it is important to keep the smaller resistor at least 10X smaller then the larger resistor to ensure that the pressed state provides at least 0.91% of the required pressed state voltage.

For example a active high switch circuit using 1K and 10K resistors should pull up to about 4.54V when the switch is pressed.

(5V / 11K) * 10K = 4.54545V

==Downloadable 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;" | '''GetState'''
|-
| colspan="2" | Reads the state of the switch (true = on, false = off) 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| 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;" | '''SetState'''
|-
| colspan="2" | Sets the switch to be on or off. 
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | bState
|-
| colspan="2" | The new state of the switch (true=on, false=off) 
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | State
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Type
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | On Label
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Off Label
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background Colour
|-
| 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'''
|-
|}

Component: Switch (Controls)

2025-05-02T08:27:19Z

MartinW: /* Examples */

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Steve Tandy
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Controls
|}

==Switch component==
A 2d switch component.

==Component Pack==

FREE

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Here is an example Flowcode program to read the value of a switch.
{{Fcfile|Switch.fcfx|Switch}}

Here is a schematic of how to connect a basic switch to a microcontroller pin.

[[File:switchschematic.jpg]]

The polarity setting within the switch properties determines how the relevant bit of the input variable responds when a switch changes state.
This applies only when using switch functions and not when using input command icons.
* Active High Polarity: When the switch is closed, the voltage on the pin transitions from 0V to the positive supply voltage (either 3.3V or 5V, depending on the microcontroller). As a result, the corresponding bit in the input variable changes from 0 to 1. A pull-down resistor is required for the input pin to ensure it stays at 0V when the switch is open.
* Active Low Polarity: When the switch is closed, the voltage on the pin transitions from the positive supply voltage to 0V, and again, the relevant bit of the input variable changes from 0 to 1. A pull-up resistor is required for the input pin to ensure it stays at the positive supply voltage when the switch is open.

There are some differences depending on the type of switch you have, the above states assume a generic push to make type switch, however a push to break type switch would have reversed logic and a toggle switch can work well with either setup.

The resistors are required for correct operation because when a microcontroller's input pin is essentially connected to nothing it will pick up noise in the environment and provide inconsistent readings. This state is referred to as floating i.e. the pin is floating. To test this remove the resistors (if possible) and touch the unconnected pin with your finger the output LED from the example file above will toggle on and off at high speed.

Any values of resistor can be used but it is important to keep the smaller resistor at least 10X smaller then the larger resistor to ensure that the pressed state provides at least 0.91% of the required pressed state voltage. For example a active high switch circuit using 1K and 10K resistors should pull up to about 4.54V when the switch is pressed.

(5V / 11K) * 10K = 4.54545V

==Downloadable 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;" | '''GetState'''
|-
| colspan="2" | Reads the state of the switch (true = on, false = off) 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| 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;" | '''SetState'''
|-
| colspan="2" | Sets the switch to be on or off. 
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | bState
|-
| colspan="2" | The new state of the switch (true=on, false=off) 
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | State
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Type
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | On Label
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Off Label
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background Colour
|-
| 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'''
|-
|}

Supporting Third Party Programming Tools

2025-04-23T15:09:28Z

MartinW: /* AISX Presto/Forte */

Library Updates

2025-04-10T09:54:16Z

MartinW:

Library Updates [[file:Library_updates_icon.png]] can be accessed via the Help ribbon or when you first [[Opening_Flowcode|open Flowcode]]

If you select ''Library Updates'' via the Help ribbon, then you will have a dropdown giving you the options of either ''Files in-use'' or ''Full database''

If required you can rollback a component to an earlier version.

To do that for your current project make sure ''Files in-use'' is selected.

Select ''Show up-to-date'' files (1)

You will see ''Filename'', ''Current Revision'', ''New Revision'' & ''Size''

Scroll down to the component/file you wish to rollback and select it via the tickbox (2) to the left of its name.

Select the required version within ''New Revision'' column (3) , then left-click on ''Download''

Close the library updates window, then left-click on the ''Reload'' icon[[File:Reload_icon.png]] at the top, or ''File'' menu, ''Reload''.

[[File:Rollback Component1.png]]

Library Updates

2025-04-10T09:53:11Z

MartinW:

Library Updates [[file:Library_updates_icon.png]] can be accessed via the Help ribbon or when you first [[Opening_Flowcode|open Flowcode]]

If you select ''Library Updates'' via the Help ribbon, then you will have a dropdown giving you the options of either ''Files in-use'' or ''Full database''

If required you can rollback a component to an earlier version.

To do that for your current project make sure ''Files in-use'' is selected.

Select ''Show up-to-date'' files (1)

You will see ''Filename'' (2), ''Current Revision'', ''New Revision'' (3) & ''Size''

Scroll down to the component/file you wish to rollback and select it via the tickbox (2) to the left of its name.

Select the required version within ''New Revision'' column (3) , then left-click on ''Download''

Close the library updates window, then left-click on the ''Reload'' icon[[File:Reload_icon.png]] at the top, or ''File'' menu, ''Reload''.

[[File:Rollback Component1.png]]

File:Rollback Component1.png

2025-04-10T09:49:38Z

MartinW:

File:ESP32 Setup8.png

2025-04-02T11:35:01Z

MartinW: MartinW uploaded a new version of File:ESP32 Setup8.png

Component: Display Manager (Graphical Library)

2025-03-28T11:36:21Z

MartinW: /* Examples */

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 2.1
|-
| width="20%" style="color:gray;" | Category
| Graphical Library
|}

==Display Manager component==
A component designed to simplify the process of drawing primitives and text onto a graphical display. Keeps track of coordinates so you don't have to. Also works great as a base layer for gLCD based games as it will check for collisions and perform movement.

==Version information==

Library Version, Component Version, Date, Author, Info
13, 2.0, 22-05-24, BR, Added text alignment options
14, 2.1, 14-06-24, BR, Renamed Button to Widget to better include things like sliders
15, 2.1, 26-07-24, BR, Added SetTextFloat and AddTextNumber macros
16, 2.1, 29-07-24, BR, Renamed Themes to ObjectThemes and WidgetThemes
17, 2.1, 29-07-24, BR, Added CreateTextField macro which automates creating a simple textbox
18, 2.1, 06-08-24, BR, Fixed a problem with updating values, theme, text on IDs
19, 2.1, 06-08-24, BR, Textfield now uses hidden object type instead of rectangle
20, 2.1, 06-08-24, BR, Fixed a problem where slider value could be set with out of range value
21, 2.1, 06-08-24, BR, Fixed problem where SetTextNumber would reset an ESP32

==Detailed description==

===Objects===

The component can create the following objects.

*'''Object_Hidden''' - 0 - A hidden area with no graphics.
*'''Object_Rectangle''' - 1 - A simple rectangular box.
*'''Object_Line''' - 2 - A simple straight line.
*'''Object_Ellipse''' - 3 - A simple ellipse or circle.
*'''Object_EllipseFilled''' - 4 - A filled ellipse or circle.
*'''Object_RectangeFilled''' - 5 - A filled rectangular box.

===TextField===

There is also an additional TextField object which consists of an Object_Rectangle that is pre-populated with text.

===Widgets===

The component can also create the following interactive buttons and sliders.

*'''Widget_Hidden''' - 0 - A hidden area with no graphics.
*'''Widget_Rectangle''' - 1 - A rectangular box with a shadow.
*'''Widget_RoundedRectangle''' - 2 - A rounded rectangular box with a shadow.
*'''Widget_Ellipse''' - 3 - A simple ellipse or circle with a shadow.
*'''Widget_VSlider''' - 4 - A vertical slider with a square thumb.
*'''Widget_HSlider''' - 5 - A horizontal slider with a square thumb.
*'''Widget_VSlider_Round''' - 6 - A vertical slider with a round thumb.
*'''Widget_HSlider_Round''' - 7 - A horizontal slider with a round thumb.

The type can be entered by using the component's public constants. Begin with the Display Manager handle name followed by :: and the list of the public variables will be displayed.

For example... '''DisplayManager1::Object_Rectangle''' or '''DisplayManager1::Widget_VSlider'''

===Touch Repeat Rate for Button Widgets===

The Touch Repeat Rate property applies to button based widgets and sets the frequency that a valid touch will be detected for a held button. This is similar to holding down a single key on a keyboard and acts to reduce the frequency of positive button detections when touching the button. For example if you had a button that incremented a value, without the repeat rate the value would increment much faster then anticipated in an uncontrollable manner. When no touch is detected it is recommended to call the NoTouch macro to clear the touch counters and allow a more responsive user experience.

Example of implementing touch repeat rate

[[File:ButtonRepeatRate.jpg]]

==Examples==

An example showing how to use the display manager with a GLCd and a touch interface to create a full HMI.

The example shows how to create a simple menu system as well as a toggle switch and a slider used to control a PWM output.

{{Fcfile|DisplayManagerDemo.fcfx|Display Manager Demo}}

An example showing how you can use the CreateWigitArray component to easily create a touch keypad for your gLCD

Component will create the widgets as keypad buttons with your custom text, it allows you to click on the widgets so you have a working keypad.

[[File:Updated__Display_Manager1.png]]

The CreateWidgetArray function macro that is very flexible in what you can create:

[[File:Updated__Display_Manager2.png]]

Lots of flexibility and there are also tooltips to help.

[[File:Updated__Display_Manager3.png]]

Note: if you get a unable to run simulation error then make sure you have the latest components downloaded.

===How the key touch is detected===

The first widget is automatically assigned a unique widget ID e.g. the first widget with text 1 on it is assigned 24.

All the following widgets ID is then incremented from 24, e.g. widget with text 6 on is assigned 24+ 5 = 29.

The widget button pressed can then be calculated from 29 – 24 + 1 = 6.

{{Fcfile|DisplayManager_WidgetArray_Keypad_Example.fcfx|Display Manager Widget Array Keypad Example}}

==Macro reference==

===CheckForTouch===
{| 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;" | '''CheckForTouch'''
|-
| colspan="2" | Uses the X and Y coordinates from a touch sensor to check for Widget presses. Returns 0 for no Widgets pressed. Returns ID for a valid Widget press. Any touched slider Widgets will automatically move their thumb and value to the touch position.  
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y
|-
| colspan="2" |  
|-
| 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''
|}

===ClearAll===
{| 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;" | '''ClearAll'''
|-
| colspan="2" | Removes all objects and Widgets from memory. Also clears the screen if required. 
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | ClearScreen
|-
| colspan="2" | 0=Don't clear the screen, 1=Clear the screen 
|-
| 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''
|}

===CreateObject===
{| 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;" | '''CreateObject'''
|-
| colspan="2" | Define a none touchable graphical object. Returns the Object ID. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ObjectType
|-
| colspan="2" | 0=Hidden, 1=Rect, 2=Line, 3=Ellipse, 4=FilledEllipse, 5=FilledRect 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X
|-
| colspan="2" | X Pixel Coordinate 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y
|-
| colspan="2" | Y Pixel Coordinate 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Width
|-
| colspan="2" | Pixel Width or X Radius 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Height
|-
| colspan="2" | Pixel Height or Y Radius 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ObjectTheme
|-
| colspan="2" | Theme index to use to draw the object 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | DrawObject
|-
| colspan="2" | 0=Do not draw object yet, 1=Draw object now (Does not apply to hidden objects) 
|-
| 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''
|}

===CreateTextField===
{| 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;" | '''CreateTextField'''
|-
| colspan="2" | Creates a text field consisting of a rectangular border containing a single line of text 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Text
|-
| colspan="2" | Text string to set as the label 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X
|-
| colspan="2" | X Pixel Coordinate 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y
|-
| colspan="2" | Y Pixel Coordinate 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Width
|-
| colspan="2" | Pixel Width 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Height
|-
| colspan="2" | Pixel Height 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Font
|-
| colspan="2" | GLCD Font Index to use 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ObjectTheme
|-
| colspan="2" | Theme index to use to draw the object 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | HAlignment
|-
| colspan="2" | 0=Left, 1=Center, 2=Right 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | VAlignment
|-
| colspan="2" | 0=Top, 1=Middle, 2=Bottom 
|-
| 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''
|}

===CreateWidget===
{| 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;" | '''CreateWidget'''
|-
| colspan="2" | Define an interactive Widget or slider. Returns the Widget ID. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | WidgetType
|-
| colspan="2" | 0=WidgetHidden, 1=WidgetRect, 2=WidgetRoundedRect, 3=WidgetEllipse, 4=VSlider, 5=HSlider, 6=VSliderRound, 7=HSliderRound 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X
|-
| colspan="2" | X Pixel Coordinate 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y
|-
| colspan="2" | Y Pixel Coordinate 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Width
|-
| colspan="2" | Pixel Width or X Radius 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Height
|-
| colspan="2" | Pixel Height or Y Radius 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | WidgetTheme
|-
| colspan="2" | Theme index to use to draw the Widget 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | DrawWidget
|-
| colspan="2" | 0=Do not draw Widget yet, 1=Draw Widget now (Does not apply to hidden widgets) 
|-
| 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''
|}

===DrawAll===
{| 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;" | '''DrawAll'''
|-
| colspan="2" | Redraws all of the defined Objects and Widgets. Doesn't draw text, this is done using the SetText macros. 
|-
|-
| 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''
|}

===DrawItem===
{| 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;" | '''DrawItem'''
|-
| colspan="2" | Draws a single object or Widget onto the display without clearing the display. Doesn't draw text, this is done using the SetText macros. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | ID
|-
| colspan="2" | Unique ID of the Object or Widget 
|-
| 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''
|}

===GetLastTouchID===
{| 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;" | '''GetLastTouchID'''
|-
| colspan="2" | Gets the ID of the last Widget that returned a valid press via the CheckForTouch macro. Returns 0 for no valid touch recorded. 
|-
|-
| 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''
|}

===GetSliderValue===
{| 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;" | '''GetSliderValue'''
|-
| colspan="2" | Reads the value of one of the sliders ranging between 0 and 1. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | WidgetID
|-
| colspan="2" |  
|-
| 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''
|}

===Initialise===
{| 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 object and Widget control variables and sets up the default themes. 
|-
|-
| 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''
|}

===ModifyPosition===
{| 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;" | '''ModifyPosition'''
|-
| colspan="2" | Moves an existing object or Widget to absolute coordinates on the screen. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | ID
|-
| colspan="2" | Unique ID of the object or Widget 
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | X
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | Y
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Relative
|-
| colspan="2" | 0=Absolute Positioning, 1=Relative Positioning 
|-
| 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''
|}

===ModifyScale===
{| 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;" | '''ModifyScale'''
|-
| colspan="2" | Changes the width and height of the selected Object or Widget. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | ID
|-
| colspan="2" | Unique ID of the object or Widget 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Width
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Height
|-
| 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''
|}

===ModifyTheme===
{| 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;" | '''ModifyTheme'''
|-
| colspan="2" | Changes the theme index of the selected Object or Widget. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | ID
|-
| colspan="2" | Unique ID of the object or Widget 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Theme
|-
| colspan="2" | Theme index of the Widget or object 
|-
| 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''
|}

===NoTouch===
{| 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;" | '''NoTouch'''
|-
| colspan="2" | Called when no touch is present, Allows the repeat rate counter to be cleared allowing for better responses to fast touches. 
|-
|-
| 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''
|}

===OverrideObjectTheme===
{| 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;" | '''OverrideObjectTheme'''
|-
| colspan="2" | Overrides the colour of an object theme, used by the draw object macro.  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ThemeIndex
|-
| colspan="2" | Index of the object colour theme 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | FG_R
|-
| colspan="2" | Foreground colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | FG_G
|-
| colspan="2" | Foreground colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | FG_B
|-
| colspan="2" | Foreground colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BG_R
|-
| colspan="2" | Background colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BG_G
|-
| colspan="2" | Background colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BG_B
|-
| colspan="2" | Background colour channel value 
|-
| 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''
|}

===OverrideWidgetTheme===
{| 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;" | '''OverrideWidgetTheme'''
|-
| colspan="2" | Overrides the colour of a Widget theme, used by the draw Widget macro.  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ThemeIndex
|-
| colspan="2" | Index of the object colour theme 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | FG_R
|-
| colspan="2" | Foreground colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | FG_G
|-
| colspan="2" | Foreground colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | FG_B
|-
| colspan="2" | Foreground colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BG_R
|-
| colspan="2" | Background colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BG_G
|-
| colspan="2" | Background colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BG_B
|-
| colspan="2" | Background colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | HL_R
|-
| colspan="2" | Highlight colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | HL_G
|-
| colspan="2" | Highlight colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | HL_B
|-
| colspan="2" | Highlight colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | LL_R
|-
| colspan="2" | Lowlight colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | LL_G
|-
| colspan="2" | Lowlight colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | LL_B
|-
| colspan="2" | Lowlight colour channel value 
|-
| 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''
|}

===SetSliderValue===
{| 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;" | '''SetSliderValue'''
|-
| colspan="2" | Sets the value of one of the sliders and optionally redraws the slider to reflect the value change. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | WidgetID
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Value
|-
| colspan="2" | Range: 0 to 1 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | RedrawSlider
|-
| colspan="2" | 0=Do not redraw, 1=Redraw 
|-
| 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''
|}

===SetTextFloat===
{| 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;" | '''SetTextFloat'''
|-
| colspan="2" | Draws a numerical value onto an object or Widget location. Useful for displaying, value statistics. Drawn using the object themes. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | ID
|-
| colspan="2" | Unique identifier of object or Widget. 
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Number
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NumDP
|-
| colspan="2" | Number of decimal points to display 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Unit
|-
| colspan="2" | Unit string to add after the numeric value. e.g. "g" or "s" 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Font
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | HAlignment
|-
| colspan="2" | 0=Left, 1=Center, 2=Right 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | VAlignment
|-
| colspan="2" | 0=Top, 1=Middle, 2=Bottom 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ObjectTheme
|-
| colspan="2" | Object theme index to control the colour of the text 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Transparent
|-
| colspan="2" | 0=Background Colour Drawn, 1=Don't Draw Background Colour 
|-
| 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''
|}

===SetTextLabel===
{| 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;" | '''SetTextLabel'''
|-
| colspan="2" | Draws a single line of text onto an object or Widget location. Useful for labelling Widgets such as buttons or having name, value statistics. Drawn using the object themes. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | ID
|-
| colspan="2" | Unique identifier of object or Widget. 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Text
|-
| colspan="2" | Text string to set as the label 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Font
|-
| colspan="2" | GLCD Font Index to use 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | HAlignment
|-
| colspan="2" | 0=Left, 1=Center, 2=Right 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | VAlignment
|-
| colspan="2" | 0=Top, 1=Middle, 2=Bottom 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ObjectTheme
|-
| colspan="2" | Object theme index to control the colour of the text 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Transparent
|-
| colspan="2" | 0=Background Colour Drawn, 1=Don't Draw Background Colour 
|-
| 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''
|}

===SetTextNumber===
{| 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;" | '''SetTextNumber'''
|-
| colspan="2" | Draws a numerical value onto an object or Widget location. Useful for displaying, value statistics. Drawn using the object themes. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | ID
|-
| colspan="2" | Unique identifier of object or Widget. 
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Number
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Unit
|-
| colspan="2" | Unit string to add after the numeric value. e.g. "g" or "s" 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Font
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | HAlignment
|-
| colspan="2" | 0=Left, 1=Center, 2=Right 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | VAlignment
|-
| colspan="2" | 0=Top, 1=Middle, 2=Bottom 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ObjectTheme
|-
| colspan="2" | Object theme index to control the colour of the text 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Transparent
|-
| colspan="2" | 0=Background Colour Drawn, 1=Don't Draw Background Colour 
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Graphical Display
|-
| colspan="2" | Graphical Display to draw our objects on 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | DM Library
|-
| colspan="2" | Display Manager compatible GLCD library component. e.g. Bitmap drawer components. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Ram Usage Bytes
|-
| colspan="2" | The calculated number of bytes of RAM required by the display manager. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Text Align Offset
|-
| colspan="2" | Number of pixels to move away from an edge when calling  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Objects
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Max Objects
|-
| colspan="2" | The total number of primitive objects allowed on the screen at once. Sets the size of the RAM buffers used to track the various screen elements. Each object requires 10 bytes of RAM to stores things like size, location and type. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Object Theme Count
|-
| colspan="2" | Sets the number of themes available when drawing primitive objects. Each object theme requires 6 bytes of RAM to store the colour channels. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Object & Text Theme 0
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Foreground
|-
| colspan="2" | Foreground colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Background
|-
| colspan="2" | Background colour of the theme 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Object & Text Theme 1
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Foreground
|-
| colspan="2" | Foreground colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Background
|-
| colspan="2" | Background colour of the theme 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Widgets
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Max Widgets
|-
| colspan="2" | The total number of touchable interactibe objects allowed on the screen at once e.g. Widgets and sliders. Sets the size of the RAM buffers used to track the various screen elements Each Widget requires 18 bytes of RAM to stores things like size, location, value and type. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Touch Repeat Rate
|-
| colspan="2" | Sets the period for touch repeats in terms of calls of the CheckForTouch macro. Widgets will only register a repeat touch after x calls if continually held down. Sliders will always register a touch. The touch count can be cleared using the NoTouch macro if no touch is detected. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Slider Thumb Width
|-
| colspan="2" | Number of pixels wide to make a slider thumb marker, 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Slider Center Line Thickness
|-
| colspan="2" | Number of pixels thick to draw the slider central line 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Widget Theme Count
|-
| colspan="2" | Sets the number of themes available for drawng Widgets. Each Widget theme requires 12 bytes of RAM to store the colour channels. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Widget Theme 0
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Foreground
|-
| colspan="2" | Foreground colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Background
|-
| colspan="2" | Background colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Highlight
|-
| colspan="2" | Highlight colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Lowlight
|-
| colspan="2" | Lowlight colour of the theme 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Widget Theme 1
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Foreground
|-
| colspan="2" | Foreground colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Background
|-
| colspan="2" | Background colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Highlight
|-
| colspan="2" | Highlight colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Lowlight
|-
| colspan="2" | Lowlight colour of the theme 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Lib_DisplayManager.fcfx FC_Comp_Source_Lib_DisplayManager.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Lib_DisplayManager.fcfx FC_Comp_Source_Lib_DisplayManager.fcfx]

Component: Display Manager (Graphical Library)

2025-03-28T11:25:59Z

MartinW: /* Examples */

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 2.1
|-
| width="20%" style="color:gray;" | Category
| Graphical Library
|}

==Display Manager component==
A component designed to simplify the process of drawing primitives and text onto a graphical display. Keeps track of coordinates so you don't have to. Also works great as a base layer for gLCD based games as it will check for collisions and perform movement.

==Version information==

Library Version, Component Version, Date, Author, Info
13, 2.0, 22-05-24, BR, Added text alignment options
14, 2.1, 14-06-24, BR, Renamed Button to Widget to better include things like sliders
15, 2.1, 26-07-24, BR, Added SetTextFloat and AddTextNumber macros
16, 2.1, 29-07-24, BR, Renamed Themes to ObjectThemes and WidgetThemes
17, 2.1, 29-07-24, BR, Added CreateTextField macro which automates creating a simple textbox
18, 2.1, 06-08-24, BR, Fixed a problem with updating values, theme, text on IDs
19, 2.1, 06-08-24, BR, Textfield now uses hidden object type instead of rectangle
20, 2.1, 06-08-24, BR, Fixed a problem where slider value could be set with out of range value
21, 2.1, 06-08-24, BR, Fixed problem where SetTextNumber would reset an ESP32

==Detailed description==

===Objects===

The component can create the following objects.

*'''Object_Hidden''' - 0 - A hidden area with no graphics.
*'''Object_Rectangle''' - 1 - A simple rectangular box.
*'''Object_Line''' - 2 - A simple straight line.
*'''Object_Ellipse''' - 3 - A simple ellipse or circle.
*'''Object_EllipseFilled''' - 4 - A filled ellipse or circle.
*'''Object_RectangeFilled''' - 5 - A filled rectangular box.

===TextField===

There is also an additional TextField object which consists of an Object_Rectangle that is pre-populated with text.

===Widgets===

The component can also create the following interactive buttons and sliders.

*'''Widget_Hidden''' - 0 - A hidden area with no graphics.
*'''Widget_Rectangle''' - 1 - A rectangular box with a shadow.
*'''Widget_RoundedRectangle''' - 2 - A rounded rectangular box with a shadow.
*'''Widget_Ellipse''' - 3 - A simple ellipse or circle with a shadow.
*'''Widget_VSlider''' - 4 - A vertical slider with a square thumb.
*'''Widget_HSlider''' - 5 - A horizontal slider with a square thumb.
*'''Widget_VSlider_Round''' - 6 - A vertical slider with a round thumb.
*'''Widget_HSlider_Round''' - 7 - A horizontal slider with a round thumb.

The type can be entered by using the component's public constants. Begin with the Display Manager handle name followed by :: and the list of the public variables will be displayed.

For example... '''DisplayManager1::Object_Rectangle''' or '''DisplayManager1::Widget_VSlider'''

===Touch Repeat Rate for Button Widgets===

The Touch Repeat Rate property applies to button based widgets and sets the frequency that a valid touch will be detected for a held button. This is similar to holding down a single key on a keyboard and acts to reduce the frequency of positive button detections when touching the button. For example if you had a button that incremented a value, without the repeat rate the value would increment much faster then anticipated in an uncontrollable manner. When no touch is detected it is recommended to call the NoTouch macro to clear the touch counters and allow a more responsive user experience.

Example of implementing touch repeat rate

[[File:ButtonRepeatRate.jpg]]

==Examples==

An example showing how to use the display manager with a GLCd and a touch interface to create a full HMI.

The example shows how to create a simple menu system as well as a toggle switch and a slider used to control a PWM output.

{{Fcfile|DisplayManagerDemo.fcfx|Display Manager Demo}}

An example showing how you can use the CreateWigitArray component to easily create a touch keypad for your gLCD

Component will create the widgets as keypad buttons with your custom text, it allows you to click on the widgets so you have a working keypad.

[[File:Updated__Display_Manager1.png]]

The CreateWidgetArray function macro that is very flexible in what you can create:

[[File:Updated__Display_Manager2.png]]

Lots of flexibility and there are also tooltips to help.

[[File:Updated__Display_Manager3.png]]

Note: if you get a unable to run simulation error then make sure you have the latest components downloaded.

{{Fcfile|DisplayManager_WidgetArray_Keypad_Example.fcfx|Display Manager Widget Array Keypad Example}}

==Macro reference==

===CheckForTouch===
{| 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;" | '''CheckForTouch'''
|-
| colspan="2" | Uses the X and Y coordinates from a touch sensor to check for Widget presses. Returns 0 for no Widgets pressed. Returns ID for a valid Widget press. Any touched slider Widgets will automatically move their thumb and value to the touch position.  
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y
|-
| colspan="2" |  
|-
| 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''
|}

===ClearAll===
{| 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;" | '''ClearAll'''
|-
| colspan="2" | Removes all objects and Widgets from memory. Also clears the screen if required. 
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | ClearScreen
|-
| colspan="2" | 0=Don't clear the screen, 1=Clear the screen 
|-
| 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''
|}

===CreateObject===
{| 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;" | '''CreateObject'''
|-
| colspan="2" | Define a none touchable graphical object. Returns the Object ID. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ObjectType
|-
| colspan="2" | 0=Hidden, 1=Rect, 2=Line, 3=Ellipse, 4=FilledEllipse, 5=FilledRect 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X
|-
| colspan="2" | X Pixel Coordinate 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y
|-
| colspan="2" | Y Pixel Coordinate 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Width
|-
| colspan="2" | Pixel Width or X Radius 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Height
|-
| colspan="2" | Pixel Height or Y Radius 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ObjectTheme
|-
| colspan="2" | Theme index to use to draw the object 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | DrawObject
|-
| colspan="2" | 0=Do not draw object yet, 1=Draw object now (Does not apply to hidden objects) 
|-
| 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''
|}

===CreateTextField===
{| 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;" | '''CreateTextField'''
|-
| colspan="2" | Creates a text field consisting of a rectangular border containing a single line of text 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Text
|-
| colspan="2" | Text string to set as the label 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X
|-
| colspan="2" | X Pixel Coordinate 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y
|-
| colspan="2" | Y Pixel Coordinate 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Width
|-
| colspan="2" | Pixel Width 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Height
|-
| colspan="2" | Pixel Height 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Font
|-
| colspan="2" | GLCD Font Index to use 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ObjectTheme
|-
| colspan="2" | Theme index to use to draw the object 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | HAlignment
|-
| colspan="2" | 0=Left, 1=Center, 2=Right 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | VAlignment
|-
| colspan="2" | 0=Top, 1=Middle, 2=Bottom 
|-
| 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''
|}

===CreateWidget===
{| 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;" | '''CreateWidget'''
|-
| colspan="2" | Define an interactive Widget or slider. Returns the Widget ID. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | WidgetType
|-
| colspan="2" | 0=WidgetHidden, 1=WidgetRect, 2=WidgetRoundedRect, 3=WidgetEllipse, 4=VSlider, 5=HSlider, 6=VSliderRound, 7=HSliderRound 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | X
|-
| colspan="2" | X Pixel Coordinate 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Y
|-
| colspan="2" | Y Pixel Coordinate 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Width
|-
| colspan="2" | Pixel Width or X Radius 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Height
|-
| colspan="2" | Pixel Height or Y Radius 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | WidgetTheme
|-
| colspan="2" | Theme index to use to draw the Widget 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | DrawWidget
|-
| colspan="2" | 0=Do not draw Widget yet, 1=Draw Widget now (Does not apply to hidden widgets) 
|-
| 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''
|}

===DrawAll===
{| 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;" | '''DrawAll'''
|-
| colspan="2" | Redraws all of the defined Objects and Widgets. Doesn't draw text, this is done using the SetText macros. 
|-
|-
| 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''
|}

===DrawItem===
{| 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;" | '''DrawItem'''
|-
| colspan="2" | Draws a single object or Widget onto the display without clearing the display. Doesn't draw text, this is done using the SetText macros. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | ID
|-
| colspan="2" | Unique ID of the Object or Widget 
|-
| 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''
|}

===GetLastTouchID===
{| 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;" | '''GetLastTouchID'''
|-
| colspan="2" | Gets the ID of the last Widget that returned a valid press via the CheckForTouch macro. Returns 0 for no valid touch recorded. 
|-
|-
| 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''
|}

===GetSliderValue===
{| 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;" | '''GetSliderValue'''
|-
| colspan="2" | Reads the value of one of the sliders ranging between 0 and 1. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | WidgetID
|-
| colspan="2" |  
|-
| 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''
|}

===Initialise===
{| 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 object and Widget control variables and sets up the default themes. 
|-
|-
| 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''
|}

===ModifyPosition===
{| 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;" | '''ModifyPosition'''
|-
| colspan="2" | Moves an existing object or Widget to absolute coordinates on the screen. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | ID
|-
| colspan="2" | Unique ID of the object or Widget 
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | X
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | Y
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Relative
|-
| colspan="2" | 0=Absolute Positioning, 1=Relative Positioning 
|-
| 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''
|}

===ModifyScale===
{| 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;" | '''ModifyScale'''
|-
| colspan="2" | Changes the width and height of the selected Object or Widget. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | ID
|-
| colspan="2" | Unique ID of the object or Widget 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Width
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Height
|-
| 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''
|}

===ModifyTheme===
{| 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;" | '''ModifyTheme'''
|-
| colspan="2" | Changes the theme index of the selected Object or Widget. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | ID
|-
| colspan="2" | Unique ID of the object or Widget 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Theme
|-
| colspan="2" | Theme index of the Widget or object 
|-
| 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''
|}

===NoTouch===
{| 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;" | '''NoTouch'''
|-
| colspan="2" | Called when no touch is present, Allows the repeat rate counter to be cleared allowing for better responses to fast touches. 
|-
|-
| 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''
|}

===OverrideObjectTheme===
{| 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;" | '''OverrideObjectTheme'''
|-
| colspan="2" | Overrides the colour of an object theme, used by the draw object macro.  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ThemeIndex
|-
| colspan="2" | Index of the object colour theme 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | FG_R
|-
| colspan="2" | Foreground colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | FG_G
|-
| colspan="2" | Foreground colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | FG_B
|-
| colspan="2" | Foreground colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BG_R
|-
| colspan="2" | Background colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BG_G
|-
| colspan="2" | Background colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BG_B
|-
| colspan="2" | Background colour channel value 
|-
| 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''
|}

===OverrideWidgetTheme===
{| 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;" | '''OverrideWidgetTheme'''
|-
| colspan="2" | Overrides the colour of a Widget theme, used by the draw Widget macro.  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ThemeIndex
|-
| colspan="2" | Index of the object colour theme 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | FG_R
|-
| colspan="2" | Foreground colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | FG_G
|-
| colspan="2" | Foreground colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | FG_B
|-
| colspan="2" | Foreground colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BG_R
|-
| colspan="2" | Background colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BG_G
|-
| colspan="2" | Background colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BG_B
|-
| colspan="2" | Background colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | HL_R
|-
| colspan="2" | Highlight colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | HL_G
|-
| colspan="2" | Highlight colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | HL_B
|-
| colspan="2" | Highlight colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | LL_R
|-
| colspan="2" | Lowlight colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | LL_G
|-
| colspan="2" | Lowlight colour channel value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | LL_B
|-
| colspan="2" | Lowlight colour channel value 
|-
| 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''
|}

===SetSliderValue===
{| 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;" | '''SetSliderValue'''
|-
| colspan="2" | Sets the value of one of the sliders and optionally redraws the slider to reflect the value change. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | WidgetID
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Value
|-
| colspan="2" | Range: 0 to 1 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | RedrawSlider
|-
| colspan="2" | 0=Do not redraw, 1=Redraw 
|-
| 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''
|}

===SetTextFloat===
{| 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;" | '''SetTextFloat'''
|-
| colspan="2" | Draws a numerical value onto an object or Widget location. Useful for displaying, value statistics. Drawn using the object themes. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | ID
|-
| colspan="2" | Unique identifier of object or Widget. 
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Number
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NumDP
|-
| colspan="2" | Number of decimal points to display 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Unit
|-
| colspan="2" | Unit string to add after the numeric value. e.g. "g" or "s" 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Font
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | HAlignment
|-
| colspan="2" | 0=Left, 1=Center, 2=Right 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | VAlignment
|-
| colspan="2" | 0=Top, 1=Middle, 2=Bottom 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ObjectTheme
|-
| colspan="2" | Object theme index to control the colour of the text 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Transparent
|-
| colspan="2" | 0=Background Colour Drawn, 1=Don't Draw Background Colour 
|-
| 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''
|}

===SetTextLabel===
{| 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;" | '''SetTextLabel'''
|-
| colspan="2" | Draws a single line of text onto an object or Widget location. Useful for labelling Widgets such as buttons or having name, value statistics. Drawn using the object themes. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | ID
|-
| colspan="2" | Unique identifier of object or Widget. 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Text
|-
| colspan="2" | Text string to set as the label 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Font
|-
| colspan="2" | GLCD Font Index to use 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | HAlignment
|-
| colspan="2" | 0=Left, 1=Center, 2=Right 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | VAlignment
|-
| colspan="2" | 0=Top, 1=Middle, 2=Bottom 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ObjectTheme
|-
| colspan="2" | Object theme index to control the colour of the text 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Transparent
|-
| colspan="2" | 0=Background Colour Drawn, 1=Don't Draw Background Colour 
|-
| 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''
|}

===SetTextNumber===
{| 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;" | '''SetTextNumber'''
|-
| colspan="2" | Draws a numerical value onto an object or Widget location. Useful for displaying, value statistics. Drawn using the object themes. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | ID
|-
| colspan="2" | Unique identifier of object or Widget. 
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Number
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Unit
|-
| colspan="2" | Unit string to add after the numeric value. e.g. "g" or "s" 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Font
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | HAlignment
|-
| colspan="2" | 0=Left, 1=Center, 2=Right 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | VAlignment
|-
| colspan="2" | 0=Top, 1=Middle, 2=Bottom 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ObjectTheme
|-
| colspan="2" | Object theme index to control the colour of the text 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Transparent
|-
| colspan="2" | 0=Background Colour Drawn, 1=Don't Draw Background Colour 
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Graphical Display
|-
| colspan="2" | Graphical Display to draw our objects on 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | DM Library
|-
| colspan="2" | Display Manager compatible GLCD library component. e.g. Bitmap drawer components. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Ram Usage Bytes
|-
| colspan="2" | The calculated number of bytes of RAM required by the display manager. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Text Align Offset
|-
| colspan="2" | Number of pixels to move away from an edge when calling  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Objects
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Max Objects
|-
| colspan="2" | The total number of primitive objects allowed on the screen at once. Sets the size of the RAM buffers used to track the various screen elements. Each object requires 10 bytes of RAM to stores things like size, location and type. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Object Theme Count
|-
| colspan="2" | Sets the number of themes available when drawing primitive objects. Each object theme requires 6 bytes of RAM to store the colour channels. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Object & Text Theme 0
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Foreground
|-
| colspan="2" | Foreground colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Background
|-
| colspan="2" | Background colour of the theme 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Object & Text Theme 1
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Foreground
|-
| colspan="2" | Foreground colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Background
|-
| colspan="2" | Background colour of the theme 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Widgets
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Max Widgets
|-
| colspan="2" | The total number of touchable interactibe objects allowed on the screen at once e.g. Widgets and sliders. Sets the size of the RAM buffers used to track the various screen elements Each Widget requires 18 bytes of RAM to stores things like size, location, value and type. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Touch Repeat Rate
|-
| colspan="2" | Sets the period for touch repeats in terms of calls of the CheckForTouch macro. Widgets will only register a repeat touch after x calls if continually held down. Sliders will always register a touch. The touch count can be cleared using the NoTouch macro if no touch is detected. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Slider Thumb Width
|-
| colspan="2" | Number of pixels wide to make a slider thumb marker, 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Slider Center Line Thickness
|-
| colspan="2" | Number of pixels thick to draw the slider central line 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Widget Theme Count
|-
| colspan="2" | Sets the number of themes available for drawng Widgets. Each Widget theme requires 12 bytes of RAM to store the colour channels. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Widget Theme 0
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Foreground
|-
| colspan="2" | Foreground colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Background
|-
| colspan="2" | Background colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Highlight
|-
| colspan="2" | Highlight colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Lowlight
|-
| colspan="2" | Lowlight colour of the theme 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Widget Theme 1
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Foreground
|-
| colspan="2" | Foreground colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Background
|-
| colspan="2" | Background colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Highlight
|-
| colspan="2" | Highlight colour of the theme 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Lowlight
|-
| colspan="2" | Lowlight colour of the theme 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Lib_DisplayManager.fcfx FC_Comp_Source_Lib_DisplayManager.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Lib_DisplayManager.fcfx FC_Comp_Source_Lib_DisplayManager.fcfx]

File:Updated Display Manager3.png

2025-03-28T11:19:09Z

MartinW:

File:Updated Display Manager2.png

2025-03-28T11:18:50Z

MartinW:

File:Updated Display Manager1.png

2025-03-28T11:18:06Z

MartinW:

File:DisplayManager WidgetArray Keypad Example.fcfx

2025-03-28T11:11:22Z

MartinW:

Component: Potentiometer (Analog Input)

2025-03-20T09:22:07Z

MartinW: /* Examples */

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Analog Input
|}

==Potentiometer component==

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Potentiometer.fcfx FC_Comp_Source_Potentiometer.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Potentiometer.fcfx FC_Comp_Source_Potentiometer.fcfx]

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

A simple example that shows how to use some common functions of the potentiometer in conjunction with an LCD.

{{Fcfile|Potentiometer Example.fcfx|Potentiometer Example}}

===Using Fixed Voltage Reference===

An example of a 0 to 1023 mV meter with a resolution of 1mv.

{{Fcfile|ADC_using_FVR_16F15324.fcfx|ADC using FVR}}

A PIC16F15324 is used since it has a Fixed Voltage Reference (FVR) register.

Bit0 and bit1 determine what the FVR is set at.

A line of C code is added to set the FVR to a gain of x1 = FVR of 1.024V:

'''FVRCON = 0b11000001;'''

With this setting, the Int value from ADC directly proportional voltage in mV.

E.g. a value of 732 = 732mV

Binary is used to make reading values a lot easier.

From the datasheet:

[[File:PIC16F1532x FVRCON.png]]

If you wanted to change the fixed voltage reference to 2.048V

Then change bit0 and bit1 of the C code to '''FVRCON = 0b11000010;'''

===Filtering ADC Inputs===

Simple example which uses a filtering technique to provide a digital low pass filter on the ADC readings. The output of the filter is 50% the ADC reading and 50% the previous reading.

{{Fcfile|LPFilter_2D.fcfx|LPFilter}}

In this example the output of the filter is 25% the ADC reading and 75% the previous reading.

{{Fcfile|LPFilter2_2D.fcfx|LPFilter2}}

===Analogue Inputs Window===

The [[Analog_Window|Analogue inputs window]] available from the View ribbon, allows you to see the values for all of the analogue inputs which are active in your program. They can also be manually altered by dragging the mouse along one of the sliders.

===Data Recorder===

An ADC based component will automatically add a trace to the [[Using_the_Data_Recorder|data recorder]] window allowing you to get a view of the analogue data over time during simulation.

[[File:Data_Recorder1.png]]

==Macro reference==

===GetAverageByte===
{| 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;" | '''GetAverageByte'''
|-
| colspan="2" | Read the ADC as a byte 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NumSamples
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | DelayUs
|-
| colspan="2" |  
|-
| 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''
|}

===GetAverageInt===
{| 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;" | '''GetAverageInt'''
|-
| colspan="2" | Read the ADC at full bit depth 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NumSamples
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | DelayUs
|-
| colspan="2" |  
|-
| 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''
|}

===GetByte===
{| 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;" | '''GetByte'''
|-
| colspan="2" | Read the ADC as a byte 
|-
|-
| 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''
|}

===GetInt===
{| 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;" | '''GetInt'''
|-
| colspan="2" | Read the ADC at full bit depth 
|-
|-
| 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''
|}

===GetString===
{| 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;" | '''GetString'''
|-
| colspan="2" | Reads the ADC as a direct voltage 
|-
|-
| 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''
|}

===GetVoltage===
{| 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;" | '''GetVoltage'''
|-
| colspan="2" | Reads the ADC as a direct voltage 
|-
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | Analogue Input Channel - Which pin is the analogue input connected to? 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Settings
|-
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | VRef voltage
|-
| colspan="2" | Used by the GetVoltage or GetString component macros to take an ADC reading and convert it into a Voltage. +VRef voltage x 10mV Default 500 = 5.0V  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | VRef option
|-
| colspan="2" | Defines what is used as the ADC maximum reference. ADC Range = GND to VRef Voltage VDD - Defines the microcontrollers power supply pin as the max reference, VREF+ Pin - Dedicated pin on the microcontroller to allow for a variable reference voltage. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Conversion speed
|-
| colspan="2" | Clock setting to select how fast the ADC peripheral will perform an ADC conversion. The FRC setting is based on a RC time base and so will vary with temperature and pressure. Other settings are generally based on divisions of the master clock. 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Acquisition cycles
|-
| colspan="2" | Number of micro seconds to wait for the ADC input to charge before starting the analogue sample. 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Bit Depth
|-
| colspan="2" | Maximum number of digital bits the ADC can sample. 8 bit = ADC range 0 - 255 10 bit = ADC range 0 - 1023 12 bit = ADC range 0 - 4095 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Retain Value
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Component Label
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | LabelColour
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Connection Label
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Pin Value
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Colour Style
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-23-icon.png]]
| width="90%" | Fill
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Frame Outline
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-23-icon.png]]
| width="90%" | Frame Fill
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Pointer Outline
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-23-icon.png]]
| width="90%" | Pointer Fill
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Text
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Tick Mark Outline
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-23-icon.png]]
| width="90%" | Tick Mark Fill
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Cap Outline
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-23-icon.png]]
| width="90%" | Cap Fill
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-13-icon.png]]
| width="90%" | Main Image
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-13-icon.png]]
| width="90%" | Cap Image
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Type
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scope Traces
|-
| colspan="2" | Selects if the scope traces are automatically generated or not 
|}

File:PIC16F1532x FVRCON.png

2025-03-20T09:12:18Z

MartinW:

File:ADC using FVR 16F15324.fcfx

2025-03-20T09:11:40Z

MartinW:

Supporting Third Party Programming Tools

2025-03-10T10:34:07Z

MartinW: /* AISX Presto/Forte */

[[File:Gen_Compiler_Options_Programmer_PIC.png|right|524x400px]]
Each version of Flowcode comes ready with a default programming tool. However it is fairly easy to change the settings in Flowcode to allow for third party programming tools to be used.

The programming tool that is invoked when the compile to chip button is pressed is configured in the '''Build menu''' under '''Compiler options''' then click on the '''Programmer tab''' page.

For help with third party programming tools the first port of call should be to check our [http://www.matrixmultimedia.com/mmforums/ forums] to see if anyone else has already tried the programming tool with Flowcode. If you are the first then if you wish you can post your findings for other users to benefit from.

==Warning==

Editing the Compiler or Linker tabs of the compiler options will likely stop Flowcode from being able to compile correctly unless you know what you are doing.

The settings below are for the '''Programmer''' tab of the compiler options. Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

If you do edit the values in the compiler or linker tab then you can simply revert back to the default settings and start again.

==Microchip PIC / PIC16 / PIC32==

===mLoader===

mLoader is the default programming software and can be used to talk to the various Matrix hardware including E-blocks, E-blocks2, Formula Flowcode, ECIO, MIAC, ProtoBoard, ProjectBoard...

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''$(appdir)tools\mLoader\mLoader.exe'''</code>

Parameters:

<code>'''-chip $(chip:u) "$(outdir)$(target).hex"'''</code>

===PPP===

PPP is the older programming software from Flowcode v5 and previous and can be used to talk to versions of the E-blocks EB006 up to and including version 8.

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''$(appdir)tools\PPP\PPPv3.exe'''</code>

Parameters:

<code>'''-cs 2 -chip PIC$(chip:u) -nogui "$(outdir)$(target).hex"'''</code>

===PICkit2===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''$(appdir)tools\PICkit2\pk2cmd.exe'''</code>

Parameters:

<code>'''-B$(appdir)tools\PICkit2\ -PPIC$(chip) -F$(target).hex -M -A5 -R'''</code>

Details on how to upgrade your PICkit 2 to work with new targets are available from [http://www.matrixtsl.com/mmforums/viewtopic.php?f=54&t=16843 here].

Please note that the PICkit 2 was never designed to work with the newer devices and although it is known to work, you may cause damage to your PIC devices by using incorrect VPP programming voltages etc as supplied by the PICkit 2.

===PICkit3 - PK3CMD (OLD)===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

There are two options for using the PICkit 3 depending on how you are powering your hardware:

'''Powered externally'''

Location:

<code>'''$(appdir)tools\PICkit3\PK3CMD.exe'''</code>

Parameters (8-bit PIC):

<code>'''-P$(chip) -F$(target).hex -E -M'''</code>

Parameters (16-bit PIC):

<code>'''-P$(chip) -F$(target).hex -E -M -L'''</code>

'''Powered via the PICkit'''

Location:

<code>'''$(appdir)tools\PICkit3\PK3CMD.exe'''</code>

Parameters (8-bit PIC):

<code>'''-P$(chip) -F$(target).hex -V5 -E -M'''</code>

Parameters (16-bit PIC):

<code>'''-P$(chip) -F$(target).hex -V3.3 -E -M -L'''</code>

Please note that the PICkit 3 will fail to program if you have spaces in your Flowcode project name, replacing spaces with underscores or removing them completely should resolve the issue.

Also note that if your using the PICkit 3 with MPLABX or have bought a new one recently then you will likely have to downgrade the firmware to allow Flowcode to work with the PICkit.

Full details on how to do this are available from [http://woodworkerb.com/pickit-3-and-flowcode-6/ here].

If your still having problems getting the PICkit 3 to fire up then this [http://www.matrixtsl.com/mmforums/viewtopic.php?f=54&t=12970&p=58454#p52318 forum topic] may be of help.

===PICkit3 - IPE (NEW)===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

First make sure you have the latest MPLAB X installed on your computer. We used version 4.20 which is used in the location path shown below. Make sure your path matches your installed location.

There are two options for using the PICkit 3 depending on how you are powering your hardware:

'''Powered externally'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK3 /M /OL'''</code>

'''Powered via the PICkit'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters - Powered at 3V3:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK3 /M /OL /W3.3'''</code>

Parameters - Powered at 5V:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK3 /M /OL /W5'''</code>

To use the Microchip Real ICE programmer instead of the PICkit 3 substitute the parameter /TPPK3 with /TPRICE

===PICkit4===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

First make sure you have the latest MPLAB X installed on your computer. We used version 4.20 which is used in the location path shown below. Make sure your path matches your installed location.

Version 4.20 is the minimum version that will work with the PICkit 4 hardware.

There are two options for using the PICkit 4 depending on how you are powering your hardware:

'''Powered externally'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK4 /M /OL'''</code>

'''Powered via the PICkit'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters - Powered at 3V3:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK4 /M /OL /W3.3'''</code>

Parameters - Powered at 5V:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPPK4 /M /OL /W5'''</code>

===SNAP===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

First make sure you have the latest MPLAB X installed on your computer. We used version 5.40 which is used in the location path shown below. Make sure your path matches your installed location.

Version 5.40 is the minimum version that will work with the Snap hardware.

There are two options for using the Snap depending on how you are powering your hardware:

'''Powered externally'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPSNAP /M /OL'''</code>

'''Powered via the PICkit'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters - Powered at 3V3:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPSNAP /M /OL /W3.3'''</code>

Parameters - Powered at 5V:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPSNAP /M /OL /W5'''</code>

===ICD3===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

First make sure you have the latest MPLAB X installed on your computer. We used version 4.20 which is used in the location path shown below. Make sure your path matches your installed location.

There are two options for using the ICD3 depending on how you are powering your hardware:

'''Powered externally'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPICD3 /M /OL'''</code>

'''Powered via the ICD3'''

Location:

<code>'''$(mplabxdir)mplab_platform\mplab_ipe\ipecmd.exe'''</code>

Parameters - Powered at 3V3:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPICD3 /M /OL /W3.3'''</code>

Parameters - Powered at 5V:

<code>'''/P$(chip) /F"$(outdir)$(target).hex" /TPICD3 /M /OL /W5'''</code>

===FS USB===

Flowcode PIC comes with a example for using the free microchip USB bootloader. Changing your target to the MCHP_FSUSB will automatically configure the programmer to use the Microchip PDFSUSB programming tool. Note - The USB bootloader firmware must be present on the device to allow the programming tool to connect correctly to the device.

===TINY PIC Bootloader===

Support for the Serial TINY PIC Bootloader is documented [http://www.matrixmultimedia.com/mmforums/viewtopic.php?f=5&t=4647 here].

==AVR==

===AVRISP mkII===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''$(compileravr)batchfiles\avrc.bat'''</code>

Parameters:

<code>'''AVRDUDE $(chipalt) $(chip:l) "$(outdir)$(target).hex" "$(target).hex" 0 $(cfgb) $(cfg0) $(cfg1) $(cfg2) $(cfg3)'''</code>

===USB Tiny===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

Location:

<code>'''$(compileravr)batchfiles\avrc_usbtiny.bat'''</code>

Parameters:

<code>'''AVRDUDE $(chipalt) $(chip:l) "$(outdir)$(target).hex" "$(target).hex" 0 $(cfgb) $(cfg0) $(cfg1) $(cfg2) $(cfg3)'''</code>

===AVR Dude===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

The AVRDUDE programming tool supports a number of third party programmers for more help and information please visit the [http://savannah.nongnu.org/projects/avrdude/ AVRDUDE home page].

[http://blog.zakkemble.co.uk/avrdudess-a-gui-for-avrdude/ AVRDUDESS] is a graphical user interface for AVRdude.

===Arduino===

Flowcode Arduino allows you to specify a COM port to connect to the Arduino hardware via the Flowcode Project options window. Once you have specified the COM port and selected the correct target board the compile to chip option should program the Arduino device automatically using AVR dude.

===Arduino Mega 2560 R1/R2===

Flowcode is currently unable to program early versions of the Arduino Mega hardware. To program these devices use the tool [http://russemotto.com/xloader/ Xloader] to manually load the Flowcode generated .hex file onto the device.

==ARM==

Flowcode ARM comes with a set of precompiled bootloader files. This allows the matrix mLoader USB reprogrammable operation to be used on any third party ARM hardware.

===mLoader===

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

mLoader is the default programming software and can be used to talk to the various Matrix hardware including EB006, EB064, EB031, Formula Flowcode, ECIO, MIAC, ProtoBoard, ProjectBoard...

Location:

<code>'''$(appdir)tools\mLoader\mLoader.exe'''</code>

Parameters:

<code>'''-eb0310 "$(target).s19"'''</code>

===SAM-BA===

The SAM-BA tool is provided by Atmel and works with the default SAM7S bootloader which can be automatically restored to the device by powering up the ARM hardware for ten seconds using the TST jumper in the none default setting. Note this will delete the Matrix USB bootloader from the device.

==ST ARM==

===ST-LINK===

Flowcode by default is setup to use the ST-LINK programmer using the compile to chip option.

===Discovery===

Discovery boards are programmed by dropping the compiled binary firmware file onto a drive that appears under My Computer. Flowcode can automatically place the file onto the drive for you when using the compile to chip option with a discovery board selected as the target device.

===Nucleo===

Nucleo boards have a ST-LINK programmer built onto the board and so these work like standard ST ARM targets only without the additional requirement of a ST-LINK programmer.

==Raspberry Pi==

Raspberry Pi boards can be programmed over the network using Putty which is included with Flowcode. Enter the network details for the Pi into the Flowcode project options and this will allow the compile to chip to connect to the Pi using Putty via a SSH connection. SSH must be enabled on your Pi for this to function correctly but this should be enabled by default.

==AISX Presto/Forte==

Take care to ensure you '''only''' edit the values in the '''Programmer''' tab.

[[File:ProgTab.jpg]]

First, make sure you have the latest UP installed on your computer.
Make sure your path matches your installed location.

Location:

<code>'''C:\Program Files (x86)\ASIX\UP\up.exe'''</code>

Parameters:

<code>'''/p "$(outdir)$(target).hex" /part PIC$(chip)'''</code>

The way the command line works is by using the last UP.exe settings.

If you want to use the programmer’s internal supply.

Open UP.exe and within the programmer settings window, select During programming check box.

I would also recommend changing Delay for VDD switching on/off when supplied from programmer from 10000 to 50000.

Close UP then all is ready for programming.

If you want to see a popup progress bar during programming, remove /q from the parameters.

Note:
Presto can only supply VDD 5.0V and VPP 13.0V
Forte can supply VDD 2.0V to 5.5V and VPP 6.5V to 17 Automatically, depending on the selected target device.

File:SimpleIBDemo.fcfx

2025-02-05T09:23:35Z

MartinW: MartinW uploaded a new version of File:SimpleIBDemo.fcfx

File:FreqGenMulti.fcfx

2025-01-31T08:39:35Z

MartinW: MartinW uploaded a new version of File:FreqGenMulti.fcfx

File:FreqGen.fcfx

2025-01-31T08:36:13Z

MartinW: MartinW uploaded a new version of File:FreqGen.fcfx

File:LowPassFilter.fcfx

2025-01-31T08:27:05Z

MartinW: MartinW uploaded a new version of File:LowPassFilter.fcfx

File:Delay.fcfx

2025-01-29T11:28:00Z

MartinW: MartinW uploaded a new version of File:Delay.fcfx

Component: Input Digital (DSP Inputs)

2025-01-29T11:27:39Z

MartinW: /* Examples */

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color:gray;" | Version
| 1.2
|-
| width="20%" style="color:gray;" | Category
| DSP Inputs
|}

==Input Digital component==
Allows the values from a buffer to be assigned. Either a value at a time or from an array. The input signal would usually take the form of an ADC reading or raw data values.

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_DSP_Input.fcfx FC_Comp_Source_DSP_Input.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_Input.fcfx FC_Comp_Source_DSP_Input.fcfx]

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Here is a basic example demonstrating how to pass a value into the DSP chain.

{{Fcfile|Delay.fcfx|Delay}}

The input value in the example uses an ADC reading but this can be taken from anything such as a reading from a CSV file on a SD card or a value passed by a sensor on a I2C bus etc.

==Macro reference==

===AddByte===
{| 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;" | '''AddByte'''
|-
| colspan="2" | Adds a single byte value to the current location in the specified buffer. Auto increments current location if output buffer size is greater than 1. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| 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''
|}

===AddByteArray===
{| 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;" | '''AddByteArray'''
|-
| colspan="2" | Adds an array of byte values to the current location in the specified buffer. Auto increments current location if output buffer size is greater than 1. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Count
|-
| 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''
|}

===AddFloat===
{| 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;" | '''AddFloat'''
|-
| colspan="2" | Adds a single float value to the current location in the specified buffer. Auto increments current location if output buffer size is greater than 1. 
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Data
|-
| 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''
|}

===AddFloatArray===
{| 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;" | '''AddFloatArray'''
|-
| colspan="2" | Adds an array of float values to the current location in the specified buffer. Auto increments current location if output buffer size is greater than 1. 
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Data
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Count
|-
| 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''
|}

===AddInt===
{| 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;" | '''AddInt'''
|-
| colspan="2" | Adds a single integer value to the current location in the specified buffer. Auto increments current location if output buffer size is greater than 1. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Data
|-
| 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''
|}

===AddIntArray===
{| 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;" | '''AddIntArray'''
|-
| colspan="2" | Adds an array of integer values to the current location in the specified buffer. Auto increments current location if output buffer size is greater than 1. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Data
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Count
|-
| 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''
|}

===AddLong===
{| 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;" | '''AddLong'''
|-
| colspan="2" | Adds a single long value to the current location in the specified buffer. Auto increments current location if output buffer size is greater than 1. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Data
|-
| 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''
|}

===AddLongArray===
{| 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;" | '''AddLongArray'''
|-
| colspan="2" | Adds an array of long values to the current location in the specified buffer. Auto increments current location if output buffer size is greater than 1. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Data
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Count
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Buffer Size
|-
| colspan="2" | Number of individual elements the buffer can store, default 1. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Buffer Type
|-
| colspan="2" | Sets the buffer data type, data is automatically scaled to fit and make full use of the data type. 
|}

Component: Servo Motor (BL0162) (E-blocks 2)

2025-01-29T11:20:12Z

MartinW: /* Examples */

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| E-blocks 2
|}

==Servo Motor component==
Servo motor component to drive the E-blocks 2 BL0162 Servo Motors board. Provides up to eight individually addressable connections for standard DC servo motors to be connected.

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EBlocks2_Servo_BL0162.fcfx FC_Comp_Source_EBlocks2_Servo_BL0162.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBlocks2_Servo_BL0162.fcfx FC_Comp_Source_EBlocks2_Servo_BL0162.fcfx]

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Example showing how to control three servos using AutoMoveToPosion, MoveTopposition & SetPosition component macros. 
{{Fcfile|Controlling_Servos_Example.fcfx|Controlling Servos Example.fcfx}} 

Example using BL0162 Servo controller for BL0055 Arduino Shield

Samples the Port D8-D13 (portB) switches and moves the servo motors based on the input states.

D8 increments motor 0, D9 decrements motor on channel 0.

D10 increments motor 1, D11 decrements motor on channel 1.

D12 increments motor 3, D13 decrements motor on channel 2.

Connections:

Servo Board Port D0-D2.

Switch Board Port D8 - D13

LCD A0 to A5 (PortC)

{{Fcfile|BL0162_Servo_BL0055.fcfx|BL0162 Servos Example for BL0055}} 

==Macro reference==

===AutoMoveToPosition===
{| 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;" | '''AutoMoveToPosition'''
|-
| colspan="2" | Automatically moves towards the new position with a fixed rate of 100 steps per second. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Position to move to. 
|-
| 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''
|}

===DisableServo===
{| 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;" | '''DisableServo'''
|-
| colspan="2" | Disables a servo channel effectivly disabling the motor. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| 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''
|}

===EnableServo===
{| 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;" | '''EnableServo'''
|-
| colspan="2" | Enables a servo channel effectivly setting the position of the motor to the value in the local position variable. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| 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''
|}

===Initialise===
{| 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" | Sets up the servo motor interrupts 
|-
|-
| 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''
|}

===IsAutoMoving===
{| 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;" | '''IsAutoMoving'''
|-
| colspan="2" | Is the AutoMoveToPosition movement complete. Returns 1 if the servo is still moving. Returns 0 if the servo movement is complete. 
|-
|-
| 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''
|}

===MoveToPosition===
{| 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;" | '''MoveToPosition'''
|-
| colspan="2" | Moves a single step towards the new position, the rate of movement is determined by how often the move to macro is called. Returns 1 if the position has been reached. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Target position to move towards. 
|-
| 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''
|}

===SetAutoMoveSpeed===
{| 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;" | '''SetAutoMoveSpeed'''
|-
| colspan="2" | Sets the speed of the auto move to position macro. Default speed is 1. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Speed
|-
| colspan="2" | 1=Slowest (Default), 2= Double, 3=Triple, 4=Quadruple 
|-
| 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''
|}

===SetPosition===
{| 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;" | '''SetPosition'''
|-
| colspan="2" | Moves directly to the specified position with no interpolation. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Target position to move towards. 
|-
| 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''
|}

===SetTrim===
{| 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;" | '''SetTrim'''
|-
| colspan="2" | Allows the level of trim for each servo channel to be adjusted progmatically. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Trim
|-
| colspan="2" | 0=0us, 1=+25us, 2=+50us, 3=+75us, 4=+100us, 5=-25us, 6=-50us, 7=-75us, 8=-100us 
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channels (1 - 8)
|-
| colspan="2" | Set the number of servo's that you need to control. Value from 1 to 8. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Channel 0
|-
| colspan="2" | Pin on which to output PWM for the servo motor. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Channel 1
|-
| colspan="2" | Pin on which to output PWM for the servo motor. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Channel 2
|-
| colspan="2" | Pin on which to output PWM for the servo motor. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Channel 3
|-
| colspan="2" | Pin on which to output PWM for the servo motor. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Channel 4
|-
| colspan="2" | Pin on which to output PWM for the servo motor. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Channel 5
|-
| colspan="2" | Pin on which to output PWM for the servo motor. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Channel 6
|-
| colspan="2" | Pin on which to output PWM for the servo motor. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Channel 7
|-
| colspan="2" | Pin on which to output PWM for the servo motor. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Pulse Width
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Minimum (us)
|-
| colspan="2" | Shortest pulse width that will be used. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Maximum (us)
|-
| colspan="2" | Longest pulse width used for the PWM signals. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Trim
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim 0
|-
| colspan="2" | Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar input values will produce the same degree of movement. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim 1
|-
| colspan="2" | Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar input values will produce the same degree of movement. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim 2
|-
| colspan="2" | Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar input values will produce the same degree of movement. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim 3
|-
| colspan="2" | Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar input values will produce the same degree of movement. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim 4
|-
| colspan="2" | Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar input values will produce the same degree of movement. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim 5
|-
| colspan="2" | Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar input values will produce the same degree of movement. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim 6
|-
| colspan="2" | Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar input values will produce the same degree of movement. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim 7
|-
| colspan="2" | Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar input values will produce the same degree of movement. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Servo Interface
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="90%" | Servo Object 0
|-
| colspan="2" | Drag a servo motor component onto the System Panel, and then select it here, to create an on screen simulation of the way that your flowchart moves the servo's. Servo motors should be based on the 'Servo Motor Base' component, or use a custom component set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)). 
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="90%" | Servo Object 1
|-
| colspan="2" | Drag a servo motor component onto the System Panel, and then select it here, to create an on screen simulation of the way that your flowchart moves the servo's. Servo motors should be based on the 'Servo Motor Base' component, or use a custom component set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)). 
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="90%" | Servo Object 2
|-
| colspan="2" | Drag a servo motor component onto the System Panel, and then select it here, to create an on screen simulation of the way that your flowchart moves the servo's. Servo motors should be based on the 'Servo Motor Base' component, or use a custom component set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)). 
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="90%" | Servo Object 3
|-
| colspan="2" | Drag a servo motor component onto the System Panel, and then select it here, to create an on screen simulation of the way that your flowchart moves the servo's. Servo motors should be based on the 'Servo Motor Base' component, or use a custom component set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)). 
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="90%" | Servo Object 4
|-
| colspan="2" | Drag a servo motor component onto the System Panel, and then select it here, to create an on screen simulation of the way that your flowchart moves the servo's. Servo motors should be based on the 'Servo Motor Base' component, or use a custom component set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)). 
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="90%" | Servo Object 5
|-
| colspan="2" | Drag a servo motor component onto the System Panel, and then select it here, to create an on screen simulation of the way that your flowchart moves the servo's. Servo motors should be based on the 'Servo Motor Base' component, or use a custom component set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)). 
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="90%" | Servo Object 6
|-
| colspan="2" | Drag a servo motor component onto the System Panel, and then select it here, to create an on screen simulation of the way that your flowchart moves the servo's. Servo motors should be based on the 'Servo Motor Base' component, or use a custom component set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)). 
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="90%" | Servo Object 7
|-
| colspan="2" | Drag a servo motor component onto the System Panel, and then select it here, to create an on screen simulation of the way that your flowchart moves the servo's. Servo motors should be based on the 'Servo Motor Base' component, or use a custom component set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)). 
|}

File:Controlling Servos Example.fcfx

2025-01-29T11:18:56Z

MartinW: MartinW uploaded a new version of File:Controlling Servos Example.fcfx

Component: Servo Motor Controller (Mechatronics)

2025-01-29T11:10:23Z

MartinW: /* Examples */

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color:gray;" | Version
| 2.1
|-
| width="20%" style="color:gray;" | Category
| Mechatronics
|}

==Servo Motor Controller component==
Can control up to eight standard PWM driven servo's. Supports 8-bit and 16-bit movement resolutions. 'Servo Object' properties allow you to connect the controller to on-screen simulations using the "Servo Motor" component and its derivatives.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Example showing how to control three servos using AutoMoveToPosion, MoveTopposition & SetPosition component macros. 
{{Fcfile|Controlling_Servos_Example.fcfx|Controlling Servos Example.fcfx}} 

Example using BL0162 Servo controller for BL0055 Arduino Shield

Samples the Port D8-D13 (portB) switches and moves the servo motors based on the input states.

D8 increments motor 0, D9 decrements motor on channel 0.

D10 increments motor 1, D11 decrements motor on channel 1.

D12 increments motor 3, D13 decrements motor on channel 2.

Connections:

Servo Board Port D0-D2.

Switch Board Port D8 - D13

LCD A0 to A5 (PortC)

{{Fcfile|BL0162_Servo_BL0055.fcfx|BL0162 Servos Example for BL0055}} 

==Macro reference==

===AutoMoveToAngle===
{| 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;" | '''AutoMoveToAngle'''
|-
| colspan="2" | Automatically moves towards the new angle at a fixed rate determined by the AutoMoveSpeed. AutoMove not currently supported by ESP32. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Angle
|-
| colspan="2" | Angle in degrees, Range 0 to calibration angle 
|-
| 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''
|}

===AutoMoveToPosition===
{| 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;" | '''AutoMoveToPosition'''
|-
| colspan="2" | Automatically moves towards the new position at a fixed rate determined by the AutoMoveSpeed. AutoMove not currently supported by ESP32. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Position to automatically move to. Range: 0-255 
|-
| 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''
|}

===AutoMoveToPositionInt===
{| 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;" | '''AutoMoveToPositionInt'''
|-
| colspan="2" | Automatically moves towards the new 16-bit position at a fixed rate determined by the AutoMoveSpeed. AutoMove not currently supported by ESP32. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Position
|-
| colspan="2" | Position to automatically move to. Range: 0-65535 
|-
| 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''
|}

===DisableServo===
{| 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;" | '''DisableServo'''
|-
| colspan="2" | Disables a servo channel effectivly disabling the motor. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| 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''
|}

===EnableServo===
{| 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;" | '''EnableServo'''
|-
| colspan="2" | Enables a servo channel effectivly setting the position of the motor to the value in the local position variable. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| 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''
|}

===Initialise===
{| 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" | Sets up the servo motor interrupts 
|-
|-
| 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''
|}

===IsAutoMoving===
{| 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;" | '''IsAutoMoving'''
|-
| colspan="2" | Is the AutoMoveToPosition movement complete. Returns 1 if the servos are still moving. Returns 0 if all servo movement is complete. 
|-
|-
| 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''
|}

===IsServoAutoMoving===
{| 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;" | '''IsServoAutoMoving'''
|-
| colspan="2" | Is the AutoMoveToPosition movement complete for a specific servo output. Returns 1 if the servo is still moving. Returns 0 if the servo movement is complete. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | Servo Motor Output Range: 0-7 
|-
| 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''
|}

===MoveToAngle===
{| 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;" | '''MoveToAngle'''
|-
| colspan="2" | Moves a single step towards the new angle, the rate of movement is determined by how often the move to macro is called. Returns 1 if the position has been reached. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Angle
|-
| colspan="2" | Angle in degrees, Range 0 to calibration angle 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===MoveToPosition===
{| 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;" | '''MoveToPosition'''
|-
| colspan="2" | Moves a single step towards the new position, the rate of movement is determined by how often the move to macro is called. Returns 1 if the position has been reached. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Target position to move towards. Range: 0-255 
|-
| 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''
|}

===MoveToPositionInt===
{| 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;" | '''MoveToPositionInt'''
|-
| colspan="2" | Moves a single step towards the new position, the rate of movement is determined by how often the move to macro is called. Returns 1 if the position has been reached. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Position
|-
| colspan="2" | Target position to move towards. Range: 0-65535 
|-
| 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''
|}

===SetAngle===
{| 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;" | '''SetAngle'''
|-
| colspan="2" | Moves the motor straight to the specified angle. Uses the angle property to calculate the correct amount to move. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Angle
|-
| colspan="2" | Angle in degrees, Range 0 to calibration angle 
|-
| 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''
|}

===SetAutoMoveSpeed===
{| 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;" | '''SetAutoMoveSpeed'''
|-
| colspan="2" | Sets the speed of the auto move to position macro. Default speed is shown in the Servo_Period_Multiplier property. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Speed
|-
| colspan="2" | 1=Slowest (Default), 2= Double, 3=Triple, 4=Quadruple 
|-
| 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''
|}

===SetAutoMoveSpeedInt===
{| 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;" | '''SetAutoMoveSpeedInt'''
|-
| colspan="2" | Sets the speed of the auto move to position macro. Default speed is shown in the Servo_Period_Multiplier property. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Speed
|-
| colspan="2" | 1=Slowest (Default), 2= Double, 3=Triple, 4=Quadruple 
|-
| 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''
|}

===SetPosition===
{| 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;" | '''SetPosition'''
|-
| colspan="2" | Moves directly to the specified position with no interpolation.  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Position to jump to. Range: 0-255 
|-
| 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''
|}

===SetPositionInt===
{| 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;" | '''SetPositionInt'''
|-
| colspan="2" | Moves directly to the specified position with no interpolation. Uses a 16-bit position parameter to add extra precision. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Position
|-
| colspan="2" | Position to jump to. Range: 0-65535 
|-
| 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''
|}

===SetTrim===
{| 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;" | '''SetTrim'''
|-
| colspan="2" | Allows the level of trim for each servo channel to be adjusted progmatically. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Trim
|-
| colspan="2" | Legacy: 0=0us, 1=+25us, 2=+50us, 3=+75us, 4=+100us, 5=-25us, 6=-50us, 7=-75us, 8=-100us or Smooth: 0-200 
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channels (1 - 8)
|-
| colspan="2" | Set the number of servo's that you need to control. Value from 1 to 8. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Resources
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Peripherals
|-
| colspan="2" | Lists the internal peripherals of the MCU used by the component. When the servo motor is initialised you will not be able to use the listed peripherals for other functionality. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Pulse Width
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Minimum (us)
|-
| colspan="2" | Shortest pulse width that will be used. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Maximum (us)
|-
| colspan="2" | Longest pulse width used for the PWM signals. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Channel 0
|-
| colspan="2" | Pin on which to output PWM for the servo motor. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Angle
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Angle 0
|-
| colspan="2" | Range of movement in the servo motor to calibrate the Angle component macros. Can be found by measuring the angle between position 0 and position 255. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Trim
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim Mode
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim 0
|-
| colspan="2" | Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar input values will produce the same degree of movement. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="90%" | Servo Object 0
|-
| colspan="2" | Drag a servo motor component onto the System Panel, and then select it here, to create an on screen simulation of the way that your flowchart moves the servo's. Servo motors should be based on the 'Servo Motor Base' component, or use a custom component set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)). 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Servo_Controller.fcfx FC_Comp_Source_Servo_Controller.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Servo_Controller.fcfx FC_Comp_Source_Servo_Controller.fcfx]

Component: Servo Motor Controller (Mechatronics)

2025-01-29T11:06:53Z

MartinW: /* Examples */

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color:gray;" | Version
| 2.1
|-
| width="20%" style="color:gray;" | Category
| Mechatronics
|}

==Servo Motor Controller component==
Can control up to eight standard PWM driven servo's. Supports 8-bit and 16-bit movement resolutions. 'Servo Object' properties allow you to connect the controller to on-screen simulations using the "Servo Motor" component and its derivatives.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Example showing how to control three servos using AutoMoveToPosion, MoveTopposition & SetPosition component macros. 
{{Fcfile|Controlling_Servos_Example.fcfx|Controlling Servos Example.fcfx}} 

Example using BL0162 Servo controller for BL0055 Arduino Shield

Samples the Port D8-D13 (portB) switches and moves the servo motors based on the input states.

D8 increments motor 0, D9 decrements motor on channel 0.

D10 increments motor 1, D11 decrements motor on channel 1.

D12 increments motor 3, D13 decrements motor on channel 2.

Connections:

Servo Board Port D0-D2.

Switch Board Port D8 - D13

LCD A0 to A5 (PortC)

==Macro reference==

===AutoMoveToAngle===
{| 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;" | '''AutoMoveToAngle'''
|-
| colspan="2" | Automatically moves towards the new angle at a fixed rate determined by the AutoMoveSpeed. AutoMove not currently supported by ESP32. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Angle
|-
| colspan="2" | Angle in degrees, Range 0 to calibration angle 
|-
| 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''
|}

===AutoMoveToPosition===
{| 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;" | '''AutoMoveToPosition'''
|-
| colspan="2" | Automatically moves towards the new position at a fixed rate determined by the AutoMoveSpeed. AutoMove not currently supported by ESP32. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Position to automatically move to. Range: 0-255 
|-
| 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''
|}

===AutoMoveToPositionInt===
{| 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;" | '''AutoMoveToPositionInt'''
|-
| colspan="2" | Automatically moves towards the new 16-bit position at a fixed rate determined by the AutoMoveSpeed. AutoMove not currently supported by ESP32. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Position
|-
| colspan="2" | Position to automatically move to. Range: 0-65535 
|-
| 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''
|}

===DisableServo===
{| 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;" | '''DisableServo'''
|-
| colspan="2" | Disables a servo channel effectivly disabling the motor. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| 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''
|}

===EnableServo===
{| 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;" | '''EnableServo'''
|-
| colspan="2" | Enables a servo channel effectivly setting the position of the motor to the value in the local position variable. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| 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''
|}

===Initialise===
{| 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" | Sets up the servo motor interrupts 
|-
|-
| 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''
|}

===IsAutoMoving===
{| 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;" | '''IsAutoMoving'''
|-
| colspan="2" | Is the AutoMoveToPosition movement complete. Returns 1 if the servos are still moving. Returns 0 if all servo movement is complete. 
|-
|-
| 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''
|}

===IsServoAutoMoving===
{| 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;" | '''IsServoAutoMoving'''
|-
| colspan="2" | Is the AutoMoveToPosition movement complete for a specific servo output. Returns 1 if the servo is still moving. Returns 0 if the servo movement is complete. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | Servo Motor Output Range: 0-7 
|-
| 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''
|}

===MoveToAngle===
{| 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;" | '''MoveToAngle'''
|-
| colspan="2" | Moves a single step towards the new angle, the rate of movement is determined by how often the move to macro is called. Returns 1 if the position has been reached. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Angle
|-
| colspan="2" | Angle in degrees, Range 0 to calibration angle 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===MoveToPosition===
{| 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;" | '''MoveToPosition'''
|-
| colspan="2" | Moves a single step towards the new position, the rate of movement is determined by how often the move to macro is called. Returns 1 if the position has been reached. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Target position to move towards. Range: 0-255 
|-
| 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''
|}

===MoveToPositionInt===
{| 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;" | '''MoveToPositionInt'''
|-
| colspan="2" | Moves a single step towards the new position, the rate of movement is determined by how often the move to macro is called. Returns 1 if the position has been reached. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Position
|-
| colspan="2" | Target position to move towards. Range: 0-65535 
|-
| 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''
|}

===SetAngle===
{| 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;" | '''SetAngle'''
|-
| colspan="2" | Moves the motor straight to the specified angle. Uses the angle property to calculate the correct amount to move. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Angle
|-
| colspan="2" | Angle in degrees, Range 0 to calibration angle 
|-
| 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''
|}

===SetAutoMoveSpeed===
{| 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;" | '''SetAutoMoveSpeed'''
|-
| colspan="2" | Sets the speed of the auto move to position macro. Default speed is shown in the Servo_Period_Multiplier property. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Speed
|-
| colspan="2" | 1=Slowest (Default), 2= Double, 3=Triple, 4=Quadruple 
|-
| 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''
|}

===SetAutoMoveSpeedInt===
{| 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;" | '''SetAutoMoveSpeedInt'''
|-
| colspan="2" | Sets the speed of the auto move to position macro. Default speed is shown in the Servo_Period_Multiplier property. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Speed
|-
| colspan="2" | 1=Slowest (Default), 2= Double, 3=Triple, 4=Quadruple 
|-
| 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''
|}

===SetPosition===
{| 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;" | '''SetPosition'''
|-
| colspan="2" | Moves directly to the specified position with no interpolation.  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Position to jump to. Range: 0-255 
|-
| 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''
|}

===SetPositionInt===
{| 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;" | '''SetPositionInt'''
|-
| colspan="2" | Moves directly to the specified position with no interpolation. Uses a 16-bit position parameter to add extra precision. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Position
|-
| colspan="2" | Position to jump to. Range: 0-65535 
|-
| 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''
|}

===SetTrim===
{| 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;" | '''SetTrim'''
|-
| colspan="2" | Allows the level of trim for each servo channel to be adjusted progmatically. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Trim
|-
| colspan="2" | Legacy: 0=0us, 1=+25us, 2=+50us, 3=+75us, 4=+100us, 5=-25us, 6=-50us, 7=-75us, 8=-100us or Smooth: 0-200 
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channels (1 - 8)
|-
| colspan="2" | Set the number of servo's that you need to control. Value from 1 to 8. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Resources
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Peripherals
|-
| colspan="2" | Lists the internal peripherals of the MCU used by the component. When the servo motor is initialised you will not be able to use the listed peripherals for other functionality. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Pulse Width
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Minimum (us)
|-
| colspan="2" | Shortest pulse width that will be used. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Maximum (us)
|-
| colspan="2" | Longest pulse width used for the PWM signals. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Channel 0
|-
| colspan="2" | Pin on which to output PWM for the servo motor. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Angle
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Angle 0
|-
| colspan="2" | Range of movement in the servo motor to calibrate the Angle component macros. Can be found by measuring the angle between position 0 and position 255. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Trim
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim Mode
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim 0
|-
| colspan="2" | Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar input values will produce the same degree of movement. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="90%" | Servo Object 0
|-
| colspan="2" | Drag a servo motor component onto the System Panel, and then select it here, to create an on screen simulation of the way that your flowchart moves the servo's. Servo motors should be based on the 'Servo Motor Base' component, or use a custom component set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)). 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Servo_Controller.fcfx FC_Comp_Source_Servo_Controller.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Servo_Controller.fcfx FC_Comp_Source_Servo_Controller.fcfx]

Component: Servo Motor Controller (Mechatronics)

2025-01-29T11:03:23Z

MartinW: /* Examples */

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color:gray;" | Version
| 2.1
|-
| width="20%" style="color:gray;" | Category
| Mechatronics
|}

==Servo Motor Controller component==
Can control up to eight standard PWM driven servo's. Supports 8-bit and 16-bit movement resolutions. 'Servo Object' properties allow you to connect the controller to on-screen simulations using the "Servo Motor" component and its derivatives.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Example showing how to control three servos using AutoMoveToPosion, MoveTopposition & SetPosition component macros. 
{{Fcfile|Controlling_Servos_Example.fcfx|Controlling Servos Example.fcfx}} 

Example using BL0162 Servo controller for BL0055 Arduino Shield 
Samples the Port D0-D7 switches and moves the servo motors based on the input states. 
D0 increments motor 0, D1 decrements motor 0. 
D2 increments motor 1, D3 decrements motor 1. 
Connections: Combo Board Ports A0-A5 & D0-D7 / Servo Board Port D8-D13. 
{{Fcfile|BL0162_Servo_BL0055.fcfx|BL0162 Servos Example for BL0055}} 

==Macro reference==

===AutoMoveToAngle===
{| 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;" | '''AutoMoveToAngle'''
|-
| colspan="2" | Automatically moves towards the new angle at a fixed rate determined by the AutoMoveSpeed. AutoMove not currently supported by ESP32. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Angle
|-
| colspan="2" | Angle in degrees, Range 0 to calibration angle 
|-
| 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''
|}

===AutoMoveToPosition===
{| 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;" | '''AutoMoveToPosition'''
|-
| colspan="2" | Automatically moves towards the new position at a fixed rate determined by the AutoMoveSpeed. AutoMove not currently supported by ESP32. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Position to automatically move to. Range: 0-255 
|-
| 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''
|}

===AutoMoveToPositionInt===
{| 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;" | '''AutoMoveToPositionInt'''
|-
| colspan="2" | Automatically moves towards the new 16-bit position at a fixed rate determined by the AutoMoveSpeed. AutoMove not currently supported by ESP32. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Position
|-
| colspan="2" | Position to automatically move to. Range: 0-65535 
|-
| 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''
|}

===DisableServo===
{| 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;" | '''DisableServo'''
|-
| colspan="2" | Disables a servo channel effectivly disabling the motor. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| 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''
|}

===EnableServo===
{| 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;" | '''EnableServo'''
|-
| colspan="2" | Enables a servo channel effectivly setting the position of the motor to the value in the local position variable. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| 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''
|}

===Initialise===
{| 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" | Sets up the servo motor interrupts 
|-
|-
| 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''
|}

===IsAutoMoving===
{| 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;" | '''IsAutoMoving'''
|-
| colspan="2" | Is the AutoMoveToPosition movement complete. Returns 1 if the servos are still moving. Returns 0 if all servo movement is complete. 
|-
|-
| 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''
|}

===IsServoAutoMoving===
{| 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;" | '''IsServoAutoMoving'''
|-
| colspan="2" | Is the AutoMoveToPosition movement complete for a specific servo output. Returns 1 if the servo is still moving. Returns 0 if the servo movement is complete. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | Servo Motor Output Range: 0-7 
|-
| 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''
|}

===MoveToAngle===
{| 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;" | '''MoveToAngle'''
|-
| colspan="2" | Moves a single step towards the new angle, the rate of movement is determined by how often the move to macro is called. Returns 1 if the position has been reached. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Angle
|-
| colspan="2" | Angle in degrees, Range 0 to calibration angle 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===MoveToPosition===
{| 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;" | '''MoveToPosition'''
|-
| colspan="2" | Moves a single step towards the new position, the rate of movement is determined by how often the move to macro is called. Returns 1 if the position has been reached. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Target position to move towards. Range: 0-255 
|-
| 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''
|}

===MoveToPositionInt===
{| 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;" | '''MoveToPositionInt'''
|-
| colspan="2" | Moves a single step towards the new position, the rate of movement is determined by how often the move to macro is called. Returns 1 if the position has been reached. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Position
|-
| colspan="2" | Target position to move towards. Range: 0-65535 
|-
| 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''
|}

===SetAngle===
{| 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;" | '''SetAngle'''
|-
| colspan="2" | Moves the motor straight to the specified angle. Uses the angle property to calculate the correct amount to move. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Angle
|-
| colspan="2" | Angle in degrees, Range 0 to calibration angle 
|-
| 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''
|}

===SetAutoMoveSpeed===
{| 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;" | '''SetAutoMoveSpeed'''
|-
| colspan="2" | Sets the speed of the auto move to position macro. Default speed is shown in the Servo_Period_Multiplier property. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Speed
|-
| colspan="2" | 1=Slowest (Default), 2= Double, 3=Triple, 4=Quadruple 
|-
| 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''
|}

===SetAutoMoveSpeedInt===
{| 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;" | '''SetAutoMoveSpeedInt'''
|-
| colspan="2" | Sets the speed of the auto move to position macro. Default speed is shown in the Servo_Period_Multiplier property. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Speed
|-
| colspan="2" | 1=Slowest (Default), 2= Double, 3=Triple, 4=Quadruple 
|-
| 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''
|}

===SetPosition===
{| 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;" | '''SetPosition'''
|-
| colspan="2" | Moves directly to the specified position with no interpolation.  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Position to jump to. Range: 0-255 
|-
| 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''
|}

===SetPositionInt===
{| 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;" | '''SetPositionInt'''
|-
| colspan="2" | Moves directly to the specified position with no interpolation. Uses a 16-bit position parameter to add extra precision. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Position
|-
| colspan="2" | Position to jump to. Range: 0-65535 
|-
| 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''
|}

===SetTrim===
{| 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;" | '''SetTrim'''
|-
| colspan="2" | Allows the level of trim for each servo channel to be adjusted progmatically. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Trim
|-
| colspan="2" | Legacy: 0=0us, 1=+25us, 2=+50us, 3=+75us, 4=+100us, 5=-25us, 6=-50us, 7=-75us, 8=-100us or Smooth: 0-200 
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channels (1 - 8)
|-
| colspan="2" | Set the number of servo's that you need to control. Value from 1 to 8. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Resources
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Peripherals
|-
| colspan="2" | Lists the internal peripherals of the MCU used by the component. When the servo motor is initialised you will not be able to use the listed peripherals for other functionality. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Pulse Width
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Minimum (us)
|-
| colspan="2" | Shortest pulse width that will be used. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Maximum (us)
|-
| colspan="2" | Longest pulse width used for the PWM signals. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Channel 0
|-
| colspan="2" | Pin on which to output PWM for the servo motor. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Angle
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Angle 0
|-
| colspan="2" | Range of movement in the servo motor to calibrate the Angle component macros. Can be found by measuring the angle between position 0 and position 255. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Trim
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim Mode
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim 0
|-
| colspan="2" | Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar input values will produce the same degree of movement. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="90%" | Servo Object 0
|-
| colspan="2" | Drag a servo motor component onto the System Panel, and then select it here, to create an on screen simulation of the way that your flowchart moves the servo's. Servo motors should be based on the 'Servo Motor Base' component, or use a custom component set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)). 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Servo_Controller.fcfx FC_Comp_Source_Servo_Controller.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Servo_Controller.fcfx FC_Comp_Source_Servo_Controller.fcfx]

Component: Filter (DSP Operators)

2025-01-29T08:31:01Z

MartinW: /* Detailed description */

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color:gray;" | Version
| 1.3
|-
| width="20%" style="color:gray;" | Category
| DSP Operators
|}

==Filter component==
Filter component to allow basic filtering to be performed Filters include: LowPass, HighPass, BandPass, BandStop, FIR, IIR

==Detailed description==

Using the data recorder you can see the analogue wave and the filter response changing as the frequency changes.

Basically allows you to play with the filter coefficients and modify the frequency to see how the filter performs.

The PWM is just providing an analogue output but would need a R/C filter to make it truly analogue.

==Examples==

=== Low Pass Filter ===

Example of the filter component set up to create a low pass filter with the input frequency controlled using the potentiometer on the panel.
{{Fcfile|LowPassFilter.fcfx|LowPassFilter}}
Low pass filter running at a low frequency - note that the amplitude of the filtered data closely matches that of the original waveform data.

[[File:LPFilter.jpg]]

Low pass filter running at a high frequency - note that the amplitude of the filtered waveform is now greatly attenuated.

[[File:LPFilter2.jpg]]

=== High Pass Filter ===

Example of the filter component set up to create a high pass filter with the input frequency controlled using the potentiometer on the panel.
{{Fcfile|HighPassFilter.fcfx|HighPassFilter}}
High pass filter running at a low frequency - note that the amplitude of the filtered waveform is greatly attenuated.

[[File:HPFilter.jpg]]

High pass filter running at a high frequency - note that the amplitude of the filtered data closely matches that of the original waveform data.

[[File:HPFilter2.jpg]]

=== Band Pass Filter ===

Example of the filter component set up to create a band pass filter with the input frequency controlled using the potentiometer on the panel.
{{Fcfile|BandPassFilter.fcfx|BandPassFilter}}
Band pass filter running at a low frequency - note that the amplitude of the filtered waveform is greatly attenuated.

[[File:BPFilter.jpg]]

Band pass filter running at a mid frequency - note that the amplitude of the filtered data closely matches that of the original waveform data.

[[File:BPFilter2.jpg]]

Band pass filter running at a high frequency - note that the amplitude of the filtered waveform is greatly attenuated.

[[File:BPFilter3.jpg]]

==Macro reference==

===Filter===
{| 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;" | '''Filter'''
|-
| colspan="2" | Performs the filter operation to the current value in the 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''
|}

===FilterArray===
{| 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;" | '''FilterArray'''
|-
| colspan="2" | Performs the filter operation to the contents of the entire buffer in one go. 
|-
|-
| 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''
|}

===SetFilterCoefficient===
{| 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;" | '''SetFilterCoefficient'''
|-
| colspan="2" | Allows the coefficients of low pass, High pass, band pass and band stop filters to be edited. Must be enabled using the Variable Coefficients property. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | Range: 0-1 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Value
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Connect To
|-
| colspan="2" | DSP component with output buffer to collect our data from. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Buffer Size
|-
| colspan="2" | Number of individual elements the buffer can store, default 1. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Buffer Type
|-
| colspan="2" | Sets the buffer data type. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Direction
|-
| colspan="2" | Sets the data direction flow of the component 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Filter Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Type
|-
| colspan="2" | Specifies the filter type created by the component: Low Pass - Filters out frequencies above the cutoff frequency High Pass - Filters out frequencies below the cutoff frequency Band Pass - Combination of High Pass and Low Pass Filters Band Stop - Inverse of Band Pass FIR - Finite impulse response using standard filter coefficients IIR - Infinite impulse response using standard filter coefficients 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Variable Coefficients
|-
| colspan="2" | Decides if the coefficient values can be altered during runtime using the SetCoefficient component macro. Only available for the simple filter types, low pass, high pass, band pass and band stop. 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Coefficient 0
|-
| colspan="2" | Cutoff frequency = Nyquist frequency / Coefficient Cutoff frequency is described as when the unwanted frequencies in the signal have been attenuated by at least 50%  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Calculations
|-
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Sample Rate
|-
| colspan="2" | Sample frequency used to work out some basic useful calculations 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Nyquist Frequency
|-
| colspan="2" | Maximum theoretical frequency that can be obtained by the sample frequency 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Cutt Off Frequency 0
|-
| colspan="2" | First cutoff frequency 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_DSP_Filter.fcfx FC_Comp_Source_DSP_Filter.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_Filter.fcfx FC_Comp_Source_DSP_Filter.fcfx]

File:LowPassFilter.fcfx

2025-01-29T08:28:00Z

MartinW: MartinW uploaded a new version of File:LowPassFilter.fcfx

File:HighPassFilter.fcfx

2025-01-29T08:27:44Z

MartinW: MartinW uploaded a new version of File:HighPassFilter.fcfx

File:BandPassFilter.fcfx

2025-01-29T08:27:28Z

MartinW: MartinW uploaded a new version of File:BandPassFilter.fcfx

File:BandPassFilter.fcfx

2025-01-29T08:06:24Z

MartinW: MartinW uploaded a new version of File:BandPassFilter.fcfx

Component: Servo Motor Controller (Mechatronics)

2025-01-28T16:49:03Z

MartinW: /* Examples */

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color:gray;" | Version
| 2.1
|-
| width="20%" style="color:gray;" | Category
| Mechatronics
|}

==Servo Motor Controller component==
Can control up to eight standard PWM driven servo's. Supports 8-bit and 16-bit movement resolutions. 'Servo Object' properties allow you to connect the controller to on-screen simulations using the "Servo Motor" component and its derivatives.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Example showing how to control three servos using AutoMoveToPosion, MoveTopposition & SetPosition component macros. 
{{Fcfile|Controlling_Servos_Example.fcfx|Controlling Servos Example.fcfx}} 

Example using BL0162 Servo controller for BL0055 Arduino Shield 
Samples the Port D0-D7 switches and moves the servo motors based on the input states. 
D0 increments motor 0, D1 decrements motor 0. 
D2 increments motor 1, D3 decrements motor 1. 
Connections: Combo Board Ports A0-A5&D0-D7 / Servo Board Port D8-D13. 
{{Fcfile|BL0162_Servo_BL0055.fcfx|BL0162 Servos Example for BL0055}} 

==Macro reference==

===AutoMoveToAngle===
{| 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;" | '''AutoMoveToAngle'''
|-
| colspan="2" | Automatically moves towards the new angle at a fixed rate determined by the AutoMoveSpeed. AutoMove not currently supported by ESP32. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Angle
|-
| colspan="2" | Angle in degrees, Range 0 to calibration angle 
|-
| 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''
|}

===AutoMoveToPosition===
{| 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;" | '''AutoMoveToPosition'''
|-
| colspan="2" | Automatically moves towards the new position at a fixed rate determined by the AutoMoveSpeed. AutoMove not currently supported by ESP32. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Position to automatically move to. Range: 0-255 
|-
| 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''
|}

===AutoMoveToPositionInt===
{| 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;" | '''AutoMoveToPositionInt'''
|-
| colspan="2" | Automatically moves towards the new 16-bit position at a fixed rate determined by the AutoMoveSpeed. AutoMove not currently supported by ESP32. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Position
|-
| colspan="2" | Position to automatically move to. Range: 0-65535 
|-
| 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''
|}

===DisableServo===
{| 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;" | '''DisableServo'''
|-
| colspan="2" | Disables a servo channel effectivly disabling the motor. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| 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''
|}

===EnableServo===
{| 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;" | '''EnableServo'''
|-
| colspan="2" | Enables a servo channel effectivly setting the position of the motor to the value in the local position variable. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| 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''
|}

===Initialise===
{| 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" | Sets up the servo motor interrupts 
|-
|-
| 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''
|}

===IsAutoMoving===
{| 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;" | '''IsAutoMoving'''
|-
| colspan="2" | Is the AutoMoveToPosition movement complete. Returns 1 if the servos are still moving. Returns 0 if all servo movement is complete. 
|-
|-
| 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''
|}

===IsServoAutoMoving===
{| 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;" | '''IsServoAutoMoving'''
|-
| colspan="2" | Is the AutoMoveToPosition movement complete for a specific servo output. Returns 1 if the servo is still moving. Returns 0 if the servo movement is complete. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | Servo Motor Output Range: 0-7 
|-
| 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''
|}

===MoveToAngle===
{| 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;" | '''MoveToAngle'''
|-
| colspan="2" | Moves a single step towards the new angle, the rate of movement is determined by how often the move to macro is called. Returns 1 if the position has been reached. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Angle
|-
| colspan="2" | Angle in degrees, Range 0 to calibration angle 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===MoveToPosition===
{| 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;" | '''MoveToPosition'''
|-
| colspan="2" | Moves a single step towards the new position, the rate of movement is determined by how often the move to macro is called. Returns 1 if the position has been reached. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Target position to move towards. Range: 0-255 
|-
| 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''
|}

===MoveToPositionInt===
{| 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;" | '''MoveToPositionInt'''
|-
| colspan="2" | Moves a single step towards the new position, the rate of movement is determined by how often the move to macro is called. Returns 1 if the position has been reached. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Position
|-
| colspan="2" | Target position to move towards. Range: 0-65535 
|-
| 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''
|}

===SetAngle===
{| 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;" | '''SetAngle'''
|-
| colspan="2" | Moves the motor straight to the specified angle. Uses the angle property to calculate the correct amount to move. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Angle
|-
| colspan="2" | Angle in degrees, Range 0 to calibration angle 
|-
| 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''
|}

===SetAutoMoveSpeed===
{| 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;" | '''SetAutoMoveSpeed'''
|-
| colspan="2" | Sets the speed of the auto move to position macro. Default speed is shown in the Servo_Period_Multiplier property. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Speed
|-
| colspan="2" | 1=Slowest (Default), 2= Double, 3=Triple, 4=Quadruple 
|-
| 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''
|}

===SetAutoMoveSpeedInt===
{| 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;" | '''SetAutoMoveSpeedInt'''
|-
| colspan="2" | Sets the speed of the auto move to position macro. Default speed is shown in the Servo_Period_Multiplier property. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Speed
|-
| colspan="2" | 1=Slowest (Default), 2= Double, 3=Triple, 4=Quadruple 
|-
| 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''
|}

===SetPosition===
{| 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;" | '''SetPosition'''
|-
| colspan="2" | Moves directly to the specified position with no interpolation.  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Position to jump to. Range: 0-255 
|-
| 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''
|}

===SetPositionInt===
{| 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;" | '''SetPositionInt'''
|-
| colspan="2" | Moves directly to the specified position with no interpolation. Uses a 16-bit position parameter to add extra precision. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to assign the new position. Range: 0-7 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Position
|-
| colspan="2" | Position to jump to. Range: 0-65535 
|-
| 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''
|}

===SetTrim===
{| 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;" | '''SetTrim'''
|-
| colspan="2" | Allows the level of trim for each servo channel to be adjusted progmatically. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | The channel to set the position for. First channel is zero. 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Trim
|-
| colspan="2" | Legacy: 0=0us, 1=+25us, 2=+50us, 3=+75us, 4=+100us, 5=-25us, 6=-50us, 7=-75us, 8=-100us or Smooth: 0-200 
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channels (1 - 8)
|-
| colspan="2" | Set the number of servo's that you need to control. Value from 1 to 8. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Resources
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Peripherals
|-
| colspan="2" | Lists the internal peripherals of the MCU used by the component. When the servo motor is initialised you will not be able to use the listed peripherals for other functionality. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Pulse Width
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Minimum (us)
|-
| colspan="2" | Shortest pulse width that will be used. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Maximum (us)
|-
| colspan="2" | Longest pulse width used for the PWM signals. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Channel 0
|-
| colspan="2" | Pin on which to output PWM for the servo motor. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Angle
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Angle 0
|-
| colspan="2" | Range of movement in the servo motor to calibrate the Angle component macros. Can be found by measuring the angle between position 0 and position 255. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Trim
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim Mode
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Trim 0
|-
| colspan="2" | Trim the pulse width for this channel. Use this to trim the positioning of two servos so that similar input values will produce the same degree of movement. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="90%" | Servo Object 0
|-
| colspan="2" | Drag a servo motor component onto the System Panel, and then select it here, to create an on screen simulation of the way that your flowchart moves the servo's. Servo motors should be based on the 'Servo Motor Base' component, or use a custom component set to responf to 'User.Notify' events (ID = n/a, Data = Position (0-127)). 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Servo_Controller.fcfx FC_Comp_Source_Servo_Controller.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Servo_Controller.fcfx FC_Comp_Source_Servo_Controller.fcfx]

File:BL0162 Servo BL0055.fcfx

2025-01-28T16:46:45Z

MartinW:

File:Timed interval example.fcfx

2025-01-24T12:21:24Z

MartinW: MartinW uploaded a new version of File:Timed interval example.fcfx

Component: Timed Interval (Timing)

2025-01-24T12:20:16Z

MartinW: /* Examples */

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.1
|-
| width="20%" style="color:gray;" | Category
| Timing
|}

==Timed Interval component==
Allows you to setup a specific timed interval via the use of a hardware timer peripheral. Useful for regular time accurate periodic polling and sampling.

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_TimerIntervalComponent.fcfx FC_Comp_Source_TimerIntervalComponent.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_TimerIntervalComponent.fcfx FC_Comp_Source_TimerIntervalComponent.fcfx]

==Detailed description==

The Timed Interval component takes the headache out of setting up timer interrupts to interrupt an amount of fixed microseconds, milliseconds, seconds, minutes, hours or days.

[[File:Timed Interval1.png]]

After selecting the Time Unit, and entering Time Period, the estimated best will show the exact time the callback macro is accessed.

[[File:Timed Interval2.png]]

You can even send the required delay within simulation (Timer Delay (ms).

Unfortunately there is a small simulation only bug that is preventing the global variable within callback macro from updating, it all works on your embedded hardware.

The workaround (included within the example) for your own project is as follows.

First set up your timed interval component within properties along with the callback macro

Within the timed interval example, select the TimedInterval callback macro ,then select the Built-in Function::Debug.PrintLn(" ")

[[File:Timed Interval3.png]]

Right-click then select copy.

Paste the Built-in Function within the callback macro of your new project.

Now the interval timer component will simulate correctly.

==Examples==

Example program showing how to use the Timed component to trigger a callback macro at precise intervals e.g. 1 second.

{{Fcfile|Timed_interval_example.fcfx|One second timed interval component example }}

==Macro reference==

===StartTimerInterval===
{| 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;" | '''StartTimerInterval'''
|-
| colspan="2" | Starts the timer interval. 
|-
|-
| 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''
|}

===StopTimerInterval===
{| 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;" | '''StopTimerInterval'''
|-
| colspan="2" | Stops the timer interval. 
|-
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Interval Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Time Unit
|-
| colspan="2" | Unit of time used for the time period. For example you might want every 4 milliseconds or every 3 hours. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Time Period
|-
| colspan="2" | Value of time used for the time period. For example you might want every 4 milliseconds or every 3 hours. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Estimated Best Period
|-
| colspan="2" | The closest we can get to the required time period based on prescaler and postscaler settings. Smaller scalers provide finer resolution but impose limits on the maximum delay. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Max Time Measurement
|-
| colspan="2" | The maximum time we can do based on the current timer and scaler settings. 
|-
| width="10%" align="center" | [[File:Fc9-type-22-icon.png]]
| width="90%" | Callback Macro
|-
| colspan="2" | User defined macro automatically called on a periodic basis. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Timer Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Timer
|-
| colspan="2" | Timer Peripheral to use to monitor the passage of time. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Bit Depth
|-
| colspan="2" | Number of bits in the timer peripheral. 8-bit timers can count from 0-255 before overflowing. 16-bit timers can count from 0 to 65535 before overflowing. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Prescaler
|-
| colspan="2" | Scaler applied to the timer, Small scalers allow for finer resolution but will limit the max time and also put more load on the microcontroller. Recommended to use as large a setting as possible which still provides enough accuracy.  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | PostScaler
|-
| colspan="2" | Scaler applied to the timer, Small scalers allow for finer resolution but will limit the max time and also put more load on the microcontroller. Recommended to use as large a setting as possible which still provides enough accuracy.  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Timer Delay (ms)
|-
| colspan="2" | Number of milliseconds between timer events which increment the simulated timer counter variable. 10ms will yield the highest resolution. Values less than this will likely just increase the error and making the timer run slow. Higher delays will yield greater accuracy. 
|}

Component: Timed Interval (Timing)

2025-01-24T12:19:46Z

MartinW:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.1
|-
| width="20%" style="color:gray;" | Category
| Timing
|}

==Timed Interval component==
Allows you to setup a specific timed interval via the use of a hardware timer peripheral. Useful for regular time accurate periodic polling and sampling.

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_TimerIntervalComponent.fcfx FC_Comp_Source_TimerIntervalComponent.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_TimerIntervalComponent.fcfx FC_Comp_Source_TimerIntervalComponent.fcfx]

==Detailed description==

The Timed Interval component takes the headache out of setting up timer interrupts to interrupt an amount of fixed microseconds, milliseconds, seconds, minutes, hours or days.

[[File:Timed Interval1.png]]

After selecting the Time Unit, and entering Time Period, the estimated best will show the exact time the callback macro is accessed.

[[File:Timed Interval2.png]]

You can even send the required delay within simulation (Timer Delay (ms).

Unfortunately there is a small simulation only bug that is preventing the global variable within callback macro from updating, it all works on your embedded hardware.

The workaround (included within the example) for your own project is as follows.

First set up your timed interval component within properties along with the callback macro

Within the timed interval example, select the TimedInterval callback macro ,then select the Built-in Function::Debug.PrintLn(" ")

[[File:Timed Interval3.png]]

Right-click then select copy.

Paste the Built-in Function within the callback macro of your new project.

Now the interval timer component will simulate correctly.

==Examples==

Example program showing how to use the Timed component to trigger a callback macro at precise intervals e.g. 1 second.

{{Fcfile|Timed_interval_example.fcfx|Once second timed interval component example }}

==Macro reference==

===StartTimerInterval===
{| 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;" | '''StartTimerInterval'''
|-
| colspan="2" | Starts the timer interval. 
|-
|-
| 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''
|}

===StopTimerInterval===
{| 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;" | '''StopTimerInterval'''
|-
| colspan="2" | Stops the timer interval. 
|-
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Interval Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Time Unit
|-
| colspan="2" | Unit of time used for the time period. For example you might want every 4 milliseconds or every 3 hours. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Time Period
|-
| colspan="2" | Value of time used for the time period. For example you might want every 4 milliseconds or every 3 hours. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Estimated Best Period
|-
| colspan="2" | The closest we can get to the required time period based on prescaler and postscaler settings. Smaller scalers provide finer resolution but impose limits on the maximum delay. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Max Time Measurement
|-
| colspan="2" | The maximum time we can do based on the current timer and scaler settings. 
|-
| width="10%" align="center" | [[File:Fc9-type-22-icon.png]]
| width="90%" | Callback Macro
|-
| colspan="2" | User defined macro automatically called on a periodic basis. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Timer Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Timer
|-
| colspan="2" | Timer Peripheral to use to monitor the passage of time. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Bit Depth
|-
| colspan="2" | Number of bits in the timer peripheral. 8-bit timers can count from 0-255 before overflowing. 16-bit timers can count from 0 to 65535 before overflowing. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Prescaler
|-
| colspan="2" | Scaler applied to the timer, Small scalers allow for finer resolution but will limit the max time and also put more load on the microcontroller. Recommended to use as large a setting as possible which still provides enough accuracy.  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | PostScaler
|-
| colspan="2" | Scaler applied to the timer, Small scalers allow for finer resolution but will limit the max time and also put more load on the microcontroller. Recommended to use as large a setting as possible which still provides enough accuracy.  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Timer Delay (ms)
|-
| colspan="2" | Number of milliseconds between timer events which increment the simulated timer counter variable. 10ms will yield the highest resolution. Values less than this will likely just increase the error and making the timer run slow. Higher delays will yield greater accuracy. 
|}

Component: Timed Interval (Timing)

2025-01-24T12:18:15Z

MartinW: /* Detailed description */

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.1
|-
| width="20%" style="color:gray;" | Category
| Timing
|}

==Timed Interval component==
Allows you to setup a specific timed interval via the use of a hardware timer peripheral. Useful for regular time accurate periodic polling and sampling.

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_TimerIntervalComponent.fcfx FC_Comp_Source_TimerIntervalComponent.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_TimerIntervalComponent.fcfx FC_Comp_Source_TimerIntervalComponent.fcfx]

==Detailed description==

The Timed Interval component takes the headache out of setting up timer interrupts to interrupt an amount of fixed microseconds, milliseconds, seconds, minutes, hours or days.

[[File:Timed Interval1.png]]

After selecting the Time Unit, and entering Time Period, the estimated best will show the exact time the callback macro is accessed.

[[File:Timed Interval2.png]]

You can even send the required delay within simulation (Timer Delay (ms).

Unfortunately there is a small simulation only bug that is preventing the global variable within callback macro from updating, it all works on your embedded hardware.

The workaround (included within the example) for your own project is as follows.

First set up your timed interval component within properties along with the callback macro

Within the timed interval example, select the TimedInterval callback macro ,then select the Built-in Function::Debug.PrintLn(" ")

[[File:Timed Interval3.png]]

Right-click then select copy.

Paste the Built-in Function within the callback macro of your new project.

Now the interval timer component will simulate correctly.

==Examples==

Example program showing how to use the Timed component to trigger a callback macro at precise intervals e.g. 1 second.

{{Fcfile|Timed_interval_example.fcfx|Once second timed interval component example }}

==Macro reference==

===StartTimerInterval===
{| 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;" | '''StartTimerInterval'''
|-
| colspan="2" | Starts the timer interval. 
|-
|-
| 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''
|}

===StopTimerInterval===
{| 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;" | '''StopTimerInterval'''
|-
| colspan="2" | Stops the timer interval. 
|-
|-
| 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''
|}

==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'''
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Interval Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Time Unit
|-
| colspan="2" | Unit of time used for the time period. For example you might want every 4 milliseconds or every 3 hours. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Time Period
|-
| colspan="2" | Value of time used for the time period. For example you might want every 4 milliseconds or every 3 hours. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Estimated Best Period
|-
| colspan="2" | The closest we can get to the required time period based on prescaler and postscaler settings. Smaller scalers provide finer resolution but impose limits on the maximum delay. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Max Time Measurement
|-
| colspan="2" | The maximum time we can do based on the current timer and scaler settings. 
|-
| width="10%" align="center" | [[File:Fc9-type-22-icon.png]]
| width="90%" | Callback Macro
|-
| colspan="2" | User defined macro automatically called on a periodic basis. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Timer Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Timer
|-
| colspan="2" | Timer Peripheral to use to monitor the passage of time. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Bit Depth
|-
| colspan="2" | Number of bits in the timer peripheral. 8-bit timers can count from 0-255 before overflowing. 16-bit timers can count from 0 to 65535 before overflowing. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Prescaler
|-
| colspan="2" | Scaler applied to the timer, Small scalers allow for finer resolution but will limit the max time and also put more load on the microcontroller. Recommended to use as large a setting as possible which still provides enough accuracy.  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | PostScaler
|-
| colspan="2" | Scaler applied to the timer, Small scalers allow for finer resolution but will limit the max time and also put more load on the microcontroller. Recommended to use as large a setting as possible which still provides enough accuracy.  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Timer Delay (ms)
|-
| colspan="2" | Number of milliseconds between timer events which increment the simulated timer counter variable. 10ms will yield the highest resolution. Values less than this will likely just increase the error and making the timer run slow. Higher delays will yield greater accuracy. 
|}

File:Timed Interval3.png

2025-01-24T12:12:49Z

MartinW: