notecard-schema/card.restore.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
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://raw.githubusercontent.com/blues/notecard-schema/master/card.restore.req.notecard.api.json",
    "title": "card.restore Request Application Programming Interface (API) Schema",
    "description": "Performs a factory reset on the Notecard and restarts.\n\n*Sending this request without either of the optional arguments below will only reset the Notecard's file system, thus forcing a re-sync of all Notefiles from Notehub.*\n\nOn Notecard LoRa there is no option to retain configuration settings, and providing `\"delete\": true` is required. The Notecard LoRa retains LoRaWAN configuration after factory resets.",
    "type": "object",
    "version": "1.1.2",
    "apiVersion": "9.1.1",
    "skus": [
        "CELL",
        "CELL+WIFI",
        "LORA",
        "SKYLO",
        "WIFI"
    ],
    "properties": {
        "connected": {
            "description": "Set to `true` to reset the Notecard on Notehub. This will delete and deprovision the Notecard from Notehub the next time the Notecard connects. This also removes any Notefile templates used by this device.\n\nConversely, if `connected` is `false` (or omitted), the Notecard's settings and data will be restored from Notehub the next time the Notecard connects to the previously used Notehub project.",
            "type": "boolean"
        },
        "delete": {
            "description": "Set to `true` to reset most Notecard configuration settings. Note that this does not reset stored WiFi credentials or the [alternate I2C address](/notecard/notecard-walkthrough/advanced-notecard-configuration/#change-the-notecard-i2c-address) (if previously set) so the Notecard can still contact the network after a reset.\n\n*The Notecard will be unable to sync with Notehub until the `ProductUID` is set again.*",
            "type": "boolean"
        },
        "req": {
            "description": "Request for the Notecard (expects response)",
            "const": "card.restore"
        },
        "cmd": {
            "description": "Command for the Notecard (no response)",
            "const": "card.restore"
        }
    },
    "oneOf": [
        {
            "required": [
                "req"
            ],
            "properties": {
                "req": {
                    "const": "card.restore"
                }
            }
        },
        {
            "required": [
                "cmd"
            ],
            "properties": {
                "cmd": {
                    "const": "card.restore"
                }
            }
        }
    ],
    "additionalProperties": false,
    "samples": [
        {
            "title": "Complete Factory Reset",
            "description": "Reset Notecard configuration and deprovision from Notehub.",
            "json": "{\"req\": \"card.restore\", \"delete\": true, \"connected\": true}"
        },
        {
            "title": "File System Reset Only",
            "description": "Reset only the file system, forcing re-sync from Notehub.",
            "json": "{\"req\": \"card.restore\"}"
        }
    ]
}