Merge pull request #4 from jagobagascon/feature/load-dll-from-sdk-path

simcontroller: find sim connect dll in MSFS SDK path

Author: jagobagascon

README.md

@@ -14,13 +14,15 @@ It exposes an http server where you can connect using your browser (either from
 ## Installation
 You can go to the [releases](https://github.com/jagobagascon/FSControl/releases) page to download the latest FSControl binary. 
 
-You will also need to copy the SimConnect SDK DLL to the folder where you will run FSControl. This DLL is located in `$(MSFS_SDK)\SimConnect SDK\lib`.
+You will also need the SimConnect DLL. It should be installed `$(MSFS_SDK)\SimConnect SDK\lib`.
 
 ## Running
+The application will look for the SimConnect DLL in the current working directory, the path where the FSControl binary is located and also in `C:\MSFS SDK\SimConnect SDK\lib`. If your MSFS SDK is located somewhere else, you can change the search path by using the `-sdk` option.
+
 Executing the downloaded app will start an HTTP server in the port 8080. 
 
 You can run it from the command line and pass the following options:
-- `--address`: The address where the app will be accessed. Set this to `localhost:8080` to disable remote access to the server. Or `:<PORT>` if you just want to customize the port used.
+- `-address`: The address where the app will be accessed. Set this to `localhost:8080` to disable remote access to the server. Or `:<PORT>` if you just want to customize the port used.
 
 > If the windows firewall asks for permission and you want to access the application remotely (a mobile phone or a tablet) you have to allow the application to open the port 8080. Otherwise you can deny its access and still use the app from `localhost:8080`.
 

SimConnect.dll

@@ -4,6 +4,7 @@ import (
 	"context"
 	"flag"
 	"log"
+	"strings"
 
 	"github.com/jagobagascon/FSControl/internal/server"
 	"github.com/peterbourgon/ff/v3"
@@ -17,19 +18,20 @@ func NewServerCommand() *ffcli.Command {
 	cfg := server.NewConfig()
 
 	fs.BoolVar(&cfg.Dev, "dev", cfg.Dev, "This mode lets the server serve files from the disk instead of the embed content to simplify development.")
-	fs.StringVar(&cfg.Address, "address", cfg.Address, "The address where the static files will be served.")
+	fs.StringVar(&cfg.HTTPAddress, "http-addr", cfg.HTTPAddress, "The http address for the UI web server.")
+	fs.StringVar(&cfg.SimSDKLocation, "sdk", cfg.SimSDKLocation, "The path of the Flight Simulator Sim SDK (defaults to 'C\\MSFS SDK').")
 
 	return &ffcli.Command{
 		Name:       fs.Name(),
 		ShortUsage: fs.Name(),
 		ShortHelp:  "Serves an HTML application with controls to interact with MS Flight Simulator 2020 game.",
 		FlagSet:    fs,
-		Options:    []ff.Option{ff.WithConfigFileFlag("config")},
+		Options: []ff.Option{
+			ff.WithConfigFileFlag("config"),
+			ff.WithEnvVarPrefix(strings.ToUpper(fs.Name())),
+		},
 		Exec: func(ctx context.Context, args []string) error {
-			srv, err := server.NewServer(&server.Config{
-				Dev:     cfg.Dev,
-				Address: cfg.Address,
-			})
+			srv, err := server.NewServer(cfg)
 			if err != nil {
 				return err
 			}

internal/cli/cli.go

@@ -22,8 +22,10 @@ type Server struct {
 
 // Config is the configuration for the FSControl server
 type Config struct {
-	Dev     bool
-	Address string
+	Dev         bool
+	HTTPAddress string
+
+	SimSDKLocation string
 }
 
 // NewServer creates a new server
@@ -38,19 +40,26 @@ func NewServer(cfg *Config) (*Server, error) {
 
 	ws, err := webserver.NewServer(&webserver.Config{
 		Dev:                 cfg.Dev,
-		Address:             cfg.Address,
+		HTTPAddress:         cfg.HTTPAddress,
 		ValueChanged:        simValueChanged,
 		ValueChangeRequests: simValueRequest,
 	})
 	if err != nil {
 		return nil, err
 	}
+
+	simcontroller, err := simdata.NewSimController(&simdata.Config{
+		ValueChanged:       simValueChanged,
+		ValueChangeRequest: simValueRequest,
+		SimSDKLocation:     cfg.SimSDKLocation,
+	})
+	if err != nil {
+		return nil, err
+	}
+
 	return &Server{
-		uiServer: ws,
-		simcontroller: simdata.NewSimController(&simdata.Config{
-			ValueChanged:       simValueChanged,
-			ValueChangeRequest: simValueRequest,
-		}),
+		uiServer:        ws,
+		simcontroller:   simcontroller,
 		simValueChanged: simValueChanged,
 		simValueRequest: simValueRequest,
 	}, nil
@@ -59,8 +68,8 @@ func NewServer(cfg *Config) (*Server, error) {
 // NewConfig creates a new configuration
 func NewConfig() *Config {
 	return &Config{
-		Dev:     false,
-		Address: ":8080",
+		Dev:         false,
+		HTTPAddress: ":8080",
 	}
 }
 

internal/server/server.go

@@ -3,13 +3,17 @@ package simdata
 import (
 	"fmt"
 	"log"
+	"path"
 	"sync"
 	"time"
 
 	sim "github.com/grumpypixel/msfs2020-simconnect-go/simconnect"
 	"github.com/jagobagascon/FSControl/internal/event"
 )
 
+const defaultSDKPath = "C:\\MSFS SDK"
+const simConnectPath = "SimConnect SDK\\lib"
+
 type dWordName struct {
 	sim.DWord
 	Name string
@@ -35,10 +39,20 @@ type Controller struct {
 type Config struct {
 	ValueChanged       chan<- SimData
 	ValueChangeRequest <-chan event.ValueChangeRequest
+
+	SimSDKLocation string
 }
 
 // NewSimController creates a new Controller
-func NewSimController(cfg *Config) *Controller {
+func NewSimController(cfg *Config) (*Controller, error) {
+	searchPath := getSimConnectDLLSearchPath(cfg.SimSDKLocation)
+	println(searchPath)
+	// initialize sim connect
+	err := sim.Initialize(searchPath)
+	if err != nil {
+		return nil, err
+	}
+
 	return &Controller{
 		shutdown:           make(chan bool),
 		valueChanged:       cfg.ValueChanged,
@@ -48,7 +62,15 @@ func NewSimController(cfg *Config) *Controller {
 		indexEvent:         0,
 		listEvent:          make(map[sim.DWord]func(sim.DWord)),
 		listSimEvent:       make(map[KeySimEvent]SimEvent),
+	}, nil
+}
+
+func getSimConnectDLLSearchPath(simSDKLocation string) string {
+	sdkPathPath := defaultSDKPath
+	if simSDKLocation != "" {
+		sdkPathPath = simSDKLocation
 	}
+	return path.Clean(sdkPathPath + "\\" + simConnectPath)
 }
 
 // Run executes the controller

internal/simdata/simcontroller.go

@@ -51,7 +51,7 @@ type Server struct {
 type Config struct {
 	Dev bool
 
-	Address string
+	HTTPAddress string
 
 	// receives events from the SIM
 	ValueChanged <-chan simdata.SimData
@@ -72,7 +72,7 @@ func NewServer(cfg *Config) (*Server, error) {
 	return &Server{
 		dev: cfg.Dev,
 		httpServer: &http.Server{
-			Addr: cfg.Address,
+			Addr: cfg.HTTPAddress,
 		},
 		staticFileServer: fs,