manual:gameplugins:voiceattack
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
manual:gameplugins:voiceattack [2016/09/21 23:14] c0nnex |
manual:gameplugins:voiceattack [2017/07/23 14:54] (current) c0nnex [SetValue] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== SPAD.neXt VoiceAttack plugin ====== | ====== SPAD.neXt VoiceAttack plugin ====== | ||
| - | [[http://voicettack.com|VoiceAttack]] >= 1.5.12.17 (Current Beta) required! | + | [[http://voiceattack.com|VoiceAttack]] >= 1.5.12.24 (Beta) required! |
| * Quit VoiceAttack | * Quit VoiceAttack | ||
| * In <VoiceAttackInstallDir>\Apps create a directory "SPAD.neXt" | * In <VoiceAttackInstallDir>\Apps create a directory "SPAD.neXt" | ||
| * Copy "GamePlugins\Voiceattack\snVoiceAttack_plugin.dll" to that Directory | * Copy "GamePlugins\Voiceattack\snVoiceAttack_plugin.dll" to that Directory | ||
| + | |||
| + | For the plugin to work you will need to enable Apps in VoiceAttack. | ||
| + | |||
| + | VoiceAttack and SPAD.neXt need to run on the same computer. | ||
| ===== General ===== | ===== General ===== | ||
| The plugin will use the variables ''snSTATUS'' ("OK" or "ERROR") to signal if the call was successful.\\ | The plugin will use the variables ''snSTATUS'' ("OK" or "ERROR") to signal if the call was successful.\\ | ||
| if ''snSTATUS'' is "ERROR" the variable ''snMESSAGE'' will contain the error message.\\ | if ''snSTATUS'' is "ERROR" the variable ''snMESSAGE'' will contain the error message.\\ | ||
| + | |||
| + | using the boolean-variable ''snDEBUG'' you can toggle debug output of the plugin on and off.\\ | ||
| + | using the boolean-variable ''snVERBOSE'' you can toggle on or off if the plugin shall log all commands to the console.\\ | ||
| + | (sn-Variables have to be set before the SPAD.neXt plugin is called to become active) | ||
| Always set the checkbox at "Wait for plugin function to finish"!\\ | Always set the checkbox at "Wait for plugin function to finish"!\\ | ||
| + | All SPAD.neXt Data accessed from VA must be in the form ''PROVIDER!Name''. | ||
| + | In SPAD.neXt the Data will be named ''PROVIDER:Name''. You will have to replace all '':'' by a ''!'' | ||
| + | |||
| + | ''Provider'' can be one of | ||
| + | * LOCAL = Local Variables | ||
| + | * LVAR = a LVAR Variable | ||
| + | * SIMCONNECT = a Simmconnect Data or Event | ||
| + | * PMDG737/PMDG747/PMDG777 = a PMDG Special Data Value/Event | ||
| + | * XPLANE = a XPLANE data or command | ||
| + | * SYSTEM = a SPAD.next System data or event | ||
| + | * FSUIPC = a FSUIPC Offset (FSUIPC!0000!0000 Replace all ':' by '!') | ||
| + | * SCS/IRACING = A ETS2/ATS/iRacing Data | ||
| ===== Functions ===== | ===== Functions ===== | ||
| Available "context" values for VoiceAttack: | Available "context" values for VoiceAttack: | ||
| Line 19: | Line 39: | ||
| Retrieve a variable Value from SPAD.neXt.\\ | Retrieve a variable Value from SPAD.neXt.\\ | ||
| Input: \\ | Input: \\ | ||
| - | ''snVariableName'' to contain the full variable name from SPAD.neXt (e.g. ''LOCAL!SYSTEM READY''). Given in textVariables \\ | + | decimal ''VariableName'' to contain the full variable name from SPAD.neXt (e.g. ''LOCAL!SYSTEM READY''). Given in decimalVariables \\ |
| **Important**: all '':'' (colon) need to be replaced by ''!'' (exclamation mark) due to a limitation of VoiceAttack | **Important**: all '':'' (colon) need to be replaced by ''!'' (exclamation mark) due to a limitation of VoiceAttack | ||
| \\ | \\ | ||
| Output:\\ | Output:\\ | ||
| - | A variable named like the value you queried (e.g. ''LOCAL!SYSTEM READY'') will contain the variable value.\\ **Important**: all '':'' (colon) will be replaced by ''!'' (exclamation mark) due to a limitation of VoiceAttack | + | The variable named like the value you queried (e.g. ''LOCAL!SYSTEM READY'') will contain the variable value.\\ **Important**: all '':'' (colon) will be replaced by ''!'' (exclamation mark) due to a limitation of VoiceAttack |
| - | {{:manual:gameplugins:va_set_variable.png?200|}} | ||
| {{:manual:gameplugins:execute_getvalue.png?200|}} | {{:manual:gameplugins:execute_getvalue.png?200|}} | ||
| ==== SetValue ==== | ==== SetValue ==== | ||
| - | Set a variable value within SPAD.neXt\\ | + | Set a variable value within SPAD.neXt or raise a simulation event\\ |
| \\ | \\ | ||
| Input:\\ | Input:\\ | ||
| - | ''snVariableName'' to contain the full variable name from SPAD.neXt (e.g. ''LOCAL!SYSTEM READY''). Given in textVariables \\ | ||
| - | **Important**: all '':'' (colon) need to be replaced by ''!'' (exclamation mark) due to a limitation of VoiceAttack | ||
| - | |||
| decimal ''variableName'' (e.g. ''LOCAL!SYSTEM READY'') needs to contain the new value\\ | decimal ''variableName'' (e.g. ''LOCAL!SYSTEM READY'') needs to contain the new value\\ | ||
| - | **Important**: all '':'' (colon) need to be replaced by ''!'' (exclamation mark) due to a limitation of VoiceAttack | + | **Important**: all '':'' (colon) need to be replaced by ''!'' (exclamation mark) due to a limitation of VoiceAttack\\ |
| + | To raise [[manual:gameplugins:voiceattack:pmdgevents|PMDG Special events]] see this table. | ||
| - | {{:manual:gameplugins:execute_setvalue.png?200|}} | ||
| {{:manual:gameplugins:va_set_decimal.png?200|}} | {{:manual:gameplugins:va_set_decimal.png?200|}} | ||
| {{:manual:gameplugins:execute_setvalue.png?200|}} | {{:manual:gameplugins:execute_setvalue.png?200|}} | ||
| ==== EmulateEvent ==== | ==== EmulateEvent ==== | ||
| - | Not yet supported\\ | + | Execute an event within SPAD.neXt\\ |
| + | \\ | ||
| + | {{:manual:gameplugins:vaemulate.png?200|}} | ||
| + | |||
| + | Following textvariables need to filled and passed to the call:\\ | ||
| + | \\ | ||
| + | ''snDevice'' must contain the target device (e.g. '06A3:0D06:0' for the first Multi-Panel in system\\ | ||
| + | ''snSwitch'' must contain the name of the switch the event shall be executed on (e.g. 'MULTIPANEL_BUTTON_AP' for the Autopilot button\\ | ||
| + | ''snEvent'' must contain the name of the event to execute (e.g. 'VALUEON' to emulate a short press )\\ | ||
| + | ''snParameter'' must contain the parameter needed by the event , if any\\ | ||
| + | |||
| + | |||
| + | To get an overview of the Devices/Swtches/Events available on you system, in SPAD.neXt navigate to ''Settings->Application->Expert'' and press the little gear next to the "Remote Service"-Setting. | ||
| + | It will generate a PDF-Document for your system. | ||
| + | |||
| + | You can preview a sample of this document here: {{:manual:gameplugins:devicedocsample.pdf|}} | ||
| - | ==== Source Code ==== | + | ===== Demo profile ===== |
| + | {{:manual:gameplugins:spad_demo_profile-profile.zip|}} | ||
| + | ===== Source Code ===== | ||
| For your reference the source code of the plugin is available at [[https://github.com/c0nnex/SPAD.neXt/tree/master/GamePlugins/VoiceAttack|GitHub SPAD.neXt Public Code]] | For your reference the source code of the plugin is available at [[https://github.com/c0nnex/SPAD.neXt/tree/master/GamePlugins/VoiceAttack|GitHub SPAD.neXt Public Code]] | ||
manual/gameplugins/voiceattack.1474492457.txt.gz · Last modified: 2016/09/21 23:14 by c0nnex
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 3.0 Unported
