API Overview: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
Flowcode provides an ''application programming interface'' to help writing simulation and PC-side programs. | Flowcode provides an ''application programming interface'' to help writing simulation and PC-side programs. | ||
| Line 48: | Line 47: | ||
| [[API Mouse|Mouse]] | | [[API Mouse|Mouse]] | ||
| Mouse reading interface | | Mouse reading interface | ||
|- | |||
| [[API Keyboard|Keyboard]] | |||
| Keyboard reading interface | |||
|- | |- | ||
| [[API FCD|FCD]] | | [[API FCD|FCD]] | ||
| Line 55: | Line 57: | ||
| Audio streaming interface | | Audio streaming interface | ||
|- | |- | ||
| [[API Scope| | | [[API Scope|DataRecorder]] | ||
| Data scope additions | | Data scope additions | ||
|- | |||
| [[API Calculations|Calculations]] | |||
| Miscellaneous calculations | |||
|- | |- | ||
| [[API Console|Console]] | | [[API Console|Console]] | ||
| Line 78: | Line 83: | ||
| [[API File.NVM|File.NVM]] | | [[API File.NVM|File.NVM]] | ||
| Reads from a file as though a block of NVM | | Reads from a file as though a block of NVM | ||
|- | |||
| [[API UI|UI]] | |||
| Display message boxes and alerts | |||
|- | |- | ||
| [[API Time|Time]] | | [[API Time|Time]] | ||
| Helps read and manage clock counters | | Helps read and manage clock counters | ||
|- | |- | ||
| [[API System|System]] | | [[API System|System]] | ||
| Line 89: | Line 94: | ||
|- | |- | ||
| [[API Debug|Debug]] | | [[API Debug|Debug]] | ||
| Debug and | | Debug and diagnostic | ||
|} | |} | ||
Revision as of 15:04, 23 July 2026
Flowcode provides an application programming interface to help writing simulation and PC-side programs.
This API is a list of macros built in to Flowcode with each group, or class, of macros dealing with a specific area of the system.
Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code.
Below is a reference to the classes available. A complete list of classes and macros is also available.
| Class path | Description |
|---|---|
| Component | Component traversal functions |
| Component.Property | Property manipulation functions |
| Panel | Panel object manipulations |
| Panel.Position | Coordinate manipulation functions |
| Panel.Position.Math | Coordinate maths functions |
| Panel.Position.Camera | Camera positioning |
| Panel.PCloud | Point cloud manipulation |
| Panel.LinkBar | Position linkage management |
| Panel.Collision | Collision detection functions |
| Panel.Graphics | Direct drawing routines for a single frame |
| Panel.Graphics.Shape | Routines to change the last drawn shape |
| Mouse | Mouse reading interface |
| Keyboard | Keyboard reading interface |
| FCD | Flowcode Chip Definition reading routines |
| Sound | Audio streaming interface |
| DataRecorder | Data scope additions |
| Calculations | Miscellaneous calculations |
| Console | Text console additions |
| Connection | Analog and digital connections |
| Expand | Various variable and code expansion routines |
| Tree | Data-tree traversal type routines |
| File | File reading and writing operations |
| File.Buffer | Reads writes and monitors circular buffers |
| File.NVM | Reads from a file as though a block of NVM |
| UI | Display message boxes and alerts |
| Time | Helps read and manage clock counters |
| System | General system operations |
| Debug | Debug and diagnostic |