@seeed-studio/sensecraft-cli 0.4.7 → 0.4.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/skills/sensecraft-cli/create-app/SKILL.md +1 -1
- package/skills/sensecraft-cli/create-app/references/manifest.md +1 -1
- package/skills/sensecraft-cli/references/file-commands.md +1 -1
- package/skills/sensecraft-cli/references/files.md +2 -2
- package/skills/sensecraft-cli/references/tool-blocks.md +5 -3
package/package.json
CHANGED
|
@@ -109,7 +109,7 @@ Update the review notes with corrections, evidence, remaining gaps, and readines
|
|
|
109
109
|
```
|
|
110
110
|
|
|
111
111
|
Exit code **1** means no complete token was found and this check passes. **0** means a token pattern was found: rebuild without the token and scan again. **2 or higher** is a path or read error to fix before retrying. Report only pass, match, or check error. Do not print matching values.
|
|
112
|
-
2. Write returned `file_url` values into the canonical manifest as each upload succeeds, keeping image order. Update the intended tool/media fields and the artifact ledger. For firmware fill `config.firmware_url`, `config.firmware_name`, and string `config.firmware_size` on the target block. Optional `file upload --name` only sets the name sent to the server. The server
|
|
112
|
+
2. Write returned `file_url` values into the canonical manifest as each upload succeeds, keeping image order. Update the intended tool/media fields and the artifact ledger. For firmware fill `config.firmware_url`, `config.firmware_name`, and string `config.firmware_size` on the target block. Optional `file upload --name` only sets the name sent to the server. The server decides the stored object name, so a name specified for the upload is not necessarily the downloaded file name. `firmware_url` and every other stored URL must be the returned `file_url`. Do not build a URL from `--name` or from stdout `file_name`. Never expose temporary signed upload URLs in review prose.
|
|
113
113
|
3. Validate again, inspect the final projection, and reassess readiness. Required deployment inputs must now be filled unless the user chose an incomplete draft. Apply the [activity submission rules](../references/app-fields.md#activity-selection-during-app-authoring) when relevant and follow [manifest → CLI payload](references/manifest.md#manifest--cli-payload). Omit local bookkeeping; images become URLs with `pic_url = images[0]`; no images → omit both keys, never `images: []`. Never send `be_public` or `privacy`.
|
|
114
114
|
4. Write `.sensecraft/<manifest-stem>.payload.json`, then create **without `--yes`**:
|
|
115
115
|
```bash
|
|
@@ -62,7 +62,7 @@ Formats JPG/JPEG/PNG/GIF/WebP, ≤ 5 MB each, prefer 4:3. SVG is rejected by the
|
|
|
62
62
|
|
|
63
63
|
## `deployment.blocks`
|
|
64
64
|
|
|
65
|
-
Flat ordered array, copied through to the payload unchanged. Blocks before the first `step` = introduction; each `step` starts a deploy step. Read [../../references/tool-blocks.md](../../references/tool-blocks.md) before selecting or configuring tools. After `file upload --type 4`, write `config.firmware_url`, `config.firmware_name`, and string `config.firmware_size` inside the `flash-firmware` block. Every tool uses one nested `config` object. Do not repeat those fields on the block. A needed block with missing inputs may stay in a local draft, but the app is not deployment-ready until those inputs have a usable path; mark gaps in review notes rather than inventing URLs or IDs.
|
|
65
|
+
Flat ordered array, copied through to the payload unchanged. Blocks before the first `step` = introduction; each `step` starts a deploy step. Read [../../references/tool-blocks.md](../../references/tool-blocks.md) before selecting or configuring tools. After `file upload --type 4`, write `config.firmware_url`, `config.firmware_name`, and string `config.firmware_size` inside the `flash-firmware` block. `firmware_url` is the returned `file_url`. The object name in that URL is the name used to download the file; the name specified for the upload is not necessarily that name. Every tool uses one nested `config` object. Do not repeat those fields on the block. A needed block with missing inputs may stay in a local draft, but the app is not deployment-ready until those inputs have a usable path; mark gaps in review notes rather than inventing URLs or IDs.
|
|
66
66
|
|
|
67
67
|
## `bom.materials`
|
|
68
68
|
|
|
@@ -32,7 +32,7 @@ Acquires an OSS POST policy, uploads the local file with multipart/form-data, an
|
|
|
32
32
|
|
|
33
33
|
`--model-id` and `--app-id` are mutually exclusive. Types `1`/`2` without attach/`--for-app`/`--unlinked` exit non-zero **before** the OSS POST (`ErrAttachRequired`). Types `3`–`6` upload directly. Type `5` without `--flow-id` exits before acquire.
|
|
34
34
|
|
|
35
|
-
`--name` is only the name sent with the upload. The
|
|
35
|
+
`--name` is only the name sent with the upload. The filename used to access or download the file is the object name in the returned `file_url`. A name specified for the upload is not necessarily that download name. stdout `file_name` echoes the name sent, not a name read back from the server. Do not build a URL from `--name` or from the printed `file_name`.
|
|
36
36
|
|
|
37
37
|
```bash
|
|
38
38
|
sensecraft-cli file upload --path ./cover.png --type 1 --for-app
|
|
@@ -23,7 +23,7 @@ Auth: **Access Key**. The China site supports SenseCraft Data only; file upload
|
|
|
23
23
|
7. Do not pass oversized files or more than 16 app image URLs; CLI rejects them before upload/update.
|
|
24
24
|
8. Types `3`–`6` have no model/app attach path and upload directly (no `--unlinked` needed).
|
|
25
25
|
9. **Security gates**: empty (0 B) files rejected; type 2–6 ≤ **100 MB**; every image ≤ **5 MB**. The CLI does not count uploads. A rate limit comes back as `11209` or `11210`.
|
|
26
|
-
10. **
|
|
26
|
+
10. **The access name is the server's.** Optional `--name` is the `file_name` sent to the server. The filename used to open or download the file is the object name in the returned `file_url`. A name specified for the upload is not necessarily that download name. Put the returned `file_url` into the app or model payload. Do not build a URL from `--name`, the local file name, or stdout `file_name`.
|
|
27
27
|
|
|
28
28
|
## Examples
|
|
29
29
|
|
|
@@ -52,7 +52,7 @@ sensecraft-cli file upload --path ./dataset.zip --type 6 --checksum
|
|
|
52
52
|
sensecraft-cli file upload --path ./fixture.bin --type 2 --checksum --unlinked --sandbox
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
Success JSON contains `file_name`, `file_type`, `file_url`, `size`, optional `checksum`, and `attached`. `file_url` is the access link. `file_name` is the name sent with `--name` or the local base name;
|
|
55
|
+
Success JSON contains `file_name`, `file_type`, `file_url`, `size`, optional `checksum`, and `attached`. `file_url` is the access link, and the object name in it is the name the server stored. `file_name` is the name sent with `--name` or the local base name; it is not necessarily the downloaded file name.
|
|
56
56
|
When attached to a model it also includes `model_id`, `previous_version`, `version`. Explicit `--unlinked` / `--for-app` sets `attached: false` and a `hint`.
|
|
57
57
|
|
|
58
58
|
## Model shortcut
|
|
@@ -84,7 +84,7 @@ Write every field below inside **`block.config`**. Keep `id` and `type` on the b
|
|
|
84
84
|
| XIAO 1.47" Touch Display | `100069905` |
|
|
85
85
|
| reTerminal Sticky | `100056818` |
|
|
86
86
|
|
|
87
|
-
When `muse_gadget` is `true`, set `full_flash` to `false`. The editor hides that checkbox until Muse is turned off. `firmware_url` must
|
|
87
|
+
When `muse_gadget` is `true`, set `full_flash` to `false`. The editor hides that checkbox until Muse is turned off. `firmware_url` must be the Muse application image linked at `0x20000`. The local build product is usually `muse-gadget.bin`; the name stored by the server does not have to stay that name. Upload it with `file upload --path <build-dir>/muse-gadget.bin --type 4 --name <project>-muse-gadget.bin`, and set `firmware_url` to the returned `file_url`. A binary linked at `0x90000` or `0x10000` will not boot. Checking the box does not change `flash_address`: E100x stays `0x90000`, Sticky / Indicator / 1.47" Touch stay `0x0`, Watcher stays on the XIAO address rule.
|
|
88
88
|
|
|
89
89
|
`full_flash: true` with `muse_gadget: false` is the switch back from a Muse image to another firmware. E1001 / E1002 then also rewrite the stock bootloader at `0x0` and the partition table at `0x8000`; the app stays at `0x90000`. Indicator, 1.47" Touch, Sticky, and Watcher non-Muse images are already merged at `0x0`, so the flag only turns on erase-all. Do not put the reTerminal stock bootloader into those images, and do not put it into a Muse image.
|
|
90
90
|
|
|
@@ -106,7 +106,7 @@ Unchecked `muse_gadget` keeps the single-file device table below and does not re
|
|
|
106
106
|
| XIAO ESP32C3 | `113991054` | `bin` or `zip` | URL contains `application` → `0x10000`, otherwise `0x0` | `.bin` or zip |
|
|
107
107
|
| XIAO ESP32C6 / S3 / S3 Plus | matching SKU (`material.device_id` empty; row comes from `app_block_options`) | same as C3 | same as C3 | same as C3 |
|
|
108
108
|
| XIAO ESP32S3 Sense | `113991115` | same as C3 | same as C3 | same as C3 |
|
|
109
|
-
| SenseCAP Watcher | `113991315` or `113991275` (one group) | `bin` |
|
|
109
|
+
| SenseCAP Watcher | `113991315` or `113991275` (one group) | `bin` | `0x0` | `merged-binary.bin`: bootloader at `0x0`, partition table at `0x8000`, app at `0x10000` |
|
|
110
110
|
| Wio Terminal | `102991299` | `bin` | `0x4000` | `.bin` |
|
|
111
111
|
| Grove Beginner Kit | `110061162` | `bin` | `0x0` (address bar hidden; `.hex` uses addresses inside the file) | `.bin` or `.hex`. `.hex` locks the board to this kit |
|
|
112
112
|
| XIAO 0.96" / 1.14" IPS, 1.47" Touch (ESP32-S3) | representative SKU of the group; 1.47" Touch Muse SKU is `100069905` | `bin` | `0x0` | merged `.bin`. nRF52840 variants cannot be flashed |
|
|
@@ -116,7 +116,9 @@ Unchecked `muse_gadget` keeps the single-file device table below and does not re
|
|
|
116
116
|
| reTerminal Sticky | `100056818` | `bin` | `0x0` | merged `.bin` |
|
|
117
117
|
| SenseCAP Indicator D1 / D1S / D1L / D1Pro | one group; example `114993068` (D1) | `bin` | `0x0` | merged ESP32-S3 `.bin`, not the RP2040 port |
|
|
118
118
|
|
|
119
|
-
|
|
119
|
+
A SenseCAP Watcher project that is not joining an activity uploads `merged-binary.bin` at `0x0`. Build it from the same `flash_args` (`0x0` bootloader, `0x8000` partition table, `0x10000` app). Leave out the app-only `.bin`, `bootloader.bin`, and `partition-table.bin`. The file name and URL must not contain `application`; that word moves the write to `0x10000`. Keep `full_flash` false.
|
|
120
|
+
|
|
121
|
+
`.hex` is only for Grove Beginner (`110061162`). E100x, e-paper, Sticky, IPS, Touch, and Indicator accept `.bin` only. Do not use zip for Grove, Wio, those screens, or Indicator. XIAO C3 / C6 / S3 / S3 Sense / S3 Plus / Watcher keep 115200 and `flashSize` / `flashMode` / `flashFreq` = `keep`. Screen boards use `0x90000`. A Watcher project that is not joining an activity uses `merged-binary.bin` at `0x0`.
|
|
120
122
|
|
|
121
123
|
**Agent:** write the SKU, file, and address into the app doc. **Do not** claim the firmware was flashed. Serial flashing stays L3 (Console / Web Serial).
|
|
122
124
|
|