Troubleshooting with Ouster & Retrieving Diagnostic File

[4wheeler]

When working with Ouster to troubleshoot sensor issues (usually through support), it’s strongly recommended to send a diagnostic file as well. This file contains information like firmware and alerts from the sensor. This reduces the amount of questions Ouster has to ask the user.

How to Retrieve the Diagnostic File:

Sensor Webpage

1. Open a browser (e.g. Chrome) and paste in the sensor hostname or IP
   1. link local example: os-000000000000.local (replace 0 with the 12 digit serial number)
2. Go to the Diagnostic page
   1. This should be in the navigation bar at the top of the page
3. Click the blue ‘System Diagnostics‘ button
   1. 
4. A diagnostics file should download (*.bin file)

HTTP Request

1. Curl
   1. Replace the 0.0.0.0 with the sensor hostname or IP
   2. curl -LOJ http://0.0.0.0/api/v1/diagnostics/dump

[4wheeler]

Here’s how to request a diagnostic file with certain Ouster Applications.
To find instructions for a specific application, use your browser search feature to quickly jump to it (Windows/Linux: ctrl + f, macOS: cmd + f).

Software Applications

• Ouster Studio Desktop: Ouster Studio: Simplified Lidar Sensor Visualization Software | Ouster
• Gemini Portal: gemini.ouster.com
• Gemini Detect: Introduction — Ouster Detect Documentation documentation

Ouster Studio Desktop

1. Open Ouster Studio Desktop
2. If mDNS is enabled between the sensor and computer, Ouster Studio Desktop should be able to detect it
3. Select the desired sensor under ‘Sensor Selection’
4. Open Advanced Configuration by clicking ‘Advanced’ next to Configuration in the ‘Sensor Setup’ box
   
   
5. Follow the Sensor Webpage instructions in the original post (start at #2)

Gemini Portal

For users who have their Gemini Detect actively connected to gemini.ouster.com.

1. Login to gemini.ouster.com
2. Find the Gemini Detect instance that the sensor is connected to
   
   
   
   – If you have multiple and you know the specific instance, you can search for the instance (e.g. Device ID, Host Name, Description) to find it easily
   – If you know the sensor location, you can search for an icon in that location.
   — if there are multiple Detects in the same region, you’ll need to click through each of them and manually look for the desired sensor in each instance’s Site Details page
   – It’s advised to document the sensor serial number + Detect instance and other related information
3. Open the Site Details for the desired instance by clicking on the icon on the map or the instance’s name in the list below the map
4. Find the desired serial number in the Site Detail’s Lidar Sensors list
   
   
   
   – You can search for the serial number or IP address in the ‘Lidar Sensors’ list
5. If the sensor health is shown as ‘ONLINE’, you should be able to click ‘Diagnostics Dump’ button
6. A dialog box should appear in the window
   
   
7. Click ‘Start New Diagnostics Dump’
   – You’ll need to wait for the file to be requested from the remote server
8. Once the file is available, click ‘Download’
   
   

Gemini Detect

For sensors connected to Gemini Detect (Introduction — Ouster Detect Documentation documentation).
Users will need a role that will allow them to configure sensors to request a diagnostic file (e.g. admin)

1. Go to the Setup Page
   
   
2. Click on the desired sensor under ‘Source Management’ on the left
3. Click the ‘Configure Sensor’ button
   – If the ‘Configure Sensor’ is greyed out, your user role doesn’t have enough permissions to access this.
   — Try (if applicable) Gemini Portal or ask a user with the right permissions to retrieve this
4. A new tab with the sensor webpage should open
   – Example: gemini_detect_url.local/api/sensorproxy/0/
5. Follow the Sensor Webpage directions in the original post (start at #2)