SET_PING_PARAMETERS

ID: 3023

Payload Definition

Data TypeNameDescription

i32

start_mm

start range in mm at which echo data is recorded. Ignored in auto range mode. Will be forced to 5% of end range as a minimum.

i32

end_mm

end range in mm over which echo data is recorded. Set to 0 for Surveyor to automatically track the bottom and adjust range dynamically.

float

sos_mps

speed of sound, meters per second.

i16

gain_index

set to -1 for auto gain (recommended). Valid manual gain ranges are from 0 to 10

i16

msec_per_ping

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.

u16

deprecated, formerly pulse_width_usec

use pulse_len_bins instead. Earlier code will still work but pulse length will be 1.5 range bins

u8

diagnostic injected signal

must be set to 0

bool

ping_enable

true to start/continue pinging, false to stop

bool

enable channel data

used by SonarView, but not necessary. if enabled log files will be much larger.

bool

reserved for raw data

must be set to false

bool

enable YZ point data

angle and time of flight data is preferred for future SonarView enhancements.

bool

enable atof data

enable angle + time of flight information for each detected point

i32

target ping hz

set to 240000. Used internally for production testing only.

u16

n_range_steps

sets range resolution in number of range steps. Must be between 200 and 800 (inclusive).

u16

reserved

float

pulse_len_steps

pulse length in number of range steps. Recommended value is 1.5

Last updated