Difference between revisions of "Flowcode Help Overview"
From Flowcode Help
Jump to navigationJump to search| (64 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | This page provides a detailed guide to using Flowcode, covering various aspects of the software. | |
| − | |||
| − | |||
| − | |||
| − | + | Here’s a brief summary of the sections: | |
| − | + | ||
| − | + | # 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 15: | 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_Project|Creating Project]] - Creating your first Flowcode project and see the options available |
| − | * [[ | + | * [[Creating_Project#Changing_configuration_settings|Configuring the Chip]] - Configuring your device |
| − | + | * [[Save_and_Open_Projects|Save and Open Projects]] - Saving and Opening Flowcode project files | |
| − | * [[ | ||
* [[Selecting_a_Template|Selecting a Template]] - Opening a template project file | * [[Selecting_a_Template|Selecting a Template]] - Opening a template project file | ||
| − | |||
* [[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 | ||
| − | == | + | ==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 38: | 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 53: | Line 62: | ||
*[[String_Manipulation_Functions|String Manipulation Functions]] - Built in routines designed to help with string manipulation | *[[String_Manipulation_Functions|String Manipulation Functions]] - Built in routines designed to help with string manipulation | ||
*[[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 | + | *[[Find_and_Replace|Find and Replace]] - Ability to search within your Flowcode project to replace specific text with alternate text |
==Variables== | ==Variables== | ||
| Line 62: | Line 70: | ||
*[[Variable_Types|Variable Types]] - Variable types and their meanings | *[[Variable_Types|Variable Types]] - Variable types and their meanings | ||
*[[Editing_Variables|Editing Variables]] - How to edit a variable | *[[Editing_Variables|Editing Variables]] - How to edit a variable | ||
| − | |||
*[[Handles|Handles]] - Handle variables and their function within the system | *[[Handles|Handles]] - Handle variables and their function within the system | ||
*[[Typecasting|Typecasting]] - Variable type casting, applications and usage | *[[Typecasting|Typecasting]] - Variable type casting, applications and usage | ||
| − | *[[FiniteStateMachine]] - Programming tutorial on using state machines | + | *[[FiniteStateMachine|Finite State Machines]] - Programming tutorial on using state machines |
==Panels== | ==Panels== | ||
<span id="Panels"></span> | <span id="Panels"></span> | ||
| − | *[[ | + | *[[Choosing_your_Simulation_Panel|Choosing your Simulation Panel]] - Information about choosing the correct panel |
| − | + | *[[2d_Panels|2D Panels]] - More in-depth information on the 2D panels | |
| − | *[[ | + | *[[System_Panel|3D System Panel]] - More in-depth information on the 3D system panel |
| − | *[[System_Panel]] - More in depth information on the system panel | + | *[[Zooming_the_View|Zooming the View]] - Zooming in and out on the 3D system panel |
| − | *[[Zooming_the_View]] - Zooming in and out on | + | *[[Camera_Control|Camera Control]] - Controlling the camera looking at the panel |
| − | *[[Camera_Control]] - Controlling the camera looking at the panel | + | *[[Object_Position|Object Position]] - Object positioning on the panels |
| − | *[[Object_Position]] - Object positioning on the panels | + | *[[Object_Scale|Object Scale]] - Objects and their scale |
| − | + | *[[Object_Rotation|Object Rotation]] - Rotating objects | |
| − | *[[Object_Scale]] - Objects and their scale | + | *[[Working_With_Primitives|Working With Primitives]] - Using primitive objects inside Flowcode |
| − | *[[Object_Rotation]] - Rotating objects | + | *[[Working_With_Meshes|Working With Meshes]] - Using meshes inside Flowcode |
| − | *[[Working_With_Primitives]] - Using primitive objects inside Flowcode | ||
| − | *[[Working_With_Meshes]] - Using meshes inside Flowcode | ||
==Tools and Views== | ==Tools and Views== | ||
<span id="Tools_and_Views"></span> | <span id="Tools_and_Views"></span> | ||
| − | *[[ | + | *[[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 | |
| − | *[[ | + | *[[Global_Settings|Global Settings]] - Detailed help on the Global Settings window |
| − | + | *[[Chip_View|Chip View]] - The chip view window | |
| − | *[[Project_Options]] - Detailed help on the Project Options window | + | *[[Properties_Panel|Properties Panel]] - The properties panel |
| − | *[[ | + | *[[Supplementary_Code|Supplementary Code]] - Supplementary code and its usage |
| − | *[[Chip_View]] - The chip view | + | *[[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 | |
| − | *[[Properties_Panel]] - The properties panel | + | *[[Auto_Documentation|Auto Documentation]] - Auto documentation features to speed up development |
| − | *[[ | + | *[[Window_Layouts|Window Layouts]] - The window layouts manager |
| − | *[[ | ||
| − | |||
| − | *[[Saving_Images_in_Flowcode]] - Creating images of your flowchart source | ||
| − | *[[Auto_Documentation]] - Auto documentation features to speed up development | ||
| − | *[[Window_Layouts]] - The window layouts manager | ||
| − | |||
| − | |||
==Components== | ==Components== | ||
<span id="Components"></span> | <span id="Components"></span> | ||
| − | *[[Component]] - Information about what a component is and how they work inside the Flowcode environment. | + | *[[Component|Components]] - Information about what a component is and how they work inside the Flowcode environment. |
| − | *[[Common_Components]] - Information on some of the more commonly used | + | *[[Common_Components|Common Components]] - Information on some of the more commonly used components |
| − | + | *[[Selecting_Component_Macros|Selecting Component Macros]] - Information on how to use component macros | |
| − | + | *[[Component_Help_Files|Component Help Files]] - How to get access to component help via Flowcode | |
| − | + | *[[Components|Components]] - Component help overview | |
| − | + | *[[Component_Properties|Component Properties]] - Information on how to use component properties | |
| − | + | *[[Component_Tree|Component Tree]] - Information regarding the component tree hierarchy | |
| − | *[[Selecting_Component_Macros]] - Information on how to use component macros | + | *[[Replacing_a_Component|Replacing a Component]] - Replacing one component with another |
| − | *[[Component_Help_Files]] - How to get access to component help via Flowcode | + | *[[CAL_Components|CAL Components]] - Overview of code abstraction layer components |
| − | *[[Components]] - Component help overview | ||
| − | *[[Component_Properties]] - Information on how to use component properties | ||
| − | *[[Component_Tree]] - Information regarding the component tree hierarchy | ||
| − | *[[Replacing_a_Component]] - Replacing one component with another | ||
| − | *[[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]] - Information on creating your own components directories | + | *[[Component_Directories|Component Directories]] - Information on creating your own components directories |
| − | *[[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]] - 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. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Chip Specifics== | ==Chip Specifics== | ||
<span id="Chip_Specifics"></span> | <span id="Chip_Specifics"></span> | ||
| − | *[[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 |
| − | *[[Internal_Oscillator]] - Specifics on using an internal oscillator | + | *[[Remappable Pin Table|Remappable Pin Table]] - Provides pin mappings and functionality for various microcontrollers and development boards. |
| − | *[[Phase_Locked_Loop_(PLL)]] - Specifics on using a PLL frequency multiplier | + | *[[Internal_Oscillator|Internal Oscillator]] - Specifics on using an internal oscillator |
| − | *[[Interrupts]] - Built in interrupts for your hardware | + | *[[Phase_Locked_Loop_(PLL)|Phase Locked Loop (PLL)]] - Specifics on using a PLL frequency multiplier |
| − | *[[Custom_Interrupts]] - Custom interrupts for your hardware | + | *[[Interrupts|Interrupts]] - Built in interrupts for your hardware |
| − | + | *[[Custom_Interrupts|Custom Interrupts]] - Custom interrupts for your hardware | |
| − | + | *[[Supporting_Third_Party_Programming_Tools|Supporting Third Party Programming Tools]] - Using 3rd party programmers such as PICkit and Arduino | |
| − | + | *[[Viewing_Code_Output|Viewing Code Output]] - Viewing the code generated by Flowcode | |
| − | + | *[[Managing_Compiler_Options|Managing Compiler Options]] - Overview of the compiler options settings | |
| − | *[[Supporting_Third_Party_Programming_Tools]] - Using 3rd party programmers such as PICkit and Arduino | + | *[[FCD_Data_Collection|FCD Data Collection]] - Chip definition files and how to collect data from them |
| − | *[[Viewing_Code_Output]] - Viewing the code generated by Flowcode | ||
| − | *[[Managing_Compiler_Options]] - Overview of the compiler options settings | ||
| − | *[[FCD_Data_Collection]] - Chip definition files and how to collect data from them | ||
==Support== | ==Support== | ||
<span id="Support"></span> | <span id="Support"></span> | ||
| − | *[[Dynamic_Updates]] - Getting updates and using older versions | + | *[[Dynamic_Updates|Dynamic Updates]] - Getting updates and using older versions |
| − | + | *[[Reporting_a_Bug|Reporting a Bug]] - How to report a bug in Flowcode | |
| − | *[[Reporting_a_Bug]] - How to report a bug in Flowcode | + | *[[Licensed_Compiler|Licensed Compiler]] - Compiler specifics and license agreement |
| − | *[[Licensed_Compiler]] - Compiler specifics and license agreement | + | *[[Technical_Support|Technical Support]] - Information on how to get further support |
| − | *[[Technical_Support]] - Information on how to get further support | + | *[[Migrating_from_older_versions|Migrating from Older Versions]] - Help on updating your projects from previous Flowcode versions |
| + | *[[Version_Updates|Version Updates]] - See what features have been added to Flowcode for each version. | ||
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:
- 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.
Contents
Getting Started
- Activating Flowcode - Activating your Flowcode license
- Opening Flowcode - Launching the Flowcode application
- Finding Your Way Around Flowcode - Finding your way around
- Creating Project - Creating your first Flowcode project and see the options available
- Configuring the Chip - Configuring your device
- Save and Open Projects - Saving and Opening Flowcode project files
- Selecting a Template - Opening a template project file
- Creating Templates - Creating your own templates
- Closing Flowcode - Closing Flowcode
- Embedded Getting Started Guide - Overview of Flowcode IDE for the embedded side, with project examples
- PC Developer Getting Started Guide - Overview of Flowcode IDE for PC Developer, with project examples
- Web Developer Getting Started Guide - Overview of Flowcode IDE for Web Developer, with program examples
- Raspberry Pi Getting Started Guide - Overview on setting up and programming the Raspberry Pi
Program Editing
- Icon Properties - Flowchart icons and their functionality
- Remappable Pin Table - Provides pin mappings and functionality for various microcontrollers and development boards.
- Adding an Icon to a Flowchart - Adding flowchart icons to your program
- Editing Icon Properties - Editing the properties of a flowchart icon
- Adding Comments to a Flowchart - Commenting your flowchart
- Selecting Icons - Selecting icons on the flowchart
- Flowchart Editing Functions - Functions to make editing your flowchart easier
- Code Folding - Compressing known working code to increase screen real estate
- Icon Grouping - Combining multiple icons together into a single group icon
- C Code Simulation - Simulating C code in your program
- C Code to Flowchart Conversion - Converting a section of C code into Flowchart icons
- Code Paradigms - Coding Paradigms - Flowchart, Blocks, Pseudocode, C Code
- State Diagrams - State Diagrams - Support for using the State Diagram coding paradigm
- Tab Tear Off - Multi Monitor Support - How to manage tabs on multi-monitor systems
Macros
- Creating a New Macro - Creating a new flowchart macro or subroutine
- Editing and Deleting Macros - Editing a macro and removing a macro from your program
- Using the Project Explorer - Features of the project explorer designed to help simplify programming
- Exporting a Macro - Exporting a macro from within Flowcode
- Importing a Macro - Importing a macro into Flowcode
Functions
- Mathematical Functions - Built in routines designed to help with mathematical operations such as Sin() and Float
- String Manipulation Functions - Built in routines designed to help with string manipulation
- Undo and Redo - Undo and Redo operations and shortcuts
- Icon Annotations - Icon annotations
- Find and Replace - Ability to search within your Flowcode project to replace specific text with alternate text
Variables
- Creating Variables - How to create a variable
- Variable Types - Variable types and their meanings
- Editing Variables - How to edit a variable
- Handles - Handle variables and their function within the system
- Typecasting - Variable type casting, applications and usage
- Finite State Machines - Programming tutorial on using state machines
Panels
- Choosing your Simulation Panel - Information about choosing the correct panel
- 2D Panels - More in-depth information on the 2D panels
- 3D System Panel - More in-depth information on the 3D system panel
- Zooming the View - Zooming in and out on the 3D system panel
- Camera Control - Controlling the camera looking at the panel
- Object Position - Object positioning on the panels
- Object Scale - Objects and their scale
- Object Rotation - Rotating objects
- Working With Primitives - Using primitive objects inside Flowcode
- Working With Meshes - Using meshes inside Flowcode
Tools and Views
- Compiler Toolchains - Toolchains used to compile to the various platforms Flowcode supports.
- Ribbon Toolbar - Detailed description of the Flowcode ribbon toolbars.
- Project Options - Detailed help on the Project Options window
- Global Settings - Detailed help on the Global Settings window
- Chip View - The chip view window
- Properties Panel - The properties panel
- Supplementary Code - Supplementary code and its usage
- Simulation Debugger - Control over the simulation speed and view simulated variable values, also known previously as the watch window
- Saving Images in Flowcode - Creating images of your flowchart source
- Auto Documentation - Auto documentation features to speed up development
- Window Layouts - The window layouts manager
Components
- Components - Information about what a component is and how they work inside the Flowcode environment.
- Common Components - Information on some of the more commonly used components
- Selecting Component Macros - Information on how to use component macros
- Component Help Files - How to get access to component help via Flowcode
- Components - Component help overview
- Component Properties - Information on how to use component properties
- Component Tree - Information regarding the component tree hierarchy
- Replacing a Component - Replacing one component with another
- CAL Components - Overview of code abstraction layer components
- DSP Components - Overview of digital signal processing components
- Graphical Display Components - Overview of graphical display components and associated libraries
- Component Directories - Information on creating your own components directories
- Editing Key Mappings - Assigning keyboard presses to functionality during simulation
- Remappable Peripheral Pins - Assigning pins to peripherals on devices with re-mappable functionality.
Chip Specifics
- Compiling a Flowchart to a Chip - Information on how to compile a flowchart into machine code
- Remappable Pin Table - Provides pin mappings and functionality for various microcontrollers and development boards.
- Internal Oscillator - Specifics on using an internal oscillator
- Phase Locked Loop (PLL) - Specifics on using a PLL frequency multiplier
- Interrupts - Built in interrupts for your hardware
- Custom Interrupts - Custom interrupts for your hardware
- Supporting Third Party Programming Tools - Using 3rd party programmers such as PICkit and Arduino
- Viewing Code Output - Viewing the code generated by Flowcode
- Managing Compiler Options - Overview of the compiler options settings
- FCD Data Collection - Chip definition files and how to collect data from them
Support
- Dynamic Updates - Getting updates and using older versions
- Reporting a Bug - How to report a bug in Flowcode
- Licensed Compiler - Compiler specifics and license agreement
- Technical Support - Information on how to get further support
- Migrating from Older Versions - Help on updating your projects from previous Flowcode versions
- Version Updates - See what features have been added to Flowcode for each version.
