module.json

{
	"name": "LedFX",
	"type": "HTTP",
	"path": "Software",
	
	"version": "1.3.0",
	"description": "send CMD to your LedFX",
	"url":"",
	"downloadURL": "",
	"hasInput": true,
	"hasOutput": true, 
	"hideDefaultCommands": false,
	"hideDefaultParameters": [
		"protocol"
	],
	
	"defaults": {
		"baseAddress":"http://127.0.0.1:8888/api",
		"autoAdd": false,
		"protocol":"JSON",
		"authentication":
			{
				"enabled":false
			}
	},

	"parameters": {
			"Run LedFX": {
				"type": "Trigger",
				"description": "Run LedFX App"
			},		
			"LedFX Info": {
				"type": "Trigger",
				"description": "LedFX documentation"
			},
			"LedFX Refresh": {
				"type": "Trigger",
				"description": "LedFX status refresh"
			},
			"LedFX Refresh Interval": {
				"type": "Integer",
				"min": 0,
				"max": 60,
				"default": 30,
				"description": "LedFX status refresh interval (in second).
	Put 0 to disable."
			},			
			"LedFX Paused": {
				"type": "Boolean",
				"description": "True if LedFX is on Pause",
				"default": true,
				"readOnly": true
			},
			"BPM Params":{
				"type": "Container",
				"description":"BPM extra parameters",
				"collapsed": true,
				"Use BPM": { 
					"type": "Boolean", 
					"description": "Check to use WLEDAudiosync BPM feature.
	WLEDAudioSync need to be present, and you need to set the BPM feature on it.
	If you do not use WLED audio sync, disable wLEDAudioSync.parameters.live to save bandwidth.
	For some BPM ranges, a LedFX scene can be set.
	Once BPM detected and on this range, this will activate corresponding LedFX scene.",
					"default": false
				},
				"Default Scene Name": {
					"type": "String",
					"description": "Enter default scene name:
	will be used where no scene has been set for tempo",
					"default": "scenename",
			},				
				"Larghissimo": {
					"type": "String",
					"description": "Enter scene name for:
	Larghissimo	24 bpm or slower	Very, very slow",
			},
				"Grave": {
					"type": "String",
					"description": "Enter scene name for:
	Grave		25 to 45 bpm		Slow and solemn",
			},
				"Lento": {
					"type": "String",
					"description": "Enter scene name for:
	Lento		46 to 60 bpm		slow",
			},
				"Larghetto": {
					"type": "String",
					"description": "Enter scene name for:
	Larghetto	61 to 66 bpm		Rather broad but still quite slow",
			},
				"Adagio": {
					"type": "String",
					"description": "Enter scene name for:
	Adagio		67 to 76 bpm		At ease, slow with great expression",
			},
				"Andante": {
					"type": "String",
					"description": "Enter scene name for:
	Andante		77 to 108 bpm		At a walking pace",
			},
				"Moderato": {
					"type": "String",
					"description": "Enter scene name for:
	Moderato	109 to 120 bpm		Moderate speed",
			},
				"Allegro": {
					"type": "String",
					"description": "Enter scene name for:
	Allegro		121 to 156 bpm		Fast and Bright",
			},
				"Vivace": {
					"type": "String",
					"description": "Enter scene name for:
	Vivace		157 to 168 bpm		Lively and fast",
			},
				"Presto": {
					"type": "String",
					"description": "Enter scene name for:
	Presto		169 to 200 bpm		Extremely fast",
			},
				"Prestissimo": {
					"type": "String",
					"description": "Enter scene name for:
	Prestissimo	201 and over		Faster than Presto",
			}			
		},
			"RTMMD Params":{
				"type": "Container",
				"description":"RTMMD extra parameters",
				"collapsed": true,
				"Use RTMMD": { 
					"type": "Boolean", 
					"description": "Check to use WLEDAudiosync RTMMD feature.
	WLEDAudioSync need to be present, and you need to set the RTMMD feature on it.
	If you do not use WLED audio sync, disable wLEDAudioSync.parameters.live to save bandwidth.
	For some Mood, a LedFX scene can be set.
	Once Mood detected this will activate corresponding LedFX scene.",
					"default": false
				},
				"Default Scene Name": {
					"type": "String",
					"description": "Enter default scene name:
	will be used where no scene has been set for Mood",
					"default": "scenename",
			},				
				"Neutral": {
					"type": "String",
					"description": "Enter scene name for:
	neutral mood , found around the center",
			},
				"Joy": {
					"type": "String",
					"description": "Enter scene name for:
	Joy (yellow), on the Top right from middle",
			},
				"Extase": {
					"type": "String",
					"description": "Enter scene name for:
	Extase (yellow), on the Top right with higher energy",
			},
				"Serenity": {
					"type": "String",
					"description": "Enter scene name for:
	Serenity (yellow), on the Top right for other",
			},
				"Disgust": {
					"type": "String",
					"description": "Enter scene name for:
	Disgust (purple), on the Extrem Left, center",
			},
				"Sad": {
					"type": "String",
					"description": "Enter scene name for:
	Sad (blue), on the Low Left from middle",
			},
				"Pensinve": {
					"type": "String",
					"description": "Enter scene name for:
	Pensinve (blue), on the Low Left for other",
			},
				"Rage": {
					"type": "String",
					"description": "Enter scene name for:
	Rage (red), on the Top Left from center or with higher energy",
			},
				"Angry": {
					"type": "String",
					"description": "Enter scene name for:
	Angry (red), on the Top Left, for other",
			},
				"Calm": {
					"type": "String",
					"description": "Enter scene name for:
	Calm (green), on the Low Right, for other",
			},
				"Relax": {
					"type": "String",
					"description": "Enter scene name for:
	Relax (green), on the Low Right, from center",
			}			
		}
	},

	"values": {	
	},
	
	"scripts": [
		"LedFXCMD.js"
	],
	
	"commands": {
		
		"Switch On/Off":
		{
			"menu":"LedFX-Virtual",
			"callback":"VirtualOnOff",
			"setupCallback":"createDeviceList",
			"parameters": {
				"On or Off": {
					"type": "Boolean",
					"default": false,
					"shortName":"onOff",
					"description": "Checked will put the virtual device On",
					"useForMapping": false
				}
			}
		},		

		"Apply Effect":
		{
			"menu":"LedFX-Virtual",
			"callback":"VirtualEffect",
			"setupCallback":"createDeviceList",
			"parameters": {
				
				"effect": { 
					"type":"Enum", 
					"options": {
						"Gradient":"gradient",
						"Bands":"bands",
						"Bands Matrix":"bands_matrix",
						"Bar":"bar",
						"Blade Power plus":"blade_power_plus",
						"Block Reflections":"block_reflections",
						"Blocks":"blocks",
						"Crawler":"crawler",						
						"Energy":"energy",
						"Energy 2":"energy2",
						"Equalizer":"equalizer",
						"Fade":"fade",
						"Fire":"fire",
						"Glitch":"glitch",
						"Lava Lamp":"lava_lamp", 
						"Magnitude":"magnitude",
						"Marching":"marching",
						"Melt":"melt",
						"Multicolor Bar":"multiBar",
						"Pitch Spectrum":"pitchSpectrum",
						"Power":"power",
						"Rain":"rain",
						"Rainbow":"rainbow",
						"Strobe":"real_strobe",
						"Scroll":"scroll",
						"Single Color":"singleColor",
						"Spectrum":"spectrum",
						"BPM Strobe":"strobe",
						"Wavelength":"wavelength"						
						} ,
					"description": "Effect Name to apply",						
					"default": "gradient"
						},
			}
		},
		"Remove Effect":
		{
			"menu":"LedFX-Virtual",
			"callback":"VirtualRemoveEffect",
			"setupCallback":"createDeviceList"			
		},
		"List All":
		{
			"menu":"LedFX-Virtual",
			"callback":"virtualsList"

		},
		"De_Activate":
		{
			"menu":"LedFX-Scene",
			"callback":"sceneOnOff",
			"setupCallback":"createSceneList",
			"parameters": {
				"Activate or Deactivate": {
					"type": "Boolean",
					"description": "Checked will activate the Scene",
					"shortName":"activate",
					"default": true, 
					"useForMapping": false
				}
			}
		},

		"List All Scene":
		{
			"menu":"LedFX-Scene",
			"callback":"scenesList"

		},		
		
		"List All Device":
		{
			"menu":"LedFX-Device",
			"callback":"deviceList"

		},		


		"Ledfx Play On/Off":
		{
			"menu":"LedFX-Main",
			"callback":"LedfxOnOff",
			"parameters":{
				"Global Play or Paused": {
					"type": "Boolean",
					"description": "Checked will put LedFX On... otherwise Paused it",
					"shortName":"play",
					"default": true, 
					"useForMapping": false
				}
			}
		},
		"Ledfx restart":
		{
			"menu":"LedFX-Main",
			"callback":"LedfxRestart",
			"parameters":{
				"Restart core": {
					"type": "Boolean",
					"description": "Checked will restart LedFX.",
					"shortName":"restart",
					"default": false, 
					"useForMapping": false
				}
			}
		}		
	}
}