lithionics/define.yaml at master · oceanplanetenergy/lithionics · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
pgn:
  -
    id: description
    type: char
  -
    id: pgn
    type: uint32_t
  -
    id: known
    alias: Complete
    type: bool
    description: Are we pretty sure we've got all fields with correct definitions?
  -
    id: size
    type: uint32_t
    description: (Minimal) size of this PGN. Helps to determine fast/single frame and initial malloc.
  -
    type: uint32_t
    id: repeatingFields
    description: How many fields at the end repeat until the PGN is exhausted?
  -
    type: Field fieldList[30]
    description: Note fixed number of fields; increase if needed. RepeatingFields support means this is enough for now.

field:
  - char *   name;
  -
    type: uint32_t
    id: size; /* Size in bits. All fields are contiguous in message; use 'reserved' fields to fill in empty bits. */
  - LEN_VARIABLE (0)
  double resolution; /* Either a positive real value or one of the following RES_ special values */
#define RES_NOTUSED (0)
#define RES_RADIANS (1e-4)
#define RES_ROTATION (1e-3 / 32.0)
#define RES_HIRES_ROTATION (1e-6 / 32.0)
#define RES_ASCII (-1.0)
#define RES_LATITUDE (-2.0)
#define RES_LONGITUDE (-3.0)
#define RES_DATE (-4.0)
#define RES_TIME (-5.0)
#define RES_TEMPERATURE (-6.0)
#define RES_6BITASCII (-7.0) /* Actually not used in N2K, only in N183 AIS */
#define RES_INTEGER (-8.0)
#define RES_LOOKUP (-9.0)
#define RES_BINARY (-10.0)
#define RES_MANUFACTURER (-11.0)
#define RES_STRING (-12.0)
#define RES_FLOAT (-13.0)
#define RES_PRESSURE (-14.0)
#define RES_STRINGLZ (-15.0)  /* ASCII string starting with length byte and terminated by zero byte */
#define RES_STRINGLAU (-16.0) /* ASCII or UNICODE string starting with length byte and ASCII/Unicode byte */
#define RES_DECIMAL (-17.0)
#define RES_BITFIELD (-18.0)
#define RES_TEMPERATURE_HIGH (-19.0)
#define RES_TEMPERATURE_HIRES (-20.0)
#define RES_PRESSURE_HIRES (-21.0)
#define MAX_RESOLUTION_LOOKUP 21

  bool  hasSign; /* Is the value signed, e.g. has both positive and negative values? */
  char *units;   /* String containing the 'Dimension' (e.g. s, h, m/s, etc.) unless it starts with , in which
                  * case it contains a set of lookup values.
                  */
  char *  description;
  int32_t offset;  /* Only used for SAE J1939 values with sign; these are in Offset/Excess-K notation instead
                    * of two's complement as used by NMEA 2000.
                    * See http://en.wikipedia.org/wiki/Offset_binary
                    */
  char *camelName; /* Filled by C, no need to set in initializers. */