Component: FCD helper (Matrix Tools)

From Flowcode Help
Revision as of 10:37, 17 November 2021 by Wiki bot (talk | contribs)
Jump to navigationJump to search
Author Matrix Ltd
Version 1.0
Category Matrix Tools


FCD helper component

A helper control to query the current Flowcode definition XML file.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png GetStrListItem
Gets a list item from a string index and a textual name Suitable for writing to a property filter Newline is added  
Fc9-string-icon.png - STRING Index
 
Fc9-string-icon.png - STRING Name
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png GetIntListItem
Gets a list item from an integer and a textual name Suitable for writing to a property filter Newline is added  
Fc9-u16-icon.png - UINT Index
 
Fc9-string-icon.png - STRING Name
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png Register
Registers a property to update when the FCD changes  
[[File:]] - Dest
 
Fc9-string-icon.png - STRING PropName
 
Fc9-string-icon.png - STRING FCDPath
 
Fc9-u16-icon.png - UINT INdex
A zero based index of the path to find 
Fc9-string-icon.png - STRING IxAttr
 
Fc9-string-icon.png - STRING NameAttr
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetPropertyList
Gets a filter list suitable for adding to a property Uses the [u]IxName[/u] as the index into the list Uses the [u]Text[/u] as the line to show in list-boxes  
Fc9-string-icon.png - STRING FCDPath
 
Fc9-u16-icon.png - UINT Index
A zero based index of the path to find 
Fc9-string-icon.png - STRING IxName
 
Fc9-string-icon.png - STRING Text
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png GPS_Read_Over_Ground
 
[[File:]] - Return


Fc9-comp-macro.png GPS_Read_UTC_Date
 
Fc9-u8-icon.png - BYTE unit
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png MIAC_Module_SetData
 
Fc9-u8-icon.png - BYTE Count
 
Fc9-u8-icon.png - BYTE D0
 
Fc9-u8-icon.png - BYTE D1
 
Fc9-u8-icon.png - BYTE D2
 
Fc9-u8-icon.png - BYTE D3
 
Fc9-u8-icon.png - BYTE D4
 
Fc9-u8-icon.png - BYTE D5
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GPS_HorizontalDilutionOfPrecision
 
[[File:]] - Return


Fc9-comp-macro.png FAT_ScanCurrentFolder
 
Fc9-u16-icon.png - UINT idx
 
Fc9-u8-icon.png - BYTE type
Scan type 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png MIAC_Module_Init
 
Fc9-u16-icon.png - UINT CAN_ID
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png MIAC_Module_GetData
 
Fc9-u8-icon.png - BYTE Index
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GPS_Is_Data_Valid
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png FAT_AppendStringToFile
 
Fc9-string-icon.png - STRING Text
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png MIAC_Module_Message
 
Fc9-u16-icon.png - UINT CAN_ID
 
Fc9-u16-icon.png - UINT CMD_ID
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png MIAC_Module_WR
 
Fc9-u16-icon.png - UINT CAN_ID
 
Fc9-u16-icon.png - UINT CMD_ID
 
[[File:]] - Count
 
[[File:]] - Start
 
[[File:]] - More
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png FAT_OpenFolder
 
Fc9-string-icon.png - STRING Folder
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png LED_Control
Sets the indicator LED On (State=1) or Off (State=0) 
Fc9-u8-icon.png - BYTE State
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png FAT_MoveToNextFileSector
 
Fc9-u8-icon.png - BYTE force
force next sector 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png FAT_ReadByteFromScan
 
Fc9-u16-icon.png - UINT idx
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GPS_Read_NumberOfSatellites
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png FAT_ReadFileLength
 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png FAT_CreateFile
 
Fc9-string-icon.png - STRING Filename
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png MIAC_Module_PushData
 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GPS_Read_VerticalDilutionOfPrecision
 
[[File:]] - Return


Fc9-comp-macro.png FAT_WriteFileSector
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GPS_Read_Altitude
 
[[File:]] - Return


Fc9-comp-macro.png DigitalOutput
Set a Terminal Output to High (Value=1) or Low (Value=0) 
Fc9-u8-icon.png - BYTE Terminal
 
Fc9-u8-icon.png - BYTE Value
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png FAT_ReadByteFromBuffer
 
Fc9-u16-icon.png - UINT address
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png MIAC_Module_GetAck
 
Fc9-u16-icon.png - UINT CAN_ID
 
Fc9-u16-icon.png - UINT CMD_ID
 
Fc9-u16-icon.png - UINT TimeOut
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png FAT_WriteByteToBuffer
 
Fc9-u16-icon.png - UINT address
 
Fc9-u8-icon.png - BYTE data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png FAT_ReadFileSector
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png FAT_DeleteFile
 
Fc9-string-icon.png - STRING Filename
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png AnalogInput
Read the ADC value of a Terminal Returns 12 bit ADC reading 
Fc9-u8-icon.png - BYTE Terminal
Terminal number to be read 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png Initialize
Forces a software reset on the module 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GPS_Read_UTC_Time
 
Fc9-u8-icon.png - BYTE unit
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png DigitalInput
Read the value of a terminal  
Fc9-u8-icon.png - BYTE Terminal
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png PWM_SetDuty
Sets the PWM Duty cycle on Channel 1 or 2 
Fc9-u8-icon.png - BYTE Channel
PWM Channel 1 or 2 
Fc9-u8-icon.png - BYTE Duty
Duty cycle (8 bit value) 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png MI2C_Start
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DigitalInput
Read the value of a terminal  
Fc9-u8-icon.png - BYTE Terminal
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png UART_SendChar
 
Fc9-u16-icon.png - UINT Character
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png EncoderReset
Resets the motor encoder counters 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png LCDVerbose
Allows the LCD to automatically report the API commands as they get processed. Default - verbose on 
Fc9-u8-icon.png - BYTE State
0=Off 1=On 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetProp
Allows the COM port property to be set from a parent component. 
Fc9-string-icon.png - STRING PropName
 
Fc9-u32-icon.png - ULONG PropVal
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png CardInit
Attempts to startup the SD card 255=No Card, 254=Init Fail, 0=Init OK 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetProp
Allows the property filter for the COM port list to be copied to a parent component. 
Fc9-string-icon.png - STRING PropName
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png LCDClear
Clears the LCD 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations