Bot test

From Flowcode Help
Revision as of 15:35, 10 August 2021 by DavidA (talk | contribs)
Jump to navigationJump to search

Macro References

Fc9-comp-macro.png StringRead
Returns the ASCII value of character idx of the Response string.
Fc9-u8-icon.png - Byte idx
Needs to be a equal to or less than the string length of the response in order to retrieve a valid character.
Fc9-u8-icon.png - Byte Return


Fc9-comp-macro.png 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

Fc9-u8-icon.png - Byte idx
Refers to the Script page to send (1-4).
Fc9-u8-icon.png - Byte Return


Fc9-comp-macro.png SendCommand
Sends the command buffer.

Returns 1 for success in sending the command. Returns 0 for errors.

Fc9-u8-icon.png - Byte ExpectEcho
Remote module automatically echos back data: 1 = On (Expect echo), 0 = off
Fc9-u8-icon.png - Byte SendCR
Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
Fc9-u8-icon.png - Byte Return


Fc9-comp-macro.png 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.

Fc9-string-icon.png - String Data
This parameter may be returned back to the caller
Fc9-u8-icon.png - Byte Return

Component Property Reference

Fc9-prop-icon.png Properties
Fc9-type-21-icon.png Command Buffer Size
Maximum number of bytes that can be stored in the outgoing command buffer.
Fc9-type-21-icon.png Response Buffer Size
Maximum number of bytes that can be stored in the incoming response buffer.
Fc9-type-16-icon.png Script Count
Controls how many AT scripts are stored into non-volatile memory
Fc9-conn-icon.png Connections
Fc9-type-21-icon.png 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.

Fc9-type-5-icon.png TX
Pin to be used for Transmit data
Fc9-type-5-icon.png RX
Pin to be used for Receive data
Fc9-type-16-icon.png 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.

Fc9-type-16-icon.png Baud Options
Baud rate option selector
Fc9-type-14-icon.png Baud Rate
 
Fc9-conn-icon.png Simulation
Fc9-type-21-icon.png Console Columns
Number of characters that can be displayed on a single line of the console.
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically added to the data recorder window or not.
Fc9-type-16-icon.png Data Sources
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.
Fc9-type-16-icon.png 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.