simgo

package module
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 5, 2023 License: GPL-3.0 Imports: 16 Imported by: 0

README

SimGo Connect

Current version: v1.0.0

Library provides abilitu to connect Microsoft Flight Simulator 2020 using SimConnect (SimConnect.dll) and get/set data from/to it.

Written in Go.

Features:

  • built-in web sockets
  • re-connection in case of any stucks
  • predefined set of variables which will be enough for the first use, but this list is fully customizable

ToDo:

  • work with SimConnect events
  • work w/o web sockets

Getting Started

Make sure that you have copy of SimConnect.dll on root of your go project (you can copy dll provided in this repo). Otherwise you will get an error.

func main() {
    
    sim := simgo.NewSimGo(logging.MustGetLogger("simgo"))
    
    if err := sim.StartWebSocket(":4050"); err != nil {
       panic(err.Error())
    }

    sim.TrackWithRecover("simgo", simgo.Report{}, 5, 1)

    ...

You will set connection to Microsoft Flight Simulator 2020 and get notifications like this:

    ...
    go func() {
        for {
            select {
            case result := <-sim.TrackEvent:
                report := result.(simgo.Report)
                ...
                // do your stuff here
                ...
            }
        }
    }()
}

Known Projects

Documentation

Index

Constants

View Source 
const (
	MSFS_CONNECTION_READY = "msfs_connection_ready"
	AIRCARFT_POSITION     = "aircraft_position"
	AIRCARFT_STATE        = "aircraft_state"
	SYSTEM_STATE          = "system_state"
	FLIGHT_DATA           = "flight_data"
	LANDING_REPORT        = "passcargo_landing"
	FAILURE_REPORT        = "passcargo_failures"
)
View Source 
const FORCIBLY_CLOSED_CONNECTION = "An existing connection was forcibly closed by the remote host"

Variables

This section is empty.

Functions

func EventNotification 

func EventNotification(event string) map[string]interface{}

Types

type FSUIPC_Command added in v1.1.0 

type FSUIPC_Command struct {
	Command  string          `json:"command"`
	Name     string          `json:"name"`
	Offsets  []FSUIPC_Offset `json:"offsets,omitempty"`
	Interval int             `json:"interval,omitempty"`
}

type FSUIPC_Command_Payload added in v1.1.0 

type FSUIPC_Command_Payload struct {
	Command    string `json:"command"`
	WeightUnit string `json:"weightUnit"`
	VolumeUnit string `json:"volumeUnit"`
	LengthUnit string `json:"lengthUnit"`
	Interval   int    `json:"interval,omitempty"`
}

type FSUIPC_FuelTank added in v1.1.0 

type FSUIPC_FuelTank struct {
	Index          int     `json:"index"`
	Name           string  `json:"name"`
	IsPresent      bool    `json:"isPresent"`
	Weight         float64 `json:"weight"`
	Volume         float64 `json:"volume"`
	Percent        float64 `json:"percent"`
	CapacityWeight float64 `json:"capacityWeight"`
	CapacityVolume float64 `json:"capacityVolume"`
}

type FSUIPC_Offset added in v1.1.0 

type FSUIPC_Offset struct {
	Name    string `json:"name"`
	Address uint32 `json:"address"`
	Type    string `json:"type"`
	Size    int    `json:"size"`
}

type FSUIPC_Offset_Payload added in v1.1.0 

type FSUIPC_Offset_Payload struct {
	WeightUnit              string                   `json:"weightUnit"`
	VolumeUnit              string                   `json:"volumeUnit"`
	LengthUnit              string                   `json:"lengthUnit"`
	GrossWeight             float64                  `json:"grossWeight"`
	MaxGrossWeight          float64                  `json:"maxGrossWeight"`
	EmptyWeight             float64                  `json:"emptyWeight"`
	TotalPayloadWeight      float64                  `json:"totalPayloadWeight"`
	TotalFuelWeight         float64                  `json:"totalFuelWeight"`
	TotalFuelVolume         float64                  `json:"totalFuelVolume"`
	TotalFuelCapacityWeight float64                  `json:"totalFuelCapacityWeight"`
	TotalFuelCapacityVolume float64                  `json:"totalFuelCapacityVolume"`
	TotalFuelPercent        float64                  `json:"totalFuelPercent"`
	FuelTanks               []FSUIPC_FuelTank        `json:"fuelTanks"`
	PayloadStations         []FSUIPC_PayloadStations `json:"payloadStations"`
}

func (*FSUIPC_Offset_Payload) LoadFromMap added in v1.1.0 

func (c *FSUIPC_Offset_Payload) LoadFromMap(m map[string]interface{}) error

type FSUIPC_PayloadStations added in v1.1.0 

type FSUIPC_PayloadStations struct {
	Index    int                `json:"index"`
	Name     string             `json:"name"`
	Weight   float64            `json:"weight"`
	Position map[string]float64 `json:"position"`
}

type FSUIPC_Response added in v1.1.0 

type FSUIPC_Response struct {
	Success      bool                   `json:"success"`
	Command      string                 `json:"command"`
	Name         string                 `json:"name"`
	ErrorCode    string                 `json:"errorCode"`
	ErrorMessage string                 `json:"errorMessage"`
	Data         map[string]interface{} `json:"data"`
}

type FlightEntry 

type FlightEntry struct {
	Payload string `json:"payload"`
}

type Offsets added in v1.1.0 

type Offsets struct {
	Agl                  float64      `address:"0x6020" type:"float" size:"8" fsuipc:"feet"`
	Alt                  int64        `address:"0x0570" type:"int" size:"8" fsuipc:"fractional"`
	AltRadio             int64        `address:"0x31E4" type:"int" size:"4" fsuipc:"radio"`
	AltIndicated         int64        `address:"0x3324" type:"uint" size:"4"`
	Lat                  float64      `address:"0x0560" type:"int" size:"8" fsuipc:"lat"`
	Lon                  float64      `address:"0x0568" type:"int" size:"8" fsuipc:"lng"`
	Heading              float64      `address:"0x0580" type:"uint" size:"4" fsuipc:"degrees"`
	MagVar               float64      `address:"0x02A0" type:"int" size:"2" fsuipc:"magvar"`
	Airspeed             int          `address:"0x02BC" type:"int" size:"4" fsuipc:"knots"`
	AirspeedTrue         int          `address:"0x02B8" type:"int" size:"4" fsuipc:"knots"`
	AirspeedMach         float64      `address:"0x11C6" type:"uint" size:"2" fsuipc:"mach"`
	VerticalSpeed        int          `address:"0x02C8" type:"int" size:"4" fsuipc:"ftm"`
	FlapsLeft            int          `address:"0x0BE0" type:"int" size:"4" fsuipc:"position"`
	FlapsRight           int          `address:"0x0BE4" type:"int" size:"4" fsuipc:"position"`
	ElevatorTrim         float64      `address:"0x0BC0" type:"int" size:"2" fsuipc:"percent"`
	RudderTrim           float64      `address:"0x0C04" type:"int" size:"2" fsuipc:"percent"`
	AleronTrim           float64      `address:"0x0C02" type:"int" size:"2" fsuipc:"percent"`
	Pitch                float64      `address:"0x0578" type:"int" size:"4" fsuipc:"degrees"`
	Bank                 float64      `address:"0x057C" type:"int" size:"4" fsuipc:"degrees"`
	AmbientWindDirection float64      `address:"0x3490" type:"float" size:"8" fsuipc:"wind"`
	AmbientWindVelocity  float64      `address:"0x0E90" type:"int" size:"2"`
	AmbientTemperature   float64      `address:"0x34A8" type:"float" size:"8"`
	SurfaceType          int          `address:"0x31E8" type:"int" size:"4"`
	SurfaceCondition     int          `address:"0x31EC" type:"int" size:"4"`
	GroundVelocity       int          `address:"0x02B4" type:"int" size:"4" fsuipc:"velocity"`
	Title                string       `address:"0x3D00" type:"string" size:"256"`
	OnGround             int          `address:"0x0366" type:"uint" size:"2" fsuipc:"bool"`
	APUSwitch            int          `address:"0x029D" type:"uint" size:"1" fsuipc:"bool"`
	BatterySwitch        int          `address:"0x281C" type:"uint" size:"4" fsuipc:"bool"`
	ExtPowerOn           int          `address:"0x07AB" type:"uint" size:"1" fsuipc:"bool"`
	IsDoorsOpen          int          `address:"0x2A70" type:"uint" size:"8" fsuipc:"bool"`
	Lights               map[int]bool `address:"0x0D0C" type:"bits" size:"2" fsuipc:"bits"`
	FastenSeatBealts     int          `address:"0x341D" type:"int" size:"1" fsuipc:"bool"`
	NoSmoking            int          `address:"0x341C" type:"int" size:"1" fsuipc:"bool"`
	StallWarning         int          `address:"0x036C" type:"int" size:"1" fsuipc:"bool"`
	OverspeedWarning     int          `address:"0x036D" type:"int" size:"1" fsuipc:"bool"`
	InParkingState       int          `address:"0x062B" type:"int" size:"1" fsuipc:"bool"`
	BrakeParkingPosition int          `address:"0x0BC8" type:"int" size:"2"`
	BrakeIndicator       int          `address:"0x0BCA" type:"int" size:"2"`
	PushbackAngle        float64      `address:"0x0334" type:"int" size:"4" fsuipc:"degrees"`
	PushbackStatus       int          `address:"0x31F0" type:"int" size:"4"`
	GearHandlePosition   int          `address:"0x0BE8" type:"int" size:"4" fsuipc:"position"`
	GForce               float64      `address:"0x11BA" type:"int" size:"2" fsuipc:"GForce"`
	NumberOfEngines      int          `address:"0x0AEC" type:"int" size:"2"`
	Engine1Combustion    int          `address:"0x0894" type:"int" size:"2" fsuipc:"bool"`
	Engine2Combustion    int          `address:"0x092C" type:"int" size:"2" fsuipc:"bool"`
	Engine3Combustion    int          `address:"0x09C4" type:"int" size:"2" fsuipc:"bool"`
	Engine4Combustion    int          `address:"0x0A5C" type:"int" size:"2" fsuipc:"bool"`
	EngineFailed         map[int]bool `address:"0x0B6B" type:"bits" size:"1" fsuipc:"bits"`
	Engine1TurbN1        int          `address:"0x0898" type:"int" size:"2" fsuipc:"percent"`
	Engine2TurbN1        int          `address:"0x0930" type:"int" size:"2" fsuipc:"percent"`
	Engine3TurbN1        int          `address:"0x09C8" type:"int" size:"2" fsuipc:"percent"`
	Engine4TurbN1        int          `address:"0x0A60" type:"int" size:"2" fsuipc:"percent"`
	Engine1TurbN2        int          `address:"0x0896" type:"int" size:"2" fsuipc:"percent"`
	Engine2TurbN2        int          `address:"0x092E" type:"int" size:"2" fsuipc:"percent"`
	Engine3TurbN2        int          `address:"0x09C6" type:"int" size:"2" fsuipc:"percent"`
	Engine4TurbN2        int          `address:"0x0A5E" type:"int" size:"2" fsuipc:"percent"`
	LocalTime            int          `address:"0x023A" type:"int" size:"1"`
	ZuluHour             int          `address:"0x023B" type:"int" size:"1"`
	ZuluMinute           int          `address:"0x023C" type:"int" size:"1"`
	ZuluDayOfWeek        int          `address:"0x0243" type:"int" size:"1"`
	ZuluDayOfMonth       int          `address:"0x023D" type:"int" size:"1"`
	ZuluMonthOfYear      int          `address:"0x0242" type:"int" size:"1"`
	ZuluDayOfYear        int          `address:"0x023E" type:"int" size:"2"`
	ZuluYear             int          `address:"0x0240" type:"int" size:"2"`
	UnitsOfMeasure       int          `address:"0x0C18" type:"int" size:"2"`
}

func (*Offsets) LoadFromMap added in v1.1.0 

func (c *Offsets) LoadFromMap(m map[string]interface{}) error

type Provider added in v1.1.0 

type Provider string
const (
	SimConnect Provider = "SimConnect"
	FSUIPC     Provider = "FSUIPC"
)

type Report 

type Report struct {
	Agl                  int
	Alt                  int
	AltRadio             int
	AltIndicated         int
	Lat                  float64
	Lon                  float64
	Heading              float64
	MagVar               float64
	Airspeed             int
	AirspeedTrue         int
	AirspeedMach         float64
	VerticalSpeed        int
	FlapsLeft            int
	FlapsRight           int
	ElevatorTrim         float64
	RudderTrim           float64
	AleronTrim           float64
	AmbientWindDirection float64
	AmbientWindVelocity  float64
	AmbientTemperature   float64
	SurfaceType          int
	SurfaceCondition     int
	GroundVelocity       int
	Pitch                float64
	Bank                 float64
	Title                string
	OnGround             bool
	APUSwitch            bool
	BatterySwitch        bool
	ExtPowerOn           bool
	IsDoorsOpen          bool
	BrakeParkingPosition int
	BrakeIndicator       int
	Lights               map[int]bool
	LightsNav            bool
	LightsBeacon         bool
	LightsLanding        bool
	LightsTaxi           bool
	LightsStrobe         bool
	LightsInstruments    bool
	LightsRecognition    bool
	LightsWing           bool
	LightsCabin          bool
	FastenSeatBealts     bool
	NoSmoking            bool
	StallWarning         bool
	OverspeedWarning     bool
	InParkingState       bool
	PushbackAngle        float64
	PushbackStatus       int
	GearHandlePosition   int
	GForce               float64
	NumberOfEngines      int
	Engine1Combustion    bool
	Engine2Combustion    bool
	Engine3Combustion    bool
	Engine4Combustion    bool
	EngineFailed         map[int]bool
	Engine1Failed        bool
	Engine2Failed        bool
	Engine3Failed        bool
	Engine4Failed        bool
	Engine1TurbN1        float64
	Engine2TurbN1        float64
	Engine3TurbN1        float64
	Engine4TurbN1        float64
	Engine1TurbN2        float64
	Engine2TurbN2        float64
	Engine3TurbN2        float64
	Engine4TurbN2        float64
	UnitsOfMeasure       int
	LocalTime            int
	ZuluHour             int
	ZuluMinute           int
	ZuluDayOfWeek        int
	ZuluDayOfMonth       int
	ZuluMonthOfYear      int
	ZuluDayOfYear        int
	ZuluYear             int
}

type SimGo 

type SimGo struct {
	Error      chan error
	State      chan int
	Connection <-chan bool
	TrackEvent chan interface{}
	TrackPause chan bool
	TrackCrash <-chan bool
	Logger     *logging.Logger
	Socket     *websockets.Websocket
	Context    context.Context
	WS         *websocket.Conn
	Provider   Provider
	Alive      bool
}

func NewSimGo 

func NewSimGo(logger *logging.Logger, provider Provider) *SimGo

creates new simgo instance

func (*SimGo) FSUIPC added in v1.1.0 

func (s *SimGo) FSUIPC(ctx context.Context, host string) error

func (*SimGo) FSUIPC_Close added in v1.1.0 

func (s *SimGo) FSUIPC_Close()

func (*SimGo) FSUIPC_Remap added in v1.1.0 

func (s *SimGo) FSUIPC_Remap(val reflect.Value) []FSUIPC_Offset

func (*SimGo) FSUIPC_ToInterface added in v1.1.0 

func (s *SimGo) FSUIPC_ToInterface(data Offsets, dst reflect.Value) interface{}

func (*SimGo) OffsetPolling added in v1.1.0 

func (s *SimGo) OffsetPolling(name string, report interface{}, interval int) error

func (*SimGo) Payload added in v1.1.0 

func (s *SimGo) Payload(interval int) error

func (*SimGo) ReadData added in v1.1.0 

func (s *SimGo) ReadData(name string, v interface{}, eventChan chan interface{}, payloadChan chan interface{})

func (*SimGo) StartWebSocket 

func (s *SimGo) StartWebSocket(httpListen string) error

starts web socket server on given host and port

func (*SimGo) TrackWithRecover 

func (s *SimGo) TrackWithRecover(name string, report interface{}, maxTries int, trackID int)

Source Files

View all Source files

Directories

Path Synopsis
Package simconnect is a binding for FS2020 ✈️ in GO.
 Package simconnect is a binding for FS2020 ✈️ in GO.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.