This command is used to get the status of a specific border.
Fieldbus Interface
PMC_GetBorderStatus
Inputs
|
Name
|
Data Type
|
Description
|
|
Execute
|
BOOL
|
Execution of the function block begins on a rising edge of this input. |
|
BorderID
|
USINT
|
Border ID, valid range [1,4]
|
|
PM_Controller
|
PMControllerType
|
Data structure that specifies which PMC to connect to. There should be only 1 instance of this variable for each connected PMC. |
Outputs
|
Name
|
Data Type
|
Description
|
|
Done
|
BOOL
|
Execution successful. Function block is finished. (Note: Done will not become TRUE if Execute is already FALSE) |
|
Busy
|
BOOL
|
Function block is active and must continue to be called. |
|
Aborted
|
BOOL
|
Command aborted by another command. |
|
Error
|
BOOL
|
If there is an error in processing the command, then Error = TRUE, otherwise, FALSE. |
|
ErrorID
|
UINT
|
0x0: All OK. Otherwise, please see Fieldbus Reply Codes. |
|
State
|
USINT
|
0: Disconnected; 1: Connected, but not ready; 2: Ready
|
Ethernet Interface
BorderStatusRtn GetBorderStatus(int borderID)
Parameters
|
Name
|
Type
|
Description
|
|
borderID
|
int
|
Border ID, valid range [1,4]
|
Returns
|
Name
|
Type
|
Description
|
|
BorderStatusRtn.PmcRtn
|
PMCRTN enum
|
ALLOK (0): Command Accepted. Otherwise, please see Ethernet Reply Codes. |
|
BorderStatusRtn.BorderStatus
|
enum
|
-
DISCONNECTED: the Flyway link between this border is not connected
-
NOTREADY: the Flyway link between this border is connected, but it is not yet ready to receive XBots
-
READY: the Flyway link at this border is connected and it is ready to receive XBots
|
Conditions
|
Operating Conditions
|
|
Preconditions
|
None
|
|
Postconditions
|
The border status is updated
|
Description
This command is used to get the status of a specific border.
