Difference between revisions of "Component: E block Helper (E blocks 1)"

From Flowcode Help
Jump to navigationJump to search
 
(3 intermediate revisions by the same user not shown)
Line 15: Line 15:
 
A purely cosmetic component to help simplify E-block connections without having to keep referring to the datasheets. Specify which E-block your using and the component will give you options for the patch settings and display the connections required.
 
A purely cosmetic component to help simplify E-block connections without having to keep referring to the datasheets. Specify which E-block your using and the component will give you options for the patch settings and display the connections required.
  
−
==Detailed description==
+
==Component Pack==
  
 +
FREE
  
 +
==Detailed description==
  
−
''No detailed description exists yet for this component''
 
  
−
==Examples==
 
  
  
  
  
−
Example of E-blocks helper component being used to determine connections.
 
  
−
[[File:EBHelp.jpg]]
 
  
−
==Downloadable macro reference==
 
  
−
{| 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;" | '''ReceiveCount'''
 
−
|-
 
−
| colspan="2" | Returns the number of bytes currently sat waiting in the receive buffer. 
 
−
|-
 
−
|-
 
−
| 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;"
+
''No detailed description exists yet for this component''
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadString'''
 
−
|-
 
−
| colspan="2" | Copies the incoming data from the data string array to a local string variable.  
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | NumBytes
 
−
|-
 
−
| colspan="2" | Maximum number of bytes to try and read 
 
−
|-
 
−
| 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''
 
−
|}
 
  
 +
==Examples==
  
−
{| 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;" | '''SendByte'''
 
−
|-
 
−
| colspan="2" | Sends a single data byte out to the Bluetooth module. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Data
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| 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;" | '''EnterCommandMode'''
 
−
|-
 
−
| colspan="2" | Enters command mode allowing commands to be sent using the SendCommand macro. Returns: 0 = No Reply / 1 = Command Mode OK 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
 
−
| 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;" | '''WaitForStringValue'''
 
−
|-
 
−
| colspan="2" | Allows us to wait and check for an incoming value. Returns 1 if the string value is found otherwise returns 0. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
−
| width="90%" | Value
 
−
|-
 
−
| colspan="2" | String value to look for 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Timeout
 
−
|-
 
−
| colspan="2" | Length of time to wait in milliseconds 
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
 
−
| 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;" | '''GetMACAddress'''
 
−
|-
 
−
| colspan="2" | Gets the local Bluetooth device MAC address. 
 
−
|-
 
−
|-
 
−
| 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;" | '''Initialise'''
 
−
|-
 
−
| colspan="2" | Sets up the Bluetooth module including:  - Enabling the UART  - Configuring the module (Name / Key / etc) Returns 1 for OK and 0 for no reply. 
 
−
|-
 
−
|-
 
−
| 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;" | '''Start'''
 
−
|-
 
−
| colspan="2" | Startup routine required by the hardware device. Automatically clears the display after initialising. 
 
−
|-
 
−
|-
 
−
| 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''
 
−
|}
 
  
 +
Example of E-blocks helper component being used to determine connections.
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
[[File:EBHelp.jpg]]
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLEDState'''
 
−
|-
 
−
| colspan="2" | Sets the state of a single LED 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Port
 
−
|-
 
−
| colspan="2" | 0 = PortA, 1 = PortB 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | LED
 
−
|-
 
−
| colspan="2" | 0 = LED0, 7 = LED7 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | State
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| 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;" | '''GetRxIdent'''
 
−
|-
 
−
| colspan="2" | Gets the Rx ID as a Integer Standard and Extended IDs. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Buffer
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
 
−
| 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;" | '''Initialise'''
 
−
|-
 
−
| colspan="2" | Must be called before any other CAN component macros to enable and initialise the CAN peripheral.  
 
−
|-
 
−
|-
 
−
| 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''
 
−
|}
 
  
 +
==Downloadable macro reference==
  
  
Line 234: Line 71:
 
|-
 
|-
 
| colspan="2" | Cosmetic name of the E-block to confirm you have the correct board. 
 
| colspan="2" | Cosmetic name of the E-block to confirm you have the correct board. 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections Port 1
 +
|-
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
Line 274: Line 115:
 
|-
 
|-
 
| colspan="2" | Port 1 Bit 7 
 
| colspan="2" | Port 1 Bit 7 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
−
| width="90%" | Bit 0
 
−
|-
 
−
| colspan="2" | Port 2 Bit 0 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
−
| width="90%" | Bit 1
 
−
|-
 
−
| colspan="2" | Port 2 Bit 1 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
−
| width="90%" | Bit 2
 
−
|-
 
−
| colspan="2" | Port 2 Bit 2 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
−
| width="90%" | Bit 3
 
−
|-
 
−
| colspan="2" | Port 2 Bit 3 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
−
| width="90%" | Bit 4
 
−
|-
 
−
| colspan="2" | Port 2 Bit 4 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
−
| width="90%" | Bit 5
 
−
|-
 
−
| colspan="2" | Port 2 Bit 5 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
−
| width="90%" | Bit 6
 
−
|-
 
−
| colspan="2" | Port 2 Bit 6 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
−
| width="90%" | Bit 7
 
−
|-
 
−
| colspan="2" | Port 2 Bit 7 
 
−
|-
 
−
| 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'''
 
−
|-
 
 
|}
 
|}

Latest revision as of 17:19, 9 November 2022

Author Matrix Ltd
Version 1.1
Category E-blocks 1


E-block Helper component

A purely cosmetic component to help simplify E-block connections without having to keep referring to the datasheets. Specify which E-block your using and the component will give you options for the patch settings and display the connections required.

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

Example of E-blocks helper component being used to determine connections.

EBHelp.jpg

Downloadable macro reference

Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png E-block ID
E-block product ID 
Fc9-type-10-icon.png E-block Name
Cosmetic name of the E-block to confirm you have the correct board. 
Fc9-conn-icon.png Connections Port 1
Fc9-type-10-icon.png Bit 0
Port 1 Bit 0 
Fc9-type-10-icon.png Bit 1
Port 1 Bit 1 
Fc9-type-10-icon.png Bit 2
Port 1 Bit 2 
Fc9-type-10-icon.png Bit 3
Port 1 Bit 3 
Fc9-type-10-icon.png Bit 4
Port 1 Bit 4 
Fc9-type-10-icon.png Bit 5
Port 1 Bit 5 
Fc9-type-10-icon.png Bit 6
Port 1 Bit 6 
Fc9-type-10-icon.png Bit 7
Port 1 Bit 7 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_E_block_Helper_(E_blocks_1)&oldid=28556"