Difference between revisions of "Flowcode Help Overview"

From Flowcode Help
Jump to navigationJump to search
 
(28 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<!--<sidebar>Sidebar: Flowcode Help Overview</sidebar>-->
+
This page provides a detailed guide to using Flowcode, covering various aspects of the software.
  
<!--A set of videos are available showing some projects using Flowcode as well as talking you through some example programs.
+
Here’s a brief summary of the sections:
[https://www.youtube.com/watch?v=g5SrkU-5TuU&list=PLCZaPFyK6UlLyg-a8Fm01ZWFvp-GxBLgc Flowcode video playlist]-->
+
 
 +
# Getting Started: Instructions on activating Flowcode, navigating the interface, creating projects, configuring devices, and saving/loading projects. It also offers specific guides for embedded, PC, web, and Raspberry Pi development.
 +
# Program Editing: Explains flowchart icons, adding/editing icons, code folding, grouping icons, simulating C code, converting C code to flowcharts, and multi-monitor support.
 +
# Macros: Covers creating, editing, and deleting macros, along with exporting/importing macros and using the project explorer.
 +
# Functions: Describes built-in mathematical and string manipulation functions, undo/redo operations, annotations, and find/replace functionality.
 +
# Variables: Guides on creating, editing, and using different variable types, handles, typecasting, and state machines.
 +
# Panels: Explains how to choose, manipulate, and control 2D and 3D simulation panels, including object positioning, scaling, and rotation.
 +
# Tools and Views: Provides details on compiler toolchains, toolbars, project options, global settings, simulation debugging, and window layouts.
 +
# Components: Information on components, including common ones, macros, properties, help files, CAL/DSP components, and remappable peripheral pins.
 +
# Chip Specifics: Explains how to compile a flowchart into machine code, use oscillators, PLLs, interrupts, third-party programming tools, and manage compiler options.
 +
# Support: Offers guidance on getting updates, reporting bugs, using licensed compilers, accessing technical support, and migrating from older Flowcode versions.
 +
 
 +
This overview serves as a comprehensive reference for users at any level, providing essential resources to navigate and maximize the use of Flowcode.
  
 
==Getting Started==
 
==Getting Started==
Line 9: Line 21:
 
* [[Opening_Flowcode|Opening Flowcode]] - Launching the Flowcode application
 
* [[Opening_Flowcode|Opening Flowcode]] - Launching the Flowcode application
 
* [[Finding_Your_Way_Around_Flowcode|Finding Your Way Around Flowcode]] - Finding your way around
 
* [[Finding_Your_Way_Around_Flowcode|Finding Your Way Around Flowcode]] - Finding your way around
* [[Creating_Flowcharts|Creating Flowcharts]] - Creating your first Flowcode flowchart and see the options available
+
* [[Creating_Project|Creating Project]] - Creating your first Flowcode project and see the options available
* [[Selecting_a_Target_Chip|Selecting a Target Chip]] - Selecting the target microcontroller device
+
* [[Creating_Project#Changing_configuration_settings|Configuring the Chip]] - Configuring your device
* [[Configuring_the_Chip|Configuring the Chip]] - Configuring your device
+
* [[Save_and_Open_Projects|Save and Open Projects]] - Saving and Opening Flowcode project files
* [[Opening_an_Existing_Flowchart|Opening an Existing Flowchart]] - Opening an existing .FCFX Flowcode project file
 
 
* [[Selecting_a_Template|Selecting a Template]] - Opening a template project file
 
* [[Selecting_a_Template|Selecting a Template]] - Opening a template project file
* [[Saving_a_Flowchart|Saving a Flowchart]] - Saving your program
 
 
* [[Creating_Templates|Creating Templates]] - Creating your own templates
 
* [[Creating_Templates|Creating Templates]] - Creating your own templates
 
* [[Closing_Flowcode|Closing Flowcode]] - Closing Flowcode
 
* [[Closing_Flowcode|Closing Flowcode]] - Closing Flowcode
 +
* [[Embedded_Getting_Started_Guide|Embedded Getting Started Guide]] - Overview of Flowcode IDE for the embedded side, with project examples
 +
* [[PC_Developer_Getting_Started_Guide|PC Developer Getting Started Guide]] - Overview of Flowcode IDE for PC Developer, with project examples
 +
* [[Web_Developer_Getting_Started_Guide|Web Developer Getting Started Guide]] - Overview of Flowcode IDE for Web Developer, with program examples
 +
* [[Raspberry_Pi_Getting_Started_Guide|Raspberry Pi Getting Started Guide]] - Overview on setting up and programming the Raspberry Pi
  
==Using the Flowchart==
+
==Program Editing==
 
<span id="Flowcharts"></span>
 
<span id="Flowcharts"></span>
 
*[[Icon_Properties|Icon Properties]] - Flowchart icons and their functionality
 
*[[Icon_Properties|Icon Properties]] - Flowchart icons and their functionality
 +
*[[Remappable Pin Table|Remappable Pin Table]] - Provides pin mappings and functionality for various microcontrollers and development boards.
 
*[[Adding_an_Icon_to_a_Flowchart|Adding an Icon to a Flowchart]] - Adding flowchart icons to your program
 
*[[Adding_an_Icon_to_a_Flowchart|Adding an Icon to a Flowchart]] - Adding flowchart icons to your program
 
*[[Editing_Icon_Properties|Editing Icon Properties]] - Editing the properties of a flowchart icon
 
*[[Editing_Icon_Properties|Editing Icon Properties]] - Editing the properties of a flowchart icon
Line 31: Line 46:
 
*[[C_Code_to_Flowchart_Conversion|C Code to Flowchart Conversion]] - Converting a section of C code into Flowchart icons
 
*[[C_Code_to_Flowchart_Conversion|C Code to Flowchart Conversion]] - Converting a section of C code into Flowchart icons
 
*[[Code_Paradigms|Code Paradigms]] - Coding Paradigms - Flowchart, Blocks, Pseudocode, C Code
 
*[[Code_Paradigms|Code Paradigms]] - Coding Paradigms - Flowchart, Blocks, Pseudocode, C Code
 +
*[[State_diagrams|State Diagrams]] - State Diagrams - Support for using the State Diagram coding paradigm
 
*[[Tab_Tear_Off_-_Multi_Monitor_Support|Tab Tear Off - Multi Monitor Support]] - How to manage tabs on multi-monitor systems
 
*[[Tab_Tear_Off_-_Multi_Monitor_Support|Tab Tear Off - Multi Monitor Support]] - How to manage tabs on multi-monitor systems
  
Line 47: Line 63:
 
*[[Undo_and_Redo|Undo and Redo]] - Undo and Redo operations and shortcuts
 
*[[Undo_and_Redo|Undo and Redo]] - Undo and Redo operations and shortcuts
 
*[[Icon_Annotations|Icon Annotations]] - Icon annotations
 
*[[Icon_Annotations|Icon Annotations]] - Icon annotations
*[[Find_and_Replace|Find and Replace]] - Ability to search within your flowcode project to replace specific text with alternate text
+
*[[Find_and_Replace|Find and Replace]] - Ability to search within your Flowcode project to replace specific text with alternate text
  
 
==Variables==
 
==Variables==
Line 60: Line 76:
 
==Panels==
 
==Panels==
 
<span id="Panels"></span>
 
<span id="Panels"></span>
*[[Panels_Where_And_Why|Panels Where And Why]] - What the panels do and how they help you design your system
 
 
*[[Choosing_your_Simulation_Panel|Choosing your Simulation Panel]] - Information about choosing the correct panel
 
*[[Choosing_your_Simulation_Panel|Choosing your Simulation Panel]] - Information about choosing the correct panel
*[[Dashboard_Panel|Dashboard Panel]] - More in depth information on the dashboard panel
+
*[[2d_Panels|2D Panels]] - More in-depth information on the 2D panels
*[[System_Panel|System Panel]] - More in depth information on the system panel
+
*[[System_Panel|3D System Panel]] - More in-depth information on the 3D system panel
*[[Zooming_the_View|Zooming the View]] - Zooming in and out on panels
+
*[[Zooming_the_View|Zooming the View]] - Zooming in and out on the 3D system panel
 
*[[Camera_Control|Camera Control]] - Controlling the camera looking at the panel
 
*[[Camera_Control|Camera Control]] - Controlling the camera looking at the panel
 
*[[Object_Position|Object Position]] - Object positioning on the panels
 
*[[Object_Position|Object Position]] - Object positioning on the panels
*[[Local_and_World_Space|Local and World Space]] - Local vs World space regarding coordinates
 
 
*[[Object_Scale|Object Scale]] - Objects and their scale
 
*[[Object_Scale|Object Scale]] - Objects and their scale
 
*[[Object_Rotation|Object Rotation]] - Rotating objects
 
*[[Object_Rotation|Object Rotation]] - Rotating objects
Line 75: Line 89:
 
==Tools and Views==
 
==Tools and Views==
 
<span id="Tools_and_Views"></span>
 
<span id="Tools_and_Views"></span>
*[[Tools_and_Views|Tools and Views]] - Various tools and views available inside Flowcode
+
*[[Compiler_Toolchains|Compiler Toolchains]] - Toolchains used to compile to the various platforms Flowcode supports.
 +
*[[Ribbon_Toolbar|Ribbon Toolbar]] - Detailed description of the Flowcode ribbon toolbars.
 
*[[Project_Options|Project Options]] - Detailed help on the Project Options window
 
*[[Project_Options|Project Options]] - Detailed help on the Project Options window
*[[Global_Options|Global Options]] - Detailed help on the Global Options window
+
*[[Global_Settings|Global Settings]] - Detailed help on the Global Settings window
 
*[[Chip_View|Chip View]] - The chip view window
 
*[[Chip_View|Chip View]] - The chip view window
 
*[[Properties_Panel|Properties Panel]] - The properties panel
 
*[[Properties_Panel|Properties Panel]] - The properties panel
 
*[[Supplementary_Code|Supplementary Code]] - Supplementary code and its usage
 
*[[Supplementary_Code|Supplementary Code]] - Supplementary code and its usage
 +
*[[Simulation_Debugger|Simulation Debugger]] - Control over the simulation speed and view simulated variable values, also known previously as the watch window
 
*[[Saving_Images_in_Flowcode|Saving Images in Flowcode]] - Creating images of your flowchart source
 
*[[Saving_Images_in_Flowcode|Saving Images in Flowcode]] - Creating images of your flowchart source
 
*[[Auto_Documentation|Auto Documentation]] - Auto documentation features to speed up development
 
*[[Auto_Documentation|Auto Documentation]] - Auto documentation features to speed up development
Line 97: Line 113:
 
*[[CAL_Components|CAL Components]] - Overview of code abstraction layer components
 
*[[CAL_Components|CAL Components]] - Overview of code abstraction layer components
 
*[[DSP|DSP Components]] - Overview of digital signal processing components
 
*[[DSP|DSP Components]] - Overview of digital signal processing components
 +
*[[GLCD|Graphical Display Components]] - Overview of graphical display components and associated libraries
 
*[[Component_Directories|Component Directories]] - Information on creating your own components directories
 
*[[Component_Directories|Component Directories]] - Information on creating your own components directories
 
*[[Editing_Key_Mappings|Editing Key Mappings]] - Assigning keyboard presses to functionality during simulation
 
*[[Editing_Key_Mappings|Editing Key Mappings]] - Assigning keyboard presses to functionality during simulation
 
*[[Remappable_Peripheral_Pins|Remappable Peripheral Pins]] - Assigning pins to peripherals on devices with re-mappable functionality.
 
*[[Remappable_Peripheral_Pins|Remappable Peripheral Pins]] - Assigning pins to peripherals on devices with re-mappable functionality.
 
==Component Creation==
 
<span id="Component_Creation"></span>
 
*[[New_Component_Features|New Component Features]] - Additional component creation features added in Flowcode 8
 
*[[Creating_a_Property|Creating a Property]] - How to create a property
 
*[[IO_Properties|IO Properties]] - How to create and use IO properties
 
*[[Panel_Managers|Component Configuration]] - Overview of the component creation panel managers
 
*[[Customising_A_Component|Customising A Component]] - Creating a new customised version of a component
 
*[[Assigning_Code_to_an_Existing_Component|Assigning Code to an Existing Component]] - Complementing or overriding an existing components functionality
 
*[[Base_Components|Base Components]] - The base components and their function
 
*[[Using_CAL_Components|Using CAL Components]] - Creating a component using CAL functionality (I2C / SPI / UART etc)
 
*[[Using_A_Base_Component|Using A Base Component]] - Creating a new component using a base component
 
*[[Exercises|Exercises]] - Worked exercises including creating components
 
*[[Number_Conversions|Example - Number Conversions]] - Creating a helper component to help convert between number systems Decimal, Hexadecimal and Binary
 
*[[Creating_a_two_wheeled_robot|Example - Creating a two-wheeled robot]] - Creating a 2 wheeled robot from scratch (simulation & downloadable)
 
  
 
==Chip Specifics==
 
==Chip Specifics==
 
<span id="Chip_Specifics"></span>
 
<span id="Chip_Specifics"></span>
 
*[[Compiling_a_Flowchart_to_a_Chip|Compiling a Flowchart to a Chip]] - Information on how to compile a flowchart into machine code
 
*[[Compiling_a_Flowchart_to_a_Chip|Compiling a Flowchart to a Chip]] - Information on how to compile a flowchart into machine code
 +
*[[Remappable Pin Table|Remappable Pin Table]] - Provides pin mappings and functionality for various microcontrollers and development boards.
 
*[[Internal_Oscillator|Internal Oscillator]] - Specifics on using an internal oscillator
 
*[[Internal_Oscillator|Internal Oscillator]] - Specifics on using an internal oscillator
 
*[[Phase_Locked_Loop_(PLL)|Phase Locked Loop (PLL)]] - Specifics on using a PLL frequency multiplier
 
*[[Phase_Locked_Loop_(PLL)|Phase Locked Loop (PLL)]] - Specifics on using a PLL frequency multiplier

Latest revision as of 12:17, 14 October 2024

This page provides a detailed guide to using Flowcode, covering various aspects of the software.

Here’s a brief summary of the sections:

  1. Getting Started: Instructions on activating Flowcode, navigating the interface, creating projects, configuring devices, and saving/loading projects. It also offers specific guides for embedded, PC, web, and Raspberry Pi development.
  2. Program Editing: Explains flowchart icons, adding/editing icons, code folding, grouping icons, simulating C code, converting C code to flowcharts, and multi-monitor support.
  3. Macros: Covers creating, editing, and deleting macros, along with exporting/importing macros and using the project explorer.
  4. Functions: Describes built-in mathematical and string manipulation functions, undo/redo operations, annotations, and find/replace functionality.
  5. Variables: Guides on creating, editing, and using different variable types, handles, typecasting, and state machines.
  6. Panels: Explains how to choose, manipulate, and control 2D and 3D simulation panels, including object positioning, scaling, and rotation.
  7. Tools and Views: Provides details on compiler toolchains, toolbars, project options, global settings, simulation debugging, and window layouts.
  8. Components: Information on components, including common ones, macros, properties, help files, CAL/DSP components, and remappable peripheral pins.
  9. Chip Specifics: Explains how to compile a flowchart into machine code, use oscillators, PLLs, interrupts, third-party programming tools, and manage compiler options.
  10. Support: Offers guidance on getting updates, reporting bugs, using licensed compilers, accessing technical support, and migrating from older Flowcode versions.

This overview serves as a comprehensive reference for users at any level, providing essential resources to navigate and maximize the use of Flowcode.

Getting Started

Program Editing

Macros

Functions

Variables

Panels

Tools and Views

Components

Chip Specifics

Support