From 9d5eb3a47a432df57005990a904526c76c3c0b77 Mon Sep 17 00:00:00 2001 From: ES-Alexander Date: Mon, 7 Mar 2022 13:48:35 +1100 Subject: [PATCH 1/5] definitions: ping360: specify valid number of samples --- src/definitions/ping360.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/definitions/ping360.json b/src/definitions/ping360.json index 7903a079..b424c2c0 100644 --- a/src/definitions/ping360.json +++ b/src/definitions/ping360.json @@ -59,7 +59,7 @@ { "name": "number_of_samples", "type": "u16", - "description": "Number of samples per reflected signal" + "description": "Number of samples per reflected signal (supported values: 200~1200)" }, { "name": "data", @@ -137,7 +137,7 @@ { "name": "number_of_samples", "type": "u16", - "description": "Number of samples per reflected signal" + "description": "Number of samples per reflected signal (supported values: 200~1200)" }, { "name": "data", @@ -209,7 +209,7 @@ { "name": "number_of_samples", "type": "u16", - "description": "Number of samples per reflected signal" + "description": "Number of samples per reflected signal (supported values: 200~1200)" }, { "name": "transmit", @@ -257,7 +257,7 @@ { "name": "number_of_samples", "type": "u16", - "description": "Number of samples per reflected signal" + "description": "Number of samples per reflected signal (supported values: 200~1200)" }, { "name": "start_angle", From d76927851e63b53c6be8b5de7eaef5da818d8322 Mon Sep 17 00:00:00 2001 From: ES-Alexander Date: Mon, 7 Mar 2022 14:25:01 +1100 Subject: [PATCH 2/5] definitions: ping360: fix units --- src/definitions/ping360.json | 54 +++++++++++++++++++++--------------- 1 file changed, 31 insertions(+), 23 deletions(-) diff --git a/src/definitions/ping360.json b/src/definitions/ping360.json index b424c2c0..82c9a4df 100644 --- a/src/definitions/ping360.json +++ b/src/definitions/ping360.json @@ -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" }, { "name": "transmit_frequency", @@ -59,7 +60,8 @@ { "name": "number_of_samples", "type": "u16", - "description": "Number of samples per reflected signal (supported values: 200~1200)" + "description": "Number of samples per reflected signal (supported values: 200~1200)", + "units": "samples" }, { "name": "data", @@ -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", @@ -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 (supported values: 200~1200)" + "description": "Number of samples per reflected signal (supported values: 200~1200)", + "units": "samples" }, { "name": "data", @@ -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", @@ -209,7 +214,8 @@ { "name": "number_of_samples", "type": "u16", - "description": "Number of samples per reflected signal (supported values: 200~1200)" + "description": "Number of samples per reflected signal (supported values: 200~1200)", + "units": "samples" }, { "name": "transmit", @@ -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", @@ -257,31 +264,32 @@ { "name": "number_of_samples", "type": "u16", - "description": "Number of samples per reflected signal (supported values: 200~1200)" + "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" } ] }, From 0404cb87d7f530cda4eb21e7166921c373d4733d Mon Sep 17 00:00:00 2001 From: ES-Alexander Date: Mon, 7 Mar 2022 14:58:40 +1100 Subject: [PATCH 3/5] definitions: ping360: improve consistency, reduce redundancy --- src/definitions/ping360.json | 40 ++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/src/definitions/ping360.json b/src/definitions/ping360.json index 82c9a4df..5f44e0f9 100644 --- a/src/definitions/ping360.json +++ b/src/definitions/ping360.json @@ -42,20 +42,20 @@ { "name": "transmit_duration", "type": "u16", - "description": "Acoustic transmission duration (1~1000 microseconds)", + "description": "Acoustic transmission duration (1~1000 us)", "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 25 ns increments (80 to 40000 == 2 to 1000 us)", "units": "eicosapenta-nanoseconds" }, { "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" + "description": "Acoustic operating frequency (500~1000 kHz). It is only practical to use say 650 to 850 kHz due to the narrow bandwidth of the acoustic receiver.", + "units": "kilohertz" }, { "name": "number_of_samples", @@ -98,31 +98,31 @@ { "name": "transmit_duration", "type": "u16", - "description": "Acoustic transmission duration (1~1000 microseconds)", + "description": "Acoustic transmission duration (1~1000 us)", "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 25 ns increments (80 to 40000 == 2 to 1000 us)", "units": "eicosapenta-nanoseconds" }, { "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" + "description": "Acoustic operating frequency (500~1000 kHz). It is only practical to use say 650 to 850 kHz due to the narrow bandwidth of the acoustic receiver.", + "units": "kilohertz" }, { "name": "start_angle", "type": "u16", - "description": "Head angle to begin scan sector for autoscan in gradians (0~399 = 0~360 degrees).", + "description": "Head angle to begin scan sector for autoscan (0~399 = 0~360 degrees).", "units": "gradians" }, { "name": "stop_angle", "type": "u16", - "description": "Head angle to end scan sector for autoscan in gradians (0~399 = 0~360 degrees).", + "description": "Head angle to end scan sector for autoscan (0~399 = 0~360 degrees).", "units": "gradians" }, { @@ -196,20 +196,20 @@ { "name": "transmit_duration", "type": "u16", - "description": "Acoustic transmission duration (1~1000 microseconds)", + "description": "Acoustic transmission duration (1~1000 us)", "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 25 ns increments (80 to 40000 == 2 to 1000 us)", "units": "eicosapenta-nanoseconds" }, { "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" + "description": "Acoustic operating frequency (500~1000 kHz). It is only practical to use say 650 to 850 kHz due to the narrow bandwidth of the acoustic receiver.", + "units": "kilohertz" }, { "name": "number_of_samples", @@ -246,20 +246,20 @@ { "name": "transmit_duration", "type": "u16", - "description": "Acoustic transmission duration (1~1000 microseconds)", + "description": "Acoustic transmission duration (1~1000 us)", "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 25 ns increments (80 to 40000 == 2 to 1000 us)", "units": "eicosapenta-nanoseconds" }, { "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" + "description": "Acoustic operating frequency (500~1000 kHz). It is only practical to use say 650 to 850 kHz due to the narrow bandwidth of the acoustic receiver.", + "units": "kilohertz" }, { "name": "number_of_samples", @@ -270,13 +270,13 @@ { "name": "start_angle", "type": "u16", - "description": "Head angle to begin scan sector for autoscan in gradians (0~399 = 0~360 degrees).", + "description": "Head angle to begin scan sector for autoscan (0~399 = 0~360 degrees).", "units": "gradians" }, { "name": "stop_angle", "type": "u16", - "description": "Head angle to end scan sector for autoscan in gradians (0~399 = 0~360 degrees).", + "description": "Head angle to end scan sector for autoscan (0~399 = 0~360 degrees).", "units": "gradians" }, { From c1d0363273d7edba8c08485c0a04a65fd55551f5 Mon Sep 17 00:00:00 2001 From: ES-Alexander Date: Mon, 7 Mar 2022 19:17:02 +1100 Subject: [PATCH 4/5] definitions: ping360: correct formatting + release state --- src/definitions/ping360.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/definitions/ping360.json b/src/definitions/ping360.json index 5f44e0f9..5f70bf67 100644 --- a/src/definitions/ping360.json +++ b/src/definitions/ping360.json @@ -77,7 +77,7 @@ }, "auto_device_data": { "id": 2301, - "description": "[NOT RELEASED] Extended version of *device_data* with *auto_transmit* information. The sensor emits this message when in *auto_transmit* mode.", + "description": "**[NOT RELEASED]** Extended version of `device_data` with `auto_transmit` information. The sensor emits this message when in `auto_transmit` mode.", "payload": [ { "name": "mode", @@ -231,7 +231,7 @@ }, "auto_transmit": { "id": 2602, - "description": "Extended *transducer* message with auto-scan function. The sonar will automatically scan the region between start_angle and end_angle and send auto_device_data messages as soon as new data is available. Send a line break to stop scanning (and also begin the autobaudrate procedure). Alternatively, a motor_off message may be sent (but retrys might be necessary on the half-duplex RS485 interface).", + "description": "**[NOT RELEASED]** Extended `transducer` message with auto-scan function. The sonar will automatically scan the region between `start_angle` and `end_angle` and send `auto_device_data` messages as soon as new data is available. Send a line break to stop scanning (and also begin the autobaudrate procedure). Alternatively, a `motor_off` message may be sent (but retries might be necessary on the half-duplex RS485 interface).", "payload": [ { "name": "mode", From be52dd67cec0fc47c63ecc175461521dfa3028f4 Mon Sep 17 00:00:00 2001 From: ES-Alexander Date: Mon, 7 Mar 2022 19:27:26 +1100 Subject: [PATCH 5/5] definitions: ping360: fix incorrect description --- src/definitions/ping360.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/definitions/ping360.json b/src/definitions/ping360.json index 5f70bf67..d1f6bf77 100644 --- a/src/definitions/ping360.json +++ b/src/definitions/ping360.json @@ -175,7 +175,7 @@ }, "transducer": { "id": 2601, - "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 response time the command timeout should be set to 4000 msec.", + "description": "The transducer will apply the commanded settings. The sonar will reply with a `device_data` message. If the `transmit` field is 0, the sonar will not transmit after locating the transducer, and the `data` field in the `device_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 `device_data` message reply. To allow for the worst case response time the command timeout should be set to 4000 msec.", "payload": [ { "name": "mode",