Difference between revisions of "Flowcode Help Overview"

From Flowcode Help
Jump to navigationJump to search
 
(167 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<sidebar>Help Contents</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
 +
* [[Configuring_the_Chip|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
  
{| class="wikitable"
+
==Using the Flowchart==
|-
+
<span id="Flowcharts"></span>
! colspan="2" | [[Introduction]]
+
*[[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
| width="40%" | [[New In Version 6]]
+
*[[Editing_Icon_Properties|Editing Icon Properties]] - Editing the properties of a flowchart icon
| New things...
+
*[[Adding_Comments_to_a_Flowchart|Adding Comments to a Flowchart]] - Commenting your flowchart
|-
+
*[[Selecting_Icons|Selecting Icons]] - Selecting icons on the flowchart
| width="40%" | [[Chips]]
+
*[[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
| width="40%" | [[Technical Support]]
+
*[[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
| width="40%" | [[Licensed Compiler]]
+
*[[Tab_Tear_Off_-_Multi_Monitor_Support|Tab Tear Off - Multi Monitor Support]] - How to manage tabs on multi-monitor systems
|
+
 
|-
+
==Macros==
! colspan="2" | [[Getting Started]]
+
<span id="Macros"></span>
|-
+
*[[Creating_a_New_Macro|Creating a New Macro]] - Creating a new flowchart macro or subroutine
| width="40%" | [[Developing a Flowchart for a Chip]]
+
*[[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
| width="40%" | [[Tools and Views]]
+
*[[Importing_a_Macro|Importing a Macro]] - Importing a macro into Flowcode
|
+
 
|-
+
==Functions==
| width="40%" | [[Zooming the View]]
+
<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
| width="40%" | [[Selecting a Target Chip]]
+
*[[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
| width="40%" | [[Project Options]]
+
 
|
+
==Variables==
|-
+
<span id="Variables"></span>
| width="40%" | [[Activating Flowcode]]
+
*[[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
| width="40%" | [[Creating a Project Report]]
+
*[[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
! colspan="2" | [[Working With Flowchart Files]]
+
 
|-
+
==Panels==
| width="40%" | [[Running Flowcode]]
+
<span id="Panels"></span>
|
+
*[[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
| width="40%" | [[Creating a New Flowchart]]
+
*[[System_Panel|System Panel]] - More in depth information on the system panel
|
+
*[[Zooming_the_View|Zooming the View]] - Zooming in and out on panels
|-
+
*[[Camera_Control|Camera Control]] - Controlling the camera looking at the panel
| width="40%" | [[Opening an Existing Flowchart]]
+
*[[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
| width="40%" | [[Saving a Flowchart]]
+
*[[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
| width="40%" | [[Printing Flowcharts]]
+
 
|
+
==Tools and Views==
|-
+
<span id="Tools_and_Views"></span>
| width="40%" | [[Saving a Flowchart Image]]
+
*[[Tools_and_Views|Tools and Views]] - Various tools and views available inside Flowcode
|
+
*[[Project_Options|Project Options]] - Detailed help on the Project Options window
|-
+
*[[Global_Options|Global Options]] - Detailed help on the Global Options window
| width="40%" | [[Closing Flowcode]]
+
*[[Chip_View|Chip View]] - The chip view window
|
+
*[[Properties_Panel|Properties Panel]] - The properties panel
|-
+
*[[Supplementary_Code|Supplementary Code]] - Supplementary code and its usage
| width="40%" | [[Global Options]]
+
*[[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
! colspan="2" | [[Creating and Editing Flowcharts]]
+
 
|-
+
==Components==
| width="40%" | [[Adding an Icon to a Flowchart]]
+
<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
| width="40%" | [[Selecting Icons]]
+
*[[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
| width="40%" | [[Flowchart Editing Functions]]
+
*[[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
| width="40%" | [[Undo and Redo]]
+
*[[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
| width="40%" | [[Using the Project Explorer]]
+
*[[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.
|-
+
 
| width="40%" | [[Find and Replace]]
+
==Chip Specifics==
|
+
<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
| width="40%" | [[Using the Icon Lists Pane]]
+
*[[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
|-
+
*[[Interrupts|Interrupts]] - Built in interrupts for your hardware
| width="40%" | [[Supplementary Code]]
+
*[[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
| width="40%" | [[Using Masks]]
+
*[[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%" | [[Disabling Icons]]
+
==Support==
|
+
<span id="Support"></span>
|-
+
*[[Dynamic_Updates|Dynamic Updates]] - Getting updates and using older versions
| width="40%" | [[Icon Annotations]]
+
*[[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
! width="40%" | [[Icon Properties]]
+
*[[Migrating_from_older_versions|Migrating from Older Versions]] - Help on updating your projects from previous Flowcode versions
! Editing the properties of each individual icon
+
*[[Version_Updates|Version Updates]] - See what features have been added to Flowcode for each version.
|-
 
! colspan="2" | [[Adding and Editing Components]]  
 
|-
 
| width="40%" | [[Adding Components]]
 
|
 
|-
 
| width="40%" | [[Editing Component Connections]]
 
|
 
|-
 
| width="40%" | [[Component Help Files]]
 
|
 
|-
 
| width="40%" | [[Component Properties]]
 
|
 
|-
 
! colspan="2" | [[Working With Macros and Variables]]
 
|-
 
| width="40%" | [[Variable Manager]]
 
|
 
|-
 
| width="40%" | [[Creating Variables]]
 
|
 
|-
 
| width="40%" | [[Variable Types]]
 
|
 
|-
 
| width="40%" | [[Editing Variables]]
 
|
 
|-
 
| width="40%" | [[Creating a New Macro]]
 
|
 
|-
 
| width="40%" | [[Editing and Deleting Macros]]
 
|
 
|-
 
| width="40%" | [[Exporting a Macro]]
 
|
 
|-
 
| width="40%" | [[Importing a Macro]]
 
|
 
|-
 
| width="40%" | [[Custom Interrupts - PICmicro]]
 
|
 
|-
 
| width="40%" | [[Custom Interrupts - AVR]]
 
|
 
|-
 
| width="40%" | [[Custom Interrupts - ARM]]
 
|
 
|-
 
| width="40%" | [[Custom Interrupts - dsPIC/PIC24]]
 
|
 
|-
 
| width="40%" | [[Mathematical Functions]]
 
|
 
|-
 
| width="40%" | [[String Manipulation Functions]]
 
|
 
|-
 
! colspan="2" | [[Simulating a Flowchart]]  
 
|-
 
| width="40%" | [[Starting Flowchart Simulation]]
 
|
 
|-
 
| width="40%" | [[Simulating Icons Step by Step]]
 
|
 
|-
 
| width="40%" | [[Changing the Speed of a Simulation]]
 
|
 
|-
 
| width="40%" | [[Pausing and Stopping a Simulation]]
 
|
 
|-
 
| width="40%" | [[Watch Window]]
 
| (Variables Window)
 
|-
 
| width="40%" | [[Call Stack Window]]
 
|
 
|-
 
| width="40%" | [[In Circuit Debugging]]
 
|
 
|-
 
| width="40%" | [[Editing Key Mappings]]
 
|
 
|-
 
! colspan="2" | [[Compiling Flowcharts to Devices]]
 
|-
 
| width="40%" | [[Specifying a Target Chip]]
 
|
 
|-
 
| width="40%" | [[Configuring the Chip]]
 
|
 
|-
 
| width="40%" | [[Compiling a Flowchart to a Chip]]
 
|
 
|-
 
| width="40%" | [[Managing Compiler Options]]
 
|
 
|-
 
| width="40%" | [[Selecting Compiler Options (PICmicro)]]
 
|
 
|-
 
| width="40%" | [[Selecting Compiler Options (AVR)]]
 
|  
 
|-
 
| width="40%" | [[Selecting Compiler Options (ARM)]]
 
|
 
|-
 
| width="40%" | [[Selecting Compiler Options (dsPIC/PIC24)]]
 
|
 
|-
 
| width="40%" | [[Supporting Third Party Programming Tools]]
 
|
 
|-
 
| width="40%" | [[Viewing Code Output]]
 
|
 
|}
 

Latest revision as of 07:34, 2 July 2019

Getting Started

Using the Flowchart

Macros

Functions

Variables

Panels

Tools and Views

Components

Chip Specifics

Support