Difference between revisions of "Flowcode Help Overview"
From Flowcode Help
Jump to navigationJump to search| (44 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<sidebar>Sidebar: Flowcode Help Overview</sidebar> | <sidebar>Sidebar: Flowcode Help Overview</sidebar> | ||
__NOTOC__ | __NOTOC__ | ||
| − | == | + | A set of videos are available showing some projects using Flowcode as well as talking you through some example programs. |
| − | + | [https://www.youtube.com/watch?v=g5SrkU-5TuU&list=PLCZaPFyK6UlLyg-a8Fm01ZWFvp-GxBLgc Flowcode video playlist] | |
| − | + | ==Version 7== | |
| − | + | <span id="Version_7"></span> | |
| − | + | * [[New_in_Version_7|New in Flowcode 7]] - Introduction to new features in Flowcode 7 and other useful information | |
| − | + | * [[Chips]] - List of supported microcontroller devices in Flowcode | |
| − | + | * [[Migrating_to_V7|Migrating to Flowcode 7]] - Help and advise moving to v7 from an older version | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Getting Started== | ==Getting Started== | ||
<span id="Getting_Started"></span> | <span id="Getting_Started"></span> | ||
| − | + | * [[Activating_Flowcode]] - Activating your Flowcode license | |
| − | + | * [[Opening_Flowcode]] - Launching the Flowcode application | |
| − | + | * [[Finding_Your_Way_Around_Flowcode]] - Finding your way around | |
| − | + | * [[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 | |
| − | + | * [[Disabling the 3D Panel]] - Disabling the 3D interface | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Flowcharts== | ==Flowcharts== | ||
<span id="Flowcharts"></span> | <span id="Flowcharts"></span> | ||
| − | + | *[[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== | ==Macros== | ||
<span id="Macros"></span> | <span id="Macros"></span> | ||
| − | + | *[[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 | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Functions== | ==Functions== | ||
<span id="Functions"></span> | <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 | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Variables== | ==Variables== | ||
<span id="Variables"></span> | <span id="Variables"></span> | ||
| − | + | *[[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 | |
| − | + | *[[FiniteStateMachine]] - Programming tutorial on using state machines | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Panels== | ==Panels== | ||
<span id="Panels"></span> | <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_Primitives]] - Using primitive objects inside Flowcode | |
| − | + | *[[Working_With_Meshes]] - Using meshes inside Flowcode | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Tools and Views== | ==Tools and Views== | ||
<span id="Tools_and_Views"></span> | <span id="Tools_and_Views"></span> | ||
| − | + | *[[Tools_and_Views]] - Various tools and views available inside Flowcode | |
| − | + | *[[Oscilloscope|Using the Oscilloscope]] - How to use the oscilloscope window to monitor repeating waveforms and pin activity | |
| − | + | *[[Using_the_Data_Console]] - How to use the data console window in your programs | |
| − | + | *[[Using_the_Data_Scope|Using the Data Recorder]] - How to use the data recorder 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 | |
| − | + | *[[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 | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Components== | ==Components== | ||
<span id="Components"></span> | <span id="Components"></span> | ||
| − | + | *[[Component]] - Information about what a component is and how they work inside the Flowcode environment. | |
| − | + | *[[Common_Components]] - Information on some of the more commonly used components | |
| − | + | *[[What_Is_a_Switch%3F]] - Detailed information regarding the switch components | |
| − | + | *[[What_Is_an_LED%3F]] - Detailed information regarding the LED components | |
| − | + | *[[What_Is_an_LCD%3F]] - Detailed information regarding the LCD components | |
| − | + | *[[What_Is_a_7_Segment_Display%3F]] - Detailed information regarding the 7Seg components | |
| − | + | *[[What_Is_a_Keypad%3F]] - Detailed information regarding the keypad components | |
| − | + | *[[Selecting_Component_Macros]] - Information on how to use component macros | |
| − | + | *[[Component_Help_Files]] - How to get access to component help via Flowcode | |
| − | + | *[[Components]] - Component help overview | |
| − | + | *[[Component_Properties]] - Information on how to use component properties | |
| − | + | *[[Component_Tree]] - Information regarding the component tree hierarchy | |
| − | + | *[[Replacing_a_Component]] - Replacing one component with another | |
| − | + | *[[CAL_Components]] - Overview of code abstraction layer components | |
| − | + | *[[DSP|DSP Components]] - Overview of digital signal processing components | |
| − | + | *[[Using_the_Data_Injector]] - Data injectors and communications components | |
| − | + | *[[Component_Directories]] - Information on creating your own components directories | |
| − | + | *[[Editing_Key_Mappings]] - Assigning keyboard presses to functionality during simulation | |
| − | + | *[[Remappable_Peripheral_Pins]] - Assigning pins to peripherals on devices with re-mappable functionality. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Component Creation== | ==Component Creation== | ||
<span id="Component_Creation"></span> | <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) | |
| − | + | *[[Exercises]] - Worked exercises including creating components | |
| − | + | *[[New_Component_Features]] - Additional component creation features added in Flowcode 7.2 | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Simulation== | ==Simulation== | ||
<span id="Simulation"></span> | <span id="Simulation"></span> | ||
| − | + | *[[Starting_Flowchart_Simulation]] - Information on how to use the flowchart simulation | |
| − | + | *[[Simulating_Icons_Step_by_Step]] - Stepping through icons | |
| − | + | *[[Breakpoints]] - Using breakpoints | |
| − | + | *[[Bookmarks]] - Using bookmarks | |
| − | + | *[[Changing_the_Speed_of_a_Simulation]] - Changing the run speed of the simulator | |
| − | + | *[[Simulation_Only_Code]] - Code designed to work only via the simulator | |
| − | + | *[[Simulation_Events]] - Event macros used to provide more functionality to both simulation and compiled code | |
| − | + | *[[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. | |
| − | + | *[[CodeProfiling]] - Introduction to Code Profiling, and how to use it | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Chip Specifics== | ==Chip Specifics== | ||
<span id="Chip_Specifics"></span> | <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 | |
| − | + | *[[Interrupts]] - Built in interrupts for your hardware | |
| − | + | *[[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 | |
| − | + | *[[Ghost_Settings]] - Overview of the Ghost functionality and settings (ICD + ICT) | |
| − | + | *[[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 | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Support== | ==Support== | ||
<span id="Support"></span> | <span id="Support"></span> | ||
| − | + | *[[Frequently_Asked_Questions]] - Frequently asked questions | |
| − | + | *[[Reporting_a_Bug]] - How to report a bug in Flowcode | |
| − | + | *[[Licensed_Compiler]] - Compiler specifics and license agreement | |
| − | + | *[[Technical_Support]] - Information on how to get further support | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 11:19, 2 March 2017
<sidebar>Sidebar: Flowcode Help Overview</sidebar>
A set of videos are available showing some projects using Flowcode as well as talking you through some example programs. Flowcode video playlist
Version 7
- New in Flowcode 7 - Introduction to new features in Flowcode 7 and other useful information
- Chips - List of supported microcontroller devices in Flowcode
- Migrating to Flowcode 7 - Help and advise moving to v7 from an older version
Getting Started
- Activating_Flowcode - Activating your Flowcode license
- Opening_Flowcode - Launching the Flowcode application
- Finding_Your_Way_Around_Flowcode - Finding your way around
- 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
- Disabling the 3D Panel - Disabling the 3D interface
Flowcharts
- 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
- 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
Functions
- 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
- 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
- FiniteStateMachine - Programming tutorial on using state machines
Panels
- 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_Primitives - Using primitive objects inside Flowcode
- Working_With_Meshes - Using meshes inside Flowcode
Tools and Views
- Tools_and_Views - Various tools and views available inside Flowcode
- Using the Oscilloscope - How to use the oscilloscope window to monitor repeating waveforms and pin activity
- Using_the_Data_Console - How to use the data console window in your programs
- Using the Data Recorder - How to use the data recorder 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
- 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
Components
- Component - Information about what a component is and how they work inside the Flowcode environment.
- Common_Components - Information on some of the more commonly used components
- What_Is_a_Switch? - Detailed information regarding the switch components
- What_Is_an_LED? - Detailed information regarding the LED components
- What_Is_an_LCD? - Detailed information regarding the LCD components
- What_Is_a_7_Segment_Display? - Detailed information regarding the 7Seg components
- What_Is_a_Keypad? - Detailed information regarding the keypad components
- Selecting_Component_Macros - Information on how to use component macros
- Component_Help_Files - How to get access to component help via Flowcode
- Components - Component help overview
- Component_Properties - Information on how to use component properties
- Component_Tree - Information regarding the component tree hierarchy
- Replacing_a_Component - Replacing one component with another
- CAL_Components - Overview of code abstraction layer components
- DSP Components - Overview of digital signal processing components
- Using_the_Data_Injector - Data injectors and communications components
- Component_Directories - Information on creating your own components directories
- Editing_Key_Mappings - Assigning keyboard presses to functionality during simulation
- Remappable_Peripheral_Pins - Assigning pins to peripherals on devices with re-mappable functionality.
Component Creation
- 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)
- Exercises - Worked exercises including creating components
- New_Component_Features - Additional component creation features added in Flowcode 7.2
Simulation
- Starting_Flowchart_Simulation - Information on how to use the flowchart simulation
- Simulating_Icons_Step_by_Step - Stepping through icons
- Breakpoints - Using breakpoints
- Bookmarks - Using bookmarks
- Changing_the_Speed_of_a_Simulation - Changing the run speed of the simulator
- Simulation_Only_Code - Code designed to work only via the simulator
- Simulation_Events - Event macros used to provide more functionality to both simulation and compiled code
- 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.
- CodeProfiling - Introduction to Code Profiling, and how to use it
Chip Specifics
- 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
- Interrupts - Built in interrupts for your hardware
- 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
- Ghost_Settings - Overview of the Ghost functionality and settings (ICD + ICT)
- 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
Support
- Frequently_Asked_Questions - Frequently asked questions
- Reporting_a_Bug - How to report a bug in Flowcode
- Licensed_Compiler - Compiler specifics and license agreement
- Technical_Support - Information on how to get further support
