Flowcode Help - User contributions [en]

File:Fc9-f32-icon.png

2021-11-17T13:25:21Z

DavidA:

File:Fc9-s16-icon.png

2021-11-17T13:22:56Z

DavidA:

File:Fc9-bool-icon.png

2021-11-17T13:13:18Z

DavidA:

Component: Bluetooth (EB024, Generic AT) (Wireless)

2021-11-16T15:23:29Z

DavidA:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color:gray;" | Version
| 2.0
|-
| width="20%" style="color:gray;" | Category
| Wireless
|}

==Bluetoot (EB024, Generic AT) component==
Low level routines for controlling a standard AT Bluetooth interface. Also available in the form of the EB024 Bluetooth E-block.

==Detailed description==

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

==Examples==

===Making a device discoverable===

Example program to set up the Bluetooth module to be discoverable with a pair key. Any data received is then output onto the LCD component. You can connect to the Bluetooth device using a PC with Bluetooth connection and using software such as Flowcode 6, RealTerm or HyperTerminal. Alternatively you can connect using a smart phone running a terminal emulator app or via another embedded Bluetooth board.
{{Fcfile|BluetoothDiscover.fcfx|Bluetooth Discover}}
Script 1 contains the AT commands to setup the Bluetooth device to be discoverable with pair key "1234".

[[File:DiscoverableScript.jpg]]

===Searching for a device===

Example program to scan for local discoverable Bluetooth devices. For each device found the MAC address is displayed on to the LCD.
{{Fcfile|BluetoothInquire.fcfx|Bluetooth Inquiry}}
===Connecting to a device===

Example program to connect to a specific Bluetooth device address and send data to the device.
{{Fcfile|BluetoothConnect.fcfx|Bluetooth Connect}}
The device MAC address is specified using the "CreateCommandString" and "SendCommand" macros.

[[File:ConnectToMAC.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;" | '''StringRead'''
|-
| colspan="2" | Returns the ASCII value of character idx of the Response string. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | idx
|-
| colspan="2" | Needs to be a equal to or less than the string length of the response in order to retrieve a valid character. 
|-
| 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;" | '''SendScript'''
|-
| colspan="2" | Sends Script idx Note that the general property Number of Scripts needs to be set so that it allows the scripts to be accessed and sent. Returns 0 for success and 1 for error  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | idx
|-
| colspan="2" | Refers to the Script page to send (1-4). 
|-
| 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;" | '''SendCommand'''
|-
| colspan="2" | Sends the command buffer. Returns 1 for success in sending the command. Returns 0 for errors. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ExpectEcho
|-
| colspan="2" | Remote module automatically echos back data: 1 = On (Expect echo), 0 = off 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | SendCR
|-
| colspan="2" | Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR. 
|-
| 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;" | '''CreateCommandString'''
|-
| colspan="2" | Assigns a string of characters to the Command buffer. Returns 1 for success in adding the characters to the buffer. Returns 0 for errors, including Buffer overflow. 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Data
|-
| colspan="2" |  
|-
| 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;" | '''StringReceive'''
|-
| colspan="2" | Checks for a response string. Returns the length of the response string if one is present otherwise returns 0.  
|-
|-
| 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;" | '''CreateCommand'''
|-
| colspan="2" | Adds a single characters to the end of the Command buffer. Returns 1 for success in adding the characters to the buffer. Returns 0 for errors, including Buffer overflow. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Character
|-
| colspan="2" | ASCII value or single character, 
|-
| 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;" | '''Send_byte'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ByteVal
|-
| 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;" | '''WaitForResponse'''
|-
| colspan="2" | Waits for a response message of type response_code for timeout ms. Returns: 0 for a Response of type response_code 255 (0xFF) for a timeout or invalid response Response string length for any Response not of type response_code 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | response_code
|-
| colspan="2" | 1:OK / 2:ERROR / 3:CONNECT / 4:NO CARRIER / 5:AUDIO / 6:PAIR / 7:RING 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | timeout
|-
| colspan="2" | The timeout value will need to set to allow sufficient time for the response to arrive. 
|-
| 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;" | '''Initialise'''
|-
| colspan="2" | Required to be used whenever the Bluetooth component is used in a program. Initialises the Bluetooth component ready for use. 
|-
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Command Buffer Size
|-
| colspan="2" | Maximum number of bytes that can be stored in the outgoing command buffer. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Response Buffer Size
|-
| colspan="2" | Maximum number of bytes that can be stored in the incoming response buffer. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Script Count
|-
| colspan="2" | Controls how many AT scripts are stored into non-volatile memory 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Script 1
|-
| colspan="2" | Data to send for script 0, each command should be terminated with a carriage return 
|-
| 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" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | TX
|-
| colspan="2" | Pin to be used for Transmit data 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | RX
|-
| colspan="2" | Pin to be used for Receive data 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Use Flow Control
|-
| colspan="2" | Flow Control (Handshake) enable or disable. On: Two I/O pins are used to control the flow of data in and out of the device. Off: Flow control is disabled. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Baud Options
|-
| colspan="2" | Baud rate option selector 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Baud Rate
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Console Columns
|-
| colspan="2" | Number of characters that can be displayed on a single line of the console. 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Console Data
|-
| colspan="2" | Selects if the console data is automatically generated or not 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scope Traces
|-
| colspan="2" | Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Data Source
|-
| colspan="2" | Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port API - Routes the communication data via a data API component on the Panel. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | API
|-
| colspan="2" | Selects whichAPI component to route the communication data via. Add API components to the panel before they will be available in this list. API components are available from the Comms component category. 
|}

Component: Bluetooth (EB024, Generic AT) (Wireless)

2021-11-16T13:37:33Z

DavidA:

2021-08-31T11:46:36Z

DavidA: Blanked the page

Bot test

2021-08-31T09:59:55Z

DavidA: Blanked the page

DavidA:

2021-08-17T13:07:39Z

DavidA:

Bot test

2021-08-17T13:06:03Z

DavidA:

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''ev_Prop_Change'''
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''StringRead'''
|-
| colspan="2" | Returns the ASCII value of character idx of the Response string.
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | idx
|-
| colspan="2" | Needs to be a equal to or less than the string length of the response in order to retrieve a valid character.
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''Ev_Timer'''
|-
| colspan="2" | Called back on the panel command System.TimerStart
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | TimerID
|-
| colspan="2" | The identifier passed to the System.TimerStart panel command
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''SendScript'''
|-
| colspan="2" | Sends Script idx Note that the general property Number of Scripts needs to be set so that it allows the scripts to be accessed and sent. Returns 0 for success and 1 for error
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | idx
|-
| colspan="2" | Refers to the Script page to send (1-4).
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''SendCommand'''
|-
| colspan="2" | Sends the command buffer. Returns 1 for success in sending the command. Returns 0 for errors.
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ExpectEcho
|-
| colspan="2" | Remote module automatically echos back data: 1 = On (Expect echo), 0 = off
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | SendCR
|-
| colspan="2" | Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''SendScriptString'''
|-
| colspan="2" |
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | str
|-
| colspan="2" |
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | SendCR
|-
| colspan="2" | Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''Ev_ChipChange'''
|-
| colspan="2" | Sent when the target device has changed
|-
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Target
|-
| colspan="2" | The name of the new target device
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | SendCR
|-
| colspan="2" | Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''Read_byte'''
|-
| colspan="2" |
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Timeout
|-
| colspan="2" |
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | SendCR
|-
| colspan="2" | Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''CreateCommandString'''
|-
| colspan="2" | Assigns a string of characters to the Command buffer. Returns 1 for success in adding the characters to the buffer. Returns 0 for errors, including Buffer overflow.
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Data
|-
| colspan="2" |
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | SendCR
|-
| colspan="2" | Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''ev_Init'''
|-
| colspan="2" |
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Data
|-
| colspan="2" |
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | SendCR
|-
| colspan="2" | Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''StringReceive'''
|-
| colspan="2" | Checks for a response string. Returns the length of the response string if one is present otherwise returns 0.
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Data
|-
| colspan="2" |
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | SendCR
|-
| colspan="2" | Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''Ev_GetVarSize'''
|-
| colspan="2" | Sent to a component to amend the size of the expected array
|-
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | VarName
|-
| colspan="2" | The original Flowcode variable
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Elements
|-
| colspan="2" | The number of elements in the array
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''CreateCommand'''
|-
| colspan="2" | Adds a single characters to the end of the Command buffer. Returns 1 for success in adding the characters to the buffer. Returns 0 for errors, including Buffer overflow.
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Character
|-
| colspan="2" | ASCII value or single character,
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Elements
|-
| colspan="2" | The number of elements in the array
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''Send_byte'''
|-
| colspan="2" |
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ByteVal
|-
| colspan="2" |
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Elements
|-
| colspan="2" | The number of elements in the array
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''WaitForResponse'''
|-
| colspan="2" | Waits for a response message of type response_code for timeout ms. Returns: 0 for a Response of type response_code 255 (0xFF) for a timeout or invalid response Response string length for any Response not of type response_code
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | response_code
|-
| colspan="2" | 1:OK / 2:ERROR / 3:CONNECT / 4:NO CARRIER / 5:AUDIO / 6:PAIR / 7:RING
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | timeout
|-
| colspan="2" | The timeout value will need to set to allow sufficient time for the response to arrive.
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''Main'''
|-
| colspan="2" |
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | response_code
|-
| colspan="2" | 1:OK / 2:ERROR / 3:CONNECT / 4:NO CARRIER / 5:AUDIO / 6:PAIR / 7:RING
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | timeout
|-
| colspan="2" | The timeout value will need to set to allow sufficient time for the response to arrive.
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''pvt_Scripts_ShowHide'''
|-
| colspan="2" |
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | response_code
|-
| colspan="2" | 1:OK / 2:ERROR / 3:CONNECT / 4:NO CARRIER / 5:AUDIO / 6:PAIR / 7:RING
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | timeout
|-
| colspan="2" | The timeout value will need to set to allow sufficient time for the response to arrive.
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''Initialise'''
|-
| colspan="2" | Required to be used whenever the Bluetooth component is used in a program. Initialises the Bluetooth component ready for use.
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | response_code
|-
| colspan="2" | 1:OK / 2:ERROR / 3:CONNECT / 4:NO CARRIER / 5:AUDIO / 6:PAIR / 7:RING
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | timeout
|-
| colspan="2" | The timeout value will need to set to allow sufficient time for the response to arrive.
|-
| 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''
|}

Bot test

2021-08-17T13:04:25Z

DavidA:

Bot test

2021-08-17T11:35:47Z

DavidA:

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''Initialise'''
|-
| colspan="2" | Required to be used whenever the Bluetooth component is used in a program. Initialises the Bluetooth component ready for use.
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | response_code
|-
| colspan="2" | 1:OK / 2:ERROR / 3:CONNECT / 4:NO CARRIER / 5:AUDIO / 6:PAIR / 7:RING
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | timeout
|-
| colspan="2" | The timeout value will need to set to allow sufficient time for the response to arrive.
|-
| 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''
|}

2021-08-12T12:46:15Z

DavidA:

Bot test

2021-08-12T12:44:09Z

DavidA:

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Command Buffer Size
|-
| colspan="2" | Maximum number of bytes that can be stored in the outgoing command buffer.
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Response Buffer Size
|-
| colspan="2" | Maximum number of bytes that can be stored in the incoming response buffer.
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Script Count
|-
| colspan="2" | Controls how many AT scripts are stored into non-volatile memory
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Script 1
|-
| colspan="2" | Data to send for script 0, each command should be terminated with a carriage return
|-
| width="10%" align="center" | [[File:Fc9-type--icon.png]]
| width="90%" | Connections
|-
| colspan="2" |
|-
| width="10%" align="center" | [[File:Fc9-type--icon.png]]
| width="90%" | Simulation
|-
| colspan="2" |
|-
| 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" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller.
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | TX
|-
| colspan="2" | Pin to be used for Transmit data
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | RX
|-
| colspan="2" | Pin to be used for Receive data
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Use Flow Control
|-
| colspan="2" | Flow Control (Handshake) enable or disable. On: Two I/O pins are used to control the flow of data in and out of the device. Off: Flow control is disabled.
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Baud Options
|-
| colspan="2" | Baud rate option selector
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Baud Rate
|-
| colspan="2" |
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Console Columns
|-
| colspan="2" | Number of characters that can be displayed on a single line of the console.
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Console Data
|-
| colspan="2" | Selects if the console data is automatically generated or not
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scope Traces
|-
| colspan="2" | Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Data Source
|-
| colspan="2" | Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port API - Routes the communication data via a data API component on the Panel.
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | API
|-
| colspan="2" | Selects whichAPI component to route the communication data via. Add API components to the panel before they will be available in this list. API components are available from the Comms component category.
|}

2021-08-10T15:35:56Z

DavidA:

===Macro References===

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''StringRead'''
|-
| colspan="2" | Returns the ASCII value of character idx of the Response string.
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - Byte
| width="90%" | idx
|-
| colspan="2" | Needs to be a equal to or less than the string length of the response in order to retrieve a valid character.
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''SendScript'''
|-
| colspan="2" | Sends Script idx
Note that the general property Number of Scripts needs to be set so that it allows the scripts to be accessed and sent.
Returns 0 for success and 1 for error
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - Byte
| width="90%" | idx
|-
| colspan="2" | Refers to the Script page to send (1-4).
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''SendCommand'''
|-
| colspan="2" | Sends the command buffer.
Returns 1 for success in sending the command.
Returns 0 for errors.
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - Byte
| width="90%" | ExpectEcho
|-
| colspan="2" | Remote module automatically echos back data: 1 = On (Expect echo), 0 = off
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - Byte
| width="90%" | SendCR
|-
| colspan="2" | Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''CreateCommandString'''
|-
| colspan="2" | Assigns a string of characters to the Command buffer.
Returns 1 for success in adding the characters to the buffer.
Returns 0 for errors, including Buffer overflow.
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - String
| width="90%" | Data
|-
| colspan="2" | This parameter may be returned back to the caller
|-
| 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''
|}

===Component Property Reference===

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="80%" | Command Buffer Size
|-
| colspan="2" | Maximum number of bytes that can be stored in the outgoing command buffer.
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="80%" | Response Buffer Size
|-
| colspan="2" | Maximum number of bytes that can be stored in the incoming response buffer.
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="80%" | Script Count
|-
| colspan="2" | Controls how many AT scripts are stored into non-volatile memory
|-
| 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" | [[File:Fc9-type-21-icon.png]]
| width="80%" | Channel
|-
| colspan="2" | UART Channel selector
Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels.
Hardware channels use the selected peripheral on-board the target microcontroller.
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="80%" | TX
|-
| colspan="2" | Pin to be used for Transmit data
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="80%" | RX
|-
| colspan="2" | Pin to be used for Receive data
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="80%" | Use Flow Control
|-
| colspan="2" | Flow Control (Handshake) enable or disable.
On: Two I/O pins are used to control the flow of data in and out of the device.
Off: Flow control is disabled.
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="80%" | Baud Options
|-
| colspan="2" | Baud rate option selector
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="80%" | Baud Rate
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulation'''
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="80%" | Console Columns
|-
| colspan="2" | Number of characters that can be displayed on a single line of the console.
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="80%" | Console Data
|-
| colspan="2" | Selects if the console data is automatically generated or not
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="80%" | Scope Traces
|-
| colspan="2" | Selects if the scope traces are automatically added to the data recorder window or not.
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="80%" | Data Sources
|-
| colspan="2" | Simulation data source used to allow the component to connect to various remote devices
Nothing - Simulation data is ignored
COM port - Routes the communication data to and from a physical or virtual COM port
API - Routes the communication data via a data API component on the Panel.
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="80%" | API
|-
| colspan="2" | Selects whichAPI component to route the communication data via.
Add API components to the panel before they will be available in this list.
API components are available from the Comms component category.
|}