This command is used to get the Planets of a Star (or Sun) XBot from a Star-Planet coupling.
Fieldbus Interface
PMC_GetPlanets
Inputs
Name | Data Type | Description |
|---|
Execute | BOOL | Execution of the function block begins on a rising edge of this input. |
StarXbotID | USINT | Real XBot IDs [1,78]. Virtual XBot IDs [100,127] |
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 PMC Reply Codes. |
NumPlanets | USINT | Number of planet XBots attached to the Star XBot. |
PlanetXbotIDs | USINT[0..31] | IDs of the planet XBots attached to the Star XBot. |
Conditions
Operating Conditions |
|---|
Preconditions | None. |
Postconditions | Planet XBot IDs will be provided in the output. |
Description
This command is used to get the Planets of a Star (or Sun) XBot from a Star-Planet coupling.
