Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

definitions: ping360: improve message descriptions #200

Merged
merged 5 commits into from
Mar 7, 2022
Merged

definitions: ping360: improve message descriptions #200

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9d5eb3a
definitions: ping360: specify valid number of samples
ES-Alexander Mar 7, 2022
d769278
definitions: ping360: fix units
ES-Alexander Mar 7, 2022
0404cb8
definitions: ping360: improve consistency, reduce redundancy
ES-Alexander Mar 7, 2022
c1d0363
definitions: ping360: correct formatting + release state
ES-Alexander Mar 7, 2022
be52dd6
definitions: ping360: fix incorrect description
ES-Alexander Mar 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 31 additions & 23 deletions src/definitions/ping360.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,19 @@
"name": "angle",
"type": "u16",
"description": "Head angle",
"units": "gradian"
"units": "gradians"
},
{
"name": "transmit_duration",
"type": "u16",
"description": "Acoustic transmission duration (1~1000 microseconds)",
"units": "microsecond"
"units": "microseconds"
},
{
"name": "sample_period",
"type": "u16",
"description": "Time interval between individual signal intensity samples in 25nsec increments (80 to 40000 == 2 microseconds to 1000 microseconds)"
"description": "Time interval between individual signal intensity samples in 25nsec increments (80 to 40000 == 2 microseconds to 1000 microseconds)",
"units": "eicosapenta-nanoseconds"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lol

},
{
"name": "transmit_frequency",
Expand All @@ -59,7 +60,8 @@
{
"name": "number_of_samples",
"type": "u16",
"description": "Number of samples per reflected signal"
"description": "Number of samples per reflected signal (supported values: 200~1200)",
"units": "samples"
},
{
"name": "data",
Expand Down Expand Up @@ -91,18 +93,19 @@
"name": "angle",
"type": "u16",
"description": "Head angle",
"units": "gradian"
"units": "gradians"
},
{
"name": "transmit_duration",
"type": "u16",
"description": "Acoustic transmission duration (1~1000 microseconds)",
"units": "microsecond"
"units": "microseconds"
},
{
"name": "sample_period",
"type": "u16",
"description": "Time interval between individual signal intensity samples in 25nsec increments (80 to 40000 == 2 microseconds to 1000 microseconds)"
"description": "Time interval between individual signal intensity samples in 25nsec increments (80 to 40000 == 2 microseconds to 1000 microseconds)",
"units": "eicosapenta-nanoseconds"
},
{
"name": "transmit_frequency",
Expand All @@ -114,30 +117,31 @@
"name": "start_angle",
"type": "u16",
"description": "Head angle to begin scan sector for autoscan in gradians (0~399 = 0~360 degrees).",
"units": "gradian"
"units": "gradians"
},
{
"name": "stop_angle",
"type": "u16",
"description": "Head angle to end scan sector for autoscan in gradians (0~399 = 0~360 degrees).",
"units": "gradian"
"units": "gradians"
},
{
"name": "num_steps",
"type": "u8",
"description": "Number of 0.9 degree motor steps between pings for auto scan (1~10 = 0.9~9.0 degrees)",
"units": "gradian"
"units": "gradians"
},
{
"name": "delay",
"type": "u8",
"description": "An additional delay between successive transmit pulses (0~100 ms). This may be necessary for some programs to avoid collisions on the RS485 USRT.",
"units": "millisecond"
"units": "milliseconds"
},
{
"name": "number_of_samples",
"type": "u16",
"description": "Number of samples per reflected signal"
"description": "Number of samples per reflected signal (supported values: 200~1200)",
"units": "samples"
},
{
"name": "data",
Expand Down Expand Up @@ -187,18 +191,19 @@
"name": "angle",
"type": "u16",
"description": "Head angle",
"units": "gradian"
"units": "gradians"
},
{
"name": "transmit_duration",
"type": "u16",
"description": "Acoustic transmission duration (1~1000 microseconds)",
"units": "microsecond"
"units": "microseconds"
},
{
"name": "sample_period",
"type": "u16",
"description": "Time interval between individual signal intensity samples in 25nsec increments (80 to 40000 == 2 microseconds to 1000 microseconds)"
"description": "Time interval between individual signal intensity samples in 25nsec increments (80 to 40000 == 2 microseconds to 1000 microseconds)",
"units": "eicosapenta-nanoseconds"
},
{
"name": "transmit_frequency",
Expand All @@ -209,7 +214,8 @@
{
"name": "number_of_samples",
"type": "u16",
"description": "Number of samples per reflected signal"
"description": "Number of samples per reflected signal (supported values: 200~1200)",
"units": "samples"
},
{
"name": "transmit",
Expand Down Expand Up @@ -241,12 +247,13 @@
"name": "transmit_duration",
"type": "u16",
"description": "Acoustic transmission duration (1~1000 microseconds)",
"units": "microsecond"
"units": "microseconds"
},
{
"name": "sample_period",
"type": "u16",
"description": "Time interval between individual signal intensity samples in 25nsec increments (80 to 40000 == 2 microseconds to 1000 microseconds)"
"description": "Time interval between individual signal intensity samples in 25nsec increments (80 to 40000 == 2 microseconds to 1000 microseconds)",
"units": "eicosapenta-nanoseconds"
},
{
"name": "transmit_frequency",
Expand All @@ -257,31 +264,32 @@
{
"name": "number_of_samples",
"type": "u16",
"description": "Number of samples per reflected signal"
"description": "Number of samples per reflected signal (supported values: 200~1200)",
"units": "samples"
},
{
"name": "start_angle",
"type": "u16",
"description": "Head angle to begin scan sector for autoscan in gradians (0~399 = 0~360 degrees).",
"units": "gradian"
"units": "gradians"
},
{
"name": "stop_angle",
"type": "u16",
"description": "Head angle to end scan sector for autoscan in gradians (0~399 = 0~360 degrees).",
"units": "gradian"
"units": "gradians"
},
{
"name": "num_steps",
"type": "u8",
"description": "Number of 0.9 degree motor steps between pings for auto scan (1~10 = 0.9~9.0 degrees)",
"units": "gradian"
"units": "gradians"
},
{
"name": "delay",
"type": "u8",
"description": "An additional delay between successive transmit pulses (0~100 ms). This may be necessary for some programs to avoid collisions on the RS485 USRT.",
"units": "millisecond"
"units": "milliseconds"
}
]
},
Expand Down