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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(19 intermediate revisions by 2 users not shown)
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
  
==[[File:Component Icon e2ed1829_6967_4339_98e1_3806650297c5.png|Image]] Device Helper component==
+
==Component Source Code==
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==
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Device_Helper.fcfx FC_Comp_Source_Device_Helper.fcfx]
''<span style="color:red;">No additional examples</span>''
 
  
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Device_Helper.fcfx FC_Comp_Source_Device_Helper.fcfx]
  
==Downloadable macro reference==
+
==Detailed description==
  
''This component does not contain any downloadable macros''
 
  
==Simulation macro reference==
 
  
''This component does not contain any simulation macros''
 
  
  
==Property reference==
 
<span style="font-weight: normal;"><u>Pin Count</u></span>
 
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''PinCount''.
 
  
''<span style="color:red;">No additional information</span>''
 
  
  
  
<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''.
 
  
Maximum frequency the device can operate.
 
  
<span style="font-weight: normal;"><u>Master Divider</u></span>
 
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Divider''.
 
  
Number of clock cycles per single device instruction.
 
  
<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''.
 
  
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.
 
  
<span style="font-weight: normal;"><u>ROM Size</u></span>
 
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''ROMSize''.
 
  
Number of bytes available for ROM storage.
+
''No detailed description exists yet for this component''
  
ROM - Read Only Memory - Contains the Flowcode program as well as other constants such as strings
+
==Examples==
  
<span style="font-weight: normal;"><u>RAM Size</u></span>
 
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''RAMSize''.
 
  
Number of bytes available for RAM storage.
 
  
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.
 
  
EEPROM - Electrically Erasable Programmable Read Only Memory - Contains user data that can persist when the power is removed
 
  
<span style="font-weight: normal;"><u>ADC Max Bits</u></span>
 
  
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.
 
  
8 bits = 0 - 255
 
  
10 bits = 0 - 1023
 
  
12 bits = 0 - 4095
 
  
<span style="font-weight: normal;"><u>ADC Pins</u></span>
 
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''ADCPins''.
 
  
Number of pins capable of reading an analogue input.
 
  
<span style="font-weight: normal;"><u>DAC Max Bits</u></span>
 
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''DACMaxBits''.
 
  
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
 
  
<span style="font-weight: normal;"><u>DAC Pins</u></span>
+
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.
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''DACPins''.
 
  
Number of pins capable of outputting an analogue voltage.
+
[[File:Dev_Helper.jpg]]
  
<span style="font-weight: normal;"><u>Digital Pins</u></span>
 
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''DigPins''.
 
  
Number of pins capable of reading a digital input and/or writing a digital output.
 
  
<span style="font-weight: normal;"><u>CAN Count</u></span>
 
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''CANCount''.
 
  
Controller Area Network (CAN)
 
  
Used for fixed system architecture in noisy environments e.g. Cars and Automotive
 
  
<span style="font-weight: normal;"><u>I2C Count</u></span>
 
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''I2CCount''.
 
  
Inter-Integrated Circuit (I2C)
 
  
Used for on board communications e.g. Sensors, Memory
+
==Macro reference==
  
<span style="font-weight: normal;"><u>PWM Count</u></span>
+
==Property reference==
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''PWMCount''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
Pulse Width Modulation Output (PWM)
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
Useful for analogue style outputs.
+
|-
 
+
|-
<span style="font-weight: normal;"><u>SPI Count</u></span>
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Device
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''SPICount''.
+
|-
 
+
|-
Serial Peripheral Interface (SPI)
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | Pin Count
Used for high speed on board communications e.g. Sensors, Memory
+
|-
 
+
| colspan="2" | &nbsp;
<span style="font-weight: normal;"><u>UART Count</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 ''UARTCount''.
+
| width="90%" | Max Clock Speed
 
+
|-
Universal Asynchronous Receiver Transmitter (UART)
+
| colspan="2" | Maximum frequency the device can operate.&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]]
 
+
| width="90%" | Master Divider
<span style="font-weight: normal;"><u>USB Count</u></span>
+
|-
 
+
| colspan="2" | Number of clock cycles per single device instruction.&nbsp;
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''USBCount''.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
Universal Serial Bus (USB)
+
| width="90%" | Max MIPs
 
+
|-
Used for interconnective communications with high end equipment such as PCs.
+
| 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;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Memory
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | ROM Size
 +
|-
 +
| 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;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | RAM Size
 +
|-
 +
| colspan="2" | Number of bytes available for RAM storage. RAM - Random Access Memory - Contains the Flowcode variables as well as the operational stack&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | EEPROM Size
 +
|-
 +
| 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;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Analogue
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | ADC Max Bits
 +
|-
 +
| 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;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | ADC Pins
 +
|-
 +
| colspan="2" | Number of pins capable of reading an analogue input.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | DAC Max Bits
 +
|-
 +
| 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;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | DAC Pins
 +
|-
 +
| colspan="2" | Number of pins capable of outputting an analogue voltage.&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Digital / Peripheral
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Digital Pins
 +
|-
 +
| 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
 +
|-
 +
| colspan="2" | Controller Area Network (CAN) Used for fixed system architecture in noisy environments e.g. Cars and Automotive&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | I2C Count
 +
|-
 +
| colspan="2" | Inter-Integrated Circuit (I2C) Used for on board communications e.g. Sensors, Memory&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | I2C Modes
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | H-Bridge Count
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | PWM Count
 +
|-
 +
| colspan="2" | Pulse Width Modulation Output (PWM) Useful for analogue style outputs.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | SPI Count
 +
|-
 +
| colspan="2" | Serial Peripheral Interface (SPI) Used for high speed on board communications e.g. Sensors, Memory&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | UART Count
 +
|-
 +
| 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;
 +
|}

Latest revision as of 13:09, 7 February 2023

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

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Device_Helper.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Device_Helper.fcfx

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






Macro reference

Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Device
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-conn-icon.png Memory
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-conn-icon.png Analogue
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-conn-icon.png Digital / Peripheral
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.