> For the complete documentation index, see [llms.txt](https://docs.ceruleansonar.com/c/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ceruleansonar.com/c/omniscan3d/technical-details/api/os3d_set_ping_parameters.md).

# OS3D\_SET\_PING\_PARAMETERS

#### ID: 3024

#### Payload Definition

<table><thead><tr><th width="145">Data Type</th><th width="219">Name</th><th>Description</th></tr></thead><tbody><tr><td>float</td><td>start_m</td><td>start range in meters at which echo data is recorded. Ignored in auto range mode. Will be forced to 5% of end range as a minimum.</td></tr><tr><td>float</td><td>end_m</td><td>end range in meters over which echo data is recorded. Set to 0 for Omniscan 3D to automatically track the bottom and adjust range dynamically.</td></tr><tr><td>float</td><td>sos_mps</td><td>speed of sound, meters per second.</td></tr><tr><td>i16</td><td>gain_index</td><td>set to -1 for auto gain (recommended). Valid manual gain ranges are from 0 to 10</td></tr><tr><td>i16</td><td>msec_per_ping</td><td>pings per second = 1000 / msec_per_ping. So 100 msec_per_ping means 10 pings per second. Actual ping rate can be limited by range and speed of sound, so the value specified defines an upper limit on ping rate.</td></tr><tr><td>u16</td><td>reserved</td><td>set to 0</td></tr><tr><td>u8</td><td>diagnostic injected signal</td><td>must be set to 0</td></tr><tr><td>bool</td><td>ping_enable</td><td>true to start/continue pinging, false to stop</td></tr><tr><td>bool</td><td>enable channel data</td><td>used by SonarView, but not necessary or generally useful. if enabled log files will be very much larger.</td></tr><tr><td>bool</td><td>reserved for raw data</td><td>must be set to false</td></tr><tr><td>bool</td><td>reserved</td><td>set to false</td></tr><tr><td>bool</td><td>enable atof data</td><td>enable angle + time of flight information for each detected point should be true</td></tr><tr><td>i32</td><td>target ping hz</td><td>set to 450000. Used internally for production testing only.</td></tr><tr><td>u16</td><td>n_range_steps</td><td>sets range resolution in number of range steps. Must be between 200 and 1000 (inclusive), 1000 is recommended.</td></tr><tr><td>u16</td><td>reserved</td><td>set to 0</td></tr><tr><td>float</td><td>pulse_len_steps</td><td>pulse length in number of range steps. Recommended value is 1.5</td></tr></tbody></table>