module.json

{
	"name": "WLED",
	"type": "HTTP",
	"path": "Software",
	
	"version": "2.0.0",
	"description": "send CMD to your WLED",
	"url":"https://github.com/zak-45/WLED-Chataigne-Module",
	"downloadURL": "https://github.com/zak-45/WLED-Chataigne-Module/archive/refs/heads/main.zip",
	"hasInput": true,
	"hasOutput": true, 
	"hideDefaultCommands": false,
	"hideDefaultParameters": [
		"protocol"
	],
	
	"defaults": {
		"baseAddress":"http://127.0.0.1/json",
		"autoAdd": false,
		"protocol":"JSON",
		"authentication":
			{
				"enabled":false
			}
	},

	"parameters": {

		"Default IP": { 
				"type":"String", 
				"description": "Default WLED IP address "
				},
		"WLED Params":{
			"type": "Container",
			"description":"WLED global parameters",
			"collapsed": false,
			"WLED Info": {
				"type": "Trigger",
				"description": "WLED documentation"
			},
			"Update all IP": { 
				"type": "Boolean", 
				"description": "Checked, this will also update all WLED devices (IP set in group WLED -- Custom Variables and only for HTTP).",
				"shortName": "loopIP",
				"default":false
			},
			"Add new IP to manage": {
				"type":"Trigger",
				"description": "Click to add IP address",
				"shortName": "addIP"
			},			
			"Re Transmit UDP packet": { 
				"type": "Integer", 
				"min":0,
				"max":5,
				"description": "UDP protocol fast but not reliable, choose how many time retransmit packet in case of.(max 5)",
				"shortName": "uDPReTransmit",
				"default":0
			},
			"Use WS": { 
				"type": "Boolean", 
				"description": "Use Websocket connection, mainly to be used for realtime update (will not take care of LoopIP = ignore)",
				"default":false
			}			
		}
	},

	"values": {	
	},
	
	
	"scripts": [
		"WLEDCMD.js"
	],
	
	"commands": {
		
		"WLED Main":
		{
			"menu":"WLED",
			"callback":"WLEDCommands",
			"parameters":{
				"wledIP":{
					"type":"String",
					"description": "WLED IP address. If 0.0.0.0 or nul, we will take the one from WLED Params -- variable.DefaultIP",
					"default":"0.0.0.0"
				},
				"live":{
					"type":"Boolean",
					"description": "Checked, WLED will receive data/command from another device (UDP)",
					"default":false
				},
				"on":{
					"type":"Boolean",
					"description": "Checked, WLED will put Led On",
					"default":true
				},
				"UDP":{
					"type":"Boolean",
					"description": "Checked, will send data thru UDP (improve speed, but no take care of live & on )",
					"default":false
				},
				"UDP Port number":{
					"type":"Integer",
					"description": "If you want to overwrite actual UDP port (set in WLEDSYNC module), put something <> 0",
					"shortName": "uDPPort",
					"min":0,
					"max":65535,
					"default":0
				},				
				"Main Color":{
					"type":"Color",
					"description": "Select the main color (double click) ",
					"shortName": "wledcolor",
					"default":[1,1,1,1]
				},
				"BackGround Color":{
					"type":"Color",
					"description": "Select the background color (double click) ",
					"shortName": "bgcolor",
					"default":[0,0,0,1]
				},				
				"brightness":{
					"type":"Float",
					"description": "Select brightness ",
					"min":0,
					"max":255,
					"default":128
				},
				"Effect Index":{
					"type":"Integer",
					"description": "ID of the effect. TIP: To see all indexes and names, command 'WLED info' and take a look at modules WLED -- Values  ",
					"shortName": "wledeffect",
					"min":0,
					"max":200,
					"default":0
				},
				"Effect Speed":{
					"type":"Float",
					"description": "Relative effect speed ",
					"shortName": "fxspeed",
					"min":0,
					"max":255,
					"default":128
				},
				"Effect Intensity":{
					"type":"Float",
					"description": "Effect intensity ",
					"shortName": "fxintensity",
					"min":0,
					"max":255,
					"default":64
				},
				"palette":{
					"type":"Integer",
					"description": "ID of the color palette. TIP: To see all palettes and names, command 'WLED info' and take a look at modules WLED -- Values  ",
					"min":0,
					"max":70,
					"default":0
				},
				"Group name":{
					"type":"String",
					"description": "Group name from where take data (used by SCAnalyzer)",
					"shortName": "wledgroup",
					"default":"",
					"readOnly":false
				},
				"Use WS":{
					"type":"Boolean",
					"description": "WebSocket for WLED (used by SCAnalyzer)",
					"shortName": "wledws",
					"default":false,
					"readOnly":false
				},
				"PS number":{
					"type":"Integer",
					"description": "Preset/playlist number (used by SCAnalyzer)",
					"shortName": "wledps",
					"default":0,
					"min":0,
					"max":255,
					"readOnly":false
				},
				"Transition time":{
					"type":"Integer",
					"description": "Duration of the crossfade between different colors/brightness levels. 
	One unit is 100ms, so a value of 4 results in a transition of 400ms. This applies to just the current API call.
	Not included in state response (used by SCAnalyzer)",
					"shortName": "wledtt",
					"default":-1,
					"min": -1,
					"max": 255,
					"readOnly":false
				}				
			}
		},
		
		"WLED On-Off":
		{
			"menu":"WLED",
			"callback":"WLEDOnOff",
			"parameters":{
				"wledIP":{
					"type":"String",
					"description": "WLED IP address. If 0.0.0.0 or nul, we will take the one from WLED Params -- variable.DefaultIP",
					"default":"0.0.0.0"
				},
				"live":{
					"type":"Boolean",
					"description": "Checked, WLED will receive data/command from another device (UDP)",
					"default":false
				},
				"on":{
					"type":"Boolean",
					"description": "Checked, WLED will put Led On",
					"default":true
				}
			}
		},
		
		"WLED Color":
		{
			"menu":"WLED",
			"callback":"WLEDColor",
			"parameters":{
				"wledIP":{
					"type":"String",
					"description": "WLED IP address. If 0.0.0.0 or nul, we will take the one from WLED Params -- variable.DefaultIP",
					"default":"0.0.0.0"
				},
				"Main Color ":{
					"type":"Color",
					"description": "Select the color (double click) ",
					"shortName" : "wledcolor",
					"default":[1,1,1,1]
				}
			}
		},
					
		"WLED Brightness":
		{
			"menu":"WLED",
			"callback":"WLEDBrightness",
			"parameters":{
				"wledIP":{
					"type":"String",
					"description": "WLED IP address. If 0.0.0.0 or nul, we will take the one from WLED Params -- variable.DefaultIP",
					"default":"0.0.0.0"
				},
				"brightness ":{
					"type":"Float",
					"description": "Select brightness ",					
					"min":0,
					"max":255,
					"default":128
				}
			}
		},
				
		"WLED Effect":
		{
			"menu":"WLED",
			"callback":"WLEDEffect",
			"parameters":{
				"wledIP":{
					"type":"String",
					"description": "WLED IP address. If 0.0.0.0 or nul, we will take the one from WLED Params -- variable.DefaultIP",
					"default":"0.0.0.0"
				},
				"Index":{
					"type":"Integer",
					"description": "ID of the effect. TIP: To see all indexes and names, command 'WLED info' and take a look at modules WLED -- Values  ",
					"shortName": "wledeffect",
					"min":0,
					"max":200,
					"default":0
				},
				"Speed":{
					"type":"Float",
					"description": "Relative effect speed ",
					"shortName": "fxspeed",
					"min":0,
					"max":255,
					"default":128
				},
				"Intensity":{
					"type":"Float",
					"description": "Effect intensity ",
					"shortName" : "fxintensity",
					"min":0,
					"max":255,
					"default":64
				}
			}
		},
		
		"WLED Effect Next":
		{
			"menu":"WLED",
			"callback":"WLEDEffectNP",
			"parameters":{
				"wledIP":{
					"type":"String",
					"description": "WLED IP address. If 0.0.0.0 or nul, we will take the one from WLED Params -- variable.DefaultIP",
					"default":"0.0.0.0"
				},
				"Next effect ~>":{
					"type":"String",
					"description": "Set Next effect. ",
					"shortName": "wledeffect",
					"default":"~",
					"readOnly":false
				}
			}
		},

		"WLED Effect Previous":
		{
			"menu":"WLED",
			"callback":"WLEDEffectNP",
			"parameters":{
				"wledIP":{
					"type":"String",
					"description": "WLED IP address. If 0.0.0.0 or nul, we will take the one from WLED Params -- variable.DefaultIP",
					"default":"0.0.0.0"
				},
				"Previous effect <~-":{
					"type":"String",
					"description": "Set Previous effect. ",
					"shortName": "wledeffect",
					"default":"~-",
					"readOnly":true
				}
			}
		},
		
		"WLED Palette":
		{
			"menu":"WLED",
			"callback":"WLEDPalette",
			"parameters":{
				"wledIP":{
					"type":"String",
					"description": "WLED IP address. If 0.0.0.0 or nul, we will take the one from WLED Params -- variable.DefaultIP",
					"default":"0.0.0.0"
				},
				"palette":{
					"type":"Integer",
					"description": "ID of the color palette. TIP: To see all palettes and names, command 'WLED info' and take a look at modules WLED -- Values  ",
					"min":0,
					"max":100,
					"default":0
				}
			}
		},

		"WLED Palette Next":
		{
			"menu":"WLED",
			"callback":"WLEDPalette",
			"parameters":{
				"wledIP":{
					"type":"String",
					"description": "WLED IP address. If 0.0.0.0 or nul, we will take the one from WLED Params -- variable.DefaultIP",
					"default":"0.0.0.0"
				},
				"palette":{
					"type":"String",
					"description": "This will select the next palette from the current ID",
					"default":"~",
					"readOnly":true
				}
			}
		},

		"WLED Palette Previous":
		{
			"menu":"WLED",
			"callback":"WLEDPalette",
			"parameters":{
				"wledIP":{
					"type":"String",
					"description": "WLED IP address. If 0.0.0.0 or nul, we will take the one from WLED Params -- variable.DefaultIP",
					"default":"0.0.0.0"
				},
				"palette":{
					"type":"String",
					"description": "This will select previous palette from the current ID",
					"default":"~-",
					"readOnly":true
				}
			}
		},
		"WLED Playlist":
		{
			"menu":"WLED",
			"callback":"WLEDPlaylist",
			"parameters":{
				"wledIP":{
					"type":"String",
					"description": "WLED IP address. If 0.0.0.0 or nul, we will take the one from WLED Params -- variable.DefaultIP",
					"default":"0.0.0.0"
				},
				"playlist/preset":{
					"type":"Integer",
					"description": "ID of the playlist/preset.",
					"shortName": "playlist",
					"min":0,
					"max":100,
					"default":0
				}
			}
		},
		"WLED Reboot":
		{
			"menu":"WLED",
			"callback":"WLEDReboot",
			"parameters":{
				"wledIP":{
					"type":"String",
					"description": "WLED IP address. If 0.0.0.0 or nul, we will take the one from WLED Params -- variable.DefaultIP",
					"default":"0.0.0.0"
				},
				"reboot":{
					"type":"Boolean",
					"description": "Checked, reboot WLED",
					"default":false
				}
			}
		},

		"WLED Info":
		{
			"menu":"WLED",
			"callback":"WLEDInfo",
			"parameters":{
				"wledIP":{
					"type":"String",
					"description": "WLED IP address. If 0.0.0.0 or nul, we will take the one from WLED Params -- variable.DefaultIP",
					"default":"0.0.0.0"
				}
			}
		}
	}
}