api: Add static method to retrieve machine description only.

Author: freezy

VisualPinball.Engine.Mpf.Test/Program.cs

@@ -12,6 +12,7 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.IO;
 using System.Linq;
 using System.Threading.Tasks;
 using VisualPinball.Engine.Mpf;
@@ -22,6 +23,8 @@ public static class Program
 	{
 		public static async Task Main(string[] args)
 		{
+			var machineFolder = Path.GetFullPath(@"../../../../VisualPinball.Engine.Mpf/machine");
+
 			// Console.WriteLine("Starting...");
 			// var client = new MpfClient();
 			// client.Connect();
@@ -33,7 +36,7 @@ public static async Task Main(string[] args)
 
 
 			var s = Stopwatch.StartNew();
-			var mpfApi = new MpfApi(@"../../../../VisualPinball.Engine.Mpf/machine");
+			var mpfApi = new MpfApi(machineFolder);
 
 			mpfApi.Launch();
 

VisualPinball.Engine.Mpf.Unity/Editor/MpfGamelogicEngineInspector.cs

@@ -9,6 +9,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+using System.IO;
 using UnityEditor;
 using UnityEngine;
 
@@ -37,7 +38,18 @@ public override void OnInspectorGUI()
 			}
 
 			if (GUILayout.Button("Synchronize")) {
-				_mpfEngine.GetMachineDescription();
+				if (!Directory.Exists(_mpfEngine.MachineFolder)) {
+					EditorUtility.DisplayDialog("Mission Pinball Framework", "Gotta choose a valid machine folder first!", "Okay");
+				} else if (!Directory.Exists(Path.Combine(_mpfEngine.MachineFolder, "config"))) {
+					EditorUtility.DisplayDialog("Mission Pinball Framework", $"{_mpfEngine.MachineFolder} doesn't seem a valid machine folder. We expect a \"config\" subfolder in there!", "Okay");
+				} else {
+					_mpfEngine.GetMachineDescription();
+				}
+			}
+
+			EditorGUILayout.LabelField("Switches", new GUIStyle(GUI.skin.label) { fontStyle = FontStyle.Bold });
+			foreach (var switchDescription in _mpfEngine.MachineDescription.Switches) {
+				EditorGUILayout.LabelField(switchDescription.HardwareNumber, switchDescription.Name);
 			}
 
 

VisualPinball.Engine.Mpf.Unity/Runtime/MpfGamelogicEngine.cs

@@ -11,6 +11,7 @@
 
 using System;
 using System.Collections.Generic;
+using Mpf.Vpe;
 using UnityEngine;
 using VisualPinball.Engine.Game.Engines;
 using VisualPinball.Unity;
@@ -28,12 +29,11 @@ public class MpfGamelogicEngine : MonoBehaviour
 
 		public string MachineFolder;
 
+		public MachineDescription MachineDescription;
+
 		public void GetMachineDescription()
 		{
-			var client = new MpfClient();
-			client.Connect();
-			client.StartGame(new Dictionary<string, bool>());
-			Debug.Log("Description = " + client.GetMachineDescription());
+			MachineDescription = MpfApi.GetMachineDescription(MachineFolder);
 		}
 
 	}

VisualPinball.Engine.Mpf/MpfApi.cs

@@ -27,6 +27,18 @@ public MpfApi(string machineFolder)
 			_spawner = new MpfSpawner(Path.GetFullPath(machineFolder));
 		}
 
+		public static MachineDescription GetMachineDescription(string machineFolder)
+		{
+			var client = new MpfClient();
+			var spawner = new MpfSpawner(machineFolder);
+			spawner.Spawn();
+			client.Connect("localhost:50051");
+			client.StartGame(new Dictionary<string, bool>(), false);
+			var description = client.GetMachineDescription();
+			client.Shutdown();
+			return description;
+		}
+
 		/// <summary>
 		/// Launches MPF in the background and connects to it via gRPC.
 		/// </summary>

VisualPinball.Engine.Mpf/MpfClient.cs

@@ -46,15 +46,20 @@ public void Connect(string serverIpPort = "127.0.0.1:50051")
 			_client = new MpfHardwareService.MpfHardwareServiceClient(_channel);
 		}
 
-		public void StartGame(Dictionary<string, bool> initialSwitches)
+		public void StartGame(Dictionary<string, bool> initialSwitches, bool handleStream = true)
 		{
 			var ms = new MachineState();
 			foreach (var sw in initialSwitches.Keys) {
 				ms.InitialSwitchStates.Add(sw, initialSwitches[sw]);
 			}
 
-			_commandsThread =  new Thread(() => ReceiveCommands(ms)) { IsBackground = true };
-			_commandsThread.Start();
+			Logger.Info("Starting client...");
+			_commandStream = _client.Start(ms);
+
+			if (handleStream) {
+				_commandsThread = new Thread(ReceiveCommands) { IsBackground = true };
+				_commandsThread.Start();
+			}
 
 			_switchStream = _client.SendSwitchChanges();
 		}
@@ -65,18 +70,12 @@ await _switchStream.RequestStream.WriteAsync(new SwitchChanges
 				{SwitchNumber = swName, SwitchState = swValue});
 		}
 
-		private async void ReceiveCommands(MachineState ms)
+		private async void ReceiveCommands()
 		{
-			Logger.Info("Starting client...");
-			_commandStream = _client.Start(ms);
-
 			Logger.Info("Client started, retrieving commands...");
-			var count = 0;
 			while (await _commandStream.ResponseStream.MoveNext()) {
-
 				var commands = _commandStream.ResponseStream.Current;
 				Logger.Info($"New command: {commands.CommandCase}");
-				count++;
 				switch (commands.CommandCase) {
 					case Commands.CommandOneofCase.None:
 						break;
@@ -110,9 +109,13 @@ public MachineDescription GetMachineDescription()
 			return _client.GetMachineDescription(new EmptyRequest());
 		}
 
-		public void Shutdown() {
-			_commandStream.Dispose();
+		public void Shutdown()
+		{
+			Logger.Info("Shutting down...");
+			_client.Quit(new QuitRequest());
+			_commandStream?.Dispose();
 			_channel.ShutdownAsync().Wait();
+			Logger.Info("All down.");
 		}
 	}
 }