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 26: Line 13:
|-
|-
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}
Line 83: Line 52:
|-
|-
| colspan="2" | Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.  
| 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" 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" 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" 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 157: Line 72:
|-
|-
| 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_Init'''
|-
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}
Line 183: Line 85:
|-
|-
| 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_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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}
Line 265: Line 144:
|-
|-
| 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%" | '''Main'''
|-
| 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" | [[File:Fc9-comp-macro.png]]
| width="90%" | '''pvt_Scripts_ShowHide'''
|-
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}

Revision as of 13:54, 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