Possible typo, PIRDS-v.0.1.md, 'We possible, we...' #11
Description
Summary
This document should be reviewed for typos and readability.
Example 1
There is a sentence with possible error in the document at: https://github.com/PubInv/PIRDS-pubinv-respiration-data-standard/blob/master/PIRDS-v.0.1.md
Should
We possible, we follow the principle of making data human-readable if possible. In particular, because this is meant in part for medical professionals, some unit types are chosen to conform that field.
be changed to
We follow the principle of making data human-readable if possible. In particular, because this is meant in part for medical professionals, some unit types are chosen to conform that field.
Example 2
Should
The the byte buffer above, the six fields are positional and don't require names. However, for discussion and in the the JavaScript binding, these fields are:
be changed to remove the repeated "the"
The byte buffer above, the six fields are positional and don't require names. However, for discussion and in the the JavaScript binding, these fields are:
Example 3
Should
D : Differential pressure: cm H2O (a medical standard) times 10 (the same unit, but RELATIVE, not ABSOLUTE)
be changed to also use the word "GAUGE" to describe the measurement type.
D : Differential pressure: cm H2O (a medical standard) times 10 (the same unit, but RELATIVE or GAUGE pressure, not ABSOLUTE)
Example 4
Regarding,
G : Gas resitance (ohms) used to check for volatile compounds
Is there really such a unit as gas resistance and measured in Ohms?
Example 5
Should
C : Carbon dioxide concentration in tenths of mmHg
be changed to say not concentration but rather partial pressure or for other units such as "millimoles per liter (mmol/L) "
See:
Example 6
Regarding, "Assertions"
Assertions have the same structure as measurements. The begin with the character "A". The most important asseritons are:
In addition to a misspelling on the second and plural location, this usage of the word "Assertions" requires a glossary or definition. This word has an incompatible connotation to a programmer.
Example 7
Regarding,
Meta Events are not measurements but may provide information about measurements. The mEta Events begin with character "E". The second character defines the meta event. Then the "ms" milliseconds unsigned 4 bytes fallows.
Is there a capitalization error for "mEta Events ". Generally, Should there be use of quotation marks around "Meta Events" and similar named elements of the protocol through out the document? Is "fallows." spelled correctly?
Meta Events are not measurements but may provide information about measurements. The Meta Events begin with character "E". The second character defines the meta event. Then the "ms" milliseconds unsigned 4 bytes fallows.
Example 8
Regarding,
C : Clock event : The Clock event is used to tie the relative milliseconds to an absolute time. The first byte after C is a number n. However, the next four bytes are an unsigned integer representing milliseconds in this data stream. After that follows n bytes which of a "time string" that specifies wall-clock time UTC time in the ISO 8601 format. An example of this format is:
{ "event": "E", "type": "C", "ms": 10443, "buff": "Sun Jul 26 22:19:10 2020" },
the example provided does not appear to have a " byte after C". Is the example correct? Is there a better way to describe name value pare { "ms": 10443}
Can the vocabulary of JSON objects be better applied?
Example 9
Regarding the bits illustrated in image sample_measurement.png, the alpha characters have single quotes but the integers characters do not. Is this correct?
Example 10
Regarding "Hex Equivalent: 4D54 4202 0023 00FA",
I think this is a mistake.
Should it not be delimited character by character with a space.
Make it clear this is a conversion to ASCII in HEX representation.
So it should be from:
MTB200350250
to the array:
4D 54 42 32 30 30 33 35 30 32 35 30
Example 11
Identify line termination convention
Regarding
Measurements are of fixed length, and consisting the character "M", a measurement type character designator, a sensor designator consisting of a letter (location) and a number 0-255.
Change to:
Measurements are of fixed length, and consisting the character "M", a measurement type character designator, a sensor designator consisting of a letter (location) and a number 0-255. The measurement is terminated with CRLF pair, (0x0D 0x0A) characters not explicated represented in these examples.
Screen shot of serial output from VentMon showing CRLF.
