Jump to content

Bot test: Difference between revisions

From Flowcode Help
DavidA (talk | contribs)
No edit summary
DavidA (talk | contribs)
No edit summary
Line 1: Line 1:
{| 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;"
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
|-
Line 13: Line 26:
|-
|-
| 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
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}

Revision as of 13:06, 17 August 2021

ev_Prop_Change
- ULONG Return


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


Ev_Timer
Called back on the panel command System.TimerStart
- ULONG TimerID
The identifier passed to the System.TimerStart panel command
- ULONG 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


SendScriptString
- STRING str
- BYTE SendCR
Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
- VOID Return


Ev_ChipChange
Sent when the target device has changed
[[File:]] - Target
The name of the new target device
- BYTE SendCR
Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
- ULONG Return


Read_byte
- BYTE Timeout
- 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 SendCR
Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
- BYTE Return


ev_Init
- STRING Data
- BYTE SendCR
Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
- ULONG Return


StringReceive
Checks for a response string. Returns the length of the response string if one is present otherwise returns 0.
- STRING Data
- BYTE SendCR
Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
- BYTE Return


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
- ULONG 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,
[[File:]] - Elements
The number of elements in the array
- BYTE Return


Send_byte
- BYTE ByteVal
[[File:]] - Elements
The number of elements in the array
- 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


Main
- 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.
- VOID Return


pvt_Scripts_ShowHide
- 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.
- VOID Return


Initialise
Required to be used whenever the Bluetooth component is used in a program. Initialises the Bluetooth component ready for use.
- 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.
- VOID Return