@esp-vision/device-cli 0.1.0 → 0.2.0

package/DEVICE_CORE_NOTICE.md

@@ -30,3 +30,16 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+Browser and Node ROM flashing use the separately installed esptool-js 0.7.1 package,
+Copyright (c) 2023 Espressif Systems (Shanghai) Co. Ltd., Apache License 2.0.
+The package's esp-flasher-stub v1.2.2 set-2 binaries retain their upstream
+dual Apache-2.0/MIT terms. Its pako (MIT/Zlib) and atob-lite (MIT) dependencies
+retain their own notices. No upstream source or stub binary is vendored here.
+The S31 native-USB watchdog reset adapter uses the register sequence also
+implemented by Apache-2.0 esptool-js P4 watchdog support.
+
+Node serial access uses @serialport/bindings-cpp 13.0.0 (MIT).
+Linux USB-Serial-JTAG modem controls use Koffi 2.16.3 (MIT).
+Portable CLI/plugin bundles preserve original loaders, binaries and licenses,
+including Koffi cnoke and Node API header notices.

package/README.md

@@ -2,7 +2,7 @@
 
 `@esp-vision/device-cli` installs the `esp-vision-device` command for device discovery, inspection, configuration, control, firmware updates, Python execution, device file operations, JPEG capture, sequential batch plans, and bounded event watches. It is an optional host interface backed by the same `@esp-vision/device-core` package used by ESP-VISION clients.
 
-Requires Node.js 22 or newer. Serial access requires Python with `pyserial`; firmware flashing requires Python `esptool>=5.3,<6`. LAN discovery uses the bundled multicast-DNS client.
+Requires Node.js 22 or newer. Serial access uses bundled npm native bindings; firmware flashing uses the same esptool-js backend as the website. No host Python, pyserial or Python esptool installation is required. LAN discovery uses the bundled multicast-DNS client. Port permissions and ownership still apply. The deprecated `--python` option is accepted but ignored for compatibility.
 
 Run `esp-vision-device --help` for the command reference, or `esp-vision-device --help --json` for the versioned machine-readable command, output, and limit capabilities envelope.
 
@@ -26,7 +26,7 @@ For a continuous app, finish directory operations and uploads before starting it
 
 `files list`, `files read`, `files write`, `files remove`, and `files mkdir` operate on device paths. `files read DEVICE_PATH --output LOCAL_FILE` writes binary content to a local file. `files write DEVICE_PATH --file LOCAL_FILE` sends local bytes to the device. Reads are capped at 16 MiB by default; `--max-bytes` can lower that limit.
 
-`capture camera|screen --output LOCAL.jpg` writes one JPEG and returns its path, byte count, source, MIME type, and capture metadata. Images are never embedded as base64 in JSON output.
+`capture camera|screen --output LOCAL.jpg` writes one JPEG and returns its path, byte count, source, MIME type, and capture metadata. Images are never embedded as base64 in JSON output. The `source` field identifies the requested source; it does not certify whether annotations are present. `camera` observes the application's latest camera frame, not the LCD image. Application drawing depends on firmware publication behavior; firmware advertising `debug.capture_frame.observed.v1` supplies an independent copy made at acquisition, before later drawing, without triggering a new acquisition. `screen` captures the current LCD framebuffer, including drawing rendered there; use it to verify LCD overlays and UI. It requires an initialized display, and camera/display dimensions may differ. Neither source starts the application or initializes the sensor/display for you.
 
 ## Bounded event watch
 
@@ -58,3 +58,9 @@ For a continuous app, finish directory operations and uploads before starting it
 Status, Python output, firmware phases, cancellation, errors, and duration are NDJSON events on stderr. SIGINT exits with code 130, SIGTERM with 143, argument/plan errors with 2, other failures with 1, and success with 0. Busy or uncertain operations are never retried automatically.
 
 Inspect JSON output uses the same versioned envelope as other commands. Human-readable inspect output remains a terminal table.
+
+Device paths such as `/models` stay absolute device paths on Windows. Git Bash/MSYS may rewrite them; use PowerShell or prefix the individual command with `MSYS2_ARG_CONV_EXCL="*"`, supplying local paths in Windows form. Quoting the device path alone does not prevent conversion. Invalid device paths now fail before connecting, with a shell hint for Windows host paths.
+
+## Coordinated source builds
+
+Before Core 0.8.0 is published, use `node tools/ci/mcp/install_host.mjs --output <project-artifact-directory>` from the repository root, then build the CLI. The tracked Core lock intentionally has no registry URL or integrity for the unpublished version; the installer qualifies an exact local tarball and records its hash without changing that lock. Other dependencies keep their registry locks. Publish Core first, refresh the CLI registry lock from that published version, then rebuild and qualify CLI/plugin artifacts before publishing their versions. The publishing gate rejects a missing or mismatched registry integrity.

package/THIRD_PARTY_NOTICES.md

@@ -5,11 +5,23 @@ The CLI bundle includes the following third-party packages. Their original licen
 | Package | Version | License | License file |
 | --- | --- | --- | --- |
 | @leichtgewicht/ip-codec | 2.0.5 | MIT | `leichtgewicht__ip-codec-LICENSE` |
+| @serialport/bindings-cpp | 13.0.0 | MIT | `serialport__bindings-cpp-LICENSE` |
+| @serialport/bindings-interface | 1.2.2 | MIT | `serialport__bindings-interface-LICENSE` |
+| @serialport/parser-delimiter | 12.0.0 | MIT | `serialport__parser-delimiter-LICENSE` |
+| @serialport/parser-readline | 12.0.0 | MIT | `serialport__parser-readline-LICENSE` |
 | ansi-regex | 6.4.0 | MIT | `ansi-regex-license` |
+| atob-lite | 2.0.0 | MIT | `atob-lite-LICENSE.md` |
+| debug | 4.4.0 | MIT | `debug-LICENSE` |
 | dns-packet | 5.6.1 | MIT | `dns-packet-LICENSE` |
 | emoji-regex | 10.6.0 | MIT | `emoji-regex-LICENSE-MIT.txt` |
+| esptool-js | 0.7.1 | Apache-2.0 | `esptool-js-LICENSE` |
 | get-east-asian-width | 1.7.0 | MIT | `get-east-asian-width-license` |
+| koffi | 2.16.3 | MIT | `koffi-LICENSE.txt` |
+| ms | 2.1.3 | MIT | `ms-license.md` |
 | multicast-dns | 7.2.5 | MIT | `multicast-dns-LICENSE` |
+| node-addon-api | 8.3.0 | MIT | `node-addon-api-LICENSE.md` |
+| node-gyp-build | 4.8.4 | MIT | `node-gyp-build-LICENSE` |
+| pako | 2.2.0 | (MIT AND Zlib) | `pako-LICENSE` |
 | smol-toml | 1.9.1 | BSD-3-Clause | `smol-toml-LICENSE` |
 | string-width | 7.2.0 | MIT | `string-width-license` |
 | strip-ansi | 7.2.0 | MIT | `strip-ansi-license` |
@@ -112,23 +124,31 @@ Bundled from: `node_modules/smol-toml/dist/date.js`, `node_modules/smol-toml/dis
 
 ### Source notice 6
 
-Bundled from: `node_modules/@esp-vision/device-core/src/firmware_feed.js`, `node_modules/@esp-vision/device-core/src/firmware_flash.js`, `node_modules/@esp-vision/device-core/src/index.js`, `node_modules/@esp-vision/device-core/src/network_discovery.js`, `node_modules/@esp-vision/device-core/src/network_discovery_node.js`, `node_modules/@esp-vision/device-core/src/node_inventory.js`, `node_modules/@esp-vision/device-core/src/node_rom.js`, `node_modules/@esp-vision/device-core/src/node_transport.js`, `src/cli.js`
+Bundled from: `node_modules/pako/dist/pako.esm.mjs`
 
 ```text
-// SPDX-FileCopyrightText: 2026 ESP-VISION-IDE
+/*! pako 2.2.0 https://github.com/nodeca/pako @license (MIT AND Zlib) */
 ```
 
 ### Source notice 7
 
-Bundled from: `node_modules/@esp-vision/device-core/src/firmware_io.js`, `node_modules/@esp-vision/device-core/src/firmware_release.js`, `node_modules/@esp-vision/device-core/src/node.js`
+Bundled from: `node_modules/@esp-vision/device-core/src/firmware_feed.js`, `node_modules/@esp-vision/device-core/src/firmware_flash.js`, `node_modules/@esp-vision/device-core/src/index.js`, `node_modules/@esp-vision/device-core/src/network_discovery.js`, `node_modules/@esp-vision/device-core/src/network_discovery_node.js`, `node_modules/@esp-vision/device-core/src/node_inventory.js`, `node_modules/@esp-vision/device-core/src/node_rom.js`, `node_modules/@esp-vision/device-core/src/node_rom_port.js`, `node_modules/@esp-vision/device-core/src/node_transport.js`, `src/cli.js`
 
 ```text
-// SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+// SPDX-FileCopyrightText: 2026 ESP-VISION-IDE
 ```
 
 ### Source notice 8
 
-Bundled from: `node_modules/@esp-vision/device-core/src/device_files.js`, `node_modules/@esp-vision/device-core/src/device_python.js`, `node_modules/@esp-vision/device-core/src/firmware_feed.js`, `node_modules/@esp-vision/device-core/src/firmware_flash.js`, `node_modules/@esp-vision/device-core/src/firmware_io.js`, `node_modules/@esp-vision/device-core/src/firmware_release.js`, `node_modules/@esp-vision/device-core/src/index.js`, `node_modules/@esp-vision/device-core/src/network_discovery.js`, `node_modules/@esp-vision/device-core/src/network_discovery_node.js`, `node_modules/@esp-vision/device-core/src/node.js`, `node_modules/@esp-vision/device-core/src/node_inventory.js`, `node_modules/@esp-vision/device-core/src/node_rom.js`, `node_modules/@esp-vision/device-core/src/node_transport.js`, `src/cli.js`
+Bundled from: `node_modules/@esp-vision/device-core/src/browser_rom_compat.js`, `node_modules/@esp-vision/device-core/src/device_capture.js`, `node_modules/@esp-vision/device-core/src/firmware_io.js`, `node_modules/@esp-vision/device-core/src/firmware_partitions.js`, `node_modules/@esp-vision/device-core/src/firmware_release.js`, `node_modules/@esp-vision/device-core/src/jpeg_validate.js`, `node_modules/@esp-vision/device-core/src/node.js`, `node_modules/@esp-vision/device-core/src/node_rom.js`, `node_modules/@esp-vision/device-core/src/node_rom_probe.js`, `node_modules/@esp-vision/device-core/src/node_serial.js`, `node_modules/@esp-vision/device-core/src/node_signals.js`, `node_modules/@esp-vision/device-core/src/rom_identity.js`, `node_modules/@esp-vision/device-core/src/rom_loader.js`, `node_modules/@esp-vision/device-core/src/rom_md5.js`, `node_modules/@esp-vision/device-core/src/rom_reset.js`, `src/serial_diagnostics.js`
+
+```text
+// SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+```
+
+### Source notice 9
+
+Bundled from: `node_modules/@esp-vision/device-core/src/browser_rom_compat.js`, `node_modules/@esp-vision/device-core/src/device_capture.js`, `node_modules/@esp-vision/device-core/src/device_files.js`, `node_modules/@esp-vision/device-core/src/device_python.js`, `node_modules/@esp-vision/device-core/src/firmware_feed.js`, `node_modules/@esp-vision/device-core/src/firmware_flash.js`, `node_modules/@esp-vision/device-core/src/firmware_io.js`, `node_modules/@esp-vision/device-core/src/firmware_partitions.js`, `node_modules/@esp-vision/device-core/src/firmware_release.js`, `node_modules/@esp-vision/device-core/src/index.js`, `node_modules/@esp-vision/device-core/src/jpeg_validate.js`, `node_modules/@esp-vision/device-core/src/network_discovery.js`, `node_modules/@esp-vision/device-core/src/network_discovery_node.js`, `node_modules/@esp-vision/device-core/src/node.js`, `node_modules/@esp-vision/device-core/src/node_inventory.js`, `node_modules/@esp-vision/device-core/src/node_rom.js`, `node_modules/@esp-vision/device-core/src/node_rom_port.js`, `node_modules/@esp-vision/device-core/src/node_rom_probe.js`, `node_modules/@esp-vision/device-core/src/node_serial.js`, `node_modules/@esp-vision/device-core/src/node_signals.js`, `node_modules/@esp-vision/device-core/src/node_transport.js`, `node_modules/@esp-vision/device-core/src/rom_identity.js`, `node_modules/@esp-vision/device-core/src/rom_loader.js`, `node_modules/@esp-vision/device-core/src/rom_md5.js`, `node_modules/@esp-vision/device-core/src/rom_reset.js`, `src/cli.js`, `src/serial_diagnostics.js`
 
 ```text
 // SPDX-License-Identifier: Apache-2.0