notecard-schema/card.temp.req.notecard.api.json at master · blues/notecard-schema · 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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://raw.githubusercontent.com/blues/notecard-schema/master/card.temp.req.notecard.api.json",
    "title": "card.temp Request Application Programming Interface (API) Schema",
    "description": "Get the current temperature from the Notecard's onboard calibrated temperature sensor.\n\nWhen using a Notecard Cellular or Notecard Cell+WiFi, if you connect a BME280 sensor on the I2C bus the Notecard will add `temperature`, `pressure`, and `humidity` fields to the response. If you connect an ENS210 sensor on the I2C bus the Notecard will add `temperature` and `pressure` fields to the response.",
    "type": "object",
    "version": "1.1.2",
    "apiVersion": "9.1.1",
    "skus": [
        "CELL",
        "CELL+WIFI",
        "LORA",
        "SKYLO",
        "WIFI"
    ],
    "properties": {
        "minutes": {
            "description": "If specified, creates a templated `_temp.qo` file that gathers Notecard temperature value at the specified minutes interval. _When using [card.aux track mode](/notecard/notecard-walkthrough/working-with-the-notecard-aux-pins#using-aux-track-mode), the sensor temperature, pressure, and humidity is also included with each Note._",
            "type": "integer"
        },
        "status": {
            "description": "Overrides `minutes` with a voltage-variable value. For example: `\"usb:15;high:30;normal:60;720\"`. See [Voltage-Variable Sync Behavior](/notecard/notecard-walkthrough/low-power-firmware-design#voltage-variable-sync-behavior) for more information on configuring these values.",
            "type": "string"
        },
        "stop": {
            "description": "If set to `true`, the Notecard will stop logging the temperature value at the interval specified with the `minutes` parameter (see above).",
            "type": "boolean"
        },
        "sync": {
            "description": "If set to `true`, the Notecard will immediately sync any pending `_temp.qo` Notes created with the `minutes` parameter (see above).",
            "type": "boolean"
        },
        "req": {
            "description": "Request for the Notecard (expects response)",
            "const": "card.temp"
        },
        "cmd": {
            "description": "Command for the Notecard (no response)",
            "const": "card.temp"
        }
    },
    "oneOf": [
        {
            "required": [
                "req"
            ],
            "properties": {
                "req": {
                    "const": "card.temp"
                }
            }
        },
        {
            "required": [
                "cmd"
            ],
            "properties": {
                "cmd": {
                    "const": "card.temp"
                }
            }
        }
    ],
    "unevaluatedProperties": false,
    "samples": [
        {
            "title": "Get Card Temperature",
            "description": "Get current temperature from Notecard's onboard sensor.",
            "json": "{\"req\": \"card.temp\"}"
        },
        {
            "title": "Configure Temperature Tracking",
            "description": "Set up automatic temperature logging at 30-minute intervals.",
            "json": "{\"req\": \"card.temp\", \"minutes\": 30}"
        },
        {
            "title": "Stop Temperature Tracking",
            "description": "Stop automatic temperature logging.",
            "json": "{\"cmd\": \"card.temp\", \"stop\": true}"
        },
        {
            "title": "Sync Temperature Notes",
            "description": "Immediately sync pending temperature notes.",
            "json": "{\"cmd\": \"card.temp\", \"sync\": true}"
        }
    ]
}