Skip to main content

Commands

The main plem commands for running a shipped device. Each row links to the page that explains it, and Command line covers each command in detail. Which commands exist depends on the installed packages; plem --help lists the ones on this device.

Run only what the docs describe

Run sudo, ros2 service call and ros2 topic pub only as these docs or support tell you to. Do not edit files under ~/.plem/ or /etc/plem/ unless a documented procedure says so. Do not send commands to the same robot from two tools at once.

Running​

CommandWhat it does
plemRobot setup, launch and control screen (plem TUI). Without the TUI installed, it lists the commands
plem --helpLists the commands installed on this device
plem versionPrints the installed version
plem updateUpdates to a new release. Update
plem codeAI agent (beta, included in the default install)

ROS 2 environment​

A new terminal opens with the same ROS 2 environment as the robot, so ros2 commands work as they are. After changing settings, restart plem and open a new terminal. Connecting from elsewhere: ROS 2 interfaces.

Custom controllers and robot profiles​

CommandWhat it does
plem init <name>Creates a torque controller plugin scaffold. Custom torque controller
plem workspaceShows the registered user workspace
plem workspace clearUnregisters it
plem profile grippersGripper models available on this device
plem profile set-gripper <robot> <model|none> [--dry-run]Changes a robot's gripper, from the next launch
plem profile ft-sensorsF/T sensor models available on this device
plem profile set-ft-sensor <robot> <model|none> [--dry-run]Changes a robot's F/T sensor, from the next launch. Only robot models the sensor supports

Servo drives​

CommandWhat it does
plem drive check <model file>Checks a drive model file. Servo drives
plem drive run <model file> [options]Brings up the drive bus described by the file. Options and behavior: Bus API
plem drive --helpLists the verbs

plem drive hands the command to the plem-drive tool, so a device with only the drive package (plem-drive) has it too, and plem-drive <verb> does the same thing.

License and removal​

CommandWhat it does
sudo plem-register --refreshGets the new license after your license contact renews it. Applies when the robot stack restarts. Troubleshooting
sudo plem-register --reissue-plem-keyIssues a new plem code device key and revokes the old one at once. Troubleshooting
plem uninstall [--keep-license]Removes PLEM, after asking. By default it also deletes the license and device key. plem uninstall

Cleanup and support​

CommandWhat it does
plem killCleans up leftover PLEM processes. Only when a normal stop does not work. plem kill
plem kill --dryShows what would be cleaned up
plem remoteOpens a remote support channel. Troubleshooting