docs/source/schema/event.json at 4dc6cb4c08794f4d8f992fe9d01bdd4ba5451db8 · NSLS-II/docs · 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
{
    "definitions": {
        "data_field": {
            "title": "data_field",
            "description": "Schema for entries in the event data property",
            "items": [
                {
                    "type": [
                        "string",
                        "number",
                        "boolean",
                        "integer"
                    ],
                    "description": "The measured value or UID to look up external data",
                    "title": "value"

                },
                {
                    "type": "number",
                    "description": "The hardware time stamp of this measurement. [s] from unix epoch",
                    "title": "timestamp"
                }

            ],
            "type": "array",
            "additionalItems": false,
            "minItems": 2
        }
    },
    "properties": {
        "data": {
            "additionalProperties": {
                "$ref": "#/definitions/data_field"
            },
            "type": "object",
            "description": "The actual measument data"
        },
        "descriptor": {
            "type": "string",
            "description": "UID to point back to Descriptor for this event stream"
        },
        "seq_num": {
            "type": "integer",
            "description": "Sequence number to identify the location of this Event in the Event stream"
        },
        "time": {
            "type": "number",
            "description": "The event time.  This maybe different than the timestamps on each of the data entries"
        },
        "uid": {
            "type": "string",
            "description": "Globally unique identifier for this Event"
        }
    },
    "required": [
        "uid",
        "data",
        "time",
        "descriptor",
        "seq_num"
    ],
    "additionalProperties": false,
    "type": "object",
    "title": "event",
    "description": "Document to record a quanta of collected data"
}