Jump to content

Component: Device Helper (Matrix Tools): Difference between revisions

From Flowcode Help
No edit summary
No edit summary
Line 16: Line 16:


==Detailed description==
==Detailed description==


''No detailed description exists yet for this component''
''No detailed description exists yet for this component''


==Examples==
==Examples==




Line 32: Line 36:
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CheckBuffer'''
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ResetRecords'''
|-
|-
| colspan="2" | Returns the number of values in the transmit or receive buffer 
| colspan="2" | Allows the peak and trough to be reset back to default values. 
|-
|-
|-
|-
| width="10%" align="center" | [[File:]] -  
| width="10%" align="center" | [[File:]] -  
| width="90%" | Buffer
| width="90%" | ResetPeak
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | ResetTrough
|-
|-
| colspan="2" | 0=Transmit / 1=Receive 
| colspan="2" |  
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}
Line 79: Line 88:
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveByteArray'''
|-
| colspan="2" | Receives an array of bytes and returns the number of bytes received. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" | A byte array variable to hold the received data 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | NumBytes
|-
| colspan="2" | Maximum number of bytes to try and receive 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Timeout
|-
| colspan="2" | Max amount of time in ms to wait between bytes 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}
Line 142: Line 123:
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Uninit'''
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Start'''
|-
|-
| colspan="2" | Un-initialize the UART and release the resources 
| colspan="2" | Startup routine required by the hardware device. Automatically clears the display after initialising. 
|-
|-
|-
|-
Line 155: Line 136:
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetList'''
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLEDState'''
|-
|-
| colspan="2" | Gets Named property List 
| colspan="2" | Sets the state of a single LED 
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Name
| width="90%" | Port
|-
|-
| colspan="2" |  
| colspan="2" | 0 = PortA, 1 = PortB 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" | LED
|}
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| colspan="2" | 0 = LED0, 7 = LED7 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Delay'''
|-
|-
| colspan="2" | Software UART Bit Delay 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
|-
| width="90%" | State
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue'''
|-
| colspan="2" | set Value of Named property 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Value
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 209: Line 164:
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Uninit'''
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRxIdent'''
|-
|-
| colspan="2" | Un-initialize the UART and release the resources 
| colspan="2" | Gets the Rx ID as a Integer Standard and Extended IDs. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetList'''
|-
| colspan="2" | Gets Named property List 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveByteArray'''
|-
| colspan="2" | Receives an array of bytes and returns the number of bytes received. 
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
| width="90%" | Buffer
|-
|-
| colspan="2" |  
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | NumBytes
|-
| colspan="2" | Maximum number of bytes to try and receive 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Timeout
|-
| colspan="2" | Max amount of time in ms to wait between bytes 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}
Line 268: Line 182:
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveString'''
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
|-
|-
| colspan="2" | Receives a string of bytes and returns the number of bytes received. 
| colspan="2" | Must be called before any other CAN component macros to enable and initialise the CAN peripheral.  
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" | StringData
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NumBytes
|-
| colspan="2" | Maximum number of bytes to try and receive 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Timeout
|-
| colspan="2" | Max amount of time in ms to wait between bytes 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetList'''
|-
| colspan="2" | returns Named property list 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}

Revision as of 10:35, 17 November 2021

Author Matrix TSL
Version 1.1
Category Matrix Tools


Device Helper component

A purely cosmetic component for viewing the details specific to your current selected target microcontroller. Lists stats like ADC resolution, ADC channels, UARTs, SPI, PWM, RAM, ROM etc

Detailed description

No detailed description exists yet for this component

Examples

By simply adding the device helper component to your project and selecting it on the panel you can see all the following statistics regarding your current selected microcontroller in the properties window.


Downloadable macro reference

ResetRecords
Allows the peak and trough to be reset back to default values. 
[[File:]] - ResetPeak
 
[[File:]] - ResetTrough
 
- VOID Return


ReceiveString
Gets a string from the receive buffer 
- UINT MaxChars
 
- UINT Timeout
Time in milliseconds to wait for data 
- STRING Return


Initialise
Initialises the UART component pins ready to send and receive data 
- VOID Return


ReceiveString
Receives a string of bytes and returns the number of bytes received. 
- STRING StringData
 
- UINT NumBytes
Maximum number of bytes to try and receive 
- UINT Timeout
Max amount of time in ms to wait between bytes 
- BYTE Return


Start
Startup routine required by the hardware device. Automatically clears the display after initialising. 
- VOID Return


SetLEDState
Sets the state of a single LED 
- BYTE Port
0 = PortA, 1 = PortB 
- BYTE LED
0 = LED0, 7 = LED7 
- BYTE State
 
- VOID Return


GetRxIdent
Gets the Rx ID as a Integer Standard and Extended IDs. 
- BYTE Buffer
 
- ULONG Return


Initialise
Must be called before any other CAN component macros to enable and initialise the CAN peripheral.  
- VOID Return



Property reference

Properties
Pin Count
 
Max Clock Speed
Maximum frequency the device can operate. 
Master Divider
Number of clock cycles per single device instruction. 
Max MIPs
Million Instructions Per Second (MIPS) Number of complete instruction cycles per second based on the max clock speed and instructions per clock divided by 1 million. Note that some instructions such as decisions can take multiple instructions to complete. 
ROM Size
Number of bytes available for ROM storage. ROM - Read Only Memory - Contains the Flowcode program as well as other constants such as strings 
RAM Size
Number of bytes available for RAM storage. RAM - Random Access Memory - Contains the Flowcode variables as well as the operational stack 
EEPROM Size
Number of bytes available for EEPROM storage. EEPROM - Electrically Erasable Programmable Read Only Memory - Contains user data that can persist when the power is removed 
ADC Max Bits
Maximum number of bits used for an ADC conversion which dictates the maximum reading the ADC can generate. 8 bits = 0 - 255 10 bits = 0 - 1023 12 bits = 0 - 4095 
ADC Pins
Number of pins capable of reading an analogue input. 
DAC Max Bits
Maximum number of bits used for an DAC conversion which dictates the output resolution of the DAC. 5 bits = 0 - 31 8 bits = 0 - 255 10 bits = 0 - 1023 
DAC Pins
Number of pins capable of outputting an analogue voltage. 
Digital Pins
Number of pins capable of reading a digital input and/or writing a digital output. 
CAN Count
Controller Area Network (CAN) Used for fixed system architecture in noisy environments e.g. Cars and Automotive 
I2C Count
Inter-Integrated Circuit (I2C) Used for on board communications e.g. Sensors, Memory 
I2C Modes
 
H-Bridge Count
 
PWM Count
Pulse Width Modulation Output (PWM) Useful for analogue style outputs. 
SPI Count
Serial Peripheral Interface (SPI) Used for high speed on board communications e.g. Sensors, Memory 
UART Count
Universal Asynchronous Receiver Transmitter (UART) Used for on board and off board communications e.g. RS232, Bluetooth, GPS, GSM 
USB Count
Universal Serial Bus (USB) Used for interconnective communications with high end equipment such as PCs. 
Connections
Simulations