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

From Flowcode Help
Jump to navigationJump to search
(XML import)
Line 1: Line 1:
 
+
{| style="width:50%"
 
 
{| width="50%"
 
 
|-
 
|-
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
| 1.1 (Release)
+
| 1.1
 
|-
 
|-
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Matrix Tools
 
| 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==
  
==[[File:Component Icon e2ed1829_6967_4339_98e1_3806650297c5.png|Image]] Device Helper component==
+
''No detailed description exists yet for this 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
 
  
 
==Examples==
 
==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.
 
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.
  
Line 27: Line 29:
 
==Downloadable macro reference==
 
==Downloadable macro reference==
  
''This component does not contain any downloadable macros''
+
{| 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;" | '''CheckBuffer'''
 +
|-
 +
| colspan="2" | Returns the number of values in the transmit or receive buffer 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Buffer
 +
|-
 +
| colspan="2" | 0=Transmit / 1=Receive 
 +
|-
 +
| 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''
 +
|}
  
==Simulation macro reference==
 
  
''This component does not contain any simulation macros''
+
{| 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;" | '''ReceiveString'''
 +
|-
 +
| colspan="2" | Gets a string from the receive buffer 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | MaxChars
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Timeout
 +
|-
 +
| colspan="2" | Time in milliseconds to wait for data 
 +
|-
 +
| 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''
 +
|}
  
  
==Property reference==
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
<span style="font-weight: normal;"><u>Pin Count</u></span>
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 +
|-
 +
| colspan="2" | Initialises the UART component pins ready to send and receive data&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''PinCount''.
 
  
''<span style="color:red;">No additional information</span>''
+
{| 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.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | A byte array variable to hold the received data&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | NumBytes
 +
|-
 +
| colspan="2" | Maximum number of bytes to try and receive&nbsp;
 +
|-
 +
| 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&nbsp;
 +
|-
 +
| 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''
 +
|}
  
  
 +
{| 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;" | '''ReceiveString'''
 +
|-
 +
| colspan="2" | Receives a string of bytes and returns the number of bytes received.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | StringData
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | NumBytes
 +
|-
 +
| colspan="2" | Maximum number of bytes to try and receive&nbsp;
 +
|-
 +
| 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&nbsp;
 +
|-
 +
| 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''
 +
|}
  
<span style="font-weight: normal;"><u>Max Clock Speed</u></span>
 
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''MaxClock''.
+
{| 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;" | '''Uninit'''
 +
|-
 +
| colspan="2" | Un-initialize the UART and release the resources&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
Maximum frequency the device can operate.
 
  
<span style="font-weight: normal;"><u>Master Divider</u></span>
+
{| 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&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Name
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Divider''.
 
  
Number of clock cycles per single device instruction.
+
{| 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;" | '''Delay'''
 +
|-
 +
| colspan="2" | Software UART Bit Delay&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
<span style="font-weight: normal;"><u>Max MIPs</u></span>
 
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''MaxInst''.
+
{| 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&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Name
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
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.
+
{| 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;" | '''Uninit'''
 +
|-
 +
| colspan="2" | Un-initialize the UART and release the resources&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
Note that some instructions such as decisions can take multiple instructions to complete.
 
  
<span style="font-weight: normal;"><u>ROM Size</u></span>
+
{| 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&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Name
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''ROMSize''.
 
  
Number of bytes available for ROM storage.
+
{| 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.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | NumBytes
 +
|-
 +
| colspan="2" | Maximum number of bytes to try and receive&nbsp;
 +
|-
 +
| 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&nbsp;
 +
|-
 +
| 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''
 +
|}
  
ROM - Read Only Memory - Contains the Flowcode program as well as other constants such as strings
 
  
<span style="font-weight: normal;"><u>RAM Size</u></span>
+
{| 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;" | '''ReceiveString'''
 +
|-
 +
| colspan="2" | Receives a string of bytes and returns the number of bytes received.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | StringData
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | NumBytes
 +
|-
 +
| colspan="2" | Maximum number of bytes to try and receive&nbsp;
 +
|-
 +
| 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&nbsp;
 +
|-
 +
| 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''
 +
|}
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''RAMSize''.
 
  
Number of bytes available for RAM storage.
+
{| 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&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Name
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
RAM - Random Access Memory - Contains the Flowcode variables as well as the operational stack
 
  
<span style="font-weight: normal;"><u>EEPROM Size</u></span>
 
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''EESize''.
 
  
Number of bytes available for EEPROM storage.
+
==Property reference==
  
EEPROM - Electrically Erasable Programmable Read Only Memory - Contains user data that can persist when the power is removed
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
<span style="font-weight: normal;"><u>ADC Max Bits</u></span>
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''ADCBits''.
+
|-
 
+
|-
Maximum number of bits used for an ADC conversion which dictates the maximum reading the ADC can generate.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | Pin Count
8 bits = 0 - 255
+
|-
 
+
| colspan="2" | &nbsp;
10 bits = 0 - 1023
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
12 bits = 0 - 4095
+
| width="90%" | Max Clock Speed
 
+
|-
<span style="font-weight: normal;"><u>ADC Pins</u></span>
+
| colspan="2" | Maximum frequency the device can operate.&nbsp;
 
+
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''ADCPins''.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | Master Divider
Number of pins capable of reading an analogue input.
+
|-
 
+
| colspan="2" | Number of clock cycles per single device instruction.&nbsp;
<span style="font-weight: normal;"><u>DAC Max Bits</u></span>
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''DACMaxBits''.
+
| width="90%" | Max MIPs
 
+
|-
Maximum number of bits used for an DAC conversion which dictates the output resolution of the DAC.
+
| colspan="2" | 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.&nbsp;
 
+
|-
5 bits = 0 - 31
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | ROM Size
8 bits = 0 - 255
+
|-
 
+
| colspan="2" | Number of bytes available for ROM storage. ROM - Read Only Memory - Contains the Flowcode program as well as other constants such as strings&nbsp;
10 bits = 0 - 1023
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
<span style="font-weight: normal;"><u>DAC Pins</u></span>
+
| width="90%" | RAM Size
 
+
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''DACPins''.
+
| colspan="2" | Number of bytes available for RAM storage. RAM - Random Access Memory - Contains the Flowcode variables as well as the operational stack&nbsp;
 
+
|-
Number of pins capable of outputting an analogue voltage.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | EEPROM Size
<span style="font-weight: normal;"><u>Digital Pins</u></span>
+
|-
 
+
| colspan="2" | 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&nbsp;
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''DigPins''.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
Number of pins capable of reading a digital input and/or writing a digital output.
+
| width="90%" | ADC Max Bits
 
+
|-
<span style="font-weight: normal;"><u>CAN Count</u></span>
+
| colspan="2" | 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&nbsp;
 
+
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''CANCount''.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | ADC Pins
Controller Area Network (CAN)
+
|-
 
+
| colspan="2" | Number of pins capable of reading an analogue input.&nbsp;
Used for fixed system architecture in noisy environments e.g. Cars and Automotive
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
<span style="font-weight: normal;"><u>I2C Count</u></span>
+
| width="90%" | DAC Max Bits
 
+
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''I2CCount''.
+
| colspan="2" | 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&nbsp;
 
+
|-
Inter-Integrated Circuit (I2C)
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | DAC Pins
Used for on board communications e.g. Sensors, Memory
+
|-
 
+
| colspan="2" | Number of pins capable of outputting an analogue voltage.&nbsp;
<span style="font-weight: normal;"><u>I2C Modes</u></span>
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
This property is of type ''Line of text'' and can be referenced with the variable name ''I2CModel''.
+
| width="90%" | Digital Pins
 
+
|-
''<span style="color:red;">No additional information</span>''
+
| colspan="2" | Number of pins capable of reading a digital input and/or writing a digital output.&nbsp;
 
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | CAN Count
<span style="font-weight: normal;"><u>PWM Count</u></span>
+
|-
 
+
| colspan="2" | Controller Area Network (CAN) Used for fixed system architecture in noisy environments e.g. Cars and Automotive&nbsp;
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''PWMCount''.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
Pulse Width Modulation Output (PWM)
+
| width="90%" | I2C Count
 
+
|-
Useful for analogue style outputs.
+
| colspan="2" | Inter-Integrated Circuit (I2C) Used for on board communications e.g. Sensors, Memory&nbsp;
 
+
|-
<span style="font-weight: normal;"><u>SPI Count</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
+
| width="90%" | I2C Modes
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''SPICount''.
+
|-
 
+
| colspan="2" | &nbsp;
Serial Peripheral Interface (SPI)
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
Used for high speed on board communications e.g. Sensors, Memory
+
| width="90%" | H-Bridge Count
 
+
|-
<span style="font-weight: normal;"><u>UART Count</u></span>
+
| colspan="2" | &nbsp;
 
+
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''UARTCount''.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | PWM Count
Universal Asynchronous Receiver Transmitter (UART)
+
|-
 
+
| colspan="2" | Pulse Width Modulation Output (PWM) Useful for analogue style outputs.&nbsp;
Used for on board and off board communications e.g. RS232, Bluetooth, GPS, GSM
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
<span style="font-weight: normal;"><u>USB Count</u></span>
+
| width="90%" | SPI Count
 
+
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''USBCount''.
+
| colspan="2" | Serial Peripheral Interface (SPI) Used for high speed on board communications e.g. Sensors, Memory&nbsp;
 
+
|-
Universal Serial Bus (USB)
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | UART Count
Used for interconnective communications with high end equipment such as PCs.
+
|-
 +
| colspan="2" | Universal Asynchronous Receiver Transmitter (UART) Used for on board and off board communications e.g. RS232, Bluetooth, GPS, GSM&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | USB Count
 +
|-
 +
| colspan="2" | Universal Serial Bus (USB) Used for interconnective communications with high end equipment such as PCs.&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
 +
|-
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
 +
|-
 +
|}

Revision as of 16:13, 16 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.


Dev Helper.jpg

Downloadable macro reference

Fc9-comp-macro.png CheckBuffer
Returns the number of values in the transmit or receive buffer 
[[File:]] - Buffer
0=Transmit / 1=Receive 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png ReceiveString
Gets a string from the receive buffer 
Fc9-u16-icon.png - UINT MaxChars
 
Fc9-u16-icon.png - UINT Timeout
Time in milliseconds to wait for data 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png Initialise
Initialises the UART component pins ready to send and receive data 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReceiveByteArray
Receives an array of bytes and returns the number of bytes received. 
Fc9-u8-icon.png - BYTE Data
A byte array variable to hold the received data 
Fc9-u16-icon.png - UINT NumBytes
Maximum number of bytes to try and receive 
Fc9-u16-icon.png - UINT Timeout
Max amount of time in ms to wait between bytes 
Fc9-u16-icon.png - UINT Return


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


Fc9-comp-macro.png Uninit
Un-initialize the UART and release the resources 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetList
Gets Named property List 
Fc9-string-icon.png - STRING Name
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png Delay
Software UART Bit Delay 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetValue
set Value of Named property 
Fc9-string-icon.png - STRING Name
 
Fc9-string-icon.png - STRING Value
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Uninit
Un-initialize the UART and release the resources 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetList
Gets Named property List 
Fc9-string-icon.png - STRING Name
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png ReceiveByteArray
Receives an array of bytes and returns the number of bytes received. 
Fc9-u8-icon.png - BYTE Data
 
Fc9-u8-icon.png - BYTE NumBytes
Maximum number of bytes to try and receive 
Fc9-u8-icon.png - BYTE Timeout
Max amount of time in ms to wait between bytes 
Fc9-u8-icon.png - BYTE Return


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


Fc9-comp-macro.png GetList
returns Named property list 
Fc9-string-icon.png - STRING Name
 
Fc9-string-icon.png - STRING Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-21-icon.png Pin Count
 
Fc9-type-21-icon.png Max Clock Speed
Maximum frequency the device can operate. 
Fc9-type-21-icon.png Master Divider
Number of clock cycles per single device instruction. 
Fc9-type-21-icon.png 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. 
Fc9-type-21-icon.png 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 
Fc9-type-21-icon.png RAM Size
Number of bytes available for RAM storage. RAM - Random Access Memory - Contains the Flowcode variables as well as the operational stack 
Fc9-type-21-icon.png 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 
Fc9-type-21-icon.png 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 
Fc9-type-21-icon.png ADC Pins
Number of pins capable of reading an analogue input. 
Fc9-type-21-icon.png 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 
Fc9-type-21-icon.png DAC Pins
Number of pins capable of outputting an analogue voltage. 
Fc9-type-21-icon.png Digital Pins
Number of pins capable of reading a digital input and/or writing a digital output. 
Fc9-type-21-icon.png CAN Count
Controller Area Network (CAN) Used for fixed system architecture in noisy environments e.g. Cars and Automotive 
Fc9-type-21-icon.png I2C Count
Inter-Integrated Circuit (I2C) Used for on board communications e.g. Sensors, Memory 
Fc9-type-10-icon.png I2C Modes
 
Fc9-type-21-icon.png H-Bridge Count
 
Fc9-type-21-icon.png PWM Count
Pulse Width Modulation Output (PWM) Useful for analogue style outputs. 
Fc9-type-21-icon.png SPI Count
Serial Peripheral Interface (SPI) Used for high speed on board communications e.g. Sensors, Memory 
Fc9-type-21-icon.png UART Count
Universal Asynchronous Receiver Transmitter (UART) Used for on board and off board communications e.g. RS232, Bluetooth, GPS, GSM 
Fc9-type-21-icon.png USB Count
Universal Serial Bus (USB) Used for interconnective communications with high end equipment such as PCs. 
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations