@viamrobotics/motion-tools 0.9.1 → 0.9.2
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/README.md +15 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,15 +1,21 @@
|
|
|
1
|
-
##
|
|
1
|
+
## motion-tools
|
|
2
|
+
|
|
3
|
+
`motion-tools` is visualizer for motion-related monitoring, testing, and debugging.
|
|
4
|
+
|
|
5
|
+
### Getting started
|
|
2
6
|
|
|
3
7
|
1. [Install pnpm](https://pnpm.io/installation)
|
|
4
8
|
2. [Install bun](https://bun.sh/docs/installation)
|
|
5
9
|
3. Install dependencies: `pnpm i`
|
|
6
10
|
4. Run local app server: `pnpm dev`
|
|
7
11
|
|
|
12
|
+
### Running the visualizer
|
|
13
|
+
|
|
8
14
|
To visit the visualizer, go to `http://localhost:5173/`
|
|
9
15
|
|
|
10
|
-
Open the machine config page (bottom right) and enter in connection details to visualize a specific machine.
|
|
16
|
+
Open the machine config page (bottom right) and enter in connection details to visualize a specific machine. You can also add machine configs from an env file (see below).
|
|
11
17
|
|
|
12
|
-
|
|
18
|
+
### Env files for machine configs
|
|
13
19
|
|
|
14
20
|
To add a list of connection configs in an `.env.local` file, use the following format:
|
|
15
21
|
|
|
@@ -25,3 +31,9 @@ VITE_CONFIGS='
|
|
|
25
31
|
}
|
|
26
32
|
}
|
|
27
33
|
```
|
|
34
|
+
|
|
35
|
+
### Executing drawing commands
|
|
36
|
+
|
|
37
|
+
The visualizer includes a golang package that allows executing commands to the visualizer.
|
|
38
|
+
|
|
39
|
+
The list of available commands [can be found here](https://pkg.go.dev/github.com/viam-labs/motion-tools@v0.9.0/client/client).
|