Skip to content

Commit b05480d

Browse files
authored
add exemplar for telecom, hardware and field comparison.adoc (#234)
* add exemplar for telecom, hardware and field comparison.adoc No exemplar yet for field comp' exemplar for telecom and hardware refers to Vocab guildeline. But as the controlled vocab are pending (not served by a vocabulary server yet, I do not know how i should fill the `*_vocabulary` attribute. * Update OG_Format.adoc resolve conversation 'V' toward 'v' * Update OG_Format.adoc typo
1 parent c81c5a4 commit b05480d

File tree

1 file changed

+27
-19
lines changed

1 file changed

+27
-19
lines changed

OG_Format.adoc

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -506,17 +506,17 @@ long_name = “longitude of deployment”;
506506
////
507507
=== Field comparison information
508508

509-
[cols=",,",options="header",]
509+
[cols=",,,",options="header",]
510510
|=========================================================================================================================================
511-
|*VARIABLE NAME* |*variable attributes* |*requirement status*
511+
|*VARIABLE NAME* |*variable attributes* |*requirement status* | *Format, fixed value or example*
512512
|FIELD_COMPARISON_REFERENCE a|
513513
String FIELD_COMPARISON_REFERENCE:
514514

515515
FIELD_COMPARISON_REFERENCE:long_name = “links (uri or url) to supplementary data that can provide field comparison for platform sensors.”;
516516

517517
FIELD_COMPARISON_REFERENCE:comment = “multiple links are separated by a comma”
518518

519-
|highly desirable
519+
|highly desirable |
520520
|=========================================================================================================================================
521521

522522
Note: FIELD_COMPARISON_REFERENCE is applicable to deployment, recovery, and delayed versions.
@@ -525,37 +525,40 @@ Note: FIELD_COMPARISON_REFERENCE is applicable to deployment, recovery, and dela
525525
* [[hardware-information]]
526526
== Hardware information
527527
////
528-
=== Hardware information
528+
== Hardware information
529529

530-
[cols=",,",options="header",]
530+
[cols=",,,",options="header",]
531531
|=============================================================================
532-
|*VARIABLE NAME* |*variable attributes* |*requirement status*
532+
|*VARIABLE NAME* |*variable attributes* |*requirement status* | *Format, fixed value or example*
533533
|GLIDER_FIRMWARE_VERSION a|
534534
string GLIDER_FIRMWARE_VERSION
535535

536536
GLIDER_FIRMWARE_VERSION:long_name = “version of the internal glider firmware”;
537537

538-
|highly desirable
538+
|highly desirable | *ex.:* v1.3.22
539539
|LANDSTATION_VERSION a|
540540
string LANDSTATION_VERSION
541541

542542
LANDSTATION_VERSION:long_name = “version of the server onshore”;
543543

544-
|highly desirable
544+
|highly desirable | *ex.:* "dockserver v3.42"
545545
|BATTERY_TYPE a|
546546
string BATTERY_TYPE
547547

548548
BATTERY_TYPE:long_name = “type of the battery”;
549549

550-
BATTERY_TYPE:battery_type_vocabulary = “”;
550+
BATTERY_TYPE:battery_type_vocabulary = “https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/battery_type.md”;
551+
552+
|suggested | *ex.:* "lithium rechargeable"
553+
554+
BATTERY_TYPE:battery_type_vocabulary = “https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/battery_type.md”
551555

552-
|suggested
553556
|BATTERY_PACK a|
554557
string BATTERY_PACK
555558

556559
BATTERY_PACK:long_name = “battery packaging”;
557560

558-
|suggested
561+
|suggested | *ex.:* "2X24 12V battery"
559562
|=============================================================================
560563

561564
////
@@ -564,25 +567,30 @@ BATTERY_PACK:long_name = “battery packaging”;
564567
////
565568
=== Telecom information
566569

567-
[cols=",,",options="header",]
570+
[cols=",,,",options="header",]
568571
|===============================================================================
569-
|*VARIABLE NAME* |*variable attributes* |*requirement status*
572+
|*VARIABLE NAME* |*variable attributes* |*requirement status* | *Format, fixed value or example*
570573
|TELECOM_TYPE a|
571574
string TELECOM_TYPE
572575

573-
TELECOM_TYPE:long_name = “type of telecommunication systems used by the glider”;
576+
TELECOM_TYPE:long_name = “types of telecommunication systems used by the glider, multiple telecom type are separated by a comma”;
574577

575-
TELECOM_TYPE:telecom_type_vocabulary = “”;
578+
TELECOM_TYPE:telecom_type_vocabulary = “https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/telecom_type.md”;
579+
580+
|highly desirable | *ex.:* iridium
581+
582+
TELECOM_TYPE:telecom_type_vocabulary = “https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/telecom_type.md”
576583

577-
|highly desirable
578584
|TRACKING_SYSTEM a|
579585
string TRACKING_SYSTEM
580586

581-
TRACKING_SYSTEM:long_name = “type of tracking systems used by the glider”;
587+
TRACKING_SYSTEM:long_name = “type of tracking systems used by the glider, multiple tracking system are separated by a comma”;
582588

583-
TRACKING_SYSTEM:tracking_system_vocabulary = “”;
589+
TRACKING_SYSTEM:tracking_system_vocabulary = “https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/tracking_system.md”;
584590

585-
|highly desirable
591+
|highly desirable | *ex.:* "gps, accoustic"
592+
593+
TRACKING_SYSTEM:tracking_system_vocabulary = "https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/tracking_system.md, https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/tracking_system.md"
586594
|===============================================================================
587595

588596
////

0 commit comments

Comments
 (0)