Jump to content

Component: FCD helper (Matrix Tools)

From Flowcode Help
Revision as of 10:37, 17 November 2021 by Wiki bot (talk | contribs)
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

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


GetIntListItem
Gets a list item from an integer and a textual name Suitable for writing to a property filter Newline is added  
- UINT Index
 
- STRING Name
 
- STRING Return


Register
Registers a property to update when the FCD changes  
[[File:]] - Dest
 
- STRING PropName
 
- STRING FCDPath
 
- UINT INdex
A zero based index of the path to find 
- STRING IxAttr
 
- STRING NameAttr
 
- VOID Return


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  
- STRING FCDPath
 
- UINT Index
A zero based index of the path to find 
- STRING IxName
 
- STRING Text
 
- STRING Return


GPS_Read_Over_Ground
 
[[File:]] - Return


GPS_Read_UTC_Date
 
- BYTE unit
 
- BYTE Return


MIAC_Module_SetData
 
- BYTE Count
 
- BYTE D0
 
- BYTE D1
 
- BYTE D2
 
- BYTE D3
 
- BYTE D4
 
- BYTE D5
 
- VOID Return


GPS_HorizontalDilutionOfPrecision
 
[[File:]] - Return


FAT_ScanCurrentFolder
 
- UINT idx
 
- BYTE type
Scan type 
- BYTE Return


MIAC_Module_Init
 
- UINT CAN_ID
 
- VOID Return


MIAC_Module_GetData
 
- BYTE Index
 
- BYTE Return


GPS_Is_Data_Valid
 
- BYTE Return


FAT_AppendStringToFile
 
- STRING Text
 
- BYTE Return


MIAC_Module_Message
 
- UINT CAN_ID
 
- UINT CMD_ID
 
- BYTE Return


MIAC_Module_WR
 
- UINT CAN_ID
 
- UINT CMD_ID
 
[[File:]] - Count
 
[[File:]] - Start
 
[[File:]] - More
 
- VOID Return


FAT_OpenFolder
 
- STRING Folder
 
- BYTE Return


LED_Control
Sets the indicator LED On (State=1) or Off (State=0) 
- BYTE State
 
- VOID Return


FAT_MoveToNextFileSector
 
- BYTE force
force next sector 
- BYTE Return


FAT_ReadByteFromScan
 
- UINT idx
 
- BYTE Return


GPS_Read_NumberOfSatellites
 
- BYTE Return


FAT_ReadFileLength
 
- UINT Return


FAT_CreateFile
 
- STRING Filename
 
- BYTE Return


MIAC_Module_PushData
 
- BYTE Data
 
- VOID Return


GPS_Read_VerticalDilutionOfPrecision
 
[[File:]] - Return


FAT_WriteFileSector
 
- BYTE Return


GPS_Read_Altitude
 
[[File:]] - Return


DigitalOutput
Set a Terminal Output to High (Value=1) or Low (Value=0) 
- BYTE Terminal
 
- BYTE Value
 
- BYTE Return


FAT_ReadByteFromBuffer
 
- UINT address
 
- BYTE Return


MIAC_Module_GetAck
 
- UINT CAN_ID
 
- UINT CMD_ID
 
- UINT TimeOut
 
- BYTE Return


FAT_WriteByteToBuffer
 
- UINT address
 
- BYTE data
 
- VOID Return


FAT_ReadFileSector
 
- BYTE Return


FAT_DeleteFile
 
- STRING Filename
 
- BYTE Return


AnalogInput
Read the ADC value of a Terminal Returns 12 bit ADC reading 
- BYTE Terminal
Terminal number to be read 
- UINT Return


Initialize
Forces a software reset on the module 
- VOID Return


GPS_Read_UTC_Time
 
- BYTE unit
 
- BYTE Return


DigitalInput
Read the value of a terminal  
- BYTE Terminal
 
- BYTE Return


PWM_SetDuty
Sets the PWM Duty cycle on Channel 1 or 2 
- BYTE Channel
PWM Channel 1 or 2 
- BYTE Duty
Duty cycle (8 bit value) 
- VOID Return


MI2C_Start
 
- VOID Return


DigitalInput
Read the value of a terminal  
- BYTE Terminal
 
- BYTE Return


UART_SendChar
 
- UINT Character
 
- VOID Return


EncoderReset
Resets the motor encoder counters 
- VOID Return


LCDVerbose
Allows the LCD to automatically report the API commands as they get processed. Default - verbose on 
- BYTE State
0=Off 1=On 
- VOID Return


SetProp
Allows the COM port property to be set from a parent component. 
- STRING PropName
 
- ULONG PropVal
 
- VOID Return


CardInit
Attempts to startup the SD card 255=No Card, 254=Init Fail, 0=Init OK 
- BYTE Return


GetProp
Allows the property filter for the COM port list to be copied to a parent component. 
- STRING PropName
 
- STRING Return


LCDClear
Clears the LCD 
- VOID Return



Property reference

Properties
Connections
Simulations