OpenCockpits Hardware (SIOC)

From Manuals
Jump to: navigation, search

1 General information

For the communication with the hardware, a running instance of SIOC software is required.

There are various panels, IOCards and other hardware available from OpenCockpits. This hardware is usually connected to the computer with a standard USB connector. All OpenCockpits hardware uses the OpenCockpits SIOC program to drive the hardware. ProSim737 in turn, talks with the SIOC program.

The SIOC program can be downloaded from the OpenCockpits website, for SIOC Direct connection, SIOC 6 is required.

Currently, there are 2 ways of using OpenCockpits hardware with ProSim

  • SIOC Direct driver (introduced in ProSim v2.x)
  • IOCP connection using SIOC scripts

You can use 2 instances of SIOC running on one computer - one for the SIOC Direct and one for SIOC Script. They need to use different port nr. and you need to make sure there are no conflicts i.e. the SIOC scripts are not trying to access the device IDs that are being used in SIOC direct mode.

It is possible to split the devices (USBs) into multiple computers over the network. You'll need to setup SIOC in a master-slave mode. All slave SIOCs will report to the Master, then the master will connect to ProSim. ProSim will see all network connected modules.

2 SIOC DIRECT

2.1 Suported hardware

2.1.1 USB PnP Devices

  • MCP
  • EFIS
  • CDU
  • Radios (NAV/COM/ADF/XPDR)
  • ASP
  • Fire Panel
  • MIP

2.1.2 Generic Cards

  • USBExpansion
  • USBServos
  • USBOutputs
  • Other generic cards may be supported but not confirmed.

2.2 General configuration

In this way, ProSim is only using SIOC software as bridge to access the hardware. All configuration and assignments are done in ProSim737 System.

SIOC just needs to recognize the hardware connected (must be visible in the "Devices" field) and have an empty script loaded.

  • Start SIOC.
  • Your modules should be visible in SIOC Devices field. Do not change any Device IDX.
  • In ProSim737 System->Config->Configuration->Drivers enable the SIOC Direct driver by filling in the IP address and port of SIOC IOCP server
  • Restart ProSim737 System
  • Now your detected OpenCockpits devices should be visible in the main ProSim737 System window

2.3 MCP

If SIOC direct driver is enabled and configured correctly as described above, the MCP will be recognized and assigned automatically by ProSim737 System.

No configuration neccesary

ProSim737 MCP must be running

2.4 EFIS

If SIOC direct driver is enabled and configured correctly as described above, the EFIS will be recognized automatically by ProSim737 System.

When using only one EFIS, it will be automatically assigned as CAPT and no action is needed.

When using 2 EFIS units, the CAPT EFIS needs to be selected in the SIOC Direct "Advanced" window in ProSim737 System->Config->Configuration->Drivers No other configuration neccesary

2.5 COMM/NAV RADIO

If SIOC direct driver is enabled and configured correctly as described above, the radio devices will be recognized automatically by ProSim737 System.

When using only one of each type (COMM / NAV / ADF...), it will be automatically assigned as CAPT and no action is needed.

When using 2x of the same unit (i.e. 2x COMM radio), the CAPT side needs to be selected in the SIOC Direct "Advanced" window in ProSim737 System->Config->Configuration->Drivers

No other configuration neccesary

2.6 Overhead

Overhead needs to be enabled in the SIOC Direct "Advanced" window in ProSim737 System->Config->Configuration->Drivers

Select "Overhead" tab

Enabled FWD or AFT overhead (or both) and select the ID(s) of corresponding USB Expansion Card

No other configuration neccesary

2.7 MIP

Overhead needs to be enabled in the SIOC Direct "Advanced" window in ProSim737 System->Config->Configuration->Drivers Select "MIP" tab Enabled MIP and select the ID of corresponding USB Expansion Card

2.8 OpenCockpits interface cards

When using non-PnP panels or home build panels, you can still use the interface cards in the SIOC direct mode as generic interface cards.

In that case, you need to configure/assign all the connected inputs/outputs in ProSim737 System->Config->Configuration->Conbined Config

3 IOCP connection (SIOC SCRIPTS)

SIOC contains a scripted language which can be used to write SIOC scripts. A SIOC script is a script that tells SIOC what to do with the buttons, knobs and indicators of the connected hardware. SIOC scripts consist of numbered variables and optional codes. The numbered variables are the storage of SIOC and contain all the data that is transmitted between SIOC and its connected hardware.

Whenever a ProSim737 module communicates with SIOC, it does so by sending and receiving the contents of the numbered variables. In ProSim737 inputs and outputs can be assigned to variables by selection “IOCP” and entering a variable number.

  • Start SIOC
  • In ProSim737 System->Config->Configuration->Drivers enable the IOCP connection driver by filling in the IP address and port of SIOC IOCP server in the "IOCP Server" field
  • Restart ProSim737 System
  • Assign the SIOC variables that ProSim737 should use for input and/or output. This is done in the configuration screen. In the first dropdown “IOCP” should be selected and in the textbox next to it, a variable number should be used. ProSim737 communicates with SIOC by using these variable numbers. What SIOC should do with these numbers is up to the SIOC script that is used. Any number may chosen, as long as it is unique.
  • Create the SIOC script.To help in creating your SIOC script, ProSim737 is able to create a stub script. This script lists all the configured variables in ProSim737 with a standard SIOC line. These SIOC lines should be edited in a text editor to set the correct physical ports on the boards that should be used. The subscript is available from the ProSim737 instructor station. While ProSim737 is running, open a web browser and use the following URL: http://localhost:8080/sioc
  • After the SIOC script has been edited with the correct port numbers, compile it with the SIOC program. To do this, press the CONFIG button in the main SIOC screen. Next, from the Compiler Menu, select “Files” and select the SIOC script that has been edited. The second line should be filled in with required output file. This file usually has an .ssi extension. Next, close the window and press the “Compiler” button.
  • Configure SIOC to run the script. This can be done by editing the sioc.ini file.
  • Restart SIOC to complete the process.

4 Troubleshooting

TBA