S500 messages
control
1015 set_ping_params
Set parameters
| Type | Name | Description | Units |
|---|---|---|---|
| u32 | start_mm | Start of ping range, normally set to 0. | mm |
| u32 | length_mm | Length of the returned profile. End of range = start_mm + length_mm. Set to 0 for auto_range. | mm |
| i16 | gain_index | Set to -1 for auto gain, otherwise 0-13 sets gain for manual gain. | |
| i16 | msec_per_ping | Set to -1 to start a single ping. Otherwise sets minimum ping interval. | msec |
| u16 | pulse_len_usec | 0 for auto mode. Currently ignored and auto duration is always used. | |
| u16 | report_id | The ID of the packet type that you would like in response. Options are distance2 (1223), profile6 (1308), or zero. Zero disables pinging. | |
| u16 | reserved | Set to 0 | |
| u8 | chirp | Set to 1 for chirp, 0 for monotone ping. | |
| u8 | decimation | Set to 0 for auto range resolution in chirp mode |
1002 set_speed_of_sound
Set the speed of sound
| Type | Name | Description | Units |
|---|---|---|---|
| u32 | sos_mm_per_sec | The speed of sound in the measurement medium, ~1,500,000 mm/s for water. | mm/s |
get
1211 altitude
| Type | Name | Description | Units |
|---|---|---|---|
| u32 | altitude_mm | Result of most recent calculated distance from device to bottom (or other target). | mm |
| u8 | quality | Measure of confidence of altitude measure, 0 (No idea) to 100 (Quite sure). |
1223 distance2
Reports a simple distance measurement.
| Type | Name | Description | Units |
|---|---|---|---|
| u32 | ping_distance_mm | Distance of most recent ping | mm |
| u32 | averaged_distance_mm | Average distance over last 20 pings | mm |
| u16 | reserved | ||
| u8 | ping_confidence | 0 to 100 | |
| u8 | average_distance_confidence | 0 to 100 | |
| u32 | timestamp | msec |
1200 fw_version
| Type | Name | Description | Units |
|---|---|---|---|
| u8 | device_type | ||
| u8 | device_model | ||
| u16 | version_major | ||
| u16 | version_minor |
1207 gain_index
| Type | Name | Description | Units |
|---|---|---|---|
| u32 | gain_index | Current gain index setting |
1206 ping_rate_msec
| Type | Name | Description | Units |
|---|---|---|---|
| u16 | msec_per_ping | Minimum time between successive pings. Can be longer depending on range. | msec |
1213 processor_degC
| Type | Name | Description | Units |
|---|---|---|---|
| u32 | centi_degC | Device CPU temperature, result = degrees C * 100 | centi-degrees C |
1308 profile6_t
Reports a measure of signal strength at all depths within the ping range. This could be used to present a 'waterfall' type display similar to a commercial marine depth sounder or fish finder. The Cerulean SonarView app uses profile6_t to do just that. The native number of results reported for the profile6_t is 1024 for monotone pings. For chirp pings, the range resolution is affected by the 'decimation' field in the set_ping_params command. If decimation is set to 0, the device will vary decimation depending on range. The smallest decimation will be used that does not exceed 6000 reported data elements. Keep in mind the bandwidth of the communication channel in use when considering which profile report to use. For example, profile6_t can generate a lot of data, and is probably best used with the USB or Ethernet interface.
| Type | Name | Description | Units |
|---|---|---|---|
| u32 | ping_number | Sequentially assigned from 0 at power up. | |
| u32 | start_mm | Start of ping range | mm |
| u32 | length_mm | Length of the returned profile. End of range = start_mm + length_mm. | mm |
| u32 | start_ping_hz | Initial frequency of ping. | hz |
| u32 | end_ping_hz | Final frequency of ping. | hz |
| u32 | adc_sample_hz | Sampling rate of adc | hz |
| u32 | timestamp_msec | msec | |
| u32 | spare2 | ||
| float | pulse_duration_sec | Pulse duration in seconds. | sec |
| float | analog_gain | ||
| float | max_pwr_db | Maximum power level in dB. | dB |
| float | min_pwr_db | Minimum power level in dB. | dB |
| float | this_ping_depth_m | Depth in meters as calculated from most recent ping. | m |
| float | smooth_depth_m | Smoothed calculated depth in meters. | m |
| float | fspare2 | 0 | |
| u8 | ping_depth_measurement_confidence | Depth measurement confidence (0-100) based on most recent ping. | |
| u8 | gain_index | ||
| u8 | decimation | ||
| u8 | smoothed_depth_measurement_confidence | 0 (0-100) | |
| u16 | num_results | ||
| u16[] | pwr_results | Power results scaled from min_pwr to max_pwr. num_results entries. Length is derived from payload_length in the header. |
1204 range
| Type | Name | Description | Units |
|---|---|---|---|
| u32 | start_mm | Normally 0. | mm |
| u32 | length_mm | start_mm + length_mm is max range. | mm |
1203 speed_of_sound
| Type | Name | Description | Units |
|---|---|---|---|
| u32 | sos_mm_per_sec | Current speed of sound setting in mm/sec, default is 1500 m/sec. | mm/sec |