Difference between revisions of "Flowcode Help Overview"

From Flowcode Help
Jump to navigationJump to search
 
(39 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
<sidebar>Sidebar: Flowcode Help Overview</sidebar>
 
<sidebar>Sidebar: Flowcode Help Overview</sidebar>
 +
__NOTOC__
 +
A set of videos are available showing some projects using Flowcode 6 as well as talking you through some example programs.
 +
[https://www.youtube.com/watch?v=g5SrkU-5TuU&list=PLCZaPFyK6UlLyg-a8Fm01ZWFvp-GxBLgc Flowcode 6 Playlist]
  
 
==Version 6==
 
==Version 6==
 
+
<span id="Version_6"></span>
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
+
* [[New_in_Version_6|New in Flowcode 6]] - Introduction to new features in Flowcode 6 and other useful information
|-
+
* [[Chips]] - List of supported microcontroller devices in Flowcode 6
! Title
+
* [[Migrating_to_V6|Migrating to Flowcode 6]] - Help and advise moving to v6 from an older version
! Description
 
|-
 
| width="40%" align="center" | [[New_in_Version_6]]
 
| width="60%" |Introduction to new features in Flowcode 6 and other useful information
 
|-
 
| width="40%" align="center" | [[Chips]]
 
| width="60%" |List of supported microcontroller devices in Flowcode 6
 
|-
 
| width="40%" align="center" | [[Migrating_to_V6]]  
 
| width="60%" |Help and advise moving to v6 from an older version
 
|}
 
  
 
==Getting Started==
 
==Getting Started==
 
+
<span id="Getting_Started"></span>
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
+
* [[Activating_Flowcode]] - Activating your Flowcode license
|-
+
* [[Opening_Flowcode]] - Launching the Flowcode application
! Title
+
* [[Finding_Your_Way_Around_Flowcode]] - Finding your way around
! Description
+
* [[Creating_Flowcharts]] - Creating your first Flowcode flowchart and see the options available
|-
+
* [[Selecting_a_Target_Chip]] - Selecting the target microcontroller device
| width="40%" align="center" | [[Activating_Flowcode]]
+
* [[Configuring_the_Chip]] - Configuring your device
| width="60%" |Activating your Flowcode license
+
* [[Opening_an_Existing_Flowchart]] - Opening an existing .FCFX Flowcode project file
|-
+
* [[Selecting_a_Template]] - Opening a template project file
| width="40%" align="center" | [[Opening_Flowcode]]
+
* [[Saving_a_Flowchart]] - Saving your program
| width="60%" |Launching the Flowcode application
+
* [[Creating_Templates]] - Creating your own templates
|-
+
* [[Closing_Flowcode]] - Closing Flowcode
| width="40%" align="center" | [[Creating_Flowcharts]]  
+
* [[Disabling the 3D Panel]] - Disabling the 3D interface
| width="60%" |Creating your first Flowcode flowchart and see the options available
 
|-
 
| width="40%" align="center" | [[Selecting_a_Target_Chip]]  
 
| width="60%" |Selecting the target microcontroller device
 
|-
 
| width="40%" align="center" | [[Configuring_the_Chip]]
 
| width="60%" |Configuring your device
 
|-
 
| width="40%" align="center" | [[Opening_an_Existing_Flowchart]]
 
| width="60%" |Opening an existing .FCFX Flowcode project file
 
|-
 
| width="40%" align="center" | [[Selecting_a_Template]]
 
| width="60%" |Opening a template project file
 
|-
 
| width="40%" align="center" | [[Saving_a_Flowchart]]
 
| width="60%" |Saving your program
 
|-
 
| width="40%" align="center" | [[Creating_Templates]]
 
| width="60%" |Creating your own templates
 
|-
 
| width="40%" align="center" | [[Closing_Flowcode]]
 
| width="60%" |Closing Flowcode
 
|}
 
  
 
==Flowcharts==
 
==Flowcharts==
 
+
<span id="Flowcharts"></span>
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
+
*[[Icon_Properties]] - Flowchart icons and their functionality
|-
+
*[[Adding_an_Icon_to_a_Flowchart]] - Adding flowchart icons to your program
! Title
+
*[[Editing_Icon_Properties]] - Editing the properties of a flowchart icon
! Description
+
*[[Adding_Comments_to_a_Flowchart]] - Commenting your flowchart
|-
+
*[[Selecting_Icons]] - Selecting icons on the flowchart
| width="40%" align="center" | [[Icon_Properties]]
+
*[[Flowchart_Editing_Functions]] - Functions to make editing your flowchart easier
| width="60%" |Flowchart icons and their functionality
+
*[[Printing_Flowcharts]] - Printing out a flowchart
|-
 
| 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==
 
==Macros==
 
+
<span id="Macros"></span>
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
+
*[[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
! Title
+
*[[Using_the_Project_Explorer]] - Features of the project explorer designed to help simplify programming
! Description
+
*[[Exporting_a_Macro]] - Exporting a macro from within Flowcode
|-
+
*[[Importing_a_Macro]] - Importing a macro into Flowcode
| 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==
 
==Functions==
 +
<span id="Functions"></span>
 +
*[[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
  
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
+
==Variables==
|-
+
<span id="Variables"></span>
! Title
+
*[[Creating_Variables]] - How to create a variable
! Description
+
*[[Variable_Types]] - Variable types and their meanings
|-
+
*[[Editing_Variables]] - How to edit a variable
| width="40%" align="center" | [[Mathematical_Functions]]
+
*[[Variable_Manager]] - The Flowcode variable manager interface
| width="60%" |Built in routines designed to help with mathematical operations such as Sin() and Float
+
*[[Handles]] - Handle variables and their function within the system
|-
+
*[[Typecasting]] - Variable type casting, applications and usage
| 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==
+
==Panels==
 +
<span id="Panels"></span>
 +
*[[Panels_Where_And_Why]] - What the panels do and how they help you design your system
 +
*[[Choosing_your_Simulation_Panel]] - Information about choosing the correct panel
 +
*[[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==
 +
<span id="Tools_and_Views"></span>
 +
*[[Tools_and_Views]] - Various tools and views available inside Flowcode
 +
*[[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
 +
*[[Window_Layouts]] - The window layouts manager
  
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
+
==Components==
|-
+
<span id="Components"></span>
! Title
+
*[[Component]] - Information about what a component is and how they work inside the Flowcode environment.
! Description
+
*[[Common_Components]] - Information on some of the more commonly used components
|-
+
*[[What_Is_a_Switch%3F]] - Detailed information regarding the switch components
| width="40%" align="center" | [[Creating_Variables]]
+
*[[What_Is_an_LED%3F]] - Detailed information regarding the LED components
| width="60%" |How to create a variable
+
*[[What_Is_an_LCD%3F]] - Detailed information regarding the LCD components
|-
+
*[[What_Is_a_7_Segment_Display%3F]] - Detailed information regarding the 7Seg components
| width="40%" align="center" | [[Variable_Types]]
+
*[[What_Is_a_Keypad%3F]] - Detailed information regarding the keypad components
| width="60%" |Variable types and their meanings
+
*[[Selecting_Component_Macros]] - Information on how to use component macros
|-
+
*[[Component_Help_Files]] - How to get access to component help via Flowcode
| width="40%" align="center" | [[Editing_Variables]]  
+
*[[Components]] - Component help overview
| width="60%" |How to edit a variable
+
*[[Component_Properties]] - Information on how to use component properties
|-
+
*[[Component_Tree]] - Information regarding the component tree hierarchy
| width="40%" align="center" | [[Variable_Manager]]  
+
*[[Replacing_a_Component]] - Replacing one component with another
| width="60%" |The Flowcode variable manager interface
+
*[[CAL_Components]] - Overview of code abstraction layer components
|-
+
*[[DSP|DSP Components]] - Overview of digital signal processing components
| width="40%" align="center" | [[Handles]]
+
*[[Using_the_Data_Injector]] - Data injectors and communications components
| width="60%" |Handle variables and their function within the system
+
*[[Component_Directories]] - Information on creating your own components directories
|-
+
*[[Editing_Key_Mappings]] - Assigning keyboard presses to functionality during simulation
| width="40%" align="center" | [[Typecasting]]
+
*[[Remappable_Peripheral_Pins]] - Assigning pins to peripherals on devices with re-mappable functionality.
| width="60%" |Variable type casting, applications and usage
 
|}
 
  
==Panels==
+
==Component Creation==
 +
<span id="Component_Creation"></span>
 +
*[[Creating_a_Property]] - How to create a property
 +
*[[Panel_Managers]] - Overview of the component creation panel managers
 +
*[[Number_Conversions]] - Creating a helper component to help convert between number systems Decimal, Hexadecimal and Binary
 +
*[[Assigning_Code_to_an_Existing_Component]] - Complementing or overriding an existing components functionality
 +
*[[Base_Components]] - The base components and their function
 +
*[[Using_A_Base_Component]] - Creating a new component using a base
 +
*[[Creating a two wheeled robot]] - Creating a 2 wheeled robot from scratch (simulation & downloadable)
  
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
+
==Simulation==
|-
+
<span id="Simulation"></span>
! Title
+
*[[Starting_Flowchart_Simulation]] - Information on how to use the flowchart simulation
! Description
+
*[[Simulating_Icons_Step_by_Step]] - Stepping through icons
|-
+
*[[Breakpoints]] - Using breakpoints
| width="40%" align="center" | [[Panels_Where_And_Why]]
+
*[[Bookmarks]] - Using bookmarks
| width="60%" |What the panels do and how they help you design your system
+
*[[Changing_the_Speed_of_a_Simulation]] - Changing the run speed of the simulator
|-
+
*[[Simulation_Only_Code]] - Code designed to work only via the simulator
| width="40%" align="center" | [[Dashboard_Panel]]
+
*[[Simulation_Events]] - Event macros used to provide more functionality to both simulation and compiled code
| width="60%" |More in depth information on the dashboard panel
+
*[[DLL_Support]] - Changing the nature of a macro to instead call a external DLL function (simulation only)
|-
+
*[[Data_Scope_Test]] - Information on how to use the Flowcode data scope window.
| 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==
+
==Chip Specifics==
 +
<span id="Chip_Specifics"></span>
 +
*[[Compiling_a_Flowchart_to_a_Chip]] - Information on how to compile a flowchart into machine code
 +
*[[Internal_Oscillator]] - Specifics on using an internal oscillator
 +
*[[Phase_Locked_Loop_(PLL)]] - Specifics on using a PLL frequency multiplier
 +
*[[Custom_Interrupts]] - Custom interrupts for your hardware
 +
*[[Debugging_Hardware_and_Software]] - Tips on how to debug hardware and software
 +
*[[In_Circuit_Debugging]] - Overview of the in circuit debugging (ICD) interface
 +
*[[In_Circuit_Test]] - Overview of the in circuit test (ICT) interface
 +
*[[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
  
{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
+
==Support==
|-
+
<span id="Support"></span>
! Title
+
*[[Frequently_Asked_Questions]] - Frequently asked questions
! Description
+
*[[Reporting_a_Bug]] - How to report a bug in Flowcode
|-
+
*[[Licensed_Compiler]] - Compiler specifics and license agreement
| width="40%" align="center" | [[Tools_and_Views]]
+
*[[Technical_Support]] - Information on how to get further support
| 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
 
|}
 

Latest revision as of 10:50, 15 August 2016

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

A set of videos are available showing some projects using Flowcode 6 as well as talking you through some example programs. Flowcode 6 Playlist

Version 6

  • New in Flowcode 6 - Introduction to new features in Flowcode 6 and other useful information
  • Chips - List of supported microcontroller devices in Flowcode 6
  • Migrating to Flowcode 6 - Help and advise moving to v6 from an older version

Getting Started

Flowcharts

Macros

Functions

Variables

Panels

Tools and Views

Components

Component Creation

Simulation

Chip Specifics

Support