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

ping360 update #161

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

ping360 update #161

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8737d38
ping360: update reserved fields
jaxxzer Jul 15, 2019
470c00e
ping360: add parameter minimum, maximum, and default metadata
jaxxzer Jul 16, 2019
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
90 changes: 68 additions & 22 deletions src/definitions/ping360.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,16 @@
{
"name": "id",
"type": "u8",
"description": "Device ID (1-254). 0 and 255 are reserved."
"description": "Device ID (1-254). 0 and 255 are reserved.",
"minimum": "1",
"maximum": "254",
"default": "2"
},
{
"name": "reserved",
"type": "u8",
"description": "reserved"
"description": "reserved, value shall be zero",
"default": "0"
}
]
}
Expand All @@ -24,42 +28,61 @@
"description": "This message is used to communicate the current sonar state. If the data field is populated, the other fields indicate the sonar state when the data was captured. The time taken before the response to the command is sent depends on the difference between the last angle scanned and the new angle in the parameters as well as the number of samples and sample interval (range). To allow for the worst case reponse time the command timeout should be set to 4000 msec.",
"payload": [
{
"name": "mode",
"name": "reserved",
"type": "u8",
"description": "Operating mode (1 for Ping360)"
"description": "reserved, value shall be zero",
"default": "0"
},
{
"name": "gain_setting",
"type": "u8",
"description": "Analog gain setting (0 = low, 1 = normal, 2 = high)"
"description": "Analog gain setting (0 = low, 1 = normal, 2 = high)",
"minimum": "0",
"maximum": "2",
"default": "0"
},
{
"name": "angle",
"type": "u16",
"description": "Head angle",
"units": "gradian"
"units": "gradian",
"minimum": "0",
"maximum": "399",
"default": "0"
},
{
"name": "transmit_duration",
"type": "u16",
"description": "Acoustic transmission duration (1~1000 microseconds)",
"units": "microsecond"
"units": "microsecond",
"minimum": "1",
"maximum": "1000",
"default": "32"
},
{
"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)",
"minimum": "80",
"maximum": "40000",
"default": "80"
},
{
"name": "transmit_frequency",
"type": "u16",
"description": "Acoustic operating frequency. Frequency range is 500kHz to 1000kHz, however it is only practical to use say 650kHz to 850kHz due to the narrow bandwidth of the acoustic receiver.",
"units": "kHz"
"units": "kHz",
"minimum": "500",
"maximum": "1000",
"default": "740"
},
{
"name": "number_of_samples",
"type": "u16",
"description": "Number of samples per reflected signal"
"description": "Number of samples per reflected signal",
"minimum": "200",
"maximum": "1200",
"default": "1024"
},
{
"name": "data",
Expand All @@ -82,12 +105,14 @@
{
"name": "bootloader",
"type": "u8",
"description": "0 = skip bootloader; 1 = run bootloader"
"description": "0 = skip bootloader; 1 = run bootloader",
"default": "0"
Copy link
Member

Choose a reason for hiding this comment

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

minimum and maximum are missing here.

Copy link
Member Author

Choose a reason for hiding this comment

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

This is not a range value. It is an enumeration. I think range does not make sense here.

Copy link

Choose a reason for hiding this comment

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

if it's an enum, it's better to use identifiers instead of integers in the json

},
{
"name": "reserved",
"type": "u8",
"description": "reserved"
"description": "reserved, value shall be zero",
"default": "0"
}
]
},
Expand All @@ -96,52 +121,73 @@
"description": "The transducer will apply the commanded settings. The sonar will reply with a `ping360_data` message. If the `transmit` field is 0, the sonar will not transmit after locating the transducer, and the `data` field in the `ping360_data` message reply will be empty. If the `transmit` field is 1, the sonar will make an acoustic transmission after locating the transducer, and the resulting data will be uploaded in the `data` field of the `ping360_data` message reply. To allow for the worst case reponse time the command timeout should be set to 4000 msec.",
"payload": [
{
"name": "mode",
"name": "reserved",
"type": "u8",
"description": "Operating mode (1 for Ping360)"
"description": "reserved, value shall be zero",
"default": "0"
},
{
"name": "gain_setting",
"type": "u8",
"description": "Analog gain setting (0 = low, 1 = normal, 2 = high)"
"description": "Analog gain setting (0 = low, 1 = normal, 2 = high)",
"minimum": "0",
"maximum": "2",
"default": "0"
},
{
"name": "angle",
"type": "u16",
"description": "Head angle",
"units": "gradian"
"units": "gradian",
"minimum": "0",
"maximum": "399",
"default": "0"
},
{
"name": "transmit_duration",
"type": "u16",
"description": "Acoustic transmission duration (1~1000 microseconds)",
"units": "microsecond"
"units": "microsecond",
"minimum": "1",
"maximum": "1000",
"default": "32"
},
{
"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)",
"minimum": "80",
"maximum": "40000",
"default": "80"
},
{
"name": "transmit_frequency",
"type": "u16",
"description": "Acoustic operating frequency. Frequency range is 500kHz to 1000kHz, however it is only practical to use say 650kHz to 850kHz due to the narrow bandwidth of the acoustic receiver.",
"units": "kHz"
"units": "kHz",
"minimum": "500",
"maximum": "1000",
"default": "740"
},
{
"name": "number_of_samples",
"type": "u16",
"description": "Number of samples per reflected signal"
"description": "Number of samples per reflected signal",
"minimum": "200",
"maximum": "1200",
"default": "1024"
},
{
"name": "transmit",
"type": "u8",
"description": "0 = do not transmit; 1 = transmit after the transducer has reached the specified angle"
"description": "0 = do not transmit; 1 = transmit after the transducer has reached the specified angle",
"default": "0"
Copy link
Member

Choose a reason for hiding this comment

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

missing maximum and minimum.

Copy link
Member Author

Choose a reason for hiding this comment

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

This is not a range value. It is an enumeration. I think range does not make sense here.

},
{
"name": "reserved",
"type": "u8",
"description": "reserved"
"description": "reserved, value shall be zero",
"default": "0"
}
]
}
Expand Down