Difference between revisions of "Flowcode Help Overview"

From Flowcode Help
Jump to navigationJump to search
 
(136 intermediate revisions by 7 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.
  
−
==Version 6==
+
Here’s a brief summary of the sections:
  
−
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
+
# 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.
−
! Title
+
# Macros: Covers creating, editing, and deleting macros, along with exporting/importing macros and using the project explorer.
−
! Description
+
# 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.
−
| width="40%" align="center" | [[New_in_Version_6]]
+
# Panels: Explains how to choose, manipulate, and control 2D and 3D simulation panels, including object positioning, scaling, and rotation.
−
| width="60%" |Introduction to new features in Flowcode 6 and other useful information
+
# 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.
−
| width="40%" align="center" | [[Chips]]
+
# Chip Specifics: Explains how to compile a flowchart into machine code, use oscillators, PLLs, interrupts, third-party programming tools, and manage compiler options.
−
| width="60%" |Learn the basics of Flowcode and how to navigate the program
+
# Support: Offers guidance on getting updates, reporting bugs, using licensed compilers, accessing technical support, and migrating from older Flowcode versions.
−
|-
+
 
−
| width="40%" align="center" | [[Migrating_to_V6]]
+
This overview serves as a comprehensive reference for users at any level, providing essential resources to navigate and maximize the use of Flowcode.
−
| width="60%" |Creating your first Flowcode flowchart and see the options available
 
−
|}
 
  
 
==Getting Started==
 
==Getting Started==
 +
<span id="Getting_Started"></span>
 +
* [[Activating_Flowcode|Activating Flowcode]] - Activating your Flowcode license
 +
* [[Opening_Flowcode|Opening Flowcode]] - Launching the Flowcode application
 +
* [[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
 +
* [[Creating_Templates|Creating Templates]] - Creating your own templates
 +
* [[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>
 +
*[[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
 +
*[[Editing_Icon_Properties|Editing Icon Properties]] - Editing the properties of a flowchart icon
 +
*[[Adding_Comments_to_a_Flowchart|Adding Comments to a Flowchart]] - Commenting your flowchart
 +
*[[Selecting_Icons|Selecting Icons]] - Selecting icons on the flowchart
 +
*[[Flowchart_Editing_Functions|Flowchart Editing Functions]] - Functions to make editing your flowchart easier
 +
*[[Code_Folding|Code Folding]] - Compressing known working code to increase screen real estate
 +
*[[Icon_Grouping|Icon Grouping]] - Combining multiple icons together into a single group icon
 +
*[[C_Code_Simulation|C Code Simulation]] - Simulating C code in your program
 +
*[[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
 +
*[[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
 +
 +
==Macros==
 +
<span id="Macros"></span>
 +
*[[Creating_a_New_Macro|Creating a New Macro]] - Creating a new flowchart macro or subroutine
 +
*[[Editing_and_Deleting_Macros|Editing and Deleting Macros]] - Editing a macro and removing a macro from your program
 +
*[[Using_the_Project_Explorer|Using the Project Explorer]] - Features of the project explorer designed to help simplify programming
 +
*[[Exporting_a_Macro|Exporting a Macro]] - Exporting a macro from within Flowcode
 +
*[[Importing_a_Macro|Importing a Macro]] - Importing a macro into Flowcode
  
−
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
+
==Functions==
−
|-
+
<span id="Functions"></span>
−
! Title
+
*[[Mathematical_Functions|Mathematical Functions]] - Built in routines designed to help with mathematical operations such as Sin() and Float
−
! Description
+
*[[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
−
| width="40%" align="center" | [[New_in_Version_6]]
+
*[[Icon_Annotations|Icon Annotations]] - Icon annotations
−
| width="60%" |Introduction to new features in Flowcode 6 and other useful information
+
*[[Find_and_Replace|Find and Replace]] - Ability to search within your Flowcode project to replace specific text with alternate text
−
|-
 
−
| width="40%" align="center" | [[Chips]]
 
−
| width="60%" |Learn the basics of Flowcode and how to navigate the program
 
−
|-
 
−
| width="40%" align="center" | [[Migrating_to_V6]]  
 
−
| width="60%" |Creating your first Flowcode flowchart and see the options available
 
−
|}
 
  
−
==Getting Started==
+
==Variables==
 +
<span id="Variables"></span>
 +
*[[Creating_Variables|Creating Variables]] - How to create a variable
 +
*[[Variable_Types|Variable Types]] - Variable types and their meanings
 +
*[[Editing_Variables|Editing Variables]] - How to edit a variable
 +
*[[Handles|Handles]] - Handle variables and their function within the system
 +
*[[Typecasting|Typecasting]] - Variable type casting, applications and usage
 +
*[[FiniteStateMachine|Finite State Machines]] - Programming tutorial on using state machines
 +
 
 +
==Panels==
 +
<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
 +
*[[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
 +
*[[Object_Position|Object Position]] - Object positioning on the panels
 +
*[[Object_Scale|Object Scale]] - Objects and their scale
 +
*[[Object_Rotation|Object Rotation]] - Rotating objects
 +
*[[Working_With_Primitives|Working With Primitives]] - Using primitive objects inside Flowcode
 +
*[[Working_With_Meshes|Working With Meshes]] - Using meshes inside Flowcode
 +
 
 +
==Tools and Views==
 +
<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
 +
*[[Properties_Panel|Properties Panel]] - The properties panel
 +
*[[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
 +
*[[Auto_Documentation|Auto Documentation]] - Auto documentation features to speed up development
 +
*[[Window_Layouts|Window Layouts]] - The window layouts manager
 +
 
 +
==Components==
 +
<span id="Components"></span>
 +
*[[Component|Components]] - Information about what a component is and how they work inside the Flowcode environment.
 +
*[[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
 +
*[[Replacing_a_Component|Replacing a Component]] - Replacing one component with another
 +
*[[CAL_Components|CAL Components]] - Overview of code abstraction layer 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
 +
*[[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.
  
−
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
+
==Chip Specifics==
−
|-
+
<span id="Chip_Specifics"></span>
−
! Title
+
*[[Compiling_a_Flowchart_to_a_Chip|Compiling a Flowchart to a Chip]] - Information on how to compile a flowchart into machine code
−
! Description
+
*[[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
−
| width="40%" align="center" | [[Introduction]]
+
*[[Phase_Locked_Loop_(PLL)|Phase Locked Loop (PLL)]] - Specifics on using a PLL frequency multiplier
−
| width="60%" |Introduction to new features in Flowcode 6 and other useful information
+
*[[Interrupts|Interrupts]] - Built in interrupts for your hardware
−
|-
+
*[[Custom_Interrupts|Custom Interrupts]] - Custom interrupts for your hardware
−
| width="40%" align="center" | [[Getting Started]]
+
*[[Supporting_Third_Party_Programming_Tools|Supporting Third Party Programming Tools]] - Using 3rd party programmers such as PICkit and Arduino
−
| width="60%" |Learn the basics of Flowcode and how to navigate the program
+
*[[Viewing_Code_Output|Viewing Code Output]] - Viewing the code generated by Flowcode
−
|-
+
*[[Managing_Compiler_Options|Managing Compiler Options]] - Overview of the compiler options settings
−
| width="40%" align="center" | [[What Is a Flowcode Flowchart?]]  
+
*[[FCD_Data_Collection|FCD Data Collection]] - Chip definition files and how to collect data from them
−
| width="60%" |Creating your first Flowcode flowchart and see the options available
 
−
|-
 
−
| width="40%" align="center" | [[Controlling Electronic Devices With Flowcode]]  
 
−
| width="60%" |Introduction to components, variables, icons, dashboard and system panels
 
−
|-
 
−
| width="40%" align="center" | [[Overview of Simulation]]
 
−
| width="60%" |Learn how to use simulation effectively including the features available
 
−
|-
 
−
| width="40%" align="center" | [[Adding Finishing Touches]]
 
−
| width="60%" |Organizing and documenting flowcharts and compiling to a chip
 
−
|-
 
−
| width="40%" align="center" | [[Taking Flowcode Further]]
 
−
| width="60%" |Learn useful functions and make the most out of tools and features
 
−
|-
 
−
| width="40%" align="center" | [[What Is a Macro?]]
 
−
| width="60%" |Introduction to macros, component macros and supplementary code
 
−
|-
 
−
| width="40%" align="center" | [[What Is an Interrupt?]]
 
−
| width="60%" |Introduction to interrupts, custom interrupts and debugging
 
−
|-
 
−
| width="40%" align="center" | [[What Is a Component?]]
 
−
| width="60%" |Introduction to components and explanation of main components
 
−
|-
 
−
| width="40%" align="center" | [[Advanced Features]]
 
−
| width="60%" |Further explanation of more advanced components and features available.
 
−
|}
 
  
−
==Flowcode Methodology==
+
==Support==
 +
<span id="Support"></span>
 +
*[[Dynamic_Updates|Dynamic Updates]] - Getting updates and using older versions
 +
*[[Reporting_a_Bug|Reporting a Bug]] - How to report a bug in Flowcode
 +
*[[Licensed_Compiler|Licensed Compiler]] - Compiler specifics and license agreement
 +
*[[Technical_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:

  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

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Flowcode_Help_Overview&oldid=41330"