|====================================| | ArtiCONTROL Protocol Version 2.01 | | Written by: Michel van Osenbruggen | | CopyRight 2024 ArtiLED B.V. | |====================================| Minimum Firmware version : 0.121 beta Minimum Node version : 0.500 beta Latest change : 22-01-2024 --------------------- | ArtiCONTROL start | --------------------- > Telnet 'IP Address' 1090 > Token 'Token' -> Authenticate (token is case sensitive) !Note commands are case insensitive. ------------------- | ArtiCONTROL end | ------------------- > Return -> Empty line ends session |============================| | Protocol Answer Formatting | |============================| -1 = TimeOut : No Answer -> Check Realtime Mode 0 = Error : Error is just 0 -> See debug for Error 1 = Success : Success is just 1 (0-255) : Single values are always between '(' and ')' (0,0,0,0) : Color values GBW or RGB or HSV Values seperates by ',' between '(' and ')' [0] : Pixels values are always single value between '[' and ']' [0][1] : Multi Pixel values will be on one line [0-10] : Segment values are always two Pixel values seperated by '-' between '[' and ']' [0-5][6-9] : Multi Segment values are Multiple Segments on one line <1> : Channels values are always between '<' and '>' on one line {(0,0,0,0)(1,1,1,1)} : Palette = multiple colors between '{' and '}' on one line |=============| | Error Codes | |=============| 1 : Command Invalid 2 : Channel Invalid 3 : Color Invalid 4 : Data Invalid 5 : Command Failed 7 : Power Overload Error 8 : Temperature Overload Error (External via Node) 9 : Authentication Failed |=============| | Definitions | |=============| Strip : Whole led strip -> All leds (Number of leds) Multi Strip : Multiple led strips with channel -> All leds Segment : Part of a led strip -> Start, End -> Start and End are two bytes (msb, lsb) Multi Segment : Multiple Parts of a led strip -> Array of n x (Start, End) -> Start and End are two bytes (msb, lsb) Multi Channel Segment : Multiple Parts of multiple led strip with channel -> Array of n x (Channel, Start, End) -> Start and End are two bytes (msb, lsb) Pixel : Single pixel of a led strip -> Pixel number -> Pixel numbers are two bytes (msb, lsb) Multi Pixel : Multiple pixels of a led strip -> Array of Pixel Numbers -> Pixel numbers are two bytes (msb, lsb) Multi Channel Pixel : Multiple pixels of multiple led strip with channels -> Array of channel and Pixel Numbers -> Pixel numbers are two bytes (msb, lsb) Pixel String : Multiple pixels of a led strip with a start (msb, lsb) then followed by an Array of Pixel Numbers (msb, lsb) Section : Named Segment of a led strip (including start, stop and channel) Group : Named Group of numbered pixels (including comma separated list of pixen and channel) Palette : Collection of Colors -> Max 16 colors Scene : Node will run predefined code to display light or single or looped effects Mode : Node will be in Specialized Active Performance Modes like ArtiAUDIO, ArtiVIDEO, ArtNet |==================== | Channel Structure | ===================== 0 : All Channels 1 : Channel 1 2 : Channel 2 3 : Channel 3 4 : Channel 4 12 : 12 = Channel 1 + 2 13 : 13 = Channel 1 + 3 14 : 14 = Channel 1 + 4 23 : 23 = Channel 2 + 3 24 : 24 = Channel 2 + 4 34 : 34 = Channel 3 + 4 123 : 123 = Channel 1 + 2 + 3 124 : 124 = Channel 1 + 2 + 4 134 : 134 = Channel 1 + 3 + 4 234 : 234 = Channel 2 + 3 + 4 |=============| | Curves List | |=============| 0 : Linear 1 : Exponential 2 : Logarithmic 3 : Quadratic Ease In 4 : Quadratic Ease Out 5 : Cubic Ease In 6 : Cubic Ease Out 7 : Sine Ease In 8 : Sine Ease Out 9 : Circular Ease In 10 : Circular Ease Out |================= | Default Colors | |================= Red : RGB (255,0,0) Green : RGB (0,255,0) Blue : RGB (0,0,255) Yellow : RGB (255,255,0) Pink : RGB (255,0,255) Cyan : RGB (0,255,255) White : RGB (255,255,255) Purple : RGB (127,0,255) Black : RGB (0,0,0) |===================== | Display Color List | |===================== Black : 0 -> 0x0000 White : 1 -> 0xFFFF Blue : 2 -> 0x001F Red : 3 -> 0xF800 Green : 4 -> 0x07E0 Purple : 5 -> 0xA81A Cyan : 6 -> 0x07FF Magenta : 7 -> 0xF81F Yellow : 8 -> 0xFFE0 Lavender : 9 -> 0x79F3 Pink : 10 -> 0xF813 Lila : 11 -> 0xAADA |===================| | Command Structure | |===================| > Command : Command + Data # Privileged Command : Command + Data (requires admin rights) * Sub Command : Sub Command, Values, Effects, Palettes etc. ! Future Command : Command not done yet, coming soon ----------------------------- | ArtiCONTROL Info Commands | ----------------------------- > Get Version : No Data => Returns ArtiCONTROL Version > Get Version Data : No Data => Returns ArtiCONTROL Version Date ---------------------- | Node Info Commands | ---------------------- > Get Node Version : No Data => Returns Node Software Version > Get OS Version : No Data => Returns Linux Distribution Version > Get Kernel Version : No Data => Returns Linux Kernel Version > Get CPU Version : No Data => Returns CPU Version > Get Python Version : No Data => Returns Python Version > Get Node Type : No Data => Returns Node Type > Get Node Serial : No Data => Returns Node Serial Number > Get Node Name : No Data => Returns Node Name > Get Node Mac : No Data => Returns Node Mac Address > Get Node IP Address : No Data => Returns Node IP Address > Get Node Uptime : No Data => Returns Node Uptime in Seconds > Get Node Status : No Data => Returns Node Status > Get Node Token : No Data => Returns Node Token > Get Node OS Updates : No Data => Returns (1) if Node needs OS Updates > Get Node OS Updates Text : No Data => Returns Text for Node OS Updates > Get Node Power Sensor : No Data => Returns type of Power Sensor (0)=None, (1)=ina219, (2)=ina226 > Get Node Temperature Sensor : No Data => Returns type of Temperature Sensor (0)=None, (1)=Display Controller, (2)=1Wire to I2C > Get Node Temperature Sensor Count : No Data => Returns number Temperature Sensors > Get Node Error : No Data => Returns Latest Node Error Code (See Error List) > Get Node Error Text : No Data => Returns Latest Node Error Text > Reset Node Error : No Data => Resets Latest Node Error Code ----------------------------- | Node Sensor Info Commands | ----------------------------- > Get Node Voltage : No Data => Returns Node Voltage in Volt > Get Node Current : No Data => Returns Node Current in Ampere > Get Node Power : No Data => Returns Node Power in Watt > Get Node Led Voltage : No Data => Returns Node Led Voltage in Volt > Get Node Led Current : No Data => Returns Node Led Current in Ampere > Get Node Led Power : No Data => Returns Node Led Power in Watt > Get Node Temperature 1 : No Data => Returns Node Temperature Sensor 1 in Degrees Celsius > Get Node Temperature 2 : No Data => Returns Node Temperature Sensor 2 in Degrees Celsius > Get Node Temperature 3 : No Data => Returns Node Temperature Sensor 3 in Degrees Celsius > Get Node Temperature 4 : No Data => Returns Node Temperature Sensor 4 in Degrees Celsius > Get Node Temperature 5 : No Data => Returns Node Temperature Sensor 5 in Degrees Celsius > Get Node CPU Temperature : No Data => Returns Node CPU Temperature in Degrees Celsius > Get Node CPU Percentage : No Data => Returns Node CPU Load in Percent (0-100) > Get Node CPU Frequency : No Data => Returns Node CPU Frequency in Mhz > Get Node Memory Percentage : No Data => Returns Node Memory Usage in Percent (0-100) > Get Node Swap Percentage : No Data => Returns Node Swap Usage in Percent (0-100) > Get Node Disk Percentage : No Data => Returns Node Disk Usage in Percent (0-100) > Get Node Traffic Received : No Data => Returns Node Incoming Traffic in Kbit/s > Get Node Traffic Sent : No Data => Returns Node Outgoing Traffic in Kbit/s ------------------------------------ | Display Controller Info Commands | ------------------------------------ > Get Display Controller : No Data => Returns (1) if Display Controller present (0) if no Display Controller > Get Display Version : No Data => Returns Display Controller Software Version > Get Display Present : No Data => Returns (1) if Display present (0) if no Display present > Get Display Color : No Data => Returns (value) for Display Background Color (See list) > Get Display Text Color : No Data => Returns (value) for Display Text Color (see list) > Get Display Orientation : No Data => Returns (value) for Display Orientation (0)=Normal, (1)=90 degrees, (2)=180 degrees, (3)=270 degrees > Get Display Screen Saver Time : No Data => Returns (value) Display Screen Saver Time in Minutes (0-20) 0=Screen Saver Off > Get Display Logo Time : No Data => Returns (value) Display Display Logo Time in Seconds (0-5) 0=Logo Display Off > Get Display Button Order : No Data => Returns (value) Button Order (0)=Normal, (1)=Reversed --------------------- | Hub Info Commands | --------------------- > Get Hub : No Data => Returns Configured Hub IP Address -------------------------------- | Led Controller Info commands | -------------------------------- > Ping : No Data -> Check if Led controller is alive. Returns 1 > Get Debug : No Data -> Returns Debug Mode, (0)=debug off, (1)=Errors, (2)=Errors and Commands, (3)=Verbose > Get Power : No Data -> Returns PSU Power state, (0)=Off, (1)=On > Get State : No Data -> Returns Led State (0)=Leds Off, (1)=Leds On > Get Led Version : No Data -> Returns Led Controller Firmware version from Led Controller (value) > Get Firmware Version : No Data -> Returns Led Controller Firmware version from Node (value) > Get Leds : No Data -> Returns number of leds (1-1000) > Get Channels : No Data -> Returns number of channels attached (1-4) > Get Led Uptime : No Data -> Returns time since last Led Controller Reset (seconds) > Get Hardware : No Data -> Returns Type of Strip attached (1)=SK6812,(2)=WS2812B,(3)=WS2811-BRG,(4)=WS2811-GRB,(5)=WS2811-RGB,(6)=WS2813,(7)=WS2815,(8)=SK9822,(9)=SK6815,(10)=APA102,(11)=TM1903,(12)=HD107S > Get Clock : No Data -> Returns Clock Speed (0)=Off,(1)=400Khz,(2)=800Khz,(3)=1Mhz,(4)=2Mhz,....,(26)=24Mhz > Get Voltage : No Data -> Returns Led Strip Voltage (5,12,24) > Get Profile : No Data -> Returns Suported Color Profile (1)=RGBW, (2)=RGB, (3)=W > Get Amperage : No Data -> Returns Amperage of attached PSU(s) -> (1-255) > Get White Model : No Data -> Returns White Model (0)=No White, (1)=Cold White, (2)=Normal White, (3)=Warm White > Get Dither : No Data -> Returns Dither Mode (0)=Off,(1)=On > Get Color Correct : No Data -> Returns Color Correction (0)=Off, (1)=On > Get PSU Startup : No Data -> Returns PSU Startup Delay (0-100 * 0.1 Seconds) > Get PSU Control : No Data -> Returns value (0)=Off, (1)=Direct, (2)=Shared, (3)=Remote > Get Led Connections : No Data -> Returns Number of Connections to Led Controller (ArtiNET Sessions) > Get Power Calculation Method : No Data -> Returns Power Calculation Method -> (0)=Total, (1)=Highest > Get Actual Calculated Power : No Data -> Returns Actual Calculated Power of Led Strip(s) in Watt (Performs New Calculation) > Get Off Calculated Power : No Data -> Returns Calculated Power of Led Strip(s) when Off in Watt > Get Last Calculated Power : No Data -> Returns Last Calculated Power of Led Strip(s) in Watt > Get Max Calculated Power : No Data -> Returns Highest Calculated Power of Led Strip(s) in Watt > Get Worst Calculated Power : No Data -> Returns Worst Possible Calculated Power of Led Strip(s) in Watt > Get Available Calculated Power : No Data -> Returns Calculated PSU Power Available to Led Strip(s) in Watt > Get Actual Calculated Brightness : No Data -> Returns Advised Actual Calculated Maximum Brightness for Led Strip(s) (Performs New Calculation) > Get Last Calculated Brightness : No Data -> Returns Advised Last Calculated Maximum Brightness for Led Strip(s) > Get Max Calculated Power : No Data -> Returns Advised Highest Calculated Maximum Brightness for Led Strip(s) > Get Worst Calculated Brightness : No Data -> Returns Advised Maximum Brightness for Worst Calculated Power for Led Strip(s) > Get Regulation Mode : No Data -> Returns Power Regulation Mode (0=Off, 1=Total, 2=Channel 3=Total Max, 4=Channel Max, 5=Overload, 6=Shutdown) No Auto Power On!! ! Get Regulation State : No Data -> Returns Power Regulation State (0=Not Active, 1=Necessary, 2=Active, 3=Overload, 4=Shutdown) > Get Max Brightness : No Data -> Returns value (0-255) > Get Max Brightness Mode : No Data -> Returns value (0)=Absolute, (1)=Relative > Get Color Correct Values : No Data -> Returns Custom Color Correction Values (R,G,B) ----------------------------------- | Led Controller Control commands | ----------------------------------- > On : No Data -> Turns PSU On and all channels On depending on Startup Mode it will go to Default or Saved State > Off : No Data -> Turns Leds Off and PSU off > Sleep : No Data -> Activates Power Save immediately depending on Power Save Mode > Awake : No Data -> Awaken if Asleep or Keep Awake. Turns Power Saver off or Resets Power Saver Timer. (After Power Save Leds will remain off. Use 'On' or 'Restore' to turn leds on). > Channel : Channel -> Sets current channel for Commands (0-4), 0=All Channels, > 4 Channel Combinations (See list) > Clear : No Data -> Clear all leds on channel (to black) > Brightness : Value -> Sets Global brightness for easy dimming (0-255) > Saturation : Value -> Sets Global Saturation (if only Hue) > Hue : Value -> Sets Global Hue (if only Sat) > Value : Value -> Sets Global Value (if only Hue or Sat) > Brighten : Value (optional) -> Reads current Global Brightness and adds value (0-255) -> No Data will default to 10 > Dim : Value (optional) -> Reads current Global Brightnes and subtracts value (0-255) -> No Data will default to 10 > Scale : Value -> Reads current led values for Channel and scales them with value (0-255) Percent > Calc Add : Value -> Reads current led values for Channel and Adds Value (0-255) > Calc Subtract : Value -> Reads current led values for Channel and Subtracts Value (0-255). > Calc Multiply : Value -> Reads current led values for Channel and Multiplies with Value (0-255) > Calc Divide : Value -> Reads current led values for Channnel and Divides by Value (1-255) > Save : No Data -> Saves current led values for Channel in memory array for restore. (RAM, lost when power down) > Restore : No Data -> Restores saved led values for Channel from memory array for restore. (RAM, lost when power down) > Default : No Data -> Sets leds for channel to default color and brightnes or default effect for channel based on Default Startup Mode > Set Color Correct Values : R,G,B -> Sets Custom Color Correction Values. R,G,B get scaled (0-100%) from normal colors > Set Debug : Value -> 0=debug off, 1=Errors, 2=Errors and Commands, 3=Verbose > Commit : No Data -> Commits uncommitted Led Actions > Reset : No Data -> Resets Hardware Led controller > Set Power : Value -> Set PSU Power -> 0=Power PSU Off, 1=Power PSU On > Set Temperature Overload : No Data -> Actives Temperature Overload Mode > Get Temperature Overload : No Data -> Returns Temperature Overload Mode (0=No Temp Overload, 1=Temp Overload) > Reset Temperature Overload : No Data -> Deactivates Temperature Overload Mode > Set Temperature Treshold : Value -> Set Temperature Overload Treshold (Value between 35-85 degrees Celsius) > Get Temperature Treshold : No Data -> Returns Temperature Overload Treshold in degrees Celsius > Set Power Overload : No Data -> Activates Power Overload Mode > Get Power Overload : No Data -> Returns Power Overload Mode (0=No Power Overload, 1=Power Overload) > Reset Power Overload : No Data -> Deactivates Power Overload Mode --------------------------- | Channel Status commands | --------------------------- !!Channel Info HSV, Luma, Light do not see White channel of RGBW!! Also HSV value are calculated approximations not actual!! !!Colors HSV does not see White channel of RGBW!! Also HSV value are calculated approximations not actual!! > Get Channel : No Data -> Returns current channel (set before) > Get Brightness : No Data -> Returns Global Brightness (set before) > Get Saturation : No Data -> Returns Global Saturation (set before) > Get Hue : No Data -> Returns Global Hue (set before) > Get Value : No Data -> Returns Value (set before) ------------------------ | Strip Color Commands | ------------------------ > Strip Color : Color -> Colors whole strip (See Default Color Table) > Strip RGBW : R,G,B,W -> Colors whole strip (Red, Green, Blue, White) > Strip RGB : R,G,B -> Colors whole strip (Red, Green, Blue) > Strip HSV : H,S,V -> Colors whole strip (Hue, Sat, Value) > Strip W : T,I -> Colors whole Strip (Temperature, Intensity) 0=Cold, 127=Normal 255=Warm -------------------------- | Segment Color Commands | -------------------------- > Segment Color : Start,End,Color -> Colors Segment (Start, End, Color) > Segment RGBW : Start,End,R,G,B,W -> Colors Segment (Start, End, Red, Green, Blue, White) > Segment RGB : Start,End,R,G,B -> Colors Segment (Start, End, Red, Green, Blue) > Segment HSV : Start,End,H,S,V -> Colors Segment (Start, End, Hue, Sat, Value) > Segment W : Start,End,T,I -> Colors Segment (Start, End, Temperature, Intensity) 0=Cold, 127=Normal, 255=Warm -------------------- | Section Commands | -------------------- > Get Sections : No Data -> Returns all defined Segment names -> (Section1,Section2, ....) > Get Section : Name -> Returns Channel, Start, End -> (channel,start,end) ! Create Section : Name,Channel, Start,End -> Creates Section with given parameters ! Edit Section : Name -> Overwrites Name, Channel, Start, End with given Name ! Delete Section : Name -> Deleted Section with given Name > Section Color : Name,Color -> Colors Section (Name, Color) > Section RGBW : Name,R,G,B,W -> Colors Section (Name, Red, Green, Blue, White) > Section RGB : Name,R,G,B -> Colors Section (Name, Red, Green, Blue) > Section HSV : Name,H,S,V -> Colors Section (Name, Hue, Sat, Value) > Section W : Name,T,I -> Colors Segment (Name, Temperature, Intensity) 0=Cold, 127=Normal, 255=Warm ------------------ | Group Commands | ------------------ > Get Groups : No Data -> Returns all defined Group names -> (Group1,Group2, ....) > Get Group : Name -> Returns Channel, Pixel Numbers -> (channel,[Pixel1][Pixel2]...) ! Create Group : Name,Channel, Pixels -> Creates Group with given parameters ! Edit Group : Name -> Overwrites Name, Channel, Pixels with given Name ! Delete Group : Name -> Deleted Group with given Name > Group Color : Name,Color -> Colors Group (Name, Color) > Group RGBW : Name,R,G,B,W -> Colors Group (Name, Red, Green, Blue, White) > Group RGB : Name,R,G,B -> Colors Group (Name, Red, Green, Blue) > Group HSV : Name,H,S,V -> Colors Group (Name, Hue, Sat, Value) > Group W : Name,T,I -> Colors Group (Name, Temperature, Intensity) 0=Cold, 127=Normal, 255=Warm -------------------- | Palette commands | -------------------- > Get Palette : No Data -> Returns Palette (see ArtiPALETTE.txt) 255=Custom Palette > Set Palette : Value -> Sets Palette (see ArtiPALETTE.txt) Always all channels! > Set Simple Color Palette : Color,Color -> Set Custom Palette with 2 Colors 2 x (Color) on Default Position 0 and 255 > Set Simple Custom Palette : R,G,B,R,G,B -> Set Custom Palette with 2 Colors 2 x (R,G,B) on Default Position 0 and 255 > Set Advanced Custom Palette : n x Position,R,G,B -> Set Custom Palette with (2-16) Colors n x (Position, Red, Green, Blue) > Set Target Palette : Value -> Sets Target Palette for Blending (see ArtiPALETTE.txt) Always all channels! > Set Simple Color Palette : Color,Color -> Set Custom Target Palette with 2 Colors for Blending 2 x (Color) on Default Position 0 and 255 > Set Simple Custom Palette : R,G,B,R,G,B -> Set Custom Target Palette with 2 Colors for Blending 2 x (R,G,B) on Default Position 0 and 255 > Set Advanced Custom Palette : n x Position,R,G,B -> Set Custom Palette with (2-16) Colors for Blending n x (Position, Red, Green, Blue) > Blend Palette : No Data -> Default or -> Speed,Steps,Delay -> Blends from Current Pallette to Target Pallete (Speed,Steps,Delay) Speed->0x00=No Blend,0x01=Very Slow, 0x40=Fast, Steps (0x00-0xff), Delay ms (0x00-0xff) > Strip Palette : No Data -> Default or -> Blend,Scale,Alternate,Start Index,End Index -> Colors whole strip with Palette (Blend, Scale, Alternate, Start Index, End Index) -> 0=No Blend 1=Circular Blend 2=Linear Blend, 0=No Scale or (1-255), 0=No Alternate 1=Alternate > Strip Part Palette : Start,End,Blend,Scale,Alternate,Start Index,End Index -> Colors whole strip with Palette (Blend, Scale, Alternate, Start Index, End Index) -> 0=No Blend 1=Circular Blend 2=Linear Blend, 0=No Scale or (1-255), 0=No Alternate 1=Alternate > Segment Palette : Start,End,Blend,Scale,Alternate,Start Index,End Index -> Colors whole strip with Palette (Blend, Scale, Alternate, Start Index, End Index) -> 0=No Blend, 1=Circular Blend, 2=Linear Blend, 0=No Scale or (1-255), 0=No Alternate 1=Alternate > Section Palette : Name,Blend,Scale,Alternate,Start Index,End Index -> Colors whole strip with Palette (Blend, Scale, Alternate, Start Index, End Index) -> 0=No Blend, 1=Circular Blend, 2=Linear Blend, 0=No Scale or (1-255), 0=No Alternate 1=Alternate ------------------ | Scene Commands | ------------------ > Get Scenes : No Data -> Returns all defined Scene Names (Scene1,Scene2,...) > Get Scenes Running : No Data -> Returns all Running Scenes (Scene1,Scene2,...) > Stop Scenes Running : No Data -> Stops all Running Scenes > Get Scene State : Name -> Returns (1) when Scene running (0) when Scene not running > Start Scene : Name -> Start Scene (Scene Name) -> Case Insensitive > Test Scene : Name -> Start Test Version of Scene (Scene Name) -> Case Insensitive > Stop Scene : Name -> Stops Scene (Scene Name) -> Case Insensitive ----------------- | Mode Commands | ----------------- > Get Modes : No Data -> Returns all defined Mode Names (Mode1,Mode2,...) > Get Modes Running : No Data -> Returns all Running Modes (Mode1,Mode2,...) > Stop Modes Running : No Data -> Stops all Running Modes > Get Mode State : Name -> Returns (1) when Mode running (0) when Mode not running > Start Mode : Name -> Start Mode (Mode Name) -> Case Insensitive > Test Mode : Name -> Start Test Version of Mode (Mode Name) -> Case Insensitive > Stop Mode : Name -> Stops Mode (Mode Name) -> Case Insensitive |=============================================================| | COMMANDS BELOW ON ARE FOR INSTALLERS ONLY. USE AT OWN RISK! | |=============================================================| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ------------------------------------- | Led Controller Data Info commands | ------------------------------------- > Get Error : No Data -> Returns latest Controller Error Number (See Error Code List) > Reset Error : No Data -> Resets latest Controller Error Number > Get Error Text : No Data -> Returns latest Controller Error as Text > Get Error Count : No Data -> Returns Controller Error Count > Get Error Rate : No Data -> Returns Controller Error Previous Minute > Reset Error Count : No Data -> Returns latest Controller Error Count > Get Error Time : No Data -> Returns Number of Seconds since Last Error ------------------------- | Node Control Commands | ------------------------- > Shutdown : No Data -> Shuts Node Down (connection will be lost) Power will not be turned Off! > Reboot : No Data -> Reboots Node (connection will be lost) > Restart ArtiNET : No Data -> Restarts ArtiNET Service > Restart ArtiUDP : No Data -> Restarts ArtiUDP Service > Restart ArtiCONTROL : No Data -> Restarts ArtiCONTROL Service > Restart ArtiPALETTE : No Data -> Restarts ArtiPALETTE Service > Restart ArtiSCENE : No Data -> Restarts ArtiSCENE Service > Restart ArtiMODE : No Data -> Restarts ArtiMODE Service > Restart Debug : No Data -> Restarts Debug Service --------------------------- | Node OS Update Commands | --------------------------- > Check Node OS : No Data -> Checks for Updates on Ubuntu Linux > Update Node OS : No Data -> Updates Ubuntu Linux and waits (Reboot might be needed) > Update Node OS Background : No Data -> Updates Ubuntu Linux in the background (Reboot might be needed) ------------------------- | Node Support Commands | ------------------------- > Phone Home : No Data -> Send Node Info to Portal > Send Info : No Data -> Send Node Info to Support via E-mail > Send Config : No Data -> Send Node Config to Support via E-mail > Send Debug : No Data -> Send Node Debug Log to Support via E-mail > Send Logs : No Data -> Send Node Server Logs to Support via E-mail -------------------- | Hub VPN Commands | -------------------- > Start VPN : No Data -> Start VPN for ArtiLED Support > Stop VPN : No Data -> Stop VPN for ArtiLED Support ------------------------------------------- | Led Controller Firmware Update Commands | ------------------------------------------- > Update Firmware : No Data -> Updates Led Controller Firmware (connection will be lost after answer because Control Service Restarts) > Update Firmware Background : No Data -> Updates Led Controller Firmware in the Background (connection will be lost after answer because Control Service Restarts) ----------------------------------------------- | Display Controller Firmware Update Commands | ----------------------------------------------- > Update Display : No Data -> Updates Display Controller Firmware from Hub > Update Display Background : No Data -> Updates Display Controller Firmware from Hub in the Background --------------------------------- | Node Software Update Commands | --------------------------------- > Update Software : No Data -> Updates Node Software from Hub (connection will be lost after andwer because Control Service Restarts) > Update Software Background : No Data -> Updates Node Software from Hub in the Background (connection will be lost after andwer because Control Service Restarts) ---------------------------------------------------------------------------- | Led Controller Configure Commands (will be saved in Data Dir first) | | Make all changes first and then run 'Configure Led' to make the changes! | | Led Controller will reset after this! | ---------------------------------------------------------------------------- > Set Channels : Value -> 0-4 number of channels (max 4). > Set Leds : Value -> number of leds 1-1000 (all channels the same) > Set Clock : Value -> Set Clock -> 0=Off, 1=400Khz, 2=800Khz, 3=1Mhz, 4=2Mhz, ....., 26=24Mhz > Set Voltage : Value -> Set PSU Voltage -> 5 = 5V, 12 = 12V, 24 = 24V > Set Hardware : Value -> Set Led Strip Hardware -> 1 = SK6812, 2=WS2812B, 3=WS2811-BRG, 4=WS2811GRB, 5=WS2811-RGB, 6=WS2813, 7=WS2815, 8=SK9822, 9=SK6815, 10=APA102, 11=TM1903, 12=HD107S > Set Profile : Value -> Set Color Profile -> 1 = RGBW, 2 = RGB, 3 = > Set Amperage : Value -> Set PSU Amperage (1-100) -> 10 = 10A, 40= 40A > Set Regulation : Value -> Set Power Regulation -> 0 = Off, 1 = Total, 3 = Total Max, 4 = Channel Max, 5 = Overload, 6 = Shutdown > Set White Model : Value -> Set White Model -> 0 = No White, 1 = Cold White, 2 = Normal White, 3 = Warm White > Set Dither : Value -> Set Dither Mode -> 0 = Off, 1 = On (Default) > Set Color Correct : Value -> Set Color Correction 0 = Off, 1 = On -> !Note Color Correction only works on RGBW, RGB and W functions NOT on HSV etc! > Set Default Color Correct Red : Value -> Sets Custom Color Correction Values for Red get scaled (0-100%) from normal Red > Set Default Color Correct Green : Value -> Sets Custom Color Correction Values for Green get scaled (0-100%) from normal Green > Set Default Color Correct Blue : Value -> Sets Custom Color Correction Values for Blue get scaled (0-100%) from normal Blue > Set Start Mode : Value -> Sets Default Start Mode -> 0 = Off, 1 = Default Brightness, 2 = Default Color, 3 = Last State or Off, 4 = Last State or Default Color, 5 = Default Effect > Set Default Bightness : Value -> Sets Default Global Brightness at Power On and Set Default: value (1-255) > Set Default Red : Value -> Sets Default Red at Power On and Set Default: value (1-255) > Set Default Green : Value -> Sets Default Green at Power On and Set Default: value (1-255) > Set Default Blue : Value -> Sets Default Blue at Power On and Set Default: value (1-255) > Set Default White : Value -> Sets Default White at Power On and Set Default: value (1-255) > Set Max Brightness : Value -> Sets Max Brightness (1-255). This is a safety feature for underpowered PSU's or overlength led strips > Set Max Brightness Mode : Value -> Sets Max Brightness Mode -> 0 = Absolute, 1 = Relative > Set Power Auto Mode : Value -> Sets PSU Power On Mode -> 0 = Startup Off and Command Off, 1 = Startup On and Command Off, 2 = Startup Off and Command On, 3 = Startup On and Command On > Set Power Save Mode : Value -> Sets Power Save Mode -> 0 = Leds Off, 1 = PSU Off, 2 = Leds and PSU both Off, 3 = Leds Off with Save Led State, 4 = PSU Off with Save Led State, 5 = Leds and PSU Off with Save Led State > Set Power Save Time : Value -> Sets Power Save Time in Hours (0-24), 0=Power Save Off > Set PSU Control : Value -> Set PSU Control Ouput for Power Controlling -> 0=Off, 1=Direct, 2=Shared, 3=Remote > Set PSU Startup Delay : Value -> Set time to wait for PSU to start before sending command in Seconds (0-100 x 0.1 Seconds) > Set Power Calculation Method : Value -> Set Power Calculation Method -> 0=Total, 1=Highest > Set Power Value Off : Value -> Set values in mA/led for calculating Leds Off power > Set Power Value Red : Value -> Set values in mA/led/brightness for calculating Red Leds power per Brightness > Set Power Value Green : Value -> Set values in mA/led/brightness for calculating Green Leds power per Brightness > Set Power Value Blue : Value -> Set values in mA/led/brightness for calculating Blue Leds power per Brightness > Set Power Value White : Value -> Set values in mA/led/brightness for calculating White Leds power per Brightness > Configure Led : No Data -> Sends Config from Data folder to Led Controller and Resets Led Controller -------------------------------------------------------------------------------- | Display Controller Configure Commands (will be saved in Data Dir first) | | Make all changes first and then run 'Configure Display' to make the changes! | | Display Controller will reset after this! | -------------------------------------------------------------------------------- > Set Display Present : Value -> Set Display Present -> 0=No Display, 1=Display Present > Set Display Color : Value -> Set Display Background Color (0-11) -> See List > Set Display Text Color : Value -> Set Display Text Color (0-11) -> See List > Set Display Orientation : Value -> Set Display Orientation in Degrees -> 0=0 Degrees, 1=90 Degrees, 2=180 Degrees, 3=270 Degrees > Set Display Screen Saver Time : Value -> Set Display Screen Saver Time in Minutes (0-20) -> 0=Screen Saver Off > Set Display Logo Time : Value -> Set Display Logo Time in Seconds (0-5) -> 0=Display Logo Off > Set Display Button Order : Value -> Set Display Button Order -> 0=Normal 1=Reversed > Configure Display : No Data -> Sends Config from Data folder to Display Controller and Resets also Restarts Display Service > Reset Display : No Data -> Resets the Display Controller and Restarts Display Service > Restart Display Service : No Data -> Restarts Display Service