> This page is for Overview.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.ouster.com/sensor-docs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.ouster.com/sensor-docs/_mcp/server.

# Quick Start Guide

> Unbox, connect, and configure an Ouster sensor for the first time.

This guide covers unboxing, connecting, and configuring an Ouster sensor for the first time.

For firmware features — lidar operation, data formats, API reference, and troubleshooting — see the [Firmware documentation](/sensor-docs/firmware).

For mechanical and electrical details, or interface box documentation, see the [Hardware documentation](/sensor-docs/hardware).

For sensor specifications, see the datasheets on the Ouster [Website](https://ouster.com/downloads/).

## What's in the box

![Ouster sensor](/sensor-docs/_fern-img/4ec1b53b284d18e31c4e428fa7828caadfed563dcb8c0269cfaefcde587da695.webp)![Interface box](/sensor-docs/_fern-img/bac09e0b48ee06eb29f39604d1e149ca1b3b6cfd29d5f5d109378b44ec039a87.webp)![Ethernet cable](/sensor-docs/_fern-img/59e79e4d3f8934287f5232d30fe1f4dec818a0d43d58992dfa5e87220d6435c9.webp)![Power supply](/sensor-docs/_fern-img/21803a04588c749a01e251bbd451ab3fe4fc13a9cb4af085ac88a02339b01708.webp)

> **Note**
>
> Interface box is not always shipped with the sensor, based on customer requirement it could be a pig tail connector cable or a custom cable.

## Sensor Setup

* Connect one end of the bayonet-style connector to the Ouster sensor as shown. Verify that the plug “UP” indicator is pointed up.

![Image](/sensor-docs/_fern-img/e66eeb6639e3fcee5ba38a9e7bc6b94e33a7fdb24394908b326ce37107b1d4f7.webp)

* Rotate the collet on the plug until one of its two pins is aligned with the major keyway. This will allow its two pins to enter the receptacle channel.

![Connector collet aligned with the keyway](/sensor-docs/_fern-img/5dfbc263785f91e97bf07807c391a1e762aff3e8f79b591e00ddb7314762b308.webp)

* Connect the plug to the sensor, then rotate the collet 180° clockwise until it clicks—fully seated. Verify the red line on the stainless steel collet aligns with the emblem on the overmold. This confirms the connector is locked.

![Image](/sensor-docs/_fern-img/2f049ce8d1baf7ecf2f9e95c6116a10117e065a75d6611787dd461d270272e38.webp)

* Connect one end of the power supply to the wall socket and the other end to the IO box.

* Connect one end of the Ethernet cable to the IO box and the other end to the host machine.

## Network Configuration

The sensor communicates with a host machine via DHCP, IPv6/IPv4 link-local, or static IP.

On most systems, connect the sensor to your network or directly to a host machine and use the sensor hostname to communicate.

Your Ouster sensor requires a host with a gigabit Ethernet connection and a 24 V supply.

Optionally, time-synchronize the sensor via an external time source or via PTP over the network.

![Network Configuration and Setup](/sensor-docs/_fern-files/ouster.docs.buildwithfern.com/57832364a336c7335bbe91b72557d0b9f0277db80330a6c0d209400164a7bb35/assets/common_images/connecting/system-diagram.svg)

The sensor hostname is `os-991234567890.local`, where `991234567890` is the sensor serial number, found on a sticker on the top of the sensor.

For OS-specific networking instructions, see the networking-guide in the Appendix.

Commands to set and delete a static IP address are in the http-api section.

> **Note**
>
> A firewall rule may be required to connect to the sensor and receive data.

Open Google Chrome/Microsoft Edge/Firefox. Use the hostname in the format of `http://OS-99xxxxxxxxxx.local` to open Ouster Dashboard.

> **Note**
>
> Use the serial number printed on your sensor when entering the hostname. Always use `http://`, not `https://`; the sensor web interface does not support HTTPS.

## Sensor Web Interface

Access the sensor homepage by entering the sensor’s address (IPv4, IPv6, or hostname) in a browser. For example, use `http://os-991234567890.local/`, where `991234567890` is the sensor serial number. From here, view sensor information, access documentation, and configure settings.

**Dashboard**: View sensor summary, firmware update controls, current status, and shortcuts to Diagnostics and Configuration.

* **System Information**: Network configuration and hardware details unique to each sensor.
* **Firmware Update**: Update sensor firmware from this panel. See update-firmware for details.
* **System Status**: Current sensor status and any active alerts. Click the link to open the Diagnostics tab.
* **Configuration**: Current sensor configuration. Click the link to open the Configuration tab and edit settings.

![Ouster Dashboard](/sensor-docs/_fern-img/df8929e4751ae243ece3a8658f423e18e9fd5ac452e5fee316bfdf92a89b7719.webp)

**Diagnostics**: View active alerts, error details, and downloadable diagnostics information. For a full list of alerts and errors, see [Alerts and Errors](/sensor-docs/firmware/alerts-and-errors).

![Ouster Alerts & Diagnostics](/sensor-docs/_fern-img/0b81252235996b9e4e400eb4b9b283c484f81403c997d0a35175a1b62c0cd353.webp)

**Configuration**: View and edit sensor configuration. Configuration changes do not take effect while the sensor is in `STANDBY` mode; switch to `NORMAL` mode before applying changes.

* **Reset Configuration**: Resets the sensor to factory settings. This also clears any configured static IP address.
* **Persist Active Config**: Writes the current configuration to persistent storage so it reloads on every startup.
* **Apply Config (reinit)**: Applies pending configuration changes by reinitializing the sensor.

![Sensor Configuration](/sensor-docs/_fern-img/746c276b0a7fcbc137dc793992cd957f5276529dfdda7d4aaa7c3d1cb0a685e7.webp)

**Documentation**: View on-sensor OpenAPI documentation for the current firmware version.

![Ouster Documentation](/sensor-docs/_fern-img/a42252bdc1b6cac31dcf43890db8beec2f97b7e8d7c6b14f5765db3d33c52c11.webp)

## Updating Firmware

Download a firmware file from [Ouster Downloads](https://ouster.com/downloads), navigate to the sensor web UI (for example, `http://os-991234567890.local/`), and upload the file when prompted.

> **Note**
>
> Firmware can also be updated via an HTTP endpoint. See update-sensor-firmware in the HTTP API section.

![Firmware update upload in progress](/sensor-docs/_fern-img/082b92c3b77f9d7e4aa3068b6e619361d11e099678ada01db12508e46d4c728e.webp)![Firmware update upload complete](/sensor-docs/_fern-img/e338c7192041812fcecd95c9d9bbcc5d4df26656d0b45c0b1785272a6c1c0925.webp)

Check the current firmware version before updating. Only update to an equal or higher version number.

After the web UI confirms the update, allow \~2 minutes for the sensor to reboot, then refresh the page to access the updated web UI.