Oakes SIOC Export/Import Scripts

Attached is my somewhat generic solution for export/import to SIOC / OpenCockpits cards. Some knowledge of programming is needed to make the scripts work.

General idea has been to keep most of the complicated stuff out of Export.lua and into a bunch of support functions + definition files to make it easier for myself and other to connect the appropriate switches, LED's etc to their simulated counterparts.

This version supports:

1. Inputs with specific function calls for each SIOC parameter. Comes with ready made functions for "two position switches" and "rotaries".
   
2. Simple on/off indicator output, cockpit LEDs, warning lamps etc.
   

Usage:

1. Install by unpacking and overwrite into the Export directory of DSC:BS. Note: Make a backup.
   
2. Configure you SIOC server host ip and port in siocConfig.lua
   
3. Configure your inputs/outputs in the appropriate files in the SIOCConfig directory.
   
4. Configure the options in the USER SETUP SECTION of Export.lua This section needs to match the files etc in the SIOCCONFIG directory.
   

Future work:

1. Add support for rotary encoders.
   
2. Add support for instruments (altimeter etc)
   
3. Add support for selected weapon.
   
4. Add support for Nav system display
   

Enjoy:thumbup:

Thanks to PanelBuilder for the help.

/Oakes

Update:

I've created a Google Project to keep tabs on the code for the scripts. Future releases will be posted there.

http://code.google.com/p/dcsbsexport/

If you want access to the code you can

1. use http://tortoisesvn.tigris.org/ for simple export to your computer

2. you can download complete releases from http://code.google.com/p/dcsbsexport/downloads/list

3. You can download individual files from the repository via the source code browser http://code.google.com/p/dcsbsexport/source/browse/ (click on the file and then right click on the "View raw" link).

/Oakes

Export_0_90_beta.zip

thank you very much! :)

Thank you very much. :thumbup:

This is great! Thanks a lot!

Cheers,

Pogo

yeah !

to be continued !!!

i just wanted to make sure i didnt miss anything...

WILL THIS STUFF FUNCTION IF .LUA import/export is TURNED OFF on the server?

no Hannibal.

intr 3 pos

any idea on how to program a 3 positions inter of this type : Momentary on / off / Momentary on ?

and for later on, how about encoders ?

I think Oakes is occupied, but could be appreciated if he advised us about what he is working on , what he will work on later, and what he won't work on at all, so other people could help without wasting time doing the same thing two times...

best regards to great work already achieved

hum... sorry didn't saw that one : http://forums.eagle.ru/showthread.php?t=45564

but other questions still pertinent

any idea on how to program a 3 positions inter of this type : Momentary on / off / Momentary on ?

 

 

and for later on, how about encoders ?

 

I think Oakes is occupied, but could be appreciated if he advised us about what he is working on , what he will work on later, and what he won't work on at all, so other people could help without wasting time doing the same thing two times...

 

best regards to great work already achieved

This will work just fine with the current scripts, from an input perspective a momentary 3 position switch is not different from a non-momentary 3 position switch.

So how do we do this with OC/SIOC?

1. Connect you 3 pos switch to two inputs (say 10 & 11) so that when the switch is up input 10 is activated and when the switch is down input 11 is activated. When you let go of the momentary switch no input is activated.

2. Connect your inputs to 2 variables (say 100 & 101) in SIOC and also create a 3:rd variable (say 102) .

3. Write some SIOC code for 100 and 101 that changes the variable 102 so that when the switch is in the up position 102 = 1, when in the middle position 102 = 2 and when in the down position 102 = 3.

4. Update the inputsTable table (use the SimpleRotary function) with the appropriate values found in clickableData.lua

Currently I'm working on getting the weapons display to function correctly and I've also done some coding for getting instruments to work (servo based, some initial success with the variometer)

Future work:

 

 

1. Add support for rotary encoders.
   
2. Add support for instruments (altimeter etc)
   
3. Add support for selected weapon.
   
4. Add support for Nav system display
   

/Oakes

hum... sorry didn't saw that one : http://forums.eagle.ru/showthread.php?t=45564

 

but other questions still pertinent

That one is for someone not using SIOC /Export.lua etc. if you use SIOC my export script has support for these types of switches as you can see in my post above.

/Oakes

thank you very much, :)

in the name of all SIOC non pro users,

your work is very time saving for us,

and your explanations very clear. :thumbup:

my two cents

http://forums.eagle.ru/showpost.php?p=764486&postcount=30

Hi, from Hellfrog to Oakes

1st question :

I don't understand your files here :

- in weaponsInterfaceIndicators.lua :

why don't you have Device ID = 12 for Weapons panel ?

so that : "[330] = {12,437}," ?

- in dataLinkIndicators.lua

why don't you have Device ID = 25 for DTL panel ?

so that : "[344] = {25,17}," ?

why 0 ?

2d question :

What are the differences and how to adapt inputtables.lua and sioc code for these three different buttons :

type = TUMB

action = {device_commands.Button_1, device_commands.Button_1},

I suppose : (pushed, then on, then off only if released ?)

type = TUMB

action = {device_commands.Button_1), stop_action = {device_commands.Button_1},

I suppose : (pushed, then on, then push again then off)

type = TUMB

action = {device_commands.Button_1, device_commands.Button_1}, stop_action = {},

I suppose : (pushed and released once at a time ? even if maintened ?)

How to input this button ? ("LWS self-test button") elements["L140-CNOB"]

-- {class_type.BTN}

-- action = {device_commands.Button_3},

-- stop_action = {device_commands.Button_4},

?

I suppose creation of 2 interrupts for SIOC :

-- [3603] = {TwoPositionSwitch, 36, 3, 1}

-- [3604] = {TwoPositionSwitch, 36, 4, 1}

How to input this button ? ("CMD Select Left/Both/Right board flares dispensers") elements["UV26-BOARD-PTR"]

-- {class_type.TUMB, class_type.TUMB}

-- action = {device_commands.Button_1, device_commands.Button_2},

-- arg_lim = {{0, 0.2}, {0, 0.2}},

?

I suppose create 2 interrupts for SIOC :

-- [2201] = {TwoPositionSwitch, 22, 1, ???}

-- [2202] = {TwoPositionSwitch, 22, 2, ???}

Hi Hellfrog/simu12011

1st question:

Well, it seems that all indicators are linked to the mainpanel device (deviceID =0) rather than the panel they are actually located at, check mainpanel_init.lua for values.

2nd question:

How to input this button ? ("LWS self-test button") elements["L140-CNOB"]

-- {class_type.BTN}

-- action = {device_commands.Button_3},

-- stop_action = {device_commands.Button_4},

?

I suppose creation of 2 interrupts for SIOC :

-- [3603] = {TwoPositionSwitch, 36, 3, 1}

-- [3604] = {TwoPositionSwitch, 36, 4, 1}

[510] = {SimpleRotary, 12, 4},

The above equals the call SimpleRotary(valueOfSiocParamNbr510, 12, 4)

[3603] = {Hellfrogsfunction, 36, 1, 3, 4},

might be appropriate....

Just remember that you can only have 5 parameters on each line i.e. in the following code 11, 22 and 33 will be ignored

[3603] = {Hellfrogsfunction, 36, 1, 3, 4, 11,22,33},

You can change this by adding more parameters to this line in Export.lua

inputsTable[lSIOC_Param][1](lSIOCValue, inputsTable[lSIOC_Param][2],inputsTable[lSIOC_Param][3],inputsTable[lSIOC_Param][4],inputsTable[lSIOC_Param][5])

How to input this button ? ("CMD Select Left/Both/Right board flares dispensers") elements["UV26-BOARD-PTR"]

-- {class_type.TUMB, class_type.TUMB}

-- action = {device_commands.Button_1, device_commands.Button_2},

-- arg_lim = {{0, 0.2}, {0, 0.2}},

?

I suppose create 2 interrupts for SIOC :

-- [2201] = {TwoPositionSwitch, 22, 1, ???}

-- [2202] = {TwoPositionSwitch, 22, 2, ???}

Make the switch change a SIOC parameter to 1, 2 and 3, code below is for the Burst Lenght switch (same behavior)

Var 0510, name BurstLen, Value 1

Var 0506, name BurstLenShort, Link IOCARD_SW, Input 8
{
 IF &BurstLenShort = 1
 {
   &BurstLen = 1    
 }
 IF &BurstLenShort = 0
 {
   &BurstLen = 2    
 }
}

Var 0507, name BurstLenLong, Link IOCARD_SW, Input 6
{
 IF &BurstLenLong = 1
 {
   &BurstLen = 3    
 }
 IF &BurstLenLong = 0
 {
   &BurstLen = 2    
 }
}

And this line in inputsTables.lua takes care of the DCS side

[510] = {SimpleRotary, 12, 4},

Just let me know if you need any more help.

/Oakes

I've created a Google Project to keep tabs on the code for the scripts. Future releases will be posted there.

http://code.google.com/p/dcsbsexport/

If you want access to the code you can

1. use http://tortoisesvn.tigris.org/ for simple export to your computer

2. you can download complete releases from http://code.google.com/p/dcsbsexport/downloads/list

3. You can download individual files from the repository via the source code browser http://code.google.com/p/dcsbsexport/source/browse/ (click on the file and then right click on the "View raw" link).

/Oakes

you're a prince Mister ;)

for beginners, a modified mainpanel_init.lua file somehow shortened to find easily and quickly values and names for BS main panel lamps, controls and so on...

_BS_mainpanel_vars.zip

New release:

http://code.google.com/p/dcsbsexport/wiki/Beta_0_92

Download:

http://dcsbsexport.googlecode.com/files/Export_0_92_beta.zip

/Oakes

ballistics data settings selector + MastterWarning + SIOC code

I think it is the selector on back right panel, so like a rotary...

If you stay with the below Inputtables.lua code

//    ("Unguided rocket and gun pods ballistics data settings selector") elements["PPK-NRAKS-PTR"]
//    [1223] = {TwoPositionSwitch, 12, 23, 1}, 

how do you implement it in SIOC ?

Why not rotary as viewed ingame? / because of class_type.Tumb (see below clickabledate.lua extract) ?

           // {class_type.TUMB, class_type.TUMB}
           // action = {device_commands.Button_23, device_commands.Button_23}, 
           // arg = {484, 484}, 
           // arg_value = {-direction*0.1, direction*0.1},
           // cycle = false, 
           // arg_lim = {{0, 1.0}, {0, 1.0}}

//    [1201] = {TwoPositionSwitch, 12, 1, 1}, 
//    [1201] = {SimpleRotary, 12, 1}, 

How to input this one ?

 

I think it is the selector on back right panel, so like a rotary...

y= 0 for pos 0

y= 0.1 for pos 1

y= 0.2 for pos 3

.

.

.

y = 1 for pos 10

So, you need to make some SIOC code that based on you inputs sets a parameter to a value between 1 and 11 based on the position of you rotary.

Below is an example for a 4 position rotary (the datalink id rotary of my cockpit). The rotary electrically activates one input per position and performClickableAction thus expects to get 0, 0.1, 02 or 0.3 as it input.

Var 0590, name DL_ID, Value 1

Var 0591, name DL_ID_1, Link IOCARD_SW, Input 28
{
 IF &DL_ID_1 = 1
 {
   &DL_ID = 1    
 }
}

Var 0592, name DL_ID_2, Link IOCARD_SW, Input 30
{
 IF &DL_ID_2 = 1
 {
   &DL_ID = 2    
 }
}

Var 0593, name DL_ID_3, Link IOCARD_SW, Input 31
{
 IF &DL_ID_3 = 1
 {
   &DL_ID = 3    
 }
}

Var 0594, name DL_ID_4, Link IOCARD_SW, Input 34
{
 IF &DL_ID_4 = 1
 {
   &DL_ID = 4    
 }
}

Below is the line from inputsTable for the same rotary.

[590] = {SimpleRotary, [color=Green]25[/color], 14},

[590] = {SimpleRotary, 25, 14} means that the rotary switch is connected to SIOC parameter 590, Device ID is 25 = devices.DATALINK, Button Nbr is 14 = Datalink self ID, whenever the SIOC Param 590 is changed these parameters gets fed into the SimpleRotary function => SimpleRotary(Value of SIOC Parameter 590 (<= 1 to 4), 25, 14). The SimpleRotary function then subtracts 1 from the Value of SIOC Parameter 590 and then divides the reminder by 10 (<= 0 to 0.3). This value the gets sent to the applicable device via the performClickableAction command.

Function below:

function SimpleRotary([color=Red]pValue[/color], [color=Green]pDevice[/color], [color=DarkOrange]pNumber[/color])
   GetDevice([color=Green]pDevice[/color]):performClickableAction([color=DarkOrange]pNumber[/color] + 3000,([color=Red]pValue[/color] - 1)/10)
end

/Oakes

What to do more from this start about MasterWarning SIOC script ?

SIOC:

Var your sioc var for the master warning led/lamp, name masterIndicator, Link IOCARD_OUT, Output ??

lamp_MasterWarning                = CreateGauge()
lamp_MasterWarning.arg_number    = [color=Blue]44[/color]
lamp_MasterWarning.input        = {0.0, 0.3}
lamp_MasterWarning.output        = {0.0, 0.3}
lamp_MasterWarning.controller    = controllers.lamp_MasterWarning

Add this as an indicator in siocConfig (make sure you update to the latest version)

   warningIndicators = {
   [[color=Red]your sioc var for the master warning led/lamp[/color]] = {0,[color=Blue]44[/color]}
}
   gIndicatorTables = {warningIndicators}
 

Master warning pushbutton:

SIOC:

Var your sioc var for the master warning pushbutton, name masterWarning, Link IOCARD_SW, Input ??

elements["CSO-PTR"] = {class = {class_type.BTN}, 
hint = LOCALIZE("Master caution push-light"), 
device = [color=DarkGreen]devices.SYST_CONTROLLER[/color], 
action = {device_commands.Button_[color=DarkOrange]1[/color]}, 
stop_action = {device_commands.Button_1}, 
arg = {44}, arg_value = {[color=Blue]0.2[/color]}, 
arg_lim = {{0.0, 0.2}}, 
use_release_message = {true} }

devices.SYST_CONTROLLER = 14 (from devices.lua)

Put this in inputsTable in siocConfig.lua

[[color=Red]your sioc var for the master warning button[/color]] = {TwoPositionSwitch, [color=Green]14[/color], [color=DarkOrange]1[/color], [color=Blue]0.2[/color]}

/Oakes

many thanks again,

- I've found myself some infos since my last posts ::music_whistling:

- I've just understood :smartass: the logic behind your siocConfig.lua, thanks to your answer :

- For rotaries I wasn't sure about values :

[color=black]GetDevice([/color][color=black]pDevice):performClickableAction([/color][color=black]pNumber + 3000,[/color][color=Blue][b](pValue - 1)/10[/b][/color])

With the same logic about values (integers / decimals) did you find this an absolute valid rule for ALL BS values in clickabledata.lua for arg_value

eg

arg_value = {[color=Blue]0.2[/color]}

or is there exceptions ? :huh:

For MasterWarning :

HOT Start vs COLD Start ? :doh:

:megalol: Joke of the day :

If Shakespeare had a cockpit project, he should have writen :

headache or not Headache... that is the cockpit !

For FRENCH USERS

As not so many french users look at good stuffs here,

I made a specific thread on C6 forums who linked usefull informations for SIOC , Oakes magnificient work, and so on,

here :

http://www.checksix-forums.com/showthread.php?t=155723

If you disagree with that, let me know...

I advised people on 3rdwing who developed LSIOC Server and so on... but few or no feedback at this time... :(

Pour les français,

j'essaie de maintenir sur C6 http://www.checksix-forums.com une page qui recense les liens les plus utiles pour le developpement SIOC et LUA pour les cockpits BS

http://www.checksix-forums.com/showthread.php?t=155723

Nope, no problem at all..but please explain that only the taged(beta, release etc) versions should be downloaded. Stuff from the trunk comes with no guarantee whatsoever:music_whistling:

/Oakes

many thanks again,

 

- I've found myself some infos since my last posts ::music_whistling:

Rotary programmation in SIOC just like you answered with one Var linked to BS via InputTables and other linked to IOCARD_SW for calculations and logics

 

- I've just understood :smartass: the logic behind your siocConfig.lua, thanks to your answer :

I knew where to find infos, but did'nt realized relation between SIOCConfig.lua and these ones

 

I understand SIOCConfig receive Inputs and Outputs adresses tables to link SIOC and BS and vice versa.

 

I understand export.lua script is to create / concatenate strings before sending to, or after receiving from, SIOC

 

I understand that with this birlliant work any process with the ability to communicate over TCP or UDP may exploit these strings. :thumbup::joystick::book:

- For rotaries I wasn't sure about values :

because of

[color=black]GetDevice([/color][color=black]pDevice):performClickableAction([/color][color=black]pNumber + 3000,[/color][color=Blue][b](pValue - 1)/10[/b][/color])

values in SIOC

ssi

file are in

units

,

(SIOC = integers only)

and in

decimals

in

lua

files

right ?

With the same logic about values (integers / decimals) did you find this an absolute valid rule for ALL BS values in clickabledata.lua for arg_value

eg

arg_value = {[color=Blue]0.2[/color]}

or is there exceptions ? :huh:

Sioc only supports integers as far as I know. LUA supports all kinds of values but is seem like DCS rotaries and buttons with leds work with decimals while regular switches are just 0 or 1 for on off.

Exceptions, maybe, I've only done buttons for the datalink and weapons panel so far. But as you know users can write their own special functions for inputTables.

My goal for the scripts are to run my cockpit so I probably won't do support for anything that I don't need. Of course if someone want's to help with adding support for something that is fine. Right now I could use some help with identify all the different weapons types in DCS:BS (for the weaponsIndicator.lua file).

- did you have reflexion about a good way to know if you launch BS in cold pit or hot pit or inflight or at ground ?

 

- how to know that with consistency form BS ?

- what about the delay between launching mission and time everything is OK ?

- and therefore it should be usefull to develop a

Var 0 Value 0 SIOC script

for initiating cockpit status on startup of BS mission... to have not to resynchronize

- there is also the 'quick start' and 'quick shutoff' 'cheats' which may cause problem ?

When you first connect DCS to SIOC you tell SIOC which variables you are interested in and SIOC then sends the status for all these variables. If you disregard this answer then the switches of the virtual cockpit will remain in their startup position but of course they might not match with the physical switches (not until you manipulate your physical switch that is).

/Oakes