> ## Índice de la documentación > Consulta el índice completo de la documentación en: https://developer.rhombus.com/llms.txt > Úsalo para descubrir todas las páginas disponibles antes de seguir explorando. # Socket en vivo del robot > Controla un robot de Rhombus y lee su telemetría por WebSocket: cómo obtener la URL del socket, los formatos de trama, los comandos que envías y la telemetría que recibes, generados a partir de la especificación AsyncAPI del robot. > **Note**: Esta página se tradujo automáticamente. Si encuentras errores o tienes sugerencias, [escríbenos](mailto:support@rhombus.com). Cada robot de Rhombus tiene un WebSocket en vivo para control y telemetría: envías comandos como velocidad, postura y parada de emergencia, y recibes la pose, el estado, la ruta planificada, los eventos de comportamiento y los datos de sensores del robot. La referencia de mensajes de abajo se genera a partir de la [especificación AsyncAPI](https://developer.rhombus.com/asyncapi/robot.json) del robot, así que siempre coincide con lo que publica el servicio; sus descripciones están en inglés. ## Conectarse 1. Llama a [`getAllMediaUris`](https://developer.rhombus.com/api-reference/robot-webservice/get-media-uris-for-every-configured-facet-of-a-robot) para el robot y toma `wanLiveRobotUri`, una URL `wss://` en el host de medios del robot. 2. Abre un WebSocket a esa URL con una credencial (consulta [Autenticarse](https://developer.rhombus.com/es/robots/live-socket#autenticarse)). 3. Envía los comandos como **tramas de texto** con JSON. Cada comando necesita `type` y `timestamp` (milisegundos de época Unix); el robot descarta sin avisar un comando que no los tenga. 4. Lee los mensajes del robot como **tramas binarias** con JSON en UTF-8, y distingue cada uno por su `type`. ### Autenticarse El socket acepta una clave de API, un access token de OAuth o un token federado. Envíalo en el handshake del WebSocket: | Cliente | Credencial | Cómo | | --------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | Servidor o app nativa | Clave de API | Encabezados `x-auth-scheme: api-token` y `x-auth-apikey` | | Servidor o app nativa | Access token de OAuth cuyo grant incluye el scope `physical` | Encabezado `Authorization: Bearer ` | | Navegador | [Token federado](https://developer.rhombus.com/es/authentication/federated-tokens) generado por tu backend | Parámetros de consulta `?x-auth-scheme=federated-token&x-auth-ft=` (o los mismos nombres como encabezados, desde clientes que puedan definirlos) | - Mover un robot es una acción física, así que un token de OAuth necesita el scope `physical`: sin él, el handshake se rechaza con 403 `PERMISSION_REQUIRED` y `WWW-Authenticate: Bearer error="insufficient_scope", scope="physical"`. - Las credenciales de partner también envían el UUID de la organización cliente en el encabezado `x-auth-org`. - Un handshake rechazado devuelve 401 (credencial ausente, desconocida, expirada o revocada) o 403 (válida pero no permitida) con el cuerpo de error JSON que se describe en [Errores](https://developer.rhombus.com/es/errors). - Si la credencial se elimina o revoca, o su rol cambia, el socket abierto se cierra con el código `1008` en 60 segundos o menos. Revisa la credencial antes de reconectarte. Consulta [Medios y transmisiones](https://developer.rhombus.com/es/authentication/media) para ver cómo funciona cada credencial en los hosts de medios. ### Comportamiento de la conexión Si el robot no está conectado al host de medios de la URL, el handshake se rechaza con `403`: vuelve a obtener `wanLiveRobotUri` (el host de medios del robot puede cambiar) y reintenta más tarde. Si el robot está conectado pero su canal de control no está listo, el socket envía un mensaje [`reconnect`](https://developer.rhombus.com/es/robots/live-socket#reconnect) como trama de texto y sigue abierto: ciérralo y vuelve a intentarlo en unos momentos. El socket se cierra tras 180 segundos sin tráfico. Se pueden agregar en cualquier momento nuevos tipos de mensaje, campos y valores de enum, así que ignora lo que no reconozcas. Un [`BEHAVIOR_EVENT`](https://developer.rhombus.com/es/robots/live-socket#behavior_event) puede llegar dos veces cuando el robot reintenta una entrega; elimina duplicados por su `event_uuid`. > **Warning**: Los comandos mueven una máquina física. Mantén la parada de emergencia ([`CMD_EMERGENCY_STOP_LOCK`](https://developer.rhombus.com/es/robots/live-socket#cmd_emergency_stop_lock)) a una sola acción de distancia en cualquier interfaz que construyas, deja de enviar comandos de velocidad cuando el operador suelte el control y haz pruebas en un área despejada. ## Mensajes que envías ### `CMD_ACTION` Run a platform-specific action; see the action field for the values each robot platform supports. ```json { "action": "GO2_STAND_UP", "timestamp": 1727800000000, "type": "CMD_ACTION" } ``` ### `CMD_EMERGENCY_STOP_LOCK` Engage the emergency stop. The robot stays stopped until CMD_EMERGENCY_STOP_UNLOCK. ```json { "timestamp": 1727800000000, "type": "CMD_EMERGENCY_STOP_LOCK" } ``` ### `CMD_EMERGENCY_STOP_UNLOCK` Release the emergency stop. ```json { "timestamp": 1727800000000, "type": "CMD_EMERGENCY_STOP_UNLOCK" } ``` ### `CMD_INITIALIZE_POSE` Set the robot's localization estimate to a pose in the map frame. ```json { "pose": { "orientation": [ 0, 0, 0, 1 ], "position": [ 0.5, 0, 0 ] }, "timestamp": 1727800000000, "type": "CMD_INITIALIZE_POSE" } ``` ### `CMD_NAVIGATE_CANCEL` Cancel navigation: the current pose, waypoint, home, route/patrol, idle docking or exploration activity, plus queued ones. Low-battery docking continues. ```json { "timestamp": 1727800000000, "type": "CMD_NAVIGATE_CANCEL" } ``` ### `CMD_POSTURE` Adjust body posture. axes is a sparse map of platform-specific axis name to value (e.g. pitch in rad); empty or missing axes returns to neutral. ```json { "axes": { "pitch": -0.1 }, "duration_ms": 5000, "timestamp": 1727800000000, "type": "CMD_POSTURE" } ``` ### `CMD_VEL` Teleoperate with a velocity twist in the robot base frame: linear \[x, y, z] in m/s, angular \[x, y, z] in rad/s. ```json { "timestamp": 1727800000000, "twist": { "angular": [ 0, 0, 0.2 ], "linear": [ 0.3, 0, 0 ] }, "type": "CMD_VEL" } ``` ## Mensajes que recibes ### `BEHAVIOR_EVENT` Activity lifecycle and progress: STARTED, PROGRESS, SUSPENDED, RESUMED, COMPLETED, FAILED, CANCELED or REJECTED. ```json { "activity": "ROUTE_RUN", "activity_uuid": "kX9mQ2rTSa6vL0pWcYb1Ng", "battery": { "start_pct": 91 }, "description": "Patrol run", "distance_remaining": 6.4, "estimated_time_remaining_sec": 18, "event": "PROGRESS", "event_uuid": "Q1w2E3r4T5y6U7i8O9p0AQ", "goal_pose": { "orientation": [ 0, 0, 0.7071, 0.7071 ], "position": [ 4.2, -1.5, 0 ] }, "navigation_time_sec": 42.5, "originator_uuid": "Zx8Cv7Bn6Mm5Ll4Kk3Jj2A", "phase": "NAVIGATE_TO_WAYPOINT", "phase_uuid": "G7Qpbx5-RnC9av0WwS3jbA", "prediction": { "available": true, "confidence": "HIGH", "consumption_pct": 4.5, "distance_basis": "planned", "distance_m": 120 }, "priority": 50, "route_uuid": "Pz5Lc8Xe1Wa4Ru7Ty0Io3Q", "started_at_ms": 1727799950000, "timestamp": 1727800000000, "type": "BEHAVIOR_EVENT", "waypoint_index": 2, "waypoint_total": 5, "waypoint_uuid": "Hw4Rt7Yp2Kd9Vs3Bn6Mq1w" } ``` ### `LASER_SCAN` Nearest obstacle per angular sector around the robot. ```json { "frame": "base_footprint", "indices": [ 0, 1, 2, 35 ], "max_range_m": 3, "ranges": [ 1.25, null, 2.4, 0.8 ], "sectors": 36, "timestamp": 1727800000000, "type": "LASER_SCAN" } ``` ### `OCCUPANCY_GRID` Live occupancy grid of the map being built or used. ```json { "data_compressed": "eJxjYASC1FRGBgZGRgAFWwDS", "height": 3, "origin": [ -10, -5, 0 ], "resolution": 0.1, "timestamp": 1727800000000, "type": "OCCUPANCY_GRID", "width": 4 } ``` ### `PLANNED_PATH` Planned navigation path as \[x, y] points. ```json { "frame": "map", "poses": [ [ 1.2, -0.4 ], [ 1.8, -0.2 ], [ 2.5, 0.1 ] ], "timestamp": 1727800000000, "type": "PLANNED_PATH" } ``` ### `ROBOT_STATE` Robot state: locomotion, battery, navigation mode and latest pose. ```json { "avoidance_mode": "GO2_AVOIDANCE_MODE", "battery_current_ma": -3200, "battery_level": 82, "battery_state": "DISCHARGING", "battery_voltage_mv": 28600, "latest_transform": { "frame": "map", "transform": { "rotation": [ 0, 0, 0.38, 0.92 ], "translation": [ 1.2, -0.4, 0 ] } }, "locomotion_state": "STANDING", "map_uuid": "bL0cfvn7Squz3-swZjifpg", "navigation_stack_state": "NAVIGATING", "operational_state": "OPERATIONAL", "return_home": { "available": true, "confidence": "HIGH", "distance_basis": "planned", "distance_m": 38.5, "required_pct": 7.2, "sufficient": true }, "timestamp": 1727800000000, "type": "ROBOT_STATE" } ``` ### `TELEMETRY` Robot pose sample. correlationId is the activity_uuid of the activity in progress. ```json { "activity": "ROUTE_RUN", "correlationId": "kX9mQ2rTSa6vL0pWcYb1Ng", "frame": "map", "mapUuid": "bL0cfvn7Squz3-swZjifpg", "timestamp": 1727800000000, "transformation": { "rotation": [ 0, 0, 0.38, 0.92 ], "translation": [ 1.2, -0.4, 0 ] }, "type": "TELEMETRY" } ``` ### `reconnect` Sent by the cloud when the robot is not connected; reconnect later. ```json { "action": "reconnect", "reason": "device_not_connected" } ```