Skip to main content

5. Getting Started

5.1 License Activation​

When you first start HARP, you will notice that only limited functionality is available on each page. To activate your license:

harp_LicenseValidation

  1. Locate the Settings icon on the left side panel and click it to open the Settings page.
  2. In the top-right area of the Settings page, enter your license key in the designated text field.
  3. Input the License Key.
  4. Click the Activate License Button to complete activation.
  5. Once the license is successfully activated, a new button labeled Revoke License will appear.
    harp_license_revoke
INFO

To activate an internet connection is required.

NOTE

Unless negotiated in the purchase of your license (for security specific applications) HARP always requires an internet connection on launch

5.1.2 License Release​

To release a license for use on another machine, click the Revoke License button.

5.2 Create a Project​

To create a project, navigate to the Connection screen.

  • When HARP launches, it will navigate to the Connection Screen and attempt to load your most recent project automatically
  • If no previous project is found, HARP will present you with the Create or Open project buttons.

harp_connectionScreen

You have two options:

  • Create New: Enter your project name and choose a directory where your new project folder will be created.
    example:
    Your Project name: MyFirstProject
    Chosen Directory: My Documents
    A folder is created at “My Documents/MyFirstProject/” with all the project files inside.
  • Open Existing: Select an existing project file to continue work.

harp_CreateNewProject

Each project includes a project file called Project.json. This file defines the configuration and structure of the project.
After using either Create New or Open Existing, You are ready to start connecting devices.

5.3 Connect Devices​

While wiring is unique to each system, Appendix A includes some wiring diagrams for common configurations.

NOTE

After connecting a new device, verify correct motion direction and speed at low speed with the cell clear of people and equipment

5.3.1 Connections Screen​

  • The Connections screen updates to show any Haply devices currently connected, as well as devices previously saved to the open project.
  • Devices can be connected over COM ports or IP (see 4.3 Connections for network guidance).
  • All connected devices must be calibrated prior to operation. Calibration procedures are detailed in Appendix C and should be followed during initial setup.

harp_5_3_1

5.3.2 Add a Follower​

  1. Create or Open a project before adding a Follower
  2. Click Add Connection at the top of the screen.
  3. Choose the correct Plugin for your Robot Arm and enter its IP, Connection String or ID.

harp_AddFollowerConnection

harp_SelectPlugin

  1. Arm Configuration (optional):
    1. Orientation (Degrees) ( X, Y, Z)
    2. Position Offsets (meters) for any undefined moves (X, Y, Z)
    3. Velocity Limits for safe default motions. (%)
    4. Allowed to move: Enable only if it is safe for the arm to move immediately when HARP starts.
  2. Click Connect.

5.3.3 Add an End-Effector​

End-Effectors are dependent on the parent follower. You will add the end-effector connection once your follower is connected.

harp_AddGripperConnection

  1. After adding your robot connection, select Add Connection in the Parent robot where the end-effector is connected.
  2. Select Plugin: Choose the plugin named for your gripper.
  3. Address: Enter the device’s IP address or COM port (e.g., COM11).
  4. Click Connect.

harp_SelectGripperPlugin

​

5.3.4 Create a Control Group​

  1. The name of your project
  2. In the Connections screen, select each device you want in your Control Group.
  3. Click Add Control Group at the bottom.
  4. The control group appears on the left and is saved to your project.

harp_controlGroupSelect

5.3.5 Launch Teleoperation​

  1. When your control group is configured and connected, click Launch (bottom‑right) to begin teleoperation.

5.3.6 Saving your project​

The current state of your project will be saved in any of the following actions

  • Press the Launch button in the Connections Screen
  • Press the save button in the workspace configuration screen
  • Create a Macro
  • Close the application

5.3.7 Load a Project with different set of devices​

When you load a project that has been created with a different robot, HARP updates the control group automatically as long as the same type of device is connected .

5.4 Workspace Configuration​

The workspace configuration page allows setup and configuration of the objects in your workspace.

harp_5_4

1Items ListA list of Followers, limits and exclusion zones in the workspace
2Follower - RobotMove, rotate, flip your Robot arm to be located in your workspace as it is in the real world system. Set robot limits in XYZ to define areas the robot should avoid. Provides Haptic feedback to the user when they are against a virtual limit
3Exclusion ZonesSet the position and size of virtual shapes to prevent the robot end-effector from entering the volume of the shape
4Selected Item SettingsA menu providing all variables needed to adjust the set point for your currently selected item from the (1) Items List
5Workspace Reference FrameRight-hand reference frame to define the objects in scene
6Add Exclusion ZoneShow robot limits, Add a cube or add a sphere symbols, respectively, allow you to interact with the workspace and set it up for your system.
7Save WorkspaceSave changes to your project files - This tool does NOT use auto-save - remember to save your changes (To save all your changes follow the procedure on saving a project 5.3.6 Saving your project).
NOTICE

Incorrect workspace limits or exclusion zones can cause the robot to move into hazardous areas. All limits and zones shall be validated physically at reduced speed or reduced scaling before operation around people or equipment.

5.4.1 Robot Workspace​

On the Workspace configuration screen (top‑left), you’ll see a list of objects in your workspace. Selecting the Robot Arm reveals editable fields on the right that let you:

  • Move the robot in the workspace – adjust the arm’s base position within the scene.
  • Rotate the robot in the workspace – set the arm’s base orientation.
  • Define workspace limits – specify the boundaries the robot is permitted to move within.
  • Haptics: Enable / Disable haptics when the robot reaches a robot limit
TIP

Make incremental changes and verify clearances in the 3D view before applying larger moves.

harp_5_4_1
Position: X, Y, Z (meters)
Rotation: X, Y, Z (degrees)
Limits: (meters) Min X, Max X Min Y, Max Y Min Z, Max Z

5.4.2 Robot Limits​

Workspace limits define the limits that the robot can operate in. The robot arm will be prevented from moving past the set distances from the robots base reference frame. These limits also provide a haptic barrier that your Haply input device allows you to feel during operation and the physical boundary the robot itself cannot exceed.

  • When you click Save (bottom‑right), HARP stores these limits in the project and sends the same limits to the robot controller base.
  • This dual‑layer approach provides redundancy: even if the application were to fail, the controller‑side limits continue to enforce a safe boundary.
NOTE

The on‑robot workspace limits are set approximately 1 cm outside the virtual limits to avoid false collisions and ensure smooth haptic rendering. This offset may vary between versions and brands.

5.4.3 Virtual Objects​

On the Workspace Configuration screen, the Object Palette (bottom‑left) provides two primitives: a Cube and a Sphere. Click either icon to add that shape to your workspace.

**TODO Image missing get new screenshot **​

  • After adding an object, it appears in the Objects list (top‑left).
  • Selecting an object reveals its Properties panel on the right.

In the Properties panel you can define:

  • Location/Position (X, Y, Z) – place the object precisely in the workspace. (by default the origin of either object is located at the center point of the object)**

  • Size/Scale – adjust the object’s dimensions.**

    • Cube/Box: set Width, Depth, and Height. For example, to create a tall, narrow rectangle, first place a cube where you want it and then increase Height while reducing Width and/or Depth.
    • Sphere: set Radius (or uniform scale) to reach the desired size.

** Units are defined in meters

TIP

Position the object first, then refine its dimensions for easier alignment with nearby elements

harp_5_4_3-2

​

5.5 Robot Options - Mecademic​

HARP is designed as a modular control platform, enabling integration with a variety of robot arms through manufacturer-provided robot modules. Each robot model has unique kinematic parameters, motion limits, tool definitions, and safety configurations, all tuning and calibration parameters must be defined by the robot manufacturer. HARP does not provide robot-specific tuning settings.

5.5.1 Default Robot Module​

The HARP software includes the module for the MECA500 robot arm. This module has been developed based on the manufacturer’s publicly available specifications and is intended to provide an out-of-the-box experience for users of the MECA500 robot.

5.5.2 Robot Settings​

The following parameters described below are taken from official Mecademic documentation. For more in depth details check Mecademic’s Official Resources.

SetCollisionCfg
This command specifies the event severity for the collision supervision (robot links, tool sphere, and MPM500 module). harp_5_5_2-1

SetToolSphere
This command defines a sphere fixed in the flange reference frame (FRF). Interferences between that sphere and the robot links as well as the outside of a bounding box set with the SetWorkZoneLimits command can then be supervised, as defined by the SetWorkZoneCfg and SetCollisionCfg commands.

harp_5_5_2-2

SetWorkZoneLimits
This command defines a bounding box (a cuboid), the sides of which are parallel to the axes of the base reference frame (BRF). The arguments of the command are the coordinates of two diagonally opposite corners, referred to as “minimum” and “maximum” corners, such that each coordinate of the minimum corner is smaller than the corresponding coordinate of the maximum corner.

harp_5_5_2-3

SetWorkZoneCfg
This command specifies the “event severity” for the work zone limits supervision and the robot parts that need to be verified.

harp_5_5_2-4

SetTrf
This command defines the pose of the TRF with respect to the FRF. Note that this command makes the robot come to a complete stop, even if blending is enabled.

harp_5_5_2-5

SetAutoConf
This command enables or disables the automatic posture configuration selection, to be observed in the MovePose and MoveLin* commands. This automatic selection, in conjunction with the turn configuration selection, allows the controller to choose the “closest” joint set corresponding to the target pose.

harp_5_5_2-6

In the case of MoveLin* commands, enabling the automatic posture configuration selection allows the change of configuration, but only if the path happens to pass exactly through a wrist or shoulder singularity.

SetAutoConfTurn
This command enables/disables the automatic turn selection for the last joint of the robot. It affects the MovePose command and all MoveLin* commands. When the automatic turn selection is enabled, and a MovePose command is executed, the last joint will always take the shortest path, and rotate no more than 180°. In the case of a MoveLin* command, however, enabling the automatic turn selection simply allows the change of turn configuration along the linear move.

harp_5_5_2-7

​

5.6 Settings​

harp_5_6

1LanguageChoose the application UI language.Dropdown of available languages
2ThemeSelect AppearanceLight, Dark, System
3Auto-update**If enabled, HARP checks for updates when the application launches. **Currently not a built in feature**Toggle
4App soundsEnable or disable interface sound effects.Toggle
5Reduce AnimationsPrevents the left toolbar from extending on hover.Toggle
6FullscreenProvides a fullscreen UI for Proper HMI usageToggle
7LicenseEnter a license key, manage activation statusInput field + Activate / Revoke buttons
8PluginsInstalled Robot and End-Effector module list