Difference between revisions of "Flowcode Help Overview"

From Flowcode Help
Jump to navigationJump to search
Line 54: Line 54:
 
| width="40%" align="center" | [[Closing_Flowcode]]
 
| width="40%" align="center" | [[Closing_Flowcode]]
 
| width="60%" |Closing Flowcode
 
| width="60%" |Closing Flowcode
 +
|}
 +
 +
==Flowcharts==
 +
 +
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
 +
|-
 +
! Title
 +
! Description
 +
|-
 +
| width="40%" align="center" | [[Icon_Properties]]
 +
| width="60%" |Flowchart icons and their functionality
 +
|-
 +
| width="40%" align="center" | [[Adding_an_Icon_to_a_Flowchart]]
 +
| width="60%" |Adding flowchart icons to your program
 +
|-
 +
| width="40%" align="center" | [[Editing_Icon_Properties]]
 +
| width="60%" |Editing the properties of a flowchart icon
 +
|-
 +
| width="40%" align="center" | [[Adding_Comments_to_a_Flowchart]]
 +
| width="60%" |Commenting your flowchart
 +
|-
 +
| width="40%" align="center" | [[Selecting_Icons]]
 +
| width="60%" |Selecting icons on the flowchart
 +
|-
 +
| width="40%" align="center" | [[Flowchart_Editing_Functions]]
 +
| width="60%" |Functions to make editing your flowchart easier
 +
|-
 +
| width="40%" align="center" | [[Printing_Flowcharts]]
 +
| width="60%" |Printing out a flowchart
 +
|}
 +
 +
==Macros==
 +
 +
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
 +
|-
 +
! Title
 +
! Description
 +
|-
 +
| width="40%" align="center" | [[Creating_a_New_Macro]]
 +
| width="60%" |Creating a new flowchart macro or subroutine
 +
|-
 +
| width="40%" align="center" | [[Editing_and_Deleting_Macros]]
 +
| width="60%" |Editing a macro and removing a macro from your program
 +
|-
 +
| width="40%" align="center" | [[Using_the_Project_Explorer]]
 +
| width="60%" |Features of the project explorer designed to help simplify programming
 +
|-
 +
| width="40%" align="center" | [[Exporting_a_Macro]]
 +
| width="60%" |Exporting a macro from within Flowcode
 +
|-
 +
| width="40%" align="center" | [[Importing_a_Macro]]
 +
| width="60%" |Importing a macro into Flowcode
 +
|-
 +
| width="40%" align="center" | [[DLL_Support]]
 +
| width="60%" |Changing the nature of a macro to instead call a external DLL function
 +
|}
 +
 +
==Functions==
 +
 +
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
 +
|-
 +
! Title
 +
! Description
 +
|-
 +
| width="40%" align="center" | [[Mathematical_Functions]]
 +
| width="60%" |Built in routines designed to help with mathematical operations such as Sin() and Float
 +
|-
 +
| width="40%" align="center" | [[String_Manipulation_Functions]]
 +
| width="60%" |Built in routines designed to help with string manipulation
 +
|-
 +
| width="40%" align="center" | [[Undo_and_Redo]]
 +
| width="60%" |Undo and Redo operations and shortcuts
 +
|-
 +
| width="40%" align="center" | [[Disabling_Icons]]
 +
| width="60%" |Disabling flowchart icons to comment out sections of code
 +
|-
 +
| width="40%" align="center" | [[Icon_Annotations]]
 +
| width="60%" |Icon annotations
 +
|-
 +
| width="40%" align="center" | [[Find_and_Replace]]
 +
| width="60%" |Ability to search within your flowcode project to replace specific text with alternate text
 +
|}
 +
 +
==Variables==
 +
 +
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
 +
|-
 +
! Title
 +
! Description
 +
|-
 +
| width="40%" align="center" | [[Creating_Variables]]
 +
| width="60%" |How to create a variable
 +
|-
 +
| width="40%" align="center" | [[Variable_Types]]
 +
| width="60%" |Variable types and their meanings
 +
|-
 +
| width="40%" align="center" | [[Editing_Variables]]
 +
| width="60%" |How to edit a variable
 +
|-
 +
| width="40%" align="center" | [[Variable_Manager]]
 +
| width="60%" |The Flowcode variable manager interface
 +
|-
 +
| width="40%" align="center" | [[Handles]]
 +
| width="60%" |Handle variables and their function within the system
 +
|-
 +
| width="40%" align="center" | [[Typecasting]]
 +
| width="60%" |Variable type casting, applications and usage
 +
|}
 +
 +
==Panels==
 +
 +
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
 +
|-
 +
! Title
 +
! Description
 +
|-
 +
| width="40%" align="center" | [[Panels_Where_And_Why]]
 +
| width="60%" |What the panels do and how they help you design your system
 +
|-
 +
| width="40%" align="center" | [[Dashboard_Panel]]
 +
| width="60%" |More in depth information on the dashboard panel
 +
|-
 +
| width="40%" align="center" | [[System_Panel]]
 +
| width="60%" |More in depth information on the system panel
 +
|-
 +
| width="40%" align="center" | [[Zooming_the_View]]
 +
| width="60%" |Zooming in and out on panels
 +
|-
 +
| width="40%" align="center" | [[Camera_Control]]
 +
| width="60%" |Controlling the camera looking at the panel
 +
|-
 +
| width="40%" align="center" | [[Object_Position]]
 +
| width="60%" |Object positioning on the panels
 +
|-
 +
| width="40%" align="center" | [[Local_and_World_Space]]
 +
| width="60%" |Local vs World space regarding coordinates
 +
|-
 +
| width="40%" align="center" | [[Object_Scale]]
 +
| width="60%" |Objects and their scale
 +
|-
 +
| width="40%" align="center" | [[Object_Rotation]]
 +
| width="60%" |Rotating objects
 +
|-
 +
| width="40%" align="center" | [[Working_With_Meshes]]
 +
| width="60%" |Using meshes inside Flowcode
 +
|}
 +
 +
==Tools and Views==
 +
 +
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
 +
|-
 +
! Title
 +
! Description
 +
|-
 +
| width="40%" align="center" | [[Tools_and_Views]]
 +
| width="60%" |Various tools and views available inside Flowcode
 +
|-
 +
| width="40%" align="center" | [[Using_the_Data_Injector]]
 +
| width="60%" |Data injectors and communications components
 +
|-
 +
| width="40%" align="center" | [[Using_the_Data_Console]]
 +
| width="60%" |How to use the data console window in your programs
 +
|-
 +
| width="40%" align="center" | [[Using_the_Data_Scope]]
 +
| width="60%" |How to use the data scope window in your programs
 +
|-
 +
| width="40%" align="center" | [[Using_the_Icon_Lists_Pane]]
 +
| width="60%" |The icon lists pane
 +
|-
 +
| width="40%" align="center" | [[Project_Options]]
 +
| width="60%" |Detailed help on the Project Options window
 +
|-
 +
| width="40%" align="center" | [[Global_Options]]
 +
| width="60%" |Detailed help on the Global Options window
 +
|-
 +
| width="40%" align="center" | [[Web_Access_Panel]]
 +
| width="60%" |The web access panel
 +
|-
 +
| width="40%" align="center" | [[Chip_View]]
 +
| width="60%" |The chip view window
 +
|-
 +
| width="40%" align="center" | [[Analog_Window]]
 +
| width="60%" |The analogue inputs window
 +
|-
 +
| width="40%" align="center" | [[Properties_Panel]]
 +
| width="60%" |The properties panel
 +
|-
 +
| width="40%" align="center" | [[Simulation_Debugger]]
 +
| width="60%" |The simulation debugger window
 +
|-
 +
| width="40%" align="center" | [[Component_Debugger]]
 +
| width="60%" |The component debugger window
 +
|-
 +
| width="40%" align="center" | [[Supplementary_Code]]
 +
| width="60%" |Supplementary code and its usage
 +
|-
 +
| width="40%" align="center" | [[Saving_Images_in_Flowcode]]
 +
| width="60%" |Creating images of your flowchart source
 +
|-
 +
| width="40%" align="center" | [[Auto_Documentation]]
 +
| width="60%" |Auto documentation features to speed up development
 
|}
 
|}

Revision as of 14:52, 7 March 2014

<sidebar>Sidebar: Flowcode Help Overview</sidebar>

Version 6

Title Description
New_in_Version_6 Introduction to new features in Flowcode 6 and other useful information
Chips List of supported microcontroller devices in Flowcode 6
Migrating_to_V6 Help and advise moving to v6 from an older version

Getting Started

Title Description
Activating_Flowcode Activating your Flowcode license
Opening_Flowcode Launching the Flowcode application
Creating_Flowcharts Creating your first Flowcode flowchart and see the options available
Selecting_a_Target_Chip Selecting the target microcontroller device
Configuring_the_Chip Configuring your device
Opening_an_Existing_Flowchart Opening an existing .FCFX Flowcode project file
Selecting_a_Template Opening a template project file
Saving_a_Flowchart Saving your program
Creating_Templates Creating your own templates
Closing_Flowcode Closing Flowcode

Flowcharts

Title Description
Icon_Properties Flowchart icons and their functionality
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
Printing_Flowcharts Printing out a flowchart

Macros

Title Description
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
DLL_Support Changing the nature of a macro to instead call a external DLL function

Functions

Title Description
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
Disabling_Icons Disabling flowchart icons to comment out sections of code
Icon_Annotations Icon annotations
Find_and_Replace Ability to search within your flowcode project to replace specific text with alternate text

Variables

Title Description
Creating_Variables How to create a variable
Variable_Types Variable types and their meanings
Editing_Variables How to edit a variable
Variable_Manager The Flowcode variable manager interface
Handles Handle variables and their function within the system
Typecasting Variable type casting, applications and usage

Panels

Title Description
Panels_Where_And_Why What the panels do and how they help you design your system
Dashboard_Panel More in depth information on the dashboard panel
System_Panel More in depth information on the system panel
Zooming_the_View Zooming in and out on panels
Camera_Control Controlling the camera looking at the panel
Object_Position Object positioning on the panels
Local_and_World_Space Local vs World space regarding coordinates
Object_Scale Objects and their scale
Object_Rotation Rotating objects
Working_With_Meshes Using meshes inside Flowcode

Tools and Views

Title Description
Tools_and_Views Various tools and views available inside Flowcode
Using_the_Data_Injector Data injectors and communications components
Using_the_Data_Console How to use the data console window in your programs
Using_the_Data_Scope How to use the data scope window in your programs
Using_the_Icon_Lists_Pane The icon lists pane
Project_Options Detailed help on the Project Options window
Global_Options Detailed help on the Global Options window
Web_Access_Panel The web access panel
Chip_View The chip view window
Analog_Window The analogue inputs window
Properties_Panel The properties panel
Simulation_Debugger The simulation debugger window
Component_Debugger The component debugger window
Supplementary_Code Supplementary code and its usage
Saving_Images_in_Flowcode Creating images of your flowchart source
Auto_Documentation Auto documentation features to speed up development