Jump to content

Bot test: Difference between revisions

From Flowcode Help
DavidA (talk | contribs)
No edit summary
DavidA (talk | contribs)
No edit summary
Line 158: Line 158:
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| 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;" | [[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.
|}
|}

Revision as of 13:56, 17 August 2021

StringRead
Returns the ASCII value of character idx of the Response string.
- BYTE idx
Needs to be a equal to or less than the string length of the response in order to retrieve a valid character.
- BYTE Return


SendScript
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
- BYTE idx
Refers to the Script page to send (1-4).
- BYTE Return


SendCommand
Sends the command buffer. Returns 1 for success in sending the command. Returns 0 for errors.
- BYTE ExpectEcho
Remote module automatically echos back data: 1 = On (Expect echo), 0 = off
- BYTE SendCR
Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
- BYTE Return


CreateCommandString
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.
- STRING Data
- BYTE Return


StringReceive
Checks for a response string. Returns the length of the response string if one is present otherwise returns 0.
- BYTE Return


CreateCommand
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.
- BYTE Character
ASCII value or single character,
- BYTE Return


Send_byte
- BYTE ByteVal
- VOID Return


WaitForResponse
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
- BYTE response_code
1:OK / 2:ERROR / 3:CONNECT / 4:NO CARRIER / 5:AUDIO / 6:PAIR / 7:RING
- BYTE timeout
The timeout value will need to set to allow sufficient time for the response to arrive.
- BYTE Return


Initialise
Required to be used whenever the Bluetooth component is used in a program. Initialises the Bluetooth component ready for use.
- VOID Return


Properties
Command Buffer Size
Maximum number of bytes that can be stored in the outgoing command buffer.
Response Buffer Size
Maximum number of bytes that can be stored in the incoming response buffer.
Script Count
Controls how many AT scripts are stored into non-volatile memory
Script 1
Data to send for script 0, each command should be terminated with a carriage return
Connections
Channel
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.
TX
Pin to be used for Transmit data
RX
Pin to be used for Receive data
Use Flow Control
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.
Baud Options
Baud rate option selector
Baud Rate
Simulations
Console Columns
Number of characters that can be displayed on a single line of the console.
Console Data
Selects if the console data is automatically generated or not
Scope Traces
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.
Data Source
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.
API
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.