Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
en:dev:tailcontrol-move-reference [2025/05/23 19:29] – darkgrueen:dev:tailcontrol-move-reference [2026/07/04 19:45] (current) – [RGB LED Commands] darkgrue
Line 1: Line 1:
 ====== TailControl Move Reference ====== ====== TailControl Move Reference ======
  
- +Move list for the Tail Company TailControl firmware. TailControl is the unified firmware platform (version 5.//x//.//x// and higher) for the EarGear 2, FlutterWings, MiTail, MiTail Mini, and Paws with Claws (ClawGear); and covers the shared features that exist across all those devices.
-Move list for the Tail Company TailControl firmware. TailControl is the unified firmware platform (version 5.//x//.//x// and higher) for the MiTail, MiTail Mini, FlutterWings, and EarGear 2.+
  
 All commands are case-sensitive. Trailing whitespace (e.g., `NULL`, `CR`, etc.) are ignored. The space between a command keyword and the parameters is mandatory. All commands are case-sensitive. Trailing whitespace (e.g., `NULL`, `CR`, etc.) are ignored. The space between a command keyword and the parameters is mandatory.
 +
 +Move commands return ''<movename> BEGIN'' upon start, and '' <movename> END'' upon completion. If the move is set to return home after completion (all firmware moves are), then it will be immediately followed by a ''TAILHM BEGIN'' and a ''TAILHM END'' as well.
 +
 +A command will return ''LOWBATT'' and reject the command if the battery is less than 10%. ''ERR'' will be returned if the command can't be parsed or otherwise executed.
 +
 +A new command that is received before the currently executing command is finished will immediately end the current command and start the new one.
  
 <WRAP round todo 90%> <WRAP round todo 90%>
 **IMPORTANT NOTICE:** TailControl and the TailControl Protocol is still under development. Some commands and features described here relate to a future release and are subject to change at this time. **IMPORTANT NOTICE:** TailControl and the TailControl Protocol is still under development. Some commands and features described here relate to a future release and are subject to change at this time.
 </WRAP> </WRAP>
 +
 +
 +===== Paws with Claws (ClawGear) =====
 +
 +| **TAILHM** | **H**o**M**e position |
 +| **TAILS1** | Full extend slow |
 +| **TAILS2** | Full extend fast |
 +| **TAILS3** | Half extend slow |
 +| **TAILFA** | Half extend fast |
 +| **TAILSH** | Full retract slow |
 +| **TAILHA** | Full retract fast |
 +| **TAILER** | RAWR! Full extend fast, pause, retract very slow |
 +| **TAILEP** | No move |
 +| **TAILT1** | No move |
 +| **TAILT2** | No move |
 +| **TAILET** | No move |
 +| **TAILU1** | **U**ser defined **1** |
 +| **TAILU2** | **U**ser defined **2** |
 +| **TAILU3** | **U**ser defined **3** |
 +| **TAILU4** | **U**ser defined **4** |
 +
 +
 +===== EarGear 2 =====
 +
 +| **TAILHM** | **H**o**M**e position |
 +| **TAILS1** | Mapped to tilt forward; both ears turn inwards slowly, pause, home |
 +| **TAILS2** | Slow left ear, pause, home |
 +| **TAILS3** | Slow right ear, pause, home |
 +| **TAILFA** | Mapped to left tilt and listen bang left |
 +| **TAILSH** | Mapped to right tilt and listen bang right |
 +| **TAILHA** | Mapped to tilt backwards; both ears turn outwards quickly, pause, home |
 +| **TAILER** | Hewo! Right twist, pause, left twist |
 +| **TAILEP** | Double right ear twist, home |
 +| **TAILT1** | Flick left ear |
 +| **TAILT2** | Flick right ear |
 +| **TAILET** | Double left ear twist, home |
 +| **TAILU1** | **U**ser defined **1** |
 +| **TAILU2** | **U**ser defined **2** |
 +| **TAILU3** | **U**ser defined **3** |
 +| **TAILU4** | **U**ser defined **4** |
 +
 +
 +===== FlutterWings =====
 +
 +| **TAILHM** | **H**o**M**e position |
 +| **TAILS1** | **S**low full flap |
 +| **TAILS2** | **S**low half flap |
 +| **TAILS3** | **S**low high half flap |
 +| **TAILFA** | **FA**st full flap |
 +| **TAILSH** | Fast low half flap |
 +| **TAILHA** | Slow rousing |
 +| **TAILER** | Wings **ER**ect, pause, and back |
 +| **TAILEP** | Fast low half flap |
 +| **TAILT1** | Right, left, home |
 +| **TAILT2** | Wings erect, then home by halves |
 +| **TAILET** | Fast high half flap |
 +| **TAILU1** | **U**ser defined **1** |
 +| **TAILU2** | **U**ser defined **2** |
 +| **TAILU3** | **U**ser defined **3** |
 +| **TAILU4** | **U**ser defined **4** |
 +
 +
 +===== Glow Tip LED Patterns =====
 +
 +| **LEDOFF** | **LED**s **OFF** |
 +| **LEDREC** | **REC**tangle wave pattern (blink 1 second on, 1 second off) |
 +| **LEDTRI** | **TRI**angle wave pattern (fade in 1 second, fade out 1 second) |
 +| **LEDSAW** | **SAW**tooth wave pattern (fade in 2 seconds, off) |
 +| **LEDSOS** | Morse **SOS** pattern |
 +| **LEDBEA** | **BEA**con (100ms on every 2 seconds) |
 +| **LEDFLA** | **FLA**me |
 +| **LEDSTR** | **STR**obe |
 +| **LEDUS1** | **US**er defined **1** |
 +| **LEDUS2** | **US**er defined **2** |
 +| **LEDUS3** | **US**er defined **3** |
 +| **LEDUS4** | **US**er defined **4** |
 +
  
 ===== MiTail ===== ===== MiTail =====
Line 28: Line 110:
 | **TAILU3** | **U**ser defined **3** | | **TAILU3** | **U**ser defined **3** |
 | **TAILU4** | **U**ser defined **4** | | **TAILU4** | **U**ser defined **4** |
 +
  
 ===== MiTail Mini ===== ===== MiTail Mini =====
Line 48: Line 131:
 | **TAILU4** | **U**ser defined **4** | | **TAILU4** | **U**ser defined **4** |
  
-===== FlutterWings =====+ 
 +===== RGB LED Commands ===== 
 + 
 +====== TailControl Move Reference ====== 
 + 
 +Move list for the Tail Company TailControl firmware. TailControl is the unified firmware platform (version 5.//x//.//x// and higher) for the EarGear 2, FlutterWings, MiTail, MiTail Mini, and Paws with Claws (ClawGear); and covers the shared features that exist across all those devices. 
 + 
 +All commands are case-sensitive. Trailing whitespace (e.g., `NULL`, `CR`, etc.) are ignored. The space between a command keyword and the parameters is mandatory. 
 + 
 +Move commands return ''<movename> BEGIN'' upon start, and '' <movename> END'' upon completion. If the move is set to return home after completion (all firmware moves are), then it will be immediately followed by a ''TAILHM BEGIN'' and a ''TAILHM END'' as well. 
 + 
 +A command will return ''LOWBATT'' and reject the command if the battery is less than 10%. ''ERR'' will be returned if the command can't be parsed or otherwise executed. 
 + 
 +A new command that is received before the currently executing command is finished will immediately end the current command and start the new one. 
 + 
 +<WRAP round todo 90%> 
 +**IMPORTANT NOTICE:** TailControl and the TailControl Protocol is still under development. Some commands and features described here relate to a future release and are subject to change at this time. 
 +</WRAP> 
 + 
 + 
 +===== Paws with Claws (ClawGear) =====
  
 | **TAILHM** | **H**o**M**e position | | **TAILHM** | **H**o**M**e position |
-| **TAILS1** | **S**low wag **1** | +| **TAILS1** | Full extend slow | 
-| **TAILS2** | **S**low wag **2** | +| **TAILS2** | Full extend fast | 
-| **TAILS3** | **S**low wag **3** | +| **TAILS3** | Half extend slow | 
-| **TAILFA** | **FA**st wag | +| **TAILFA** | Half extend fast | 
-| **TAILSH** | **SH**ort wag | +| **TAILSH** | Full retract slow | 
-| **TAILHA** | **HA**ppy wag | +| **TAILHA** | Full retract fast | 
-| **TAILER** | **ER**ect | +| **TAILER** | RAWR! Full extend fast, pause, retract very slow | 
-| **TAILEP** | **E**rect **P**ulse | +| **TAILEP** | No move | 
-| **TAILT1** | **T**remble **1** | +| **TAILT1** | No move | 
-| **TAILT2** | **T**remble **2** | +| **TAILT2** | No move | 
-| **TAILET** | **E**rect **T**rem |+| **TAILET** | No move |
 | **TAILU1** | **U**ser defined **1** | | **TAILU1** | **U**ser defined **1** |
 | **TAILU2** | **U**ser defined **2** | | **TAILU2** | **U**ser defined **2** |
 | **TAILU3** | **U**ser defined **3** | | **TAILU3** | **U**ser defined **3** |
 | **TAILU4** | **U**ser defined **4** | | **TAILU4** | **U**ser defined **4** |
 +
  
 ===== EarGear 2 ===== ===== EarGear 2 =====
Line 85: Line 189:
 | **TAILU3** | **U**ser defined **3** | | **TAILU3** | **U**ser defined **3** |
 | **TAILU4** | **U**ser defined **4** | | **TAILU4** | **U**ser defined **4** |
 +
 +
 +===== FlutterWings =====
 +
 +| **TAILHM** | **H**o**M**e position |
 +| **TAILS1** | **S**low full flap |
 +| **TAILS2** | **S**low half flap |
 +| **TAILS3** | **S**low high half flap |
 +| **TAILFA** | **FA**st full flap |
 +| **TAILSH** | Fast low half flap |
 +| **TAILHA** | Slow rousing |
 +| **TAILER** | Wings **ER**ect, pause, and back |
 +| **TAILEP** | Fast low half flap |
 +| **TAILT1** | Right, left, home |
 +| **TAILT2** | Wings erect, then home by halves |
 +| **TAILET** | Fast high half flap |
 +| **TAILU1** | **U**ser defined **1** |
 +| **TAILU2** | **U**ser defined **2** |
 +| **TAILU3** | **U**ser defined **3** |
 +| **TAILU4** | **U**ser defined **4** |
 +
 +
 +===== Glow Tip LED Patterns =====
 +
 +| **LEDOFF** | **LED**s **OFF** |
 +| **LEDREC** | **REC**tangle wave pattern (blink 1 second on, 1 second off) |
 +| **LEDTRI** | **TRI**angle wave pattern (fade in 1 second, fade out 1 second) |
 +| **LEDSAW** | **SAW**tooth wave pattern (fade in 2 seconds, off) |
 +| **LEDSOS** | Morse **SOS** pattern |
 +| **LEDBEA** | **BEA**con (100ms on every 2 seconds) |
 +| **LEDFLA** | **FLA**me |
 +| **LEDSTR** | **STR**obe |
 +| **LEDUS1** | **US**er defined **1** |
 +| **LEDUS2** | **US**er defined **2** |
 +| **LEDUS3** | **US**er defined **3** |
 +| **LEDUS4** | **US**er defined **4** |
 +
 +
 +===== MiTail =====
 +
 +| **TAILHM** | **H**o**M**e position |
 +| **TAILS1** | **S**low wag **1** |
 +| **TAILS2** | **S**low wag **2** |
 +| **TAILS3** | **S**low wag **3** |
 +| **TAILFA** | **FA**st wag |
 +| **TAILSH** | **SH**ort wag |
 +| **TAILHA** | **HA**ppy wag |
 +| **TAILER** | **ER**ect |
 +| **TAILEP** | **E**rect **P**ulse |
 +| **TAILT1** | **T**remble **1** |
 +| **TAILT2** | **T**remble **2** |
 +| **TAILET** | **E**rect **T**rem |
 +| **TAILU1** | **U**ser defined **1** |
 +| **TAILU2** | **U**ser defined **2** |
 +| **TAILU3** | **U**ser defined **3** |
 +| **TAILU4** | **U**ser defined **4** |
 +
 +
 +===== MiTail Mini =====
 +
 +| **TAILHM** | **H**o**M**e position |
 +| **TAILS1** | **S**low wag **1** |
 +| **TAILS2** | **S**low wag **2** |
 +| **TAILS3** | **S**low wag **3** |
 +| **TAILFA** | **FA**st wag |
 +| **TAILSH** | No move |
 +| **TAILHA** | No move |
 +| **TAILER** | No move |
 +| **TAILEP** | No move |
 +| **TAILT1** | No move |
 +| **TAILT2** | No move |
 +| **TAILET** | No move |
 +| **TAILU1** | **U**ser defined **1** |
 +| **TAILU2** | **U**ser defined **2** |
 +| **TAILU3** | **U**ser defined **3** |
 +| **TAILU4** | **U**ser defined **4** |
 +
 +
 +===== RGB LED Commands =====
 +
 +All **RGB**''xxx'' pattern commands below (except **RGBOFF**), accept an optional trailing **brightness** parameter, an integer from ''0'' to ''100'' representing the overall brightness of the string in percent (e.g., ''RGBRBW 50''). If omitted, brightness defaults to ''DEFAULT_RGB_BRIGHTNESS'' (100%).
 +
 +| **RGBOFF** | **RGB** LEDs **OFF**, returns ''OK'' |
 +| **RGBCHS** | **RGB** **CH**a**S**e; theater marquee chase; optionally takes a hue color (in RGB Hexidecimal, otherwise default #7F7F7F is used) (e.g., ''RGBCHS'' [''7F7F7F''] [''brightness'']), returns ''OK'' |
 +| **RGBCLN** | **RGB** **CY**lo**N**; color dot sweeping back and forth, with fading trails; optionally takes a hue color (in RGB Hexidecimal, otherwise default #FF0000 is used) (e.g., ''RGBCLN'' [''FF0000''] [''brightness'']); returns ''OK'' |
 +| **RGBDMO** | **RGB** **DE**m**O**; cycle through all the preceding patterns, changing every 10 seconds (e.g., ''RGBDMO'' [''brightness'']); returns ''OK'' |
 +| **RGBFDE** | **RGB** **F**a**DE**; fade in/out effect (e.g., ''RGBFDE'' [''brightness'']), returns ''OK'' |
 +| **RGBFIR** | **RGB** **FIR**e; fire effect (e.g., ''RGBFIR'' [''brightness'']), returns ''OK'' |
 +| **RGBRBW** | **RGB** **R**ain**B**o**W** pattern (e.g., ''RGBRBW'' [''brightness'']), returns ''OK'' |
 +| **RGBSLD** | **RGB** **S**o**L**i**D**; display a solid color (in RGB Hexidecimal) on all pixels (e.g., ''RGBSLD FFD700'' [''brightness'']), returns ''OK'' |
 +| **RGBSNO** | **RGB** **SNO**w; snow effect; optionally takes a hue color (in RGB Hexidecimal, otherwise default #FFFFFF is used) (e.g., ''RGBSNO'' [''FFFFFF''] [''brightness'']), returns ''OK'' |
 +| **RGBTST** | **RGB** **TE**s**T**; color cycle the first and last pixel of the RGB string (endpoints test) (e.g., ''RGBTST'' [''brightness'']), returns ''OK'' |
 +| **RGBTWK** | **RGB** **TW**in**K**le; random twinkle effect (e.g., ''RGBTWK'' [''brightness'']), returns ''OK'' |
 +| **RGBWPE** | **RGB** **W**i**PE**; color wipe (e.g., ''RGBWPE'' [''brightness'']), returns ''OK'' |
 +
 +
 +== Copyright 2023-2026 © The Mechanical Tail Company Limited contact@thetailcompany.com. All Rights Reserved. ==