Move Gui

This module provides a GUI panel for controlling the robot's position and orientation.

ATTRIBUTE	DESCRIPTION
`PRECISION`	The number of decimal places to which to round the robot's position and orientation. TYPE: `int`
`TICK_INTERVAL`	The interval between tick marks on the rotation scales. TYPE: `int`
`BUTTON_HEIGHT`	The height of the buttons in the GUI panel. TYPE: `int`
`BUTTON_WIDTH`	The width of the buttons in the GUI panel. TYPE: `int`

CLASS	DESCRIPTION
`Move`	A protocol for objects that can move and rotate.
`MovePanel`	A GUI panel for controlling the robot's position and orientation.

Documentation last updated: 2025-02-22

MovePanel

MovePanel(principal: Move | Proxy | None = None)

Bases: Panel

MovePanel is a GUI panel for controlling the robot's position and orientation.

ATTRIBUTE	DESCRIPTION
`principal`	The object to control. TYPE: `Move \| Proxy \| None`
`title`	The title of the panel. TYPE: `str`
`status`	The status of the robot connection. TYPE: `str`
`x`	The x-coordinate of the robot's position. TYPE: `float`
`y`	The y-coordinate of the robot's position. TYPE: `float`
`z`	The z-coordinate of the robot's position. TYPE: `float`
`a`	The angle around the x-axis (roll) of the robot's orientation. TYPE: `float`
`b`	The angle around the y-axis (pitch) of the robot's orientation. TYPE: `float`
`c`	The angle around the z-axis (yaw) of the robot's orientation. TYPE: `float`
`button_height`	The height of the buttons in the GUI panel. TYPE: `int`
`button_width`	The width of the buttons in the GUI panel. TYPE: `int`
`precision`	The number of decimal places to which to round the robot's position and orientation. TYPE: `int`
`tick_interval`	The interval between tick marks on the rotation scales. TYPE: `int`

METHOD	DESCRIPTION
`update`	Update the panel with the current position and orientation of the robot.
`refresh`	Refresh the panel with the current position and orientation of the robot.
`addTo`	Add the panel to a master widget.
`move`	Move the robot along the specified axis by the specified value.
`rotate`	Rotate the robot around the specified axis by the specified value.
`moveTo`	Move the robot to the specified position.
`rotateTo`	Rotate the robot to the specified orientation.
`home`	Move the robot to the home position.
`safe`	Move the robot to a safe height above the work surface.
`bindObject`	Bind a principal object to the Panel.
`releaseObject`	Release the principal object from the Panel.
`bindWidget`	Bind a tkinter.Tk object to the Panel.
`releaseWidget`	Release the tkinter.Tk object from the Panel.
`show`	Show the Panel.
`close`	Close the Panel.
`getAttribute`	Get an attribute from the principal object.
`getAttributes`	Get multiple attributes from the principal object.
`execute`	Execute a method from the principal object.
`addPack`	Add a Panel to the layout using the pack geometry manager.
`addGrid`	Add a Panel to the layout using the grid geometry manager.
`addPanel`	Add a Panel to the layout.
`clearPanels`	Clear all the Panels from the layout.
`updateStream`	Update the Panel continuously.

Initialize the MovePanel.

PARAMETER	DESCRIPTION
`principal`	The object to control. Defaults to None. TYPE: `Move \| Proxy \| None` DEFAULT: `None`

home

home()

Move the robot to the home position.

move

move(axis: str, value: int | float)

Move the robot along the specified axis by the specified value.

PARAMETER	DESCRIPTION
`axis`	The axis along which to move the robot. Must be one of 'x', 'y', or 'z'. TYPE: `str`
`value`	The distance by which to move the robot along the specified axis. TYPE: `int \| float`

moveTo

moveTo(
    x: int | float | str | None = None,
    y: int | float | str | None = None,
    z: int | float | str | None = None,
    a: int | float | str | None = None,
    b: int | float | str | None = None,
    c: int | float | str | None = None,
)

Move the robot to the specified position.

PARAMETER	DESCRIPTION
`x`	The x-coordinate of the position to which to move the robot. TYPE: `int \| float \| str \| None` DEFAULT: `None`
`y`	The y-coordinate of the position to which to move the robot. TYPE: `int \| float \| str \| None` DEFAULT: `None`
`z`	The z-coordinate of the position to which to move the robot. TYPE: `int \| float \| str \| None` DEFAULT: `None`
`a`	The angle around the x-axis (roll) of the position to which to move the robot. TYPE: `int \| float \| str \| None` DEFAULT: `None`
`b`	The angle around the y-axis (pitch) of the position to which to move the robot. TYPE: `int \| float \| str \| None` DEFAULT: `None`
`c`	The angle around the z-axis (yaw) of the position to which to move the robot. TYPE: `int \| float \| str \| None` DEFAULT: `None`

rotate

rotate(axis: str, value: int | float)

Rotate the robot around the specified axis by the specified value.

PARAMETER	DESCRIPTION
`axis`	The axis around which to rotate the robot. Must be one of 'a', 'b', or 'c'. TYPE: `str`
`value`	The angle by which to rotate the robot around the specified axis. TYPE: `int \| float`

rotateTo

rotateTo(
    a: int | float | None = None,
    b: int | float | None = None,
    c: int | float | None = None,
)

Rotate the robot to the specified orientation.

PARAMETER	DESCRIPTION
`a`	The angle around the x-axis (roll) to which to rotate the robot. TYPE: `int \| float \| None` DEFAULT: `None`
`b`	The angle around the y-axis (pitch) to which to rotate the robot. TYPE: `int \| float \| None` DEFAULT: `None`
`c`	The angle around the z-axis (yaw) to which to rotate the robot. TYPE: `int \| float \| None` DEFAULT: `None`

safe

safe()

Move the robot to a safe height above the work surface.