Flowcode Help - User contributions [en]

Software Assurance

2026-05-07T14:24:52Z

MartinW: Replaced content with "''TBA''"

''TBA''

Version Updates

2026-05-06T14:30:19Z

MartinW:

==Flowcode 11==

=====Licensing changes=====

Licence model has been changed to [[Software_Assurance|Software Assurance]]

=====Graphical Display Design Tools=====
New for version 11 is a full library of components for driving touch screen graphical displays: display drivers for the most popular touch screens, graphics widgets, graph widgets, touch screen components, WYSIWYG graphical display designer and menu control subroutines. These allow you to design touch screen graphical displays based on any 8, 16, or 32 bit microcontroller.

=====Web Mirror=====
The Web Mirror features allows you to mirror the functionality of you touch screen system on any browser anywhere in the world. This is only available on the E-Blocks 3 hardware for now. The great benefit is that you can use your mobile phone to control your electronic projects.

No coding is needed. It's just a couple of settings on the Graphical display component. Flowcode takes care of all the details.

=====New Project Wizard and Auto-detect=====
Getting started is so hard. So many options, choices, settings in our beautiful complex world. The [[Creating_Project|new project wizard]] provides a menu system that makes this easier for all users showing options and guiding users through choices.

If you have E-Blocks 3 hardware then it is even easier: Flowcode sees what upstream and downstream boards you have connected and sets up the program for you.

=====Serial Debugging on Hardware=====
Serial debugging allows you to pause your program as it runs in hardware and see the status of variables in your project. You can set breakpoints in your code and change the values of variables while program execution is paused.

Serial debugging was only available on Matrix hardware in V10. In V11, Serial debugging now works on third party hardware that has a serial COM port available via USB. This includes many Arduino, ESP32 and PIC boards.

=====E-Blocks 3 and Auto-id=====
The goal is simple: create the best environment for developing electronic projects. Its hard to separate the hardware from the software sometimes. The combination of Flowcode and E-Blocks 3 provides an amazing development platform for both educators and industrial engineers.

Each E-blocks downstream board has a small microcontroller on it. These communicate to the upstream board to inform Flowcode what hardware is connected. This allows Flowcode to put the appropriate components on the 2D panel with all the right settings, making project setup much easier!

=====New Microcontrollers=====
The world does not stand still. Manufacturers are constantly adding new microcontrollers with more features, smaller silicon areas, faster clock rates and so on.

We constantly add new microcontrollers to the chip lists. A lot of work has been done recently to add the Microchip PIC8 Q range.

Flowcode is now compatible with 1,789 microcontrollers.

=====2D Panel Updates=====
The 2D panel has been upgraded so that it is now possible to zoom in and out on all component views.

A new rich text components adds formatted text to components and panels, and all panel objects now can be anchored to the panel sides or even set to display completely in the panel (e.g. for showing charts in a separate window).

New features include:

*[[2d_Panels#Other_features_of_2D_panels|2D Panel zoom]]
*[[Component:_ID_component:GdiRichText|Richtext primitive]]
*Component anchoring
*Fill panel window

=====New Coding Features=====
A variety of new features have been added to make coding in Flowcode v11 even simpler than before.

Direct string comparisons can now be made in decision icons, the loop command has a "loop forever" option and several new operators (e.g. increment/decrement and assignment) have been added to make Flowcode calculations more representative of C code.

*Direct string comparisons
*[[Loop_Icon_Properties|Loop forever]]
*Increment and decrement operators
*Assignment operators (e.g. myval += 10)

=====Other improvements=====
*Dynamic menus and web-based windows added
*Anchors and 'fit component' options for panel objects
*Group icon contents can be viewed without needing to ungroup
*User is now warned when openign a project that is already open
*Flowcode now has separate icons for Embedded, Web Developer and PC Developer project files
*Macros can now be shown as a different graphical/text view direct from the macro tab
*Library version log file shows which versions of library files are used in compiled project
*Colour options available on macro descriptions
*Position anchors for components
*New richtext primitive for component panels
*View group icon contents
*Access variables in simulated component code
*Direct access to variable manager
*Warn when opening a project that is already open
*New file extensions for Flowcode project types
*Change macro view types on the fly
*Advanced component profiling and debugging
*Clear All Breakpoints no longer ignores the loop command
*Digital i/o panel now updated correctly when PORT property change iterates through subcomponents
*Digital i/o panel now updated correctly when pane is first opened
*Caption bar now shows project type
*Dropping icons onto overlapped macro views correctly drops onto topmost window
*Non-flowchart macros can now be exported as image
*New state diagram macro menu item added
*Web Developer projects do not show state diagram icons
*List Occurrences check is now case-insensitive
*Improvements to dark colour scheme
*Added ability to show and hide component macros via API command
*Fixed read-only nature of component properties
*Fixed the sim control speed slider
*Fixed 'corrupt macro' error message text that got lost during an exception
*Mouse events now triggered at the dead area at the top of Project Explorer
*Component major/minor versions now 0-999 (was 0-100)
*Hidden option to show '!=' as '<>'
*Fixed MatrixLight/MatrixDark inbuilt colour schemes for charts
*2d panels now hide toolbar when simulating
*FCDChange event is fired when chip stays the same but clock speed changes
*Fixed longstanding bug with broadcast message parameter corruption
*Moved components on 2d panel now redraw their vacated areas too
*Subcomponents of a group now get unique names when copying/pasting
*Added GetActual2dPosition/GetActual2dPosition API commands
*Context menu for component panels stops renames, deletion, etc, when simulating
*Wndhost comps (button, combobox and textbox) now update when resized on the panel
*Text primitives now redraw their actual text area too
*Improved visual styling for dark mode, and fixed styling issues with combo boxes, etc.
*Removed redundant colour and code-customisation information from saved project files
*Fixed SIGNED/UNSIGNED casting
*Fixed simulation of Decision tail icon
*Search now finds ports/pins
*Added logical AND, OR and NOT (&&, ||, !) to maths functions list
*Improved tooltip help for maths and string functions
*Function lists now categorised
*Call stack view width can be altered using mouse wheel in Simulation Debugger window
*Component panel zoom level now shown on status bar
*Improved component toolbar display on non-100% DPI systems
*New variables are given default initialisers
*Macro parameters can have default values for parameters
*Macro tabs have 'close' and 'close other' menu item
*Added CallMacro in-built functions
*Added in-built functions to manipulate text-based property lists
*Fixed flicker in IOC chip view in interrupt prpoperties dialog
*Components and macros now available to add to expressions in icon dialogs
*List properties can now be auto-sorted
*Flowcode now uses a 'ping' to ensure web-based dialogs retain current information

[https://flowcode.co.uk/forums/viewtopic.php?p=23397#p23397 Update v11.0.1.14]

==Flowcode 10==

=====Licensing changes=====

*Flowcode V10 is now free for makers and hobbyists with full functionality for a limited range of devices which include; '''[[Supported_Chips#Free_Targets|Arduino Uno & Nano, RPI etc. ]]'''

=====Components=====
*Can now view component code

*'''[[Components|Components]]''' are now free and open-sourced so you can use existing components and tailor them to your own requirements.

*Dedicated 2D primitive components

=====2D panels=====
New [[2d_Panels|2D panels]] provide clearer graphics, customisation of all panels with your own drawings, notes and much more printer friendly options available.

Add an unlimited number of 2D panels into your project.

Unlocks a host of new 2D panel only panel options such as graphing tools.

====Simulation====

*Improved ''[[Variable_Types|variable values]]'' display on simulation – view and edit ''[[Variable_Types|variable values]]'' during simulation and '''[[Ghost_Technology|ICD]]

*Interrupt on Change diagram visual improvements

*View and step through the simulation of component code (Pro Licence only)

*Ghost support for EB0058 ESP board

*Icon lists now show disabled icons in a muted colour

*Show variables on ''[[Oscilloscope|oscilloscope]]'' and ''[[Using_the_Data_Recorder|data recorder]]''

*The text colour of flowchart icons can be altered

=====Application=====
*Create separate .c and .h files

*Show help/wiki in separate browser

=====UI Trees=====

*New ''UI Trees'' tab within ''[[Global_Settings|Global Settings]]'' for customising ''[[Project Explorer|Project Explorer]]'' and Icon Lists

=====User Tools=====

*New ''User Tools'' tab within ''[[Global_Settings|Global Settings]]'' for setting up User Tools to be used within the ''Build ribbon''

=====I/O ports=====

*Connected components lists on analogue/digital windows

*When using Calculation icons (etc), pins can be dragged to the expression
=====Variables=====
*Combines global and local ''[[Creating_Variables|variables]]'' (which are also available separately)

*Show''[[Using_the_Project_Explorer| values]]'' during ''[[Starting_Flowchart_Simulation|simulation]]''

*Float ''[[Variable_Types|variables]]'' are now shown to a user-defined precision (defaults to “%g”)

=====Built-in Functions=====

*Single-dimension arrays show individual elements in Watch and Project Explorer lists

*There are some new built-in functions available

''[[API_Reference|New API calls]]'' : GetPanel and GetPanelName, SetSimSpeed and GetBackgroundColour

[[String_Manipulation_Functions|New String Functions routines]]'' : Contains$, SplitString$, ExplodeToIntArray$, ImplodeFromIntArray$, ExplodeToFloatArray$, ImplodeFromFloatArray$, Int2FormattedString$, Float2FormattedString$, InsertString$, RemoveFromString$, SearchAndReplace$

[[Mathematical_Functions|New Mathematical Functions]]'' : cosh, sinh, tanh, arraydims, arraysize, GetOriginalScale

=====Events=====
*There are some new events available

====Miscellaneous====

*TODO list - auto generated icon list based on icons containing TODO in the comment. For example. TODO this icon needs work or TODO this will need changing.

*''[[Auto_Documentation|Project Report improvements]]''

==Flowcode 9==

Here are some of the new features added in Flowcode 9. Please click on a feature to learn more about it.

===App Developer===
* '''[[App_Developer|Flowcode App Developer]]'''

A completely new piece of software - based on Flowcode - that allows you to create fantastic distributed control and data gathering systems with intuitive Human Machine interfaces for Windows PCs and tablets.

This comes with a suite of Application Programming Interfaces for low cost hardware including Arduino, Raspberry Pi, ESP32 and PIC which allows you to create powerful smart embedded + PC devices with Windows HMI displays that can be freely distributed.

===State Diagrams===
* '''[[State_diagrams|State diagrams]]'''

New graphical programming icons allows you to make use of this powerful programming paradigm.

Create new state machine projects or enhance your existing ones and mix and match with flow chart icons, C code, blocks etc.

===New ESP32 Toolchain===
* '''[[Compiler_Toolchains#ESP32_Toolchain|ESP32 toolchain]]'''

Flowcode now supports a range of new devices for this powerful 80MHz board level device with integrated TCP/IP stack, and Wi-fi.

This allows you to create great web-interconnected projects with this incredibly low cost hardware platform from Espressif semiconductors in China.

===Data flow programming===
* '''[[DSP|Data flow programming]]'''
Now you can use data flow programming icons in your projects. This is a really great programming technique for projects including communications systems and Digital Signal Processing.

===New Components===
* '''[[Components|New components]]'''
New components include new DSP components, new Mechatronics parts, Easy Internet Of Things components, more sensors, and new test injectors.
We have updated our forums and now have sections to post your projects for both App Developer and Embedded. There are already a few posted. Why not come and replicate these projects to learn some interesting new things?

===New Website===
* '''[https://flowcode.co.uk/ New website]'''

Flowcode now has its own web site.
Here, you can find more information on Flowcode Embedded, Flowcode App Developer, a new Wiki, and a host of new courses on developing advanced communications systems from Mobile phone technology to CAN bus technology in automotive.

==Flowcode 8==

===Features Added===

Here are some of the new features added in Flowcode 8. Please click on a feature to learn more about it.

* '''[[Code_Folding|Code Folding]]'''

* '''[[Icon_Grouping|Icon Grouping]]'''

* '''[[C_Code_Simulation|Simulating Custom C Code]]'''

* '''[[C_Code_to_Flowchart_Conversion|Custom C Code to Flowchart Conversion]]'''

* '''[[Code_Paradigms|Coding Paradigms - Flowchart, Blocks, Pseudocode, C Code]]'''

* '''[[Tab Tear Off - Multi Monitor Support]]'''

* '''[[Dynamic_Updates|Dynamic Updates]]'''

* '''[[Raspberry_Pi_Chip_Pack|Raspberry Pi Chip Pack]]'''

* '''[[E-blocks2_Auto_ID|E-blocks2 Auto ID]]'''

* '''[[Matrix_SCADA | Matrix SCADA]]'''

===Component changes and additions===

CAL components such as ADC, I2C, PWM, SPI and UART are now free to allow for more user-based component creation and library generation.

High-level components created by Matrix are still licensed under the various component feature packs.

We also have made a large selection of component, CAL and FCD updates.

====New components====

Some of the new components include:

*FAT Based GLCD Bitmap Drawer
*New sensor components
*Network abstraction component for TCP/IP and WIFI modules
*E-block specific categories
*Scenario simulation components and wiki based curriculum
*Graphical LCD Graph drawer
*Arduino style serial terminal - via the console
*Raspberry Pi specific - Console Text Generation, TCP/IP
*Raspberry Pi HDMI gLCD
*Modbus TCP - Master and Slave
*DAC MCP48x1
*HTS221
*ESP12S
*PCF8575
*SHT31 Humidity Sensor
*WAV Playback and Record
*RealSpeak
*Bluetooth RN4677
*Various new Grove sensors
*HBridge CAL

====Component improvements====

*CAL components are more usable and stand alone, injector, scope and console functionality is now built in making it much easier to build into your own components
*Bitmap Drawer component - more bitmap file formats (Mono, 16-Colour, 256-Colour, 24-bit) and up to ten bitmaps per component
*Servo motor 16-bit mode
*PWM Frequency based Period and Prescaler calculator

==Flowcode 7==

===Performance improvements===
* Code Profiling - See which icons are 'hit' or 'missed', and the frequency of execution, to determine bugs/ redundancy in your code

* New 2 channel integrated oscilloscope, with triggering

* New template files for Microchip devices - get you up and running with your projects faster

===Visual enhancments===
* New modern UI with a choice of dark/ light themes

* Ability to colour code individual flowchart icons for ease of viewing, or select from pre-made colour schemes

* Create, save and load colour schemes for icons

* Overhaul of user interface

* 3D engine graphical improvements

===New Toolchain and Compilers===
* Support for 32bit PIC microcontrollers

* Support for Microchip XC8, XC16 and XC32 compilers.

* Significantly faster compilation of 8bit Microchip devices (approximately 10 times faster compilation than previous versions)

===Licensing structure===
* Flexible licensing structure - build a bespoke license exactly to your requirements

* License upgradable at any point to add new features

* Free version available - for a limited number of microcontrollers and feature set

===Mechanical Support Improvements===
* Users can now import 3D assemblies, rather than individual parts only.

* Support for industry standard file types; STEP and IGES

===Testing===
* Access readings and data from external instruments using DLL support. Display data with dashboard HMIs or third party software.

* Use our EB006 multiprogrammer, EB091 or Flowkit v2 to monitor every pin on your PICmicro design, and monitor and interpret serial data I/O using Ghost Technology.

==Flowcode 6==

===Component Creator===
* Now you can design your own electronic components and add them to your component library. You can use simulation API calls to define the electrical behaviour and mechanical behaviour in simulation.

* The component library has been expanded considerably to include many new electronic components and simulation components. Components can be designed and shared on our website.

* In addition to PCB style components you now have access to panel mounted switches, meters and displays for industrial control.

* Customise or create Dashboard components like graphs, dials and meters to allow you to monitor how your system is functioning in simulation and In-Circuit Test.

===Simulation===
* Improvements in simulation speed means that your simulation works close to real time which allows you to verify your design ‘live’.

* The powerful API allows control of simulation events and components providing a wide range of PC-side functions.

* Human Machine Interface components show your system parameters during simulation and In-Circuit-Test using intuitive displays including meters, graphs, oscillograms and tables.

* Use text based consoles to see data passing around your system: perfect for designing systems with digital communications.

===Mechanical Support===
* Import 3D models and characterise the movement and simulation using API.

* Use the system panel to design your own simple 3D model. View your design from different angles whilst it simulates.

* Create low cost parts with laser cutters and 3D printers and see the parts working with your electronics on-screen.

* Create simulations of your model which move in 3D space under electrical stimulus from a microcontroller and other components in your system. Use 2D dashboard controls to monitor your system in real time.

===Testing===
* Access readings and data from external instruments using DLL support. Display data with dashboard HMIs or third party software.

* Use our new EB006 multiprogrammer to monitor every pin on your PICmicro design, and monitor and interpret serial data I/O.

* Monitor how your system is functioning in simulation and In-Circuit-Test. Use new components like graphs, meters, consoles and scrolling text boxes to verify your design.

* Use Softscope and Consoles to see data in waveform or textual formats. Use the API to translate incoming data to hex or ASCII equivalent. Link Softscope and consoles to third party hardware using DLLs to create a full SCADA system.

Software Assurance

2026-05-06T14:23:04Z

MartinW:

Just like previous versions of Flowcode, when you purchase Flowcode you receive a perpetual licence to use it forever.

During a major release (e.g. v9 or v10) we provide free updates for the software which often includes new features, new components, bug fixes, etc.

When a new major version is released, you are charged to upgrade to the new version - often with a discount (e.g. 40% when coming from v10 -> v11).

Our new Software Assurance scheme formalises this process to some extent.

When you purchase v11, you will receive 12 months of Software Assurance, which means that any updates (large and small) are free for you during this period.

Towards the end of this 12 month period, you will have the option to extend this Software Assurance for a further 12 months.

Our development team have been very keen to implement a scheme like this because we can now release new features and improvements to Flowcode quicker without holding them back for a new major release.

For example, the new 2d panel zoom feature was developed well over a year ago, but we chose to keep that feature for v11.

=====More details=====

Current delivery model and its problems

We release a major version of Flowcode every few years.

This new version needs new features to entice users to upgrade to the new version.

Improvements and fixes often need to wait for this new major release - sometimes more than 18 months.

A better experience for users would be to have continuous improvement of Flowcode.

This would also have the benefits for Matrix of a more relaxed release process and a more even and predictable revenue stream.

=====How does it work?=====

Just like the current licensing system, users will purchase the new version of Flowcode (again, with a discount if coming from v9 or v10).

This provides a perpetual licence for that particular version of Flowcode, along with a Software Assurance licence for any upgrades to Flowcode for the following 12 months.

After 12 months (and every subsequent year), users will be asked to renew their licence by paying an ongoing software assurance fee (35%). This provides access to free upgrades for the following 12 months.

If a user drops off this Software Assurance scheme, they will still be allowed to use Flowcode in perpetuity. However, they will no longer receive updates to the core package and will also receive limited updates to components, etc.

If they want to rejoin the Software Assurance scheme, they will need to repurchase a licence for Flowcode.

Any chip-pack purchased has a perpetual licence and the devices available to you now will continue to be available even without paying the annual Software Assurance payment.

=====What are the benefits?=====

For a loyal user who consistently purchases new versions, the overall cost difference is not too different.

Bug fixes and quality improvements should be released quicker (rather than waiting for major new version).

For the user who does not upgrade there is no real change: they get to keep the software as it was when the purchase was made with the updates for the 12 months after purchase date.

Overall, the development of Flowcode can be better geared towards improving existing aspects of Flowcode rather than developing major new features.

Software Assurance

2026-05-06T14:20:10Z

MartinW: Created page with "Just like previous versions of Flowcode, when you purchase Flowcode you receive a perpetual licence to use it forever. During a major release (e.g. v9 or v10) we provide fre..."

Just like previous versions of Flowcode, when you purchase Flowcode you receive a perpetual licence to use it forever.

During a major release (e.g. v9 or v10) we provide free updates for the software which often includes new features, new components, bug fixes, etc.

When a new major version is released, you are charged to upgrade to the new version - often with a discount (e.g. 40% when coming from v10 -> v11).

Our new Software Assurance scheme formalises this process to some extent.

When you purchase v11, you will receive 12 months of Software Assurance, which means that any updates (large and small) are free for you during this period.

Towards the end of this 12 month period, you will have the option to extend this Software Assurance for a further 12 months.

Our development team have been very keen to implement a scheme like this because we can now release new features and improvements to Flowcode quicker without holding them back for a new major release.

For example, the new 2d panel zoom feature was developed well over a year ago, but we chose to keep that feature for v11.

Here are some more details:

Current delivery model and its problems

We release a major version of Flowcode every few years.

This new version needs new features to entice users to upgrade to the new version.

Improvements and fixes often need to wait for this new major release - sometimes more than 18 months.

A better experience for users would be to have continuous improvement of Flowcode.

This would also have the benefits for Matrix of a more relaxed release process and a more even and predictable revenue stream.

Software Assurance - how does it work?

Just like the current licensing system, users will purchase the new version of Flowcode (again, with a discount if coming from v9 or v10).

This provides a perpetual licence for that particular version of Flowcode, along with a Software Assurance licence for any upgrades to Flowcode for the following 12 months.

After 12 months (and every subsequent year), users will be asked to renew their licence by paying an ongoing software assurance fee (35%). This provides access to free upgrades for the following 12 months.

If a user drops off this Software Assurance scheme, they will still be allowed to use Flowcode in perpetuity. However, they will no longer receive updates to the core package and will also receive limited updates to components, etc.

If they want to rejoin the Software Assurance scheme, they will need to repurchase a licence for Flowcode.

Any chip-pack purchased has a perpetual licence and the devices available to you now will continue to be available even without paying the annual Software Assurance payment.

What are the benefits?

For a loyal user who consistently purchases new versions, the overall cost difference is not too different.

Bug fixes and quality improvements should be released quicker (rather than waiting for major new version).

For the user who does not upgrade there is no real change: they get to keep the software as it was when the purchase was made with the updates for the 12 months after purchase date.

Overall, the development of Flowcode can be better geared towards improving existing aspects of Flowcode rather than developing major new features.

Version Updates

2026-05-06T14:10:03Z

MartinW:

==Flowcode 11==

=====Graphical Display Design Tools=====
New for version 11 is a full library of components for driving touch screen graphical displays: display drivers for the most popular touch screens, graphics widgets, graph widgets, touch screen components, WYSIWYG graphical display designer and menu control subroutines. These allow you to design touch screen graphical displays based on any 8, 16, or 32 bit microcontroller.

=====Web Mirror=====
The Web Mirror features allows you to mirror the functionality of you touch screen system on any browser anywhere in the world. This is only available on the E-Blocks 3 hardware for now. The great benefit is that you can use your mobile phone to control your electronic projects.

No coding is needed. It's just a couple of settings on the Graphical display component. Flowcode takes care of all the details.

=====New Project Wizard and Auto-detect=====
Getting started is so hard. So many options, choices, settings in our beautiful complex world. The [[Creating_Project|new project wizard]] provides a menu system that makes this easier for all users showing options and guiding users through choices.

If you have E-Blocks 3 hardware then it is even easier: Flowcode sees what upstream and downstream boards you have connected and sets up the program for you.

=====Serial Debugging on Hardware=====
Serial debugging allows you to pause your program as it runs in hardware and see the status of variables in your project. You can set breakpoints in your code and change the values of variables while program execution is paused.

Serial debugging was only available on Matrix hardware in V10. In V11, Serial debugging now works on third party hardware that has a serial COM port available via USB. This includes many Arduino, ESP32 and PIC boards.

=====E-Blocks 3 and Auto-id=====
The goal is simple: create the best environment for developing electronic projects. Its hard to separate the hardware from the software sometimes. The combination of Flowcode and E-Blocks 3 provides an amazing development platform for both educators and industrial engineers.

Each E-blocks downstream board has a small microcontroller on it. These communicate to the upstream board to inform Flowcode what hardware is connected. This allows Flowcode to put the appropriate components on the 2D panel with all the right settings, making project setup much easier!

=====New Microcontrollers=====
The world does not stand still. Manufacturers are constantly adding new microcontrollers with more features, smaller silicon areas, faster clock rates and so on.

We constantly add new microcontrollers to the chip lists. A lot of work has been done recently to add the Microchip PIC8 Q range.

Flowcode is now compatible with 1,789 microcontrollers.

=====2D Panel Updates=====
The 2D panel has been upgraded so that it is now possible to zoom in and out on all component views.

A new rich text components adds formatted text to components and panels, and all panel objects now can be anchored to the panel sides or even set to display completely in the panel (e.g. for showing charts in a separate window).

New features include:

*[[2d_Panels#Other_features_of_2D_panels|2D Panel zoom]]
*[[Component:_ID_component:GdiRichText|Richtext primitive]]
*Component anchoring
*Fill panel window

=====New Coding Features=====
A variety of new features have been added to make coding in Flowcode v11 even simpler than before.

Direct string comparisons can now be made in decision icons, the loop command has a "loop forever" option and several new operators (e.g. increment/decrement and assignment) have been added to make Flowcode calculations more representative of C code.

*Direct string comparisons
*[[Loop_Icon_Properties|Loop forever]]
*Increment and decrement operators
*Assignment operators (e.g. myval += 10)

=====Other improvements=====
*Dynamic menus and web-based windows added
*Anchors and 'fit component' options for panel objects
*Group icon contents can be viewed without needing to ungroup
*User is now warned when openign a project that is already open
*Flowcode now has separate icons for Embedded, Web Developer and PC Developer project files
*Macros can now be shown as a different graphical/text view direct from the macro tab
*Library version log file shows which versions of library files are used in compiled project
*Colour options available on macro descriptions
*Position anchors for components
*New richtext primitive for component panels
*View group icon contents
*Access variables in simulated component code
*Direct access to variable manager
*Warn when opening a project that is already open
*New file extensions for Flowcode project types
*Change macro view types on the fly
*Advanced component profiling and debugging
*Clear All Breakpoints no longer ignores the loop command
*Digital i/o panel now updated correctly when PORT property change iterates through subcomponents
*Digital i/o panel now updated correctly when pane is first opened
*Caption bar now shows project type
*Dropping icons onto overlapped macro views correctly drops onto topmost window
*Non-flowchart macros can now be exported as image
*New state diagram macro menu item added
*Web Developer projects do not show state diagram icons
*List Occurrences check is now case-insensitive
*Improvements to dark colour scheme
*Added ability to show and hide component macros via API command
*Fixed read-only nature of component properties
*Fixed the sim control speed slider
*Fixed 'corrupt macro' error message text that got lost during an exception
*Mouse events now triggered at the dead area at the top of Project Explorer
*Component major/minor versions now 0-999 (was 0-100)
*Hidden option to show '!=' as '<>'
*Fixed MatrixLight/MatrixDark inbuilt colour schemes for charts
*2d panels now hide toolbar when simulating
*FCDChange event is fired when chip stays the same but clock speed changes
*Fixed longstanding bug with broadcast message parameter corruption
*Moved components on 2d panel now redraw their vacated areas too
*Subcomponents of a group now get unique names when copying/pasting
*Added GetActual2dPosition/GetActual2dPosition API commands
*Context menu for component panels stops renames, deletion, etc, when simulating
*Wndhost comps (button, combobox and textbox) now update when resized on the panel
*Text primitives now redraw their actual text area too
*Improved visual styling for dark mode, and fixed styling issues with combo boxes, etc.
*Removed redundant colour and code-customisation information from saved project files
*Fixed SIGNED/UNSIGNED casting
*Fixed simulation of Decision tail icon
*Search now finds ports/pins
*Added logical AND, OR and NOT (&&, ||, !) to maths functions list
*Improved tooltip help for maths and string functions
*Function lists now categorised
*Call stack view width can be altered using mouse wheel in Simulation Debugger window
*Component panel zoom level now shown on status bar
*Improved component toolbar display on non-100% DPI systems
*New variables are given default initialisers
*Macro parameters can have default values for parameters
*Macro tabs have 'close' and 'close other' menu item
*Added CallMacro in-built functions
*Added in-built functions to manipulate text-based property lists
*Fixed flicker in IOC chip view in interrupt prpoperties dialog
*Components and macros now available to add to expressions in icon dialogs
*List properties can now be auto-sorted
*Flowcode now uses a 'ping' to ensure web-based dialogs retain current information

[https://flowcode.co.uk/forums/viewtopic.php?p=23397#p23397 Update v11.0.1.14]

==Flowcode 10==

=====Licensing changes=====

*Flowcode V10 is now free for makers and hobbyists with full functionality for a limited range of devices which include; '''[[Supported_Chips#Free_Targets|Arduino Uno & Nano, RPI etc. ]]'''

=====Components=====
*Can now view component code

*'''[[Components|Components]]''' are now free and open-sourced so you can use existing components and tailor them to your own requirements.

*Dedicated 2D primitive components

=====2D panels=====
New [[2d_Panels|2D panels]] provide clearer graphics, customisation of all panels with your own drawings, notes and much more printer friendly options available.

Add an unlimited number of 2D panels into your project.

Unlocks a host of new 2D panel only panel options such as graphing tools.

====Simulation====

*Improved ''[[Variable_Types|variable values]]'' display on simulation – view and edit ''[[Variable_Types|variable values]]'' during simulation and '''[[Ghost_Technology|ICD]]

*Interrupt on Change diagram visual improvements

*View and step through the simulation of component code (Pro Licence only)

*Ghost support for EB0058 ESP board

*Icon lists now show disabled icons in a muted colour

*Show variables on ''[[Oscilloscope|oscilloscope]]'' and ''[[Using_the_Data_Recorder|data recorder]]''

*The text colour of flowchart icons can be altered

=====Application=====
*Create separate .c and .h files

*Show help/wiki in separate browser

=====UI Trees=====

*New ''UI Trees'' tab within ''[[Global_Settings|Global Settings]]'' for customising ''[[Project Explorer|Project Explorer]]'' and Icon Lists

=====User Tools=====

*New ''User Tools'' tab within ''[[Global_Settings|Global Settings]]'' for setting up User Tools to be used within the ''Build ribbon''

=====I/O ports=====

*Connected components lists on analogue/digital windows

*When using Calculation icons (etc), pins can be dragged to the expression
=====Variables=====
*Combines global and local ''[[Creating_Variables|variables]]'' (which are also available separately)

*Show''[[Using_the_Project_Explorer| values]]'' during ''[[Starting_Flowchart_Simulation|simulation]]''

*Float ''[[Variable_Types|variables]]'' are now shown to a user-defined precision (defaults to “%g”)

=====Built-in Functions=====

*Single-dimension arrays show individual elements in Watch and Project Explorer lists

*There are some new built-in functions available

''[[API_Reference|New API calls]]'' : GetPanel and GetPanelName, SetSimSpeed and GetBackgroundColour

[[String_Manipulation_Functions|New String Functions routines]]'' : Contains$, SplitString$, ExplodeToIntArray$, ImplodeFromIntArray$, ExplodeToFloatArray$, ImplodeFromFloatArray$, Int2FormattedString$, Float2FormattedString$, InsertString$, RemoveFromString$, SearchAndReplace$

[[Mathematical_Functions|New Mathematical Functions]]'' : cosh, sinh, tanh, arraydims, arraysize, GetOriginalScale

=====Events=====
*There are some new events available

====Miscellaneous====

*TODO list - auto generated icon list based on icons containing TODO in the comment. For example. TODO this icon needs work or TODO this will need changing.

*''[[Auto_Documentation|Project Report improvements]]''

==Flowcode 9==

Here are some of the new features added in Flowcode 9. Please click on a feature to learn more about it.

===App Developer===
* '''[[App_Developer|Flowcode App Developer]]'''

A completely new piece of software - based on Flowcode - that allows you to create fantastic distributed control and data gathering systems with intuitive Human Machine interfaces for Windows PCs and tablets.

This comes with a suite of Application Programming Interfaces for low cost hardware including Arduino, Raspberry Pi, ESP32 and PIC which allows you to create powerful smart embedded + PC devices with Windows HMI displays that can be freely distributed.

===State Diagrams===
* '''[[State_diagrams|State diagrams]]'''

New graphical programming icons allows you to make use of this powerful programming paradigm.

Create new state machine projects or enhance your existing ones and mix and match with flow chart icons, C code, blocks etc.

===New ESP32 Toolchain===
* '''[[Compiler_Toolchains#ESP32_Toolchain|ESP32 toolchain]]'''

Flowcode now supports a range of new devices for this powerful 80MHz board level device with integrated TCP/IP stack, and Wi-fi.

This allows you to create great web-interconnected projects with this incredibly low cost hardware platform from Espressif semiconductors in China.

===Data flow programming===
* '''[[DSP|Data flow programming]]'''
Now you can use data flow programming icons in your projects. This is a really great programming technique for projects including communications systems and Digital Signal Processing.

===New Components===
* '''[[Components|New components]]'''
New components include new DSP components, new Mechatronics parts, Easy Internet Of Things components, more sensors, and new test injectors.
We have updated our forums and now have sections to post your projects for both App Developer and Embedded. There are already a few posted. Why not come and replicate these projects to learn some interesting new things?

===New Website===
* '''[https://flowcode.co.uk/ New website]'''

Flowcode now has its own web site.
Here, you can find more information on Flowcode Embedded, Flowcode App Developer, a new Wiki, and a host of new courses on developing advanced communications systems from Mobile phone technology to CAN bus technology in automotive.

==Flowcode 8==

===Features Added===

Here are some of the new features added in Flowcode 8. Please click on a feature to learn more about it.

* '''[[Code_Folding|Code Folding]]'''

* '''[[Icon_Grouping|Icon Grouping]]'''

* '''[[C_Code_Simulation|Simulating Custom C Code]]'''

* '''[[C_Code_to_Flowchart_Conversion|Custom C Code to Flowchart Conversion]]'''

* '''[[Code_Paradigms|Coding Paradigms - Flowchart, Blocks, Pseudocode, C Code]]'''

* '''[[Tab Tear Off - Multi Monitor Support]]'''

* '''[[Dynamic_Updates|Dynamic Updates]]'''

* '''[[Raspberry_Pi_Chip_Pack|Raspberry Pi Chip Pack]]'''

* '''[[E-blocks2_Auto_ID|E-blocks2 Auto ID]]'''

* '''[[Matrix_SCADA | Matrix SCADA]]'''

===Component changes and additions===

CAL components such as ADC, I2C, PWM, SPI and UART are now free to allow for more user-based component creation and library generation.

High-level components created by Matrix are still licensed under the various component feature packs.

We also have made a large selection of component, CAL and FCD updates.

====New components====

Some of the new components include:

*FAT Based GLCD Bitmap Drawer
*New sensor components
*Network abstraction component for TCP/IP and WIFI modules
*E-block specific categories
*Scenario simulation components and wiki based curriculum
*Graphical LCD Graph drawer
*Arduino style serial terminal - via the console
*Raspberry Pi specific - Console Text Generation, TCP/IP
*Raspberry Pi HDMI gLCD
*Modbus TCP - Master and Slave
*DAC MCP48x1
*HTS221
*ESP12S
*PCF8575
*SHT31 Humidity Sensor
*WAV Playback and Record
*RealSpeak
*Bluetooth RN4677
*Various new Grove sensors
*HBridge CAL

====Component improvements====

*CAL components are more usable and stand alone, injector, scope and console functionality is now built in making it much easier to build into your own components
*Bitmap Drawer component - more bitmap file formats (Mono, 16-Colour, 256-Colour, 24-bit) and up to ten bitmaps per component
*Servo motor 16-bit mode
*PWM Frequency based Period and Prescaler calculator

==Flowcode 7==

===Performance improvements===
* Code Profiling - See which icons are 'hit' or 'missed', and the frequency of execution, to determine bugs/ redundancy in your code

* New 2 channel integrated oscilloscope, with triggering

* New template files for Microchip devices - get you up and running with your projects faster

===Visual enhancments===
* New modern UI with a choice of dark/ light themes

* Ability to colour code individual flowchart icons for ease of viewing, or select from pre-made colour schemes

* Create, save and load colour schemes for icons

* Overhaul of user interface

* 3D engine graphical improvements

===New Toolchain and Compilers===
* Support for 32bit PIC microcontrollers

* Support for Microchip XC8, XC16 and XC32 compilers.

* Significantly faster compilation of 8bit Microchip devices (approximately 10 times faster compilation than previous versions)

===Licensing structure===
* Flexible licensing structure - build a bespoke license exactly to your requirements

* License upgradable at any point to add new features

* Free version available - for a limited number of microcontrollers and feature set

===Mechanical Support Improvements===
* Users can now import 3D assemblies, rather than individual parts only.

* Support for industry standard file types; STEP and IGES

===Testing===
* Access readings and data from external instruments using DLL support. Display data with dashboard HMIs or third party software.

* Use our EB006 multiprogrammer, EB091 or Flowkit v2 to monitor every pin on your PICmicro design, and monitor and interpret serial data I/O using Ghost Technology.

==Flowcode 6==

===Component Creator===
* Now you can design your own electronic components and add them to your component library. You can use simulation API calls to define the electrical behaviour and mechanical behaviour in simulation.

* The component library has been expanded considerably to include many new electronic components and simulation components. Components can be designed and shared on our website.

* In addition to PCB style components you now have access to panel mounted switches, meters and displays for industrial control.

* Customise or create Dashboard components like graphs, dials and meters to allow you to monitor how your system is functioning in simulation and In-Circuit Test.

===Simulation===
* Improvements in simulation speed means that your simulation works close to real time which allows you to verify your design ‘live’.

* The powerful API allows control of simulation events and components providing a wide range of PC-side functions.

* Human Machine Interface components show your system parameters during simulation and In-Circuit-Test using intuitive displays including meters, graphs, oscillograms and tables.

* Use text based consoles to see data passing around your system: perfect for designing systems with digital communications.

===Mechanical Support===
* Import 3D models and characterise the movement and simulation using API.

* Use the system panel to design your own simple 3D model. View your design from different angles whilst it simulates.

* Create low cost parts with laser cutters and 3D printers and see the parts working with your electronics on-screen.

* Create simulations of your model which move in 3D space under electrical stimulus from a microcontroller and other components in your system. Use 2D dashboard controls to monitor your system in real time.

===Testing===
* Access readings and data from external instruments using DLL support. Display data with dashboard HMIs or third party software.

* Use our new EB006 multiprogrammer to monitor every pin on your PICmicro design, and monitor and interpret serial data I/O.

* Monitor how your system is functioning in simulation and In-Circuit-Test. Use new components like graphs, meters, consoles and scrolling text boxes to verify your design.

* Use Softscope and Consoles to see data in waveform or textual formats. Use the API to translate incoming data to hex or ASCII equivalent. Link Softscope and consoles to third party hardware using DLLs to create a full SCADA system.

Version Updates

2026-05-05T14:21:03Z

MartinW:

==Flowcode 11==
Full graphical display WYSIWYG editor

Web Mirror functionality

New Project Wizard

Zoomable 2d Panels

Direct string comparisons

E-Blocks 3 and Auto-id

A new rich text components adds formatted text to components and panels

New operators (e.g. increment/decrement and assignment)

Dynamic menus and web-based windows added

Anchors and 'fit component' options for panel objects

Group icon contents can be viewed without needing to ungroup

User is now warned when opening a project that is already open

Flowcode now has separate icons for Embedded, Web Developer and PC Developer project files

Macros can now be shown as a different graphical/text view direct from the macro tab

Library version log file shows which versions of library files are used in compiled project

Colour options available on macro descriptions

Position anchors for components

New richtext primitive for component panels

View group icon contents

Access variables in simulated component code

Direct access to variable manager

Warn when opening a project that is already open

New file extensions for Flowcode project types

Change macro view types on the fly

Advanced component profiling and debugging

Clear All Breakpoints no longer ignores the loop command

Digital i/o panel now updated correctly when PORT property change iterates through subcomponents

Digital i/o panel now updated correctly when pane is first opened

Caption bar now shows project type

Dropping icons onto overlapped macro views correctly drops onto topmost window

Non-flowchart macros can now be exported as image

New state diagram macro menu item added

Web Developer projects do not show state diagram icons

List Occurrences check is now case-insensitive

Improvements to dark colour scheme

Added ability to show and hide component macros via API command

Fixed read-only nature of component properties

Fixed the sim control speed slider

Fixed 'corrupt macro' error message text that got lost during an exception

Mouse events now triggered at the dead area at the top of Project Explorer

Component major/minor versions now 0-999 (was 0-100)

Hidden option to show '!=' as '<>'

Fixed MatrixLight/MatrixDark inbuilt colour schemes for charts

2d panels now hide toolbar when simulating

FCDChange event is fired when chip stays the same but clock speed changes

Fixed longstanding bug with broadcast message parameter corruption

Moved components on 2d panel now redraw their vacated areas too

Subcomponents of a group now get unique names when copying/pasting

Added GetActual2dPosition/GetActual2dPosition API commands

Context menu for component panels stops renames, deletion, etc, when simulating

Wndhost comps (button, combobox and textbox) now update when resized on the panel

Text primitives now redraw their actual text area too

Improved visual styling for dark mode, and fixed styling issues with combo boxes, etc.

Removed redundant colour and code-customisation information from saved project files

Fixed SIGNED/UNSIGNED casting

Fixed simulation of Decision tail icon

Search now finds ports/pins

Added logical AND, OR and NOT (&&, ||, !) to maths functions list

Improved tooltip help for maths and string functions

Function lists now categorised

Call stack view width can be altered using mouse wheel in Simulation Debugger window

Component panel zoom level now shown on status bar

Improved component toolbar display on non-100% DPI systems

New variables are given default initialisers

Macro parameters can have default values for parameters

Macro tabs have 'close' and 'close other' menu item

Added CallMacro in-built functions

Added in-built functions to manipulate text-based property lists

Fixed flicker in IOC chip view in interrupt properties dialog

Components and macros now available to add to expressions in icon dialogs

List properties can now be auto-sorted

Flowcode now uses a 'ping' to ensure web-based dialogs retain current information

[https://flowcode.co.uk/forums/viewtopic.php?p=23397#p23397 Update v11.0.1.14]

==Flowcode 10==

=====Licensing changes=====

*Flowcode V10 is now free for makers and hobbyists with full functionality for a limited range of devices which include; '''[[Supported_Chips#Free_Targets|Arduino Uno & Nano, RPI etc. ]]'''

=====Components=====
*Can now view component code

*'''[[Components|Components]]''' are now free and open-sourced so you can use existing components and tailor them to your own requirements.

*Dedicated 2D primitive components

=====2D panels=====
New [[2d_Panels|2D panels]] provide clearer graphics, customisation of all panels with your own drawings, notes and much more printer friendly options available.

Add an unlimited number of 2D panels into your project.

Unlocks a host of new 2D panel only panel options such as graphing tools.

====Simulation====

*Improved ''[[Variable_Types|variable values]]'' display on simulation – view and edit ''[[Variable_Types|variable values]]'' during simulation and '''[[Ghost_Technology|ICD]]

*Interrupt on Change diagram visual improvements

*View and step through the simulation of component code (Pro Licence only)

*Ghost support for EB0058 ESP board

*Icon lists now show disabled icons in a muted colour

*Show variables on ''[[Oscilloscope|oscilloscope]]'' and ''[[Using_the_Data_Recorder|data recorder]]''

*The text colour of flowchart icons can be altered

=====Application=====
*Create separate .c and .h files

*Show help/wiki in separate browser

=====UI Trees=====

*New ''UI Trees'' tab within ''[[Global_Settings|Global Settings]]'' for customising ''[[Project Explorer|Project Explorer]]'' and Icon Lists

=====User Tools=====

*New ''User Tools'' tab within ''[[Global_Settings|Global Settings]]'' for setting up User Tools to be used within the ''Build ribbon''

=====I/O ports=====

*Connected components lists on analogue/digital windows

*When using Calculation icons (etc), pins can be dragged to the expression
=====Variables=====
*Combines global and local ''[[Creating_Variables|variables]]'' (which are also available separately)

*Show''[[Using_the_Project_Explorer| values]]'' during ''[[Starting_Flowchart_Simulation|simulation]]''

*Float ''[[Variable_Types|variables]]'' are now shown to a user-defined precision (defaults to “%g”)

=====Built-in Functions=====

*Single-dimension arrays show individual elements in Watch and Project Explorer lists

*There are some new built-in functions available

''[[API_Reference|New API calls]]'' : GetPanel and GetPanelName, SetSimSpeed and GetBackgroundColour

[[String_Manipulation_Functions|New String Functions routines]]'' : Contains$, SplitString$, ExplodeToIntArray$, ImplodeFromIntArray$, ExplodeToFloatArray$, ImplodeFromFloatArray$, Int2FormattedString$, Float2FormattedString$, InsertString$, RemoveFromString$, SearchAndReplace$

[[Mathematical_Functions|New Mathematical Functions]]'' : cosh, sinh, tanh, arraydims, arraysize, GetOriginalScale

=====Events=====
*There are some new events available

====Miscellaneous====

*TODO list - auto generated icon list based on icons containing TODO in the comment. For example. TODO this icon needs work or TODO this will need changing.

*''[[Auto_Documentation|Project Report improvements]]''

==Flowcode 9==

Here are some of the new features added in Flowcode 9. Please click on a feature to learn more about it.

===App Developer===
* '''[[App_Developer|Flowcode App Developer]]'''

A completely new piece of software - based on Flowcode - that allows you to create fantastic distributed control and data gathering systems with intuitive Human Machine interfaces for Windows PCs and tablets.

This comes with a suite of Application Programming Interfaces for low cost hardware including Arduino, Raspberry Pi, ESP32 and PIC which allows you to create powerful smart embedded + PC devices with Windows HMI displays that can be freely distributed.

===State Diagrams===
* '''[[State_diagrams|State diagrams]]'''

New graphical programming icons allows you to make use of this powerful programming paradigm.

Create new state machine projects or enhance your existing ones and mix and match with flow chart icons, C code, blocks etc.

===New ESP32 Toolchain===
* '''[[Compiler_Toolchains#ESP32_Toolchain|ESP32 toolchain]]'''

Flowcode now supports a range of new devices for this powerful 80MHz board level device with integrated TCP/IP stack, and Wi-fi.

This allows you to create great web-interconnected projects with this incredibly low cost hardware platform from Espressif semiconductors in China.

===Data flow programming===
* '''[[DSP|Data flow programming]]'''
Now you can use data flow programming icons in your projects. This is a really great programming technique for projects including communications systems and Digital Signal Processing.

===New Components===
* '''[[Components|New components]]'''
New components include new DSP components, new Mechatronics parts, Easy Internet Of Things components, more sensors, and new test injectors.
We have updated our forums and now have sections to post your projects for both App Developer and Embedded. There are already a few posted. Why not come and replicate these projects to learn some interesting new things?

===New Website===
* '''[https://flowcode.co.uk/ New website]'''

Flowcode now has its own web site.
Here, you can find more information on Flowcode Embedded, Flowcode App Developer, a new Wiki, and a host of new courses on developing advanced communications systems from Mobile phone technology to CAN bus technology in automotive.

==Flowcode 8==

===Features Added===

Here are some of the new features added in Flowcode 8. Please click on a feature to learn more about it.

* '''[[Code_Folding|Code Folding]]'''

* '''[[Icon_Grouping|Icon Grouping]]'''

* '''[[C_Code_Simulation|Simulating Custom C Code]]'''

* '''[[C_Code_to_Flowchart_Conversion|Custom C Code to Flowchart Conversion]]'''

* '''[[Code_Paradigms|Coding Paradigms - Flowchart, Blocks, Pseudocode, C Code]]'''

* '''[[Tab Tear Off - Multi Monitor Support]]'''

* '''[[Dynamic_Updates|Dynamic Updates]]'''

* '''[[Raspberry_Pi_Chip_Pack|Raspberry Pi Chip Pack]]'''

* '''[[E-blocks2_Auto_ID|E-blocks2 Auto ID]]'''

* '''[[Matrix_SCADA | Matrix SCADA]]'''

===Component changes and additions===

CAL components such as ADC, I2C, PWM, SPI and UART are now free to allow for more user-based component creation and library generation.

High-level components created by Matrix are still licensed under the various component feature packs.

We also have made a large selection of component, CAL and FCD updates.

====New components====

Some of the new components include:

*FAT Based GLCD Bitmap Drawer
*New sensor components
*Network abstraction component for TCP/IP and WIFI modules
*E-block specific categories
*Scenario simulation components and wiki based curriculum
*Graphical LCD Graph drawer
*Arduino style serial terminal - via the console
*Raspberry Pi specific - Console Text Generation, TCP/IP
*Raspberry Pi HDMI gLCD
*Modbus TCP - Master and Slave
*DAC MCP48x1
*HTS221
*ESP12S
*PCF8575
*SHT31 Humidity Sensor
*WAV Playback and Record
*RealSpeak
*Bluetooth RN4677
*Various new Grove sensors
*HBridge CAL

====Component improvements====

*CAL components are more usable and stand alone, injector, scope and console functionality is now built in making it much easier to build into your own components
*Bitmap Drawer component - more bitmap file formats (Mono, 16-Colour, 256-Colour, 24-bit) and up to ten bitmaps per component
*Servo motor 16-bit mode
*PWM Frequency based Period and Prescaler calculator

==Flowcode 7==

===Performance improvements===
* Code Profiling - See which icons are 'hit' or 'missed', and the frequency of execution, to determine bugs/ redundancy in your code

* New 2 channel integrated oscilloscope, with triggering

* New template files for Microchip devices - get you up and running with your projects faster

===Visual enhancments===
* New modern UI with a choice of dark/ light themes

* Ability to colour code individual flowchart icons for ease of viewing, or select from pre-made colour schemes

* Create, save and load colour schemes for icons

* Overhaul of user interface

* 3D engine graphical improvements

===New Toolchain and Compilers===
* Support for 32bit PIC microcontrollers

* Support for Microchip XC8, XC16 and XC32 compilers.

* Significantly faster compilation of 8bit Microchip devices (approximately 10 times faster compilation than previous versions)

===Licensing structure===
* Flexible licensing structure - build a bespoke license exactly to your requirements

* License upgradable at any point to add new features

* Free version available - for a limited number of microcontrollers and feature set

===Mechanical Support Improvements===
* Users can now import 3D assemblies, rather than individual parts only.

* Support for industry standard file types; STEP and IGES

===Testing===
* Access readings and data from external instruments using DLL support. Display data with dashboard HMIs or third party software.

* Use our EB006 multiprogrammer, EB091 or Flowkit v2 to monitor every pin on your PICmicro design, and monitor and interpret serial data I/O using Ghost Technology.

==Flowcode 6==

===Component Creator===
* Now you can design your own electronic components and add them to your component library. You can use simulation API calls to define the electrical behaviour and mechanical behaviour in simulation.

* The component library has been expanded considerably to include many new electronic components and simulation components. Components can be designed and shared on our website.

* In addition to PCB style components you now have access to panel mounted switches, meters and displays for industrial control.

* Customise or create Dashboard components like graphs, dials and meters to allow you to monitor how your system is functioning in simulation and In-Circuit Test.

===Simulation===
* Improvements in simulation speed means that your simulation works close to real time which allows you to verify your design ‘live’.

* The powerful API allows control of simulation events and components providing a wide range of PC-side functions.

* Human Machine Interface components show your system parameters during simulation and In-Circuit-Test using intuitive displays including meters, graphs, oscillograms and tables.

* Use text based consoles to see data passing around your system: perfect for designing systems with digital communications.

===Mechanical Support===
* Import 3D models and characterise the movement and simulation using API.

* Use the system panel to design your own simple 3D model. View your design from different angles whilst it simulates.

* Create low cost parts with laser cutters and 3D printers and see the parts working with your electronics on-screen.

* Create simulations of your model which move in 3D space under electrical stimulus from a microcontroller and other components in your system. Use 2D dashboard controls to monitor your system in real time.

===Testing===
* Access readings and data from external instruments using DLL support. Display data with dashboard HMIs or third party software.

* Use our new EB006 multiprogrammer to monitor every pin on your PICmicro design, and monitor and interpret serial data I/O.

* Monitor how your system is functioning in simulation and In-Circuit-Test. Use new components like graphs, meters, consoles and scrolling text boxes to verify your design.

* Use Softscope and Consoles to see data in waveform or textual formats. Use the API to translate incoming data to hex or ASCII equivalent. Link Softscope and consoles to third party hardware using DLLs to create a full SCADA system.

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]