Firmware Introduction

This Firmware User Manual is meant to allow the users to take advantage of all the features that are available with Ouster Sensors. Detailed Instructions regarding lidar operations, lidar data, API Guides and Troubleshooting guide are present in this user manual.

For information on the mechanical and electrical operations or the interface box, please refer to the Hardware User Manual.

To know more about Ouster sensors and their specifications please refer to the datasheets available on our Website.

Connecting to Sensor

What’s in the box

../../../_images/sensor.png
../../../_images/interfacebox.png
../../../_images/ethernetcable.png
../../../_images/powersupply.png

Note

Ibox 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.

../../../_images/colletup.png
  • 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.

../../../_images/collet.png
  • Connect the plug to the sensor, then rotate the collet 180 degrees clockwise until it clicks. This indicates that it is fully seated.

../../../_images/collet180.png
  • 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 provided to the IO box and the other end to a PC/LINUX/MAC user interface.

Network Configuration

The sensor is designed to communicate with a host machine through a variety of different methods such a DHCP, IPv6/IPv4 link-local, and static IP.

On most systems you should be able to connect the sensor into your network or directly to a host machine and simply use the sensor hostname to communicate with it.

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

Optionally you may time synchronize the sensor through an external time source or through the computer via PTP.

../../../_images/system-diagram.svg

Network Configuration and Setup

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

For more detailed guidance on communicating with the sensor on various operating systems and network settings please reference the Networking Guide in the Appendix.

Commands for setting and deleting a static IP address can be found in the HTTP API Reference Guide section.

Note

May be required to deactivate the firewall to connect with the sensor and access sensor data.

Open Google Chrome/Microsoft Edge/Firefox. Use the hostname in the format of http://OS-99xxxxxxxxxx.local and click on “Enter/Character turn” to open Ouster Dashboard.

Note

  • The serial number of the sensor need not start with 99 and is only taken as an example in this document, the sensor serial number can be found on a sticker affixed to the top of the sensor.

  • Please keep in mind NOT to use https:// as it will result in an error, use without s as shown http://OS-99xxxxxxxxxx.local.

Web Interface

The sensor homepage can be accessed by typing in the sensor’s address (IPv4, IPv6, or hostname) in a web browser (http://os-991234567890.local/ where 991234567890 is the serial number). From here you can see information about the sensor, access documentation, and configure sensor settings.

Note

This new version of the web UI will only be accessible after updating to FW 2.2.0 or later.

Dashboard: Contains an overview of the sensor.

  • System Information: This panel provides information regarding the network configuration and hardware details that are unique to each sensor

  • Firmware Update: You can update firmware on this panel. See Updating Firmware for more details.

  • System Status: This panel displays the status of the sensor and information regarding any Active Alerts. More information on the status of the sensor can be found by clicking the link, which will take the user to the Diagnostics tab

  • Configuration: An overview of the sensor configuration is available on this panel. The sensor configuration can also be edited by clicking on the link below, which will take the user to the Configuration tab

../../../_images/FW2.3.png

Ouster Dashboard

Diagnostics: Contains diagnostic alert and error information about the sensor for troubleshooting purposes. For a list of possible alerts and errors, see Alerts and Errors. Some Alerts require the user to reach out to ouster support. Please include a copy of the System Diagnostics file which can be downloaded by clicking the blue tab on this page.

../../../_images/alerts_FW2.3.png

Ouster Alerts & Diagnostics

Configuration: This tab contains a user interface to change sensor configuration. While in STANDBY mode, we can update the configuration settings in the WEB UI, but it will not take effect until we switch the sensor back to NORMAL mode

../../../_images/ouster_dashboard_sensorconfig1.png

Sensor Configuration

  • Reset Configuration: Resets sensor to factory configurations and settings. Note that this resets any static IP address given to the sensor.

  • Persist Active Config: Allows the user to configure the sensor settings and set them as the active configuration without reinitializing the sensor

  • Apply Config (reinit): Allows the user to configure the sensor settings. This involves a reinitialization of the sensor, so that the sensor configuration settings can take effect

  • Documentation: Contains the HTTP and TCP API guides that are compatible with the version of the firmware on the sensor. Visit Ouster Sensor Documentation for latest hardware and software user manuals, along with integration guides and troubleshooting guides.

../../../_images/sensor_documentation.png

Ouster Documentation

Updating Firmware

Sensor firmware can be updated with an Ouster-provided firmware file from Ouster FW (or directly from the deployment engineering team) by accessing the sensor over http - e.g., http://os-991900123456.local/ and uploading the file as prompted.

../../../_images/updating_FW.png

Uploading a new firmware image onto the sensor

Always check your firmware version before attempting an update. Only update to an equal or higher version number.

After the web UI confirms that the update is complete, please allow the sensor to reboot (about 2 minutes) and refresh your webpage to get access to the updated Web UI.

Software Resources

After connecting to your sensor, you can quickly visualize the point cloud using Ouster Python SDK or using Ouster Studio . Both Ouster Python SDK and Ouster Studio are available for Linux, Mac, and Windows. Please visit Ouster Resources for the latest tools to visualize your sensor output.

Ouster Python SDK Ouster Python SDK provides a high-level interface for interacting with sensor hardware and record sensor data suitable for prototyping, evaluation, and other non-safety critical applications. Example and reference code is provided for several common operations on sensor data. he SDK includes APIs for:

  • Querying and setting sensor configuration

  • Recording and reading data in pcap format

  • Reading and buffering sensor UDP data streams reliably

  • Frame-based access to lidar data as numpy datatypes

  • Conversion of raw data to range/signal/near_ir/reflectivity images (de-staggering)

  • Efficient projection of range measurements to Cartesian (X, Y, Z) coordinates

Ouster Studio Ouster Studio is software provided by Ouster to visualize, record, and analyze data from Ouster lidar sensors. Ouster Studio is cross-platform, with official support for Windows, MacOS and Ubuntu. The software performs real-time visualization, processing, and recording of live 3D lidar data captured from Ouster lidar sensors.

Note

Ouster recommends users to utilize Ouster Python SDK.