@esp-vision/device-cli 0.0.0-stage → 0.1.1
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/DEVICE_CORE_NOTICE.md +32 -0
- package/LICENSE +202 -0
- package/README.md +61 -2
- package/THIRD_PARTY_NOTICES.md +135 -0
- package/dist/device-cli.mjs +9114 -0
- package/dist/node_rom.py +64 -0
- package/dist/node_serial.py +77 -0
- package/licenses/ansi-regex-license +9 -0
- package/licenses/dns-packet-LICENSE +21 -0
- package/licenses/emoji-regex-LICENSE-MIT.txt +20 -0
- package/licenses/get-east-asian-width-license +9 -0
- package/licenses/leichtgewicht__ip-codec-LICENSE +21 -0
- package/licenses/multicast-dns-LICENSE +21 -0
- package/licenses/smol-toml-LICENSE +24 -0
- package/licenses/string-width-license +9 -0
- package/licenses/strip-ansi-license +9 -0
- package/licenses/thunky-LICENSE +21 -0
- package/package.json +54 -4
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
ESP-VISION Device Core
|
|
2
|
+
Copyright 2026 Espressif Systems (Shanghai) CO LTD
|
|
3
|
+
|
|
4
|
+
The package as a whole and ESP-VISION contributions are distributed under
|
|
5
|
+
the Apache License, Version 2.0. See LICENSE.
|
|
6
|
+
|
|
7
|
+
The following notices are retained from the Device Core source migrated
|
|
8
|
+
from ESP-VISION-IDE for previously MIT-licensed and upstream-derived portions.
|
|
9
|
+
Third-party dependencies retain their respective licenses.
|
|
10
|
+
|
|
11
|
+
MIT License
|
|
12
|
+
|
|
13
|
+
Copyright (c) 2026 ESP-VISION-IDE contributors
|
|
14
|
+
Copyright (c) 2024 Volodymyr Shymanskyy
|
|
15
|
+
|
|
16
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
17
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
18
|
+
in the Software without restriction, including without limitation the rights
|
|
19
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
20
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
21
|
+
furnished to do so, subject to the following conditions:
|
|
22
|
+
|
|
23
|
+
The above copyright notice and this permission notice shall be included in all
|
|
24
|
+
copies or substantial portions of the Software.
|
|
25
|
+
|
|
26
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
27
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
28
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
29
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
30
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
31
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
32
|
+
SOFTWARE.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,62 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ESP-VISION Device CLI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`@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.
|
|
4
|
+
|
|
5
|
+
Requires Node.js 22 or newer. Serial access requires Python with `pyserial`; firmware flashing requires Python `esptool==5.6.0`. LAN discovery uses the bundled multicast-DNS client. Check the selected interpreter with `PYTHON --version` and `PYTHON -c "import serial"`; install pyserial there with `PYTHON -m pip install pyserial` (replace `PYTHON` with that executable). Windows Python Launcher users can use `--python py` and `py -m pip install pyserial`. A failed serial setup gets a bounded environment diagnosis after connection cleanup; successful connections, TCP operations, help, and offline firmware checks do not start it. Busy/access-denied errors keep their port-specific guidance; an unknown adapter failure is not proof of missing Python or pyserial.
|
|
6
|
+
|
|
7
|
+
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.
|
|
8
|
+
|
|
9
|
+
## Python execution
|
|
10
|
+
|
|
11
|
+
Choose exactly one input: `--source CODE` for inline code, `--file LOCAL.py` for a local source file, or `--path DEVICE.py` for a file already on the device. `--timeout MS` must be a positive integer and cancels a waiting execution when it expires. `--max-output-chars` bounds captured Python output.
|
|
12
|
+
|
|
13
|
+
The default `--completion wait` waits for completion and returns bounded output metadata. `--completion start` requires `--path` and acknowledges after the device VM enters its runner. Omit `--timeout` with `start`; it is an execution deadline for `wait` only. This does not confirm that the application initialized successfully or completed. The CLI then releases the connection and exits; it does not keep watching or resume the script.
|
|
14
|
+
|
|
15
|
+
During foreground `python` execution and Python steps in a batch, `python.output`, `python.log`, and `python.state` events stream as NDJSON on stderr while the command is still running. Python text is capped by `--max-output-chars` (16,384 by default); a single event with `truncated: true` marks the limit. The stdout JSON summary contains metadata, not a duplicate of streamed output. For live Python output, use `--completion wait`.
|
|
16
|
+
|
|
17
|
+
## Runtime state and connection behavior
|
|
18
|
+
|
|
19
|
+
A targeted `inspect`, `configure`, firmware check, `capture`, `watch`, or native `files write` acquires the device without probing the friendly REPL, so these operations do not send Ctrl-C to a running application. `inspect --probe` actively checks discovered ports using the same passive connection. Python execution, REPL-backed `files list/read/remove/mkdir`, `control`, firmware updates, and batches use the normal REPL connection probe; these commands can send Ctrl-C.
|
|
20
|
+
|
|
21
|
+
The `runtime.scriptRunning` and `runtime.run` fields describe work tracked by the current SDK session. A fresh CLI process cannot use them to determine whether a detached program started earlier is still running on the device. `runtime.vmReady` means the VM is ready; it does not mean the VM is idle.
|
|
22
|
+
|
|
23
|
+
## Device files and capture
|
|
24
|
+
|
|
25
|
+
For a continuous app, finish directory operations and uploads before starting it, then take passive captures while it runs. Stop it with `control --action stop` before reading progress files. `--mode soft|hard` applies only to `control --action reset`; it is not a stop option. A REPL-backed read can interrupt the app and trigger LCD cleanup, so a subsequent `DISPLAY_NOT_READY` does not by itself establish a firmware failure. Use increasing application frame counters across captures to verify liveness; a fresh connection's session-local execution state cannot establish global idleness.
|
|
26
|
+
|
|
27
|
+
`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.
|
|
28
|
+
|
|
29
|
+
`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.
|
|
30
|
+
|
|
31
|
+
## Bounded event watch
|
|
32
|
+
|
|
33
|
+
`watch --duration MS --port PATH` or `watch --duration MS --tcp HOST[:PORT]` keeps one device connection open for the requested duration (1 ms to 1 hour). It passively observes Python output, device logs, state changes, and diagnostics available to the currently acquired session as NDJSON on stderr, then releases the connection and returns a JSON summary. EV-MUX pins Python stdout to the session that started the program, so a new watch cannot reattach to stdout from a detached `--completion start` run. Use foreground `--completion wait` when live Python output is needed. To check a detached app, use captures or have the app write progress artifacts that can be read later. SIGINT and SIGTERM cancel the watch and still release ownership. A lost device connection is reported as a command failure; the CLI does not reconnect or launch a script.
|
|
34
|
+
|
|
35
|
+
## Batch plan
|
|
36
|
+
|
|
37
|
+
`batch PLAN.json --port PATH` or `batch PLAN.json --tcp HOST[:PORT]` validates the complete plan before connecting, then runs each operation in order over one connection. Local `file` and `output` paths are relative to the plan file. The first failed operation stops the plan; the report contains completed operations and the failure. The device is disconnected in all cases.
|
|
38
|
+
|
|
39
|
+
```json
|
|
40
|
+
{
|
|
41
|
+
"schemaVersion": 1,
|
|
42
|
+
"operations": [
|
|
43
|
+
{ "op": "python", "source": "print('hello')" },
|
|
44
|
+
{ "op": "files.list", "path": "/" },
|
|
45
|
+
{ "op": "files.read", "path": "/boot.py", "output": "./boot.py" },
|
|
46
|
+
{ "op": "files.write", "path": "/backup.bin", "file": "./backup.bin" },
|
|
47
|
+
{ "op": "files.remove", "path": "/old.bin" },
|
|
48
|
+
{ "op": "files.mkdir", "path": "/data", "recursive": true },
|
|
49
|
+
{ "op": "capture", "source": "camera", "output": "./frame.jpg", "quality": 80 }
|
|
50
|
+
]
|
|
51
|
+
}
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Output and cancellation
|
|
55
|
+
|
|
56
|
+
`--json` writes exactly one JSON envelope to stdout with `schemaVersion: 1`. A success uses `{ "schemaVersion": 1, "ok": true, "command": "...", "result": ... }`. A failure uses `{ "schemaVersion": 1, "ok": false, "command": "...", "error": { "code": "...", "message": "..." } }`; cleanup failures appear separately as `cleanupError`. Batch failures include `completed` and `failed` entries. Binary data is written to files, never embedded in the envelope.
|
|
57
|
+
|
|
58
|
+
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.
|
|
59
|
+
|
|
60
|
+
Inspect JSON output uses the same versioned envelope as other commands. Human-readable inspect output remains a terminal table.
|
|
61
|
+
|
|
62
|
+
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.
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# Third-party notices
|
|
2
|
+
|
|
3
|
+
The CLI bundle includes the following third-party packages. Their original license files are in `licenses/`.
|
|
4
|
+
|
|
5
|
+
| Package | Version | License | License file |
|
|
6
|
+
| --- | --- | --- | --- |
|
|
7
|
+
| @leichtgewicht/ip-codec | 2.0.5 | MIT | `leichtgewicht__ip-codec-LICENSE` |
|
|
8
|
+
| ansi-regex | 6.4.0 | MIT | `ansi-regex-license` |
|
|
9
|
+
| dns-packet | 5.6.1 | MIT | `dns-packet-LICENSE` |
|
|
10
|
+
| emoji-regex | 10.6.0 | MIT | `emoji-regex-LICENSE-MIT.txt` |
|
|
11
|
+
| get-east-asian-width | 1.7.0 | MIT | `get-east-asian-width-license` |
|
|
12
|
+
| multicast-dns | 7.2.5 | MIT | `multicast-dns-LICENSE` |
|
|
13
|
+
| smol-toml | 1.9.1 | BSD-3-Clause | `smol-toml-LICENSE` |
|
|
14
|
+
| string-width | 7.2.0 | MIT | `string-width-license` |
|
|
15
|
+
| strip-ansi | 7.2.0 | MIT | `strip-ansi-license` |
|
|
16
|
+
| thunky | 1.1.0 | MIT | `thunky-LICENSE` |
|
|
17
|
+
|
|
18
|
+
## Preserved source license comments
|
|
19
|
+
|
|
20
|
+
Original copyright and SPDX comments from bundled source files are reproduced below. Recognized legal comments also remain inline in `dist/device-cli.mjs`.
|
|
21
|
+
|
|
22
|
+
### Source notice 1
|
|
23
|
+
|
|
24
|
+
Bundled from: `node_modules/@esp-vision/device-core/src/evrepl.js`
|
|
25
|
+
|
|
26
|
+
```text
|
|
27
|
+
/*
|
|
28
|
+
* SPDX-FileCopyrightText: 2026 ESP-VISION-IDE
|
|
29
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
30
|
+
*
|
|
31
|
+
* Framed friendly-REPL client over EV-MUX repl channels.
|
|
32
|
+
*
|
|
33
|
+
* With boot-default EV-MUX firmware there is no raw REPL bootstrap: the
|
|
34
|
+
* device speaks frames from power-on, and the friendly REPL is reachable
|
|
35
|
+
* through repl.stdin / repl.stdout frames. This module executes Python
|
|
36
|
+
* snippets over that channel and resolves their stdout, so device info,
|
|
37
|
+
* the file tree and all filesystem operations (read/write/create/delete)
|
|
38
|
+
* run framed, with no raw REPL access anywhere.
|
|
39
|
+
*/
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Source notice 2
|
|
43
|
+
|
|
44
|
+
Bundled from: `node_modules/@esp-vision/device-core/src/device_session.js`
|
|
45
|
+
|
|
46
|
+
```text
|
|
47
|
+
/*
|
|
48
|
+
* SPDX-FileCopyrightText: 2026 ESP-VISION-IDE
|
|
49
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
50
|
+
*
|
|
51
|
+
* UI-independent EV-MUX device interpreter. Both the browser IDE and agent
|
|
52
|
+
* integrations construct this class with the same EvMuxParser/EvRepl
|
|
53
|
+
* implementations, so protocol negotiation and firmware operations cannot
|
|
54
|
+
* drift between the two entry points.
|
|
55
|
+
*/
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Source notice 3
|
|
59
|
+
|
|
60
|
+
Bundled from: `node_modules/@esp-vision/device-core/src/evmux.js`
|
|
61
|
+
|
|
62
|
+
```text
|
|
63
|
+
/*
|
|
64
|
+
* SPDX-FileCopyrightText: 2026 ESP-VISION-IDE
|
|
65
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
66
|
+
*/
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Source notice 4
|
|
70
|
+
|
|
71
|
+
Bundled from: `node_modules/@esp-vision/device-core/src/device.js`, `node_modules/@esp-vision/device-core/src/device_operations.js`, `node_modules/@esp-vision/device-core/src/firmware_updates.js`
|
|
72
|
+
|
|
73
|
+
```text
|
|
74
|
+
/* SPDX-FileCopyrightText: 2026 ESP-VISION-IDE
|
|
75
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
76
|
+
*/
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Source notice 5
|
|
80
|
+
|
|
81
|
+
Bundled from: `node_modules/smol-toml/dist/date.js`, `node_modules/smol-toml/dist/error.js`, `node_modules/smol-toml/dist/extract.js`, `node_modules/smol-toml/dist/index.js`, `node_modules/smol-toml/dist/parse.js`, `node_modules/smol-toml/dist/primitive.js`, `node_modules/smol-toml/dist/stringify.js`, `node_modules/smol-toml/dist/struct.js`, `node_modules/smol-toml/dist/util.js`
|
|
82
|
+
|
|
83
|
+
```text
|
|
84
|
+
/*!
|
|
85
|
+
* Copyright (c) Squirrel Chat et al., All rights reserved.
|
|
86
|
+
* SPDX-License-Identifier: BSD-3-Clause
|
|
87
|
+
*
|
|
88
|
+
* Redistribution and use in source and binary forms, with or without
|
|
89
|
+
* modification, are permitted provided that the following conditions are met:
|
|
90
|
+
*
|
|
91
|
+
* 1. Redistributions of source code must retain the above copyright notice, this
|
|
92
|
+
* list of conditions and the following disclaimer.
|
|
93
|
+
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
94
|
+
* this list of conditions and the following disclaimer in the
|
|
95
|
+
* documentation and/or other materials provided with the distribution.
|
|
96
|
+
* 3. Neither the name of the copyright holder nor the names of its contributors
|
|
97
|
+
* may be used to endorse or promote products derived from this software without
|
|
98
|
+
* specific prior written permission.
|
|
99
|
+
*
|
|
100
|
+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
101
|
+
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
102
|
+
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
103
|
+
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
104
|
+
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
105
|
+
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
106
|
+
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
107
|
+
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
108
|
+
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
109
|
+
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
110
|
+
*/
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Source notice 6
|
|
114
|
+
|
|
115
|
+
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`
|
|
116
|
+
|
|
117
|
+
```text
|
|
118
|
+
// SPDX-FileCopyrightText: 2026 ESP-VISION-IDE
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Source notice 7
|
|
122
|
+
|
|
123
|
+
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`, `src/serial_diagnostics.js`
|
|
124
|
+
|
|
125
|
+
```text
|
|
126
|
+
// SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### Source notice 8
|
|
130
|
+
|
|
131
|
+
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`, `src/serial_diagnostics.js`
|
|
132
|
+
|
|
133
|
+
```text
|
|
134
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
135
|
+
```
|