Difference between revisions of "Bot test"

From Flowcode Help
Jump to navigationJump to search
(Undo revision 24875 by DavidA (talk))
Tag: Undo
Line 101: Line 101:
 
|-
 
|-
 
| colspan="2" |   
 
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 124: Line 119:
 
|-
 
|-
 
| colspan="2" | The name of the new target device  
 
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
Line 147: Line 137:
 
|-
 
|-
 
| colspan="2" |   
 
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
Line 170: Line 155:
 
|-
 
|-
 
| colspan="2" |   
 
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
Line 188: Line 168:
 
| colspan="2" |   
 
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
Line 211: Line 181:
 
| colspan="2" | Checks for a response string. Returns the length of the response string if one is present otherwise returns 0.   
 
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
Line 262: Line 222:
 
|-
 
|-
 
| colspan="2" | ASCII value or single 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
Line 285: Line 240:
 
|-
 
|-
 
| colspan="2" |   
 
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 326: Line 276:
 
| colspan="2" |   
 
| 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="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;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Line 349: Line 288:
 
| colspan="2" |   
 
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 372: Line 301:
 
| colspan="2" | Required to be used whenever the Bluetooth component is used in a program. Initialises the Bluetooth component ready for use.  
 
| 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="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''
 
|}
 
|}

Revision as of 13:53, 17 August 2021

Fc9-comp-macro.png ev_Prop_Change
Fc9-u32-icon.png - ULONG Return


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 Ev_Timer
Called back on the panel command System.TimerStart
Fc9-u32-icon.png - ULONG TimerID
The identifier passed to the System.TimerStart panel command
Fc9-u32-icon.png - ULONG 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 SendScriptString
Fc9-string-icon.png - STRING str
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Ev_ChipChange
Sent when the target device has changed
[[File:]] - Target
The name of the new target device
Fc9-u32-icon.png - ULONG Return


Fc9-comp-macro.png Read_byte
Fc9-u8-icon.png - BYTE Timeout
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
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ev_Init
Fc9-u32-icon.png - ULONG Return


Fc9-comp-macro.png StringReceive
Checks for a response string. Returns the length of the response string if one is present otherwise returns 0.
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png Ev_GetVarSize
Sent to a component to amend the size of the expected array
[[File:]] - VarName
The original Flowcode variable
[[File:]] - Elements
The number of elements in the array
Fc9-u32-icon.png - ULONG Return


Fc9-comp-macro.png 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.
Fc9-u8-icon.png - BYTE Character
ASCII value or single character,
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png Send_byte
Fc9-u8-icon.png - BYTE ByteVal
Fc9-void-icon.png - VOID Return


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


Fc9-comp-macro.png Main
Fc9-void-icon.png - VOID Return
Fc9-comp-macro.png pvt_Scripts_ShowHide
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
Required to be used whenever the Bluetooth component is used in a program. Initialises the Bluetooth component ready for use.
Fc9-void-icon.png - VOID Return