Skip to main content

LiftAuth Integration High Level Guide

Flow A: Standard Mode (Without Robot Mode)

StepActionDescription
1Robot Arrives at Lift LandingRobot navigates to the lift landing area and positions itself for entry.
2Connect to Cloud WebSocketRobot/Fleet Manager establishes WebSocket connection to LiftAuth cloud servers using API key.
3Retrieve OTPSystem retrieves one-time password for secure lift access authorization.
4Call LiftSend CALL_LIFT request to summon lift to current floor.
5Lift Arrival NotificationLift arrives and notifies robot via cloud WebSocket.
6Robot Enters LiftRobot drives into the lift cabin.
7Connect to Cabin LAN & WebSocketRobot establishes local connection to cabin controller via LAN and cabin WebSocket.
8Close Door & Call Target FloorRobot sends SET_DOOR_CLOSE command, then sends CALL_LIFT request with destination floor.
9Lift Services Target FloorLift travels to destination floor (may stop at intermediate floors for other passengers).
10Target Floor Arrival NotificationLift arrives at destination and notifies robot via cabin WebSocket.
11Robot Exits LiftRobot drives out of the lift cabin and proceeds to its task.

Flow B: Exclusive Mode (With Robot Mode)

StepActionDescription
1Robot Arrives at Lift LandingRobot navigates to the lift landing area and positions itself for entry.
2Connect to Cloud WebSocketRobot/Fleet Manager establishes WebSocket connection to LiftAuth cloud servers using API key.
3Retrieve OTPSystem retrieves one-time password for secure lift access authorization.
4Enable Robot ModeSend ROBOT_MODE_ON request to take exclusive control of lobby operations.
5Wait for Robot Mode ActivationSystem waits for confirmation that robot mode is fully activated before proceeding.
6Call LiftSend CALL_LIFT request to summon lift to current floor.
7Lift Arrival NotificationLift arrives and notifies robot via cloud WebSocket.
8Robot Enters LiftRobot drives into the lift cabin.
9Connect to Cabin LAN & WebSocketRobot establishes local connection to cabin controller via LAN and cabin WebSocket.
10Close Door & Call Target FloorRobot sends SET_DOOR_CLOSE command, then sends CALL_LIFT request with destination floor.
11Lift Services Target FloorLift travels to destination floor without stopping for other calls due to robot mode.
12Target Floor Arrival NotificationLift arrives at destination and notifies robot via cabin WebSocket.
13Robot Exits LiftRobot drives out of the lift cabin.
14Reconnect to Cloud WebSocketRobot/Fleet Manager reconnects to cloud WebSocket (if disconnected).
15Disable Robot ModeSend ROBOT_MODE_OFF request to release exclusive control and return lobby to normal operations.

Key Differences

Standard Mode

  • Lift sharing enabled: Lift may stop at intermediate floors for other passengers
  • No exclusive control: Other building users can summon and use the lift normally
  • Best for: Low-traffic periods, non-time-sensitive deliveries, buildings with multiple lifts

Robot Mode

  • Exclusive lift control: Lift dedicated to robot operation during active session
  • No intermediate stops: Direct travel to destination floor
  • Requires activation wait: Must confirm robot mode is fully active before calling lift
  • Requires explicit deactivation: Must turn off robot mode after task completion