Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Checklists (LINK TO POH IN HERE) #3

Open
erikgeo opened this issue Sep 6, 2020 · 25 comments
Open

Checklists (LINK TO POH IN HERE) #3

erikgeo opened this issue Sep 6, 2020 · 25 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@erikgeo
Copy link
Owner

erikgeo commented Sep 6, 2020

Complete checklist XML's

@50North4West
Copy link
Collaborator

bonanza-g36-POH-compressed.pdf

I'm making a start on the Pre-flight checklist on pages 162-167

@50North4West
Copy link
Collaborator

50North4West commented Sep 7, 2020

Hi @TheFrett
What are your thoughts regarding including the emergency and abnormal checklists? I've so far, added each section for the normal procedures following the layout of the POH. I've got as far as the battery voltage checks on the pre-flight so far. Once I get the pre-flight done, I will send a pull request accross.

@erikgeo
Copy link
Owner Author

erikgeo commented Sep 8, 2020

Hey,

I haven't thought about this yet. Someone mentioned it on the forum so I thought lets raise it as an issue to work on later. If you want to pick up this task please go ahead! The POH is a good source. maybe indicate which elements are not working in the sim on the checklist.

Question: do you include interactive elements as well (highlighting switches, moving view etc?)

@Exp232
Copy link

Exp232 commented Sep 8, 2020

@50North4West Thanks for starting work on the checklists. Since no other a/c in the sim lists their emergency procedures, I don't see a reason to with the G36.

@50North4West
Copy link
Collaborator

I'm not great on the flight dynamics modelling so certainly somewhere I can help. I think we have come to as far as we can with the warnings etc.

I've managed so far to use the interactive elements for the pre-flight part. It seems fairly intuitive to make them although their (Asobo's) code is spread out over a number of files which takes a while to find how they do it.

Thoughts on including the non-modeled elements such as Landing Gear Emergency Handcrank ??? Once I finish pre-flight I'll send a pull request.

@Exp232
Copy link

Exp232 commented Sep 8, 2020

It's up to you if you ask me... Personally I'm okay with keeping non-modeled items out, accessibility is still important. I can imagine newcomers being frustrated trying to go through a checklist and coming upon all this stuff they can't find or interact with.

@50North4West
Copy link
Collaborator

I had the same thoughts. I'll leave out non-modelled functions but leave commented code spaces in case we go mad and add some bits and bobs

@50North4West
Copy link
Collaborator

HI All,

Sorry for lack of updates so far; I'm moving house at the moment and trying to snatch time in between packing boxes. Should be in a position to do more effective work from Monday next week.

@erikgeo
Copy link
Owner Author

erikgeo commented Sep 11, 2020

No worries! It's not a job. I work on it when I feel like it to keep it fun. Your work is very much appreciated, I will test the checklist tomorrow!

@50North4West
Copy link
Collaborator

Although always a good way to get out of packing and loading the car ;-)

@erikgeo erikgeo changed the title Checklists Checklists (LINK TO POH IN HERE) Sep 22, 2020
@erikgeo
Copy link
Owner Author

erikgeo commented Sep 29, 2020

@50North4West How much is there to do before v0.5 release do you think?

@50North4West
Copy link
Collaborator

Not much, feedback so far has been good. I've got to remove a few camera changes and I cant seem to get the copilot to recognise the bus2 voltage but other than that I think we're ready with regard an initial checklist release. How have you found them?

I've pretty much finished sections 1 & 2 of the documentation, and checked we can leave the folder in the mod structure without registering it on the json. Do you want to include that as a start?

I'll have a crack after work tonight to sort those last bits, I think @jonas? mentioned a few wording changes...

@erikgeo erikgeo added the documentation Improvements or additions to documentation label Oct 2, 2020
@erikgeo
Copy link
Owner Author

erikgeo commented Oct 15, 2020

Hi Matt,

Since I've added some new working switches, maybe we can include them in the checklist?

  • Annunciator test (<NODE_ID>SAFETY_Push_Annunciator</NODE_ID>) (page 4-7 in POH)

Actually that may be the only one that should be in there (bit of an anticlimax here)

@50North4West
Copy link
Collaborator

50North4West commented Oct 15, 2020

Will do :-)

Do you know what the switch is called?? We get it to highlight with <Instrument Id="LANDING_GEAR_Lever_Gear" /> but I can't find what the switch is called.

Once we have the switch ID and I wonder if we can get a simvar or xmlvar to check whether the lights are on or not.

<Checkpoint Id="PREFLIGHT_ANNUCIATOR">
  <ForceCamera name="Switches" />
  <Clue name="Check the Gear, Gear in Transit and Flap annuciators light up" />
  <CheckpointDesc SubjectTT="Annunciator test" ExpectationTT="Tested" />
  <Test>
    <TestValue>
      <Val SimVarName="xxxxxxxxxx" Units="Boolean" />
    </TestValue>
    <Instrument Id="SAFETY_Push_Annunciator" />
  </Test>
</Checkpoint>

@erikgeo
Copy link
Owner Author

erikgeo commented Oct 15, 2020

Same as NODE_ID, see above.

@50North4West
Copy link
Collaborator

50North4West commented Oct 15, 2020

Thanks - have tried using SAFETY_Push_Annunciator, G36_Annun_Test, and ANNUNCIATOR_TEST as the instrument Id but none of them highlight the switch???

Might need to check which branch you're working on...

@erikgeo
Copy link
Owner Author

erikgeo commented Oct 15, 2020

That's weird. Can't think of another name. The NODE_ID and instrument ID's correspond for all others... Which branch I work on shouldn't matter. I did not change any definitions in the model names. G36_Annun_Test is the name of the custom template (which is in CustomTemplates.xml) and ANNUNCIATOR_TEST is an arbitrary name for the component in the interior.xml.

@50North4West
Copy link
Collaborator

Thanks will carry on trying :-)

@erikgeo
Copy link
Owner Author

erikgeo commented Oct 15, 2020

Can you try for:

ELECTRICAl_Switch_AC
switch_AC_blowerHI
PASSENGER_Switch_CockpitAir
ENGINE_Lever_AlternateAir

These are also former (Inop.) items...

@50North4West
Copy link
Collaborator

Will do, just rebooting the sim :-)

@50North4West
Copy link
Collaborator

None of those have the blue highlight when putting them into the <Instrument Id="SAFETY_Push_Annunciator" /> sadly. I wonder if there is a setting somewhere else in the files?? Will do some digging...

@50North4West
Copy link
Collaborator

Just did some digging through the MSFS code and found the issue.

We need to add a PART_ID to the templates in \ModelBehaviorDefs\G36X\Subtemplates\G36_Subtemplates.xml

E.g.


<Template Name = "G36_pushbutton_xml">
	<DefaultTemplateParameters>
		<SWITCH_POSITION_TYPE>O</SWITCH_POSITION_TYPE>
		<SWITCH_POSITION_VAR>SwitchState</SWITCH_POSITION_VAR>
		<LEFT_SINGLE_CODE></LEFT_SINGLE_CODE>
		<LEFT_LEAVE_CODE></LEFT_LEAVE_CODE>
		<INIT_VALUE>0</INIT_VALUE>
		<ANIMREF_ID>0</ANIMREF_ID>
		<ANIMTIP_0_ON_PERCENT>0</ANIMTIP_0_ON_PERCENT>
		<ANIMTIP_1_ON_PERCENT>1</ANIMTIP_1_ON_PERCENT>
		<PART_ID>g36Test</PART_ID>
	</DefaultTemplateParameters>
	<Component ID="#NODE_ID#" Node="#NODE_ID#">
		<Update Once="True">
			#INIT_VALUE# (&gt;#SWITCH_POSITION_TYPE#:#SWITCH_POSITION_VAR#)
		</Update>
		<UseTemplate Name = "ASOBO_GT_Anim_Code">
			<ANIM_CODE>(#SWITCH_POSITION_TYPE#:#SWITCH_POSITION_VAR#) 100 *</ANIM_CODE>
		</UseTemplate>
		<UseTemplate Name = "ASOBO_GT_AnimTriggers_2SoundEvents">
		</UseTemplate>
		<UseTemplate Name = "ASOBO_GT_Interaction_LeftSingle_Leave_Code">
			<LEFT_SINGLE_CODE>
				(#SWITCH_POSITION_TYPE#:#SWITCH_POSITION_VAR#) ! (&gt;#SWITCH_POSITION_TYPE#:#SWITCH_POSITION_VAR#)
				#LEFT_SINGLE_CODE#
			</LEFT_SINGLE_CODE>
			<LEFT_LEAVE_CODE>
				(#SWITCH_POSITION_TYPE#:#SWITCH_POSITION_VAR#) ! (&gt;#SWITCH_POSITION_TYPE#:#SWITCH_POSITION_VAR#)
				#LEFT_LEAVE_CODE#
			</LEFT_LEAVE_CODE>
		</UseTemplate>
	</Component>
</Template>

I can then put <Instrument Id="g36Test" /> or whatever we want to call it and the instrument/switch highlights! :-)

@erikgeo
Copy link
Owner Author

erikgeo commented Oct 15, 2020

Ah nice, great find! Learned something again about the modelbehavior XML. However, try to add it to the appropriate lines in Interior_Model.xml, like so:

<Component ID="ANNUNCIATOR_TEST">
	<UseTemplate Name="G36_Annun_Test">
		<NODE_ID>SAFETY_Push_Annunciator</NODE_ID>
		<ANIM_NAME>SAFETY_Push_Annunciator</ANIM_NAME>
                <PART_ID>SAFETY_Push_Annunciator</PART_ID>              
	</UseTemplate>			
</Component>

This should be possible since the usedtemplates inherit from the template that calls them. In other words, when the PART_ID is given as argument in the above lines, it will pass the PART_ID to all underlying used templates (including the G36_pushbutton_xml, which is called in G36_Annun_Test). Although this subtemplate is only used by the annunciator test now, I'd like to stick to the format and conventions that Asobo uses. For example: if we have more buttons making use of G36_pushbutton_xml, we have to give the unique PART_ID explicitly like in the above example, so setting a default for this does not make sense as the purpose of the subtemplate is to be applicable to whatever interactive element is passed on to it. As for the name: the PART_ID (if used) is usually the same as NODE_ID and ANIM_NAME from what I've seen so far.

Could you test if this works?

@erikgeo
Copy link
Owner Author

erikgeo commented Oct 15, 2020

I must say that I'm not very consistent either at the moment. For example with regards the the annunciator example I pass NODE_ID and ANIM_NAME as argument in the Interior_Model.xml file and reference them in CustomTemplates as #NODE_ID# and #ANIM_NAME# respectively (which are then passed on the the used subtemplate if applicable), whereas for the landing gear and the flaps I explicitly give the NODE_ID (Not ANIM_NAME because they are only lights) in the CustomTemplates.xml file itself...

Since each custom template is unique to the switch/function they reference, I should probably move the NODE_ID and ANIM_NAME there (as well as PART_ID if we start adding those), such that I only have to call the templates with no arguments in the interior model file.

@50North4West
Copy link
Collaborator

50North4West commented Oct 16, 2020

try to add it to the appropriate lines in Interior_Model.xml, like so:

Hey @TheFrett, yep that works :-) I added it to Bonanza_g36_interior.xml as you mentioned in the snippet and can confirm all works as you thought. I think my orignial pull request has updated with the code???

erikgeo pushed a commit that referenced this issue Nov 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants