Skip to main content

Connect to a Lift

1. Authenticate​

Retrieve your API key and Lift ID from the LiftAuth Dashboard. Use this API Key and Lift ID to authenticate your websocket connection.

2. Establish Connection​

To connect to the lift server via WebSocket:

  • Pass the liftId as a query parameter in the connection URL.
  • Include the API key in the Authorization header.
info

The WebSocket connection will close automatically in 30 minutes. Be sure to finish up your session before then.

3. Send Commands​

Once you are connected, you can begin to send commands to control the lift. The commands are documented in detail here.

To get you started, we have set up a public test lift for you to run operations on.

We will simulate the workflow of a robot travelling from one floor to another.

info

All floors are indexed starting from 0, regardless of how the floors are labeled in the actual lift.

Mapping real-world floor labels: For example, [B2, B1, G, 1, 2] in a real lift would be mapped to [0, 1, 2, 3, 4] in our system.

Best Practices​

  1. Reconnect on Failure: If the WebSocket connection is lost, ensure your fleet manager can reconnect automatically.
  2. Handle Errors Gracefully: Design your system to manage error codes and retry failed operations where appropriate.
  3. Monitor Lift Status: Periodically poll the lift's position and door status to ensure smooth coordination between your robots and the lift.
  4. Optimize Command Timing: Avoid sending excessive commands. Let the lift system manage its queue efficiently.

Support​

For further assistance, please contact our support team at hello@liftauth.com.