@intechstudio/grid-protocol 1.20260304.1550 → 1.20260323.1453

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 CHANGED
@@ -18,33 +18,27 @@ npm run build
18
18
  ### Minify (human-readable → device format)
19
19
 
20
20
  ```bash
21
- # Inline script
22
21
  node minify.mjs "midi_send(ch, 176, cc, val)" 2>/dev/null
23
-
24
- # From a file
25
- node minify.mjs path/to/script.lua 2>/dev/null
26
- ```
27
-
28
- Example output:
29
-
30
- ```
31
- gms(ch,176,cc,val)
22
+ # gms(ch,176,cc,val)
32
23
  ```
33
24
 
34
25
  ### Humanize (device format → human-readable)
35
26
 
36
27
  ```bash
37
- # Inline script
38
28
  node humanize.mjs "gms(ch,176,cc,val)" 2>/dev/null
39
-
40
- # From a file
41
- node humanize.mjs path/to/script.lua 2>/dev/null
29
+ # midi_send(ch, 176, cc, val)
42
30
  ```
43
31
 
44
- Example output:
32
+ > Note: Invalid Lua syntax will throw a parse error with the token and position.
33
+
34
+ > Note: When passing scripts with special characters as shell arguments, use single quotes to avoid shell interpretation: `node minify.mjs 'self:midi_send(-1, -1, -1, -1)'`
45
35
 
46
- ```
47
- midi_send(ch, 176, cc, val)
48
- ```
36
+ > Note: JSON output from the inspect scripts will have special characters escaped (e.g. `"` → `\"`, newline → `\n`). This is expected — parse the JSON before using the strings.
49
37
 
50
- > Note: Invalid Lua syntax will throw a parse error with the token and position.
38
+ ### Inspect protocol data
39
+
40
+ ```bash
41
+ node list-modules.mjs 2>/dev/null # module types and their elements
42
+ node list-elements.mjs 2>/dev/null # element types, events and default configs
43
+ node list-functions.mjs 2>/dev/null # Lua functions grouped by element type
44
+ ```