Difference between revisions of "Flowcode Help Overview"

From Flowcode Help
Jump to navigationJump to search
 
(129 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<sidebar>Sidebar: Flowcode Help Overview</sidebar>
+
==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]] - Oveview of Flowcode IDE for the embedded side, with project examples
 +
* [[App_Developer_Getting_Started_Guide|App Developer Getting Started Guide]] - Oveview of Flowcode IDE for  App Developer, with project examples
 +
* [[Raspberry_Pi_Getting_Started_Guide|Raspberry Pi Getting Started Guide]] - Overview on setting up and programming the Raspbery pi.
 +
* [[Web_Developer_Getting_Started_Guide|Web Developer Getting Started Guide]] - Oveview of Flowcode IDE for Web Developer, with program examples ''<span style="color:red;">(Coming soon. Available with Flowcode 10.1 or higher)</span>''
  
==Version 6==
+
==Program Editing==
 +
<span id="Flowcharts"></span>
 +
*[[Icon_Properties|Icon Properties]] - Flowchart icons and their functionality
 +
*[[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
  
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
+
==Macros==
|-
+
<span id="Macros"></span>
! Title
+
*[[Creating_a_New_Macro|Creating a New Macro]] - Creating a new flowchart macro or subroutine
! Description
+
*[[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
| width="40%" align="center" | [[New_in_Version_6]]
+
*[[Exporting_a_Macro|Exporting a Macro]] - Exporting a macro from within Flowcode
| width="60%" |Introduction to new features in Flowcode 6 and other useful information
+
*[[Importing_a_Macro|Importing a Macro]] - Importing a macro into Flowcode
|-
 
| 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==
+
==Functions==
 +
<span id="Functions"></span>
 +
*[[Mathematical_Functions|Mathematical Functions]] - Built in routines designed to help with mathematical operations such as Sin() and Float
 +
*[[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
 +
*[[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
 +
 
 +
==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
  
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
+
==Tools and Views==
|-
+
<span id="Tools_and_Views"></span>
! Title
+
*[[Compiler_Toolchains|Compiler Toolchains]] - Toolchains used to compile to the various platforms Flowcode supports.
! Description
+
*[[Ribbon_Toolbar|Ribbon Toolbar]] - Detailed description of the Flowcode ribbon toolbars.
|-
+
*[[Project_Options|Project Options]] - Detailed help on the Project Options window
| width="40%" align="center" | [[New_in_Version_6]]
+
*[[Global_Settings|Global Settings]] - Detailed help on the Global Settings window
| width="60%" |Introduction to new features in Flowcode 6 and other useful information
+
*[[Chip_View|Chip View]] - The chip view window
|-
+
*[[Properties_Panel|Properties Panel]] - The properties panel
| width="40%" align="center" | [[Chips]]
+
*[[Supplementary_Code|Supplementary Code]] - Supplementary code and its usage
| width="60%" |Learn the basics of Flowcode and how to navigate the program
+
*[[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
| width="40%" align="center" | [[Migrating_to_V6]]  
+
*[[Auto_Documentation|Auto Documentation]] - Auto documentation features to speed up development
| width="60%" |Creating your first Flowcode flowchart and see the options available
+
*[[Window_Layouts|Window Layouts]] - The window layouts manager
|}
 
  
==Getting Started==
+
==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
 +
*[[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
+
*[[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
| width="40%" align="center" | [[Introduction]]
+
*[[Interrupts|Interrupts]] - Built in interrupts for your hardware
| width="60%" |Introduction to new features in Flowcode 6 and other useful information
+
*[[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
| width="40%" align="center" | [[Getting Started]]
+
*[[Viewing_Code_Output|Viewing Code Output]] - Viewing the code generated by Flowcode
| width="60%" |Learn the basics of Flowcode and how to navigate the program
+
*[[Managing_Compiler_Options|Managing Compiler Options]] - Overview of the compiler options settings
|-
+
*[[FCD_Data_Collection|FCD Data Collection]] - Chip definition files and how to collect data from them
| width="40%" align="center" | [[What Is a Flowcode Flowchart?]]
 
| 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 08:47, 4 December 2023

Getting Started

Program Editing

Macros

Functions

Variables

Panels

Tools and Views

Components

Chip Specifics

Support