瀏覽代碼

Update readme

Kevin Lee 1 年之前
父節點
當前提交
983524bf67
共有 1 個文件被更改,包括 18 次插入18 次删除
  1. 18 18
      README.md

+ 18 - 18
README.md

@@ -25,28 +25,28 @@ Three operations are supported for patching pen settings:
 ``` yaml
 Pens: 
   - !Patch
-    Pen: 0                  # Required - pen index
-    Color: [127, 127, 127]  # Optional - pen RGB color
-    Enabled: true           # Optional - pen enable flag
-    LoopCount: 3            # Optional - pen loop count
-    Speed: 1.234            # Optional - pen speed
-    Power: 10.5             # Optional - pen power 
-    Frequency: 10000        # Optional - pen frequency
+    Pen: 0                  # Required - target pen
+    Color: [127, 127, 127]  # Optional - target pen RGB color
+    Enabled: true           # Optional - target pen enable flag
+    LoopCount: 3            # Optional - target pen loop count
+    Speed: 1.234            # Optional - target pen speed
+    Power: 10.5             # Optional - target pen power 
+    Frequency: 10000        # Optional - target pen frequency
 ```
 
-2. Cloning one pen to another:
+2. Cloning one pen to another (and optionally override settings):
 
 ``` yaml
 Pens: 
   - !Clone
-    From: 0
-    To: 1
-    # Color: [127, 127, 127]  # Optional - cloned pen RGB color
-    # Enabled: true           # Optional - cloned pen enable flag
-    # LoopCount: 3            # Optional - cloned pen loop count
-    # Speed: 1.234            # Optional - cloned pen speed
-    # Power: 10.5             # Optional - cloned pen power 
-    # Frequency: 10000        # Optional - cloned pen frequency
+    From: 0                 # Required - source pen
+    To: 1                   # Required - target pen
+    # Color: [64, 64, 64]   # Optional - target pen RGB color
+    # Enabled: true         # Optional - target pen enable flag
+    # LoopCount: 3          # Optional - target pen loop count
+    # Speed: 1.234          # Optional - target pen speed
+    # Power: 10.5           # Optional - target pen power 
+    # Frequency: 10000      # Optional - target pen frequency
 ```
 
 3. Incrementing a specific field across a sequence of pens:
@@ -54,8 +54,8 @@ Pens:
 ``` yaml
 Pens: 
   - !Pattern
-    From: 1
-    To: 5
+    From: 1                 # Required - starting pen to copy settings from
+    To: 5                   # Required - ending pen to stop at (inclusive)
     # Field: !Loops 1         # Choose one
     # Field: !Speed 100.0     # Choose one
     # Field: !Power 10.0      # Choose one