Skip to main content
Skip table of contents

Get Star

This command is used to get the Star (or Sun) of a Planet XBot from a Star-Planet coupling.

image-20250730-181154.png

Fieldbus Interface

PMC_GetStar

Inputs

Name

Data Type

Description

Execute

BOOL

Execution of the function block begins on a rising edge of this input.

PlanetXbotID

USINT

ID of the XBot. Real XBot IDs [1,78].

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.

StarXbotID

USINT

  • 0: Not linked to any XBot

  • > 0: Star XBot ID

Conditions

Operating Conditions

Preconditions

None

Postconditions

Star XBot ID is provided in the output

Description

This command is used to get the Star (or Sun) of a Planet XBot from a Star-Planet coupling.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.