panda_py.cli module¶

This submodule contains convenience functions that are installed as executables. These executables can be integrated into bash scripts, alias commands etc. The table below lists the available executables and the corresponding entry-points.

Executable	Entry-point
panda-unlock	`unlock()`
panda-lock	`lock()`
panda-reboot	`reboot()`
panda-take-control	`take_control()`
panda-release-control	`release_control()`

panda_py.cli.unlock()[source]¶

Unlocks the robot’s brakes and activates the FCI.

Parameters:

host – IP or hostname of the control unit running the Desk.
user – Username used to log into the Desk.
password – Password of the given username.
platform – The targeted robot platform, i.e. panda or fr3.

panda_py.cli.lock()[source]¶

Locks the robot’s brakes and deactivates the FCI.

Parameters:

host – IP or hostname of the control unit running the Desk.
user – Username used to log into the Desk.
password – Password of the given username.
platform – The targeted robot platform, i.e. panda or fr3.

panda_py.cli.reboot()[source]¶

Reboots the robot. Current versions of the robot’s Desk software will eventually hang up when running the FCI continuously for several days. This function can be conveniently integrated into cronjobs or similar to regularly reboot the robot.

Parameters:

host – IP or hostname of the control unit running the Desk.
user – Username used to log into the Desk.
password – Password of the given username.

panda_py.cli.take_control()[source]¶

Take control of the Desk with the given user credentials.

Parameters:

host – IP or hostname of the control unit running the Desk.
user – Username used to log into the Desk.
password – Password of the given username.
force – Forcibly take control from another active user by pressing circle button on physical robot.

panda_py.cli.release_control()[source]¶

Release control of the desk. This will allow another user to take control without needing physical access to the robot.

Parameters:

host – IP or hostname of the control unit running the Desk.
user – Username used to log into the Desk.
password – Password of the given username.
force – Forcibly take control from another active user by pressing circle button on physical robot.