Difference between revisions of "Flowcode Help Overview"
From Flowcode Help
Jump to navigationJump to searchLine 255: | Line 255: | ||
| width="40%" align="center" | [[Auto_Documentation]] | | width="40%" align="center" | [[Auto_Documentation]] | ||
| width="60%" |Auto documentation features to speed up development | | width="60%" |Auto documentation features to speed up development | ||
+ | |} | ||
+ | |||
+ | ==Components== | ||
+ | |||
+ | {| class="wikitable" style="width: 70%; margin:auto; text-align:center;" | ||
+ | |- | ||
+ | ! Title | ||
+ | ! Description | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Common_Components]] | ||
+ | | width="60%" |Information on some of the more commonly used components | ||
+ | |- | ||
+ | | width="40%" align="center" | [[What_Is_a_Switch%3F]] | ||
+ | | width="60%" |Detailed information regarding the switch components | ||
+ | |- | ||
+ | | width="40%" align="center" | [[What_Is_an_LED%3F]] | ||
+ | | width="60%" |Detailed information regarding the LED components | ||
+ | |- | ||
+ | | width="40%" align="center" | [[What_Is_an_LCD%3F]] | ||
+ | | width="60%" |Detailed information regarding the LCD components | ||
+ | |- | ||
+ | | width="40%" align="center" | [[What_Is_a_7_Segment_Display%3F]] | ||
+ | | width="60%" |Detailed information regarding the 7Seg components | ||
+ | |- | ||
+ | | width="40%" align="center" | [[What_Is_a_Keypad%3F]] | ||
+ | | width="60%" |Detailed information regarding the keypad components | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Selecting_Component_Macros]] | ||
+ | | width="60%" |Information on how to use component macros | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Component_Help_Files]] | ||
+ | | width="60%" |How to get access to component help via Flowcode | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Components]] | ||
+ | | width="60%" |Component help overview | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Component_Properties]] | ||
+ | | width="60%" |Information on how to use component properties | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Component_Tree]] | ||
+ | | width="60%" |Information regarding the component tree hierarchy | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Replacing_a_Component]] | ||
+ | | width="60%" |Replacing one component with another | ||
+ | |- | ||
+ | | width="40%" align="center" | [[CAL_Components]] | ||
+ | | width="60%" |Overview of code abstraction layer components | ||
+ | |- | ||
+ | | width="40%" align="center" | [[DSP_Components]] | ||
+ | | width="60%" |Overview of digital signal processing components | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Injector_Components]] | ||
+ | | width="60%" |Overview of communications injector components. | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Component_Directories]] | ||
+ | | width="60%" |Information on creating your own components directories | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Editing_Key_Mappings]] | ||
+ | | width="60%" |Assigning keyboard presses to functionality during simulation | ||
+ | |} | ||
+ | |||
+ | ==Component Creation== | ||
+ | |||
+ | {| class="wikitable" style="width: 70%; margin:auto; text-align:center;" | ||
+ | |- | ||
+ | ! Title | ||
+ | ! Description | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Creating_a_Property]] | ||
+ | | width="60%" |How to create a property | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Panel_Managers]] | ||
+ | | width="60%" |Overview of the component creation panel managers | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Assigning_Code_to_an_Existing_Component]] | ||
+ | | width="60%" |Complementing or overriding an existing components functionality | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Exercise_-_Create_an_LED_Component]] | ||
+ | | width="60%" |Creating a component from scratch | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Base_Components]] | ||
+ | | width="60%" |The base components and their function | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Using_A_Base_Component]] | ||
+ | | width="60%" |Creating a new component using a base | ||
+ | |} | ||
+ | |||
+ | ==Simulation== | ||
+ | |||
+ | {| class="wikitable" style="width: 70%; margin:auto; text-align:center;" | ||
+ | |- | ||
+ | ! Title | ||
+ | ! Description | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Starting_Flowchart_Simulation]] | ||
+ | | width="60%" |Information on how to use the flowchart simulation | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Simulating_Icons_Step_by_Step]] | ||
+ | | width="60%" |Stepping through icons | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Breakpoints]] | ||
+ | | width="60%" |Using breakpoints | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Changing_the_Speed_of_a_Simulation]] | ||
+ | | width="60%" |Changing the run speed of the simulator | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Simulation_Only_Code]] | ||
+ | | width="60%" |Code designed to work only via the simulator | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Simulation_Events]] | ||
+ | | width="60%" |Event macros used to provide more functionality to both simulation and compiled code | ||
+ | |} | ||
+ | |||
+ | ==Chip Specifics== | ||
+ | |||
+ | {| class="wikitable" style="width: 70%; margin:auto; text-align:center;" | ||
+ | |- | ||
+ | ! Title | ||
+ | ! Description | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Compiling_a_Flowchart_to_a_Chip]] | ||
+ | | width="60%" |Information on how to compile a flowchart into machine code | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Internal_Oscillator]] | ||
+ | | width="60%" |Specifics on using an internal oscillator | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Phase_Locked_Loop_(PLL)]] | ||
+ | | width="60%" |Specifics on using a PLL frequency multiplier | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Custom_Interrupts]] | ||
+ | | width="60%" |Custom interrupts for your hardware | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Debugging_Hardware_and_Software]] | ||
+ | | width="60%" |Tips on how to debug hardware and software | ||
+ | |- | ||
+ | | width="40%" align="center" | [[In_Circuit_Debugging]] | ||
+ | | width="60%" |Overview of the in circuit debugging (ICD) interface | ||
+ | |- | ||
+ | | width="40%" align="center" | [[In_Circuit_Test]] | ||
+ | | width="60%" |Overview of the in circuit test (ICT) interface | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Supporting_Third_Party_Programming_Tools]] | ||
+ | | width="60%" |Using 3rd party programmers such as PICkit and Arduino | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Viewing_Code_Output]] | ||
+ | | width="60%" |Viewing the code generated by Flowcode | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Managing_Compiler_Options]] | ||
+ | | width="60%" |Overview of the compiler options settings | ||
+ | |- | ||
+ | | width="40%" align="center" | [[FCD_Data_Collection]] | ||
+ | | width="60%" |Chip definition files and how to collect data from them | ||
+ | |} | ||
+ | |||
+ | ==Support== | ||
+ | |||
+ | {| class="wikitable" style="width: 70%; margin:auto; text-align:center;" | ||
+ | |- | ||
+ | ! Title | ||
+ | ! Description | ||
+ | |- | ||
+ | | width="40%" align="center" | [[FAQs]] | ||
+ | | width="60%" |Frequently asked questions | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Reporting_a_Bug]] | ||
+ | | width="60%" |How to report a bug in Flowcode | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Licensed_Compiler]] | ||
+ | | width="60%" |Compiler specifics and license agreement | ||
+ | |- | ||
+ | | width="40%" align="center" | [[Technical_Support]] | ||
+ | | width="60%" |Information on how to get further support | ||
|} | |} |
Revision as of 15:20, 7 March 2014
<sidebar>Sidebar: Flowcode Help Overview</sidebar>
Contents
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 |
Components
Title | Description |
---|---|
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 |
Injector_Components | Overview of communications injector components. |
Component_Directories | Information on creating your own components directories |
Editing_Key_Mappings | Assigning keyboard presses to functionality during simulation |
Component Creation
Title | Description |
---|---|
Creating_a_Property | How to create a property |
Panel_Managers | Overview of the component creation panel managers |
Assigning_Code_to_an_Existing_Component | Complementing or overriding an existing components functionality |
Exercise_-_Create_an_LED_Component | Creating a component from scratch |
Base_Components | The base components and their function |
Using_A_Base_Component | Creating a new component using a base |
Simulation
Title | Description |
---|---|
Starting_Flowchart_Simulation | Information on how to use the flowchart simulation |
Simulating_Icons_Step_by_Step | Stepping through icons |
Breakpoints | Using breakpoints |
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 |
Chip Specifics
Title | Description |
---|---|
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 |
Support
Title | Description |
---|---|
FAQs | 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 |