https://shergoodaviation.com/wiki/api.php?action=feedcontributions&user=Kelly&feedformat=atom - User contributions [en]2024-03-29T02:17:05ZUser contributionsMediaWiki 1.31.0https://shergoodaviation.com/wiki/index.php?title=MD-500D&diff=5687MD-500D2023-10-09T00:43:05Z<p>Kelly: </p>
<hr />
<div>{| class=sa-infobox style="float: right;"<br />
|<br />
<div style='text-align: center; line-height: 130%;'><br />
<span style="font-size: 150%">'''MD-500D'''</span><br><br />
</div><br />
|-<br />
|<br />
[[File:Md500d.jpg|350px]]<br />
|-<br />
|<br />
----<br />
|-<br />
|<br />
<br />
{| class=sa-infotable<br />
|Role||Utility<br />
|-<br />
|Manufacturer||Hughs/MD<br />
|-<br />
|SL First Flight||1976<br />
|-<br />
|SL Introduction||TBD<br />
|-<br />
|GTFO Code|| SAKS321002MD500D<br />
|}<br />
<br />
|}<br />
<br />
Description TBD<br />
<br />
The SAFE (Shergood Aviation Flight Engine) engine driving this virtual reproduction is the most advanced and realistic in SL., developed by an RL helicopter pilot The engine is purely physics based and features independent control of cyclic, collective and anti-torque pedals. Many real-world helicopter effects are also modeled as part of the engine including translational lift, translating tendency, ground effect, main rotor torque and vortex ring state.<br />
<br />
<h1>Master Contents</h1><br />
<br />
<div style="font-size: 130%;"><br />
{|<br />
|style="width: 50%; vertical-align: text-top;"|<br />
# [[MD-500D/General|General]]<br />
|}<br />
</div><br />
<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Credits</div><br />
----<br />
* Sounds - Lorin Tone<br />
* Flight Testing, Design - Tsukino Usagi (tsukino.firethorn)<br />
* Design, Mesh, Textures and Scripting - Kelly Shergood<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Links</div><br />
----<br />
* [[MD-500D|Release Notes]]</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=MD-500D&diff=5686MD-500D2023-09-02T17:53:53Z<p>Kelly: </p>
<hr />
<div>{| class=sa-infobox style="float: right;"<br />
|<br />
<div style='text-align: center; line-height: 130%;'><br />
<span style="font-size: 150%">'''MD-500D'''</span><br><br />
</div><br />
|-<br />
|<br />
[[File:Md500d.jpg|350px]]<br />
|-<br />
|<br />
----<br />
|-<br />
|<br />
<br />
{| class=sa-infotable<br />
|Role||Utility<br />
|-<br />
|Manufacturer||Hughs/MD<br />
|-<br />
|SL First Flight||1976<br />
|-<br />
|SL Introduction||TBD<br />
|-<br />
|GTFO Code|| TBD<br />
|}<br />
<br />
|}<br />
<br />
Description TBD<br />
<br />
The SAFE (Shergood Aviation Flight Engine) engine driving this virtual reproduction is the most advanced and realistic in SL., developed by an RL helicopter pilot The engine is purely physics based and features independent control of cyclic, collective and anti-torque pedals. Many real-world helicopter effects are also modeled as part of the engine including translational lift, translating tendency, ground effect, main rotor torque and vortex ring state.<br />
<br />
<h1>Master Contents</h1><br />
<br />
<div style="font-size: 130%;"><br />
{|<br />
|style="width: 50%; vertical-align: text-top;"|<br />
# [[MD-500D/General|General]]<br />
|}<br />
</div><br />
<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Credits</div><br />
----<br />
* Sounds - Lorin Tone<br />
* Flight Testing, Design - Tsukino Usagi (tsukino.firethorn)<br />
* Design, Mesh, Textures and Scripting - Kelly Shergood<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Links</div><br />
----<br />
* [[MD-500D|Release Notes]]</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=MD-500D&diff=5685MD-500D2023-09-02T17:53:38Z<p>Kelly: </p>
<hr />
<div>{| class=sa-infobox style="float: right;"<br />
|<br />
<div style='text-align: center; line-height: 130%;'><br />
<span style="font-size: 150%">'''MD-500D'''</span><br><br />
</div><br />
|-<br />
|<br />
[[File:Md500d.jpg|350px]]<br />
|-<br />
|<br />
----<br />
|-<br />
|<br />
<br />
{| class=sa-infotable<br />
|Role||Utility<br />
|-<br />
|Manufacturer||MD<br />
|-<br />
|SL First Flight||1976<br />
|-<br />
|SL Introduction||TBD<br />
|-<br />
|GTFO Code|| TBD<br />
|}<br />
<br />
|}<br />
<br />
Description TBD<br />
<br />
The SAFE (Shergood Aviation Flight Engine) engine driving this virtual reproduction is the most advanced and realistic in SL., developed by an RL helicopter pilot The engine is purely physics based and features independent control of cyclic, collective and anti-torque pedals. Many real-world helicopter effects are also modeled as part of the engine including translational lift, translating tendency, ground effect, main rotor torque and vortex ring state.<br />
<br />
<h1>Master Contents</h1><br />
<br />
<div style="font-size: 130%;"><br />
{|<br />
|style="width: 50%; vertical-align: text-top;"|<br />
# [[MD-500D/General|General]]<br />
|}<br />
</div><br />
<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Credits</div><br />
----<br />
* Sounds - Lorin Tone<br />
* Flight Testing, Design - Tsukino Usagi (tsukino.firethorn)<br />
* Design, Mesh, Textures and Scripting - Kelly Shergood<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Links</div><br />
----<br />
* [[MD-500D|Release Notes]]</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=MD-500D&diff=5684MD-500D2023-09-02T17:53:22Z<p>Kelly: </p>
<hr />
<div>{| class=sa-infobox style="float: right;"<br />
|<br />
<div style='text-align: center; line-height: 130%;'><br />
<span style="font-size: 150%">'''Steamly S2-S'''</span><br><br />
</div><br />
|-<br />
|<br />
[[File:Md500d.jpg|350px]]<br />
|-<br />
|<br />
----<br />
|-<br />
|<br />
<br />
{| class=sa-infotable<br />
|Role||Utility<br />
|-<br />
|Manufacturer||MD<br />
|-<br />
|SL First Flight||1976<br />
|-<br />
|SL Introduction||TBD<br />
|-<br />
|GTFO Code|| TBD<br />
|}<br />
<br />
|}<br />
<br />
Description TBD<br />
<br />
The SAFE (Shergood Aviation Flight Engine) engine driving this virtual reproduction is the most advanced and realistic in SL., developed by an RL helicopter pilot The engine is purely physics based and features independent control of cyclic, collective and anti-torque pedals. Many real-world helicopter effects are also modeled as part of the engine including translational lift, translating tendency, ground effect, main rotor torque and vortex ring state.<br />
<br />
<h1>Master Contents</h1><br />
<br />
<div style="font-size: 130%;"><br />
{|<br />
|style="width: 50%; vertical-align: text-top;"|<br />
# [[MD-500D/General|General]]<br />
|}<br />
</div><br />
<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Credits</div><br />
----<br />
* Sounds - Lorin Tone<br />
* Flight Testing, Design - Tsukino Usagi (tsukino.firethorn)<br />
* Design, Mesh, Textures and Scripting - Kelly Shergood<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Links</div><br />
----<br />
* [[MD-500D|Release Notes]]</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=MD-500D&diff=5683MD-500D2023-09-02T17:52:44Z<p>Kelly: Created page with "{| class=sa-infobox style="float: right;" | <div style='text-align: center; line-height: 130%;'> <span style="font-size: 150%">'''Steamly S2-S'''</span><br> </div> |- | File..."</p>
<hr />
<div>{| class=sa-infobox style="float: right;"<br />
|<br />
<div style='text-align: center; line-height: 130%;'><br />
<span style="font-size: 150%">'''Steamly S2-S'''</span><br><br />
</div><br />
|-<br />
|<br />
[[File:Md-500d.jpg|350px]]<br />
|-<br />
|<br />
----<br />
|-<br />
|<br />
<br />
{| class=sa-infotable<br />
|Role||Utility<br />
|-<br />
|Manufacturer||MD<br />
|-<br />
|SL First Flight||1976<br />
|-<br />
|SL Introduction||TBD<br />
|-<br />
|GTFO Code|| TBD<br />
|}<br />
<br />
|}<br />
<br />
Description TBD<br />
<br />
The SAFE (Shergood Aviation Flight Engine) engine driving this virtual reproduction is the most advanced and realistic in SL., developed by an RL helicopter pilot The engine is purely physics based and features independent control of cyclic, collective and anti-torque pedals. Many real-world helicopter effects are also modeled as part of the engine including translational lift, translating tendency, ground effect, main rotor torque and vortex ring state.<br />
<br />
<h1>Master Contents</h1><br />
<br />
<div style="font-size: 130%;"><br />
{|<br />
|style="width: 50%; vertical-align: text-top;"|<br />
# [[MD-500D/General|General]]<br />
|}<br />
</div><br />
<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Credits</div><br />
----<br />
* Sounds - Lorin Tone<br />
* Flight Testing, Design - Tsukino Usagi (tsukino.firethorn)<br />
* Design, Mesh, Textures and Scripting - Kelly Shergood<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Links</div><br />
----<br />
* [[MD-500D|Release Notes]]</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=File:Md500d.jpg&diff=5682File:Md500d.jpg2023-09-02T17:50:05Z<p>Kelly: Kelly uploaded a new version of File:Md500d.jpg</p>
<hr />
<div></div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=Main_Page&diff=5681Main Page2023-09-02T17:47:47Z<p>Kelly: /* Aircraft */</p>
<hr />
<div>=Flying Resources=<br />
<br />
{|<br />
|[[File:Sl-hfh-cover.png|250px|link=SL_Helicopter_Flying_Handbook]]<br />
|valign=top|The SL Helicopter Flying Handbook is full of useful information on flying helicopters equipped with the [[Shergood Flight System]]. This manual includes fundamentals of helicopter aerodynamics, helicopter systems, basic and advanced flight maneuvers, and navigation in SL.<br />
|}<br />
<br />
=Aircraft=<br />
<br />
{|<br />
|[[File:Md500d.jpg|250px|link=MD-500D]]<br />
|[[File:S2s-promo.png|250px|link=Steamly S2-S]]<br />
|[[File:S58_001.png|250px|link=H-34 Choctaw]]<br />
|[[File:S61-pelican.png|250px|link=S-61R Pelican]]<br />
|-<br />
|style="text-align:center;"|MD-500D<br />
|style="text-align:center;"|Steamly S2-S<br />
|style="text-align:center;"|H-34 (S-58) Choctaw<br />
|style="text-align:center;"|S-61R Pelican<br />
|}<br />
<br />
<br />
{|<br />
|[[File:H160-square.png|250px|link=H-160]]<br />
|[[File:Chinook.png|250px|link=Chinook CH-47]]<br />
|[[File:ec135-vip.png|250px|link=EC-135]]<br />
|[[File:S64-instrument-panel.png|250px|link=S-64]]<br />
|-<br />
|style="text-align:center;"|H-160<br />
|style="text-align:center;"|Chinook CH-47<br />
|style="text-align:center;"|EC-135<br />
|style="text-align:center;"|S-64<br />
|}<br />
<br />
<br />
{|<br />
|[[File:H92.png|250px|link=H-92]]<br />
|[[File:S92.png|250px|link=S-92]]<br />
|[[File:E280c.png|250px|link=Enstrom 280C]]<br />
|[[File:Uh4.png|250px|link=UH-4 Commuter]]<br />
|-<br />
|style="text-align:center;"|H-92<br />
|style="text-align:center;"|S-92<br />
|style="text-align:center;"|Enstrom 280C<br />
|style="text-align:center;"|UH-4 Commuter<br />
|}<br />
<br />
{|<br />
|[[File:B305.jpg|250px|link=Brantly 305]]<br />
|[[File:New b2b-sqr.jpg|250px|link=Brantly B2-B]]<br />
|-<br />
|style="text-align:center;"|Brantly 305<br />
|style="text-align:center;"|Brantly B2-B<br />
|}<br />
<br />
<div style='clear: both;'></div><br />
<br />
=Aircraft Feature Comparison=<br />
{|class=wikitable<br />
!Aircraft<br />
!SA-FE Ver.<br />
!Instruments<br />
!Onboard<br />
!Weather<br />
!Hooks<br />
!Hoist<br />
!Rappel<br />
!Autopilot<br />
!Nav.<br />
!Floats<br />
|-<br />
!Steamly S2-S<br />
|1.4<br />
|gauges<br />
|n/a<br />
|n/a<br />
|<br />
|<br />
|<br />
|n/a<br />
|GPS<br />
|n/a<br />
|-<br />
!H-34 (S-58) Choctaw<br />
|1.4.1<br />
|gauges<br />
|swap<br />
|2.0<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|limited<br />
|VOR<br />
|add-on<br />
|-<br />
!S-61R Pelican<br />
|1.4<br />
|gauges<br />
|full<br />
|2.0<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|integrated<br />
|FMS+GPS+VOR<br />
|[[File:Green-check-32.png|18px]]<br />
|-<br />
!H-160-UTL<br />
|1.3.5<br />
|glass<br />
|swap<br />
|1.0<br />
|<br />
|<br />
|<br />
|integrated<br />
|FMS+GPS<br />
|emergency<br />
|-<br />
!H-160-VIP<br />
|1.3.5<br />
|glass<br />
|swap<br />
|1.0<br />
|<br />
|<br />
|<br />
|integrated<br />
|FMS+GPS<br />
|emergency<br />
|-<br />
!H-160-EMS<br />
|1.3.5<br />
|glass<br />
|swap<br />
|1.0<br />
|<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|integrated<br />
|FMS+GPS<br />
|emergency<br />
|-<br />
!Chinook CH-47<br />
|1.3<br />
|gauges<br />
|full<br />
|1.0<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|<br />
|integrated<br />
|FMS+GPS*<br />
|[[File:Green-check-32.png|18px]]<br />
|-<br />
!EC-135-EMS<br />
|1.3<br />
|glass<br />
|n/a<br />
|1.0<br />
|<br />
|add-on<br />
|<br />
|stand-alone<br />
|GPS<br />
|add-on<br />
|-<br />
!EC-135-VIP<br />
|1.3<br />
|glass<br />
|n/a<br />
|1.0<br />
|<br />
|<br />
|<br />
|stand-alone<br />
|GPS<br />
|add-on<br />
|-<br />
!EC-135-POL<br />
|1.3<br />
|glass<br />
|n/a<br />
|1.0<br />
|<br />
|<br />
|[[File:Green-check-32.png|18px]]<br />
|stand-alone<br />
|GPS<br />
|add-on<br />
|-<br />
!S-64<br />
|1.3<br />
|gauges<br />
|n/a<br />
|n/a<br />
|(cargo hoist)<br />
|<br />
|<br />
|stand-alone<br />
|GPS<br />
|n/a<br />
|-<br />
!H-92<br />
|1.3<br />
|glass<br />
|full<br />
|n/a<br />
|<br />
|[[File:Green-check-32.png|18px]]<br />
|<br />
|stand-alone<br />
|GPS<br />
|emergency<br />
|-<br />
!S-92<br />
|1.3<br />
|glass<br />
|full<br />
|n/a<br />
|<br />
|<br />
|<br />
|stand-alone<br />
|GPS<br />
|emergency<br />
|-<br />
!Enstrom 280C<br />
|1.2<br />
|gauges<br />
|n/a<br />
|n/a<br />
|<br />
|<br />
|<br />
|n/a<br />
|GPS<br />
|n/a<br />
|-<br />
!UH-4 Commuter<br />
|1.2<br />
|gauges<br />
|n/a<br />
|n/a<br />
|<br />
|<br />
|<br />
|n/a<br />
|n/a<br />
|n/a<br />
|-<br />
!Brantly 305<br />
|1.1<br />
|gauges<br />
|n/a<br />
|n/a<br />
|<br />
|<br />
|<br />
|n/a<br />
|GPS<br />
|n/a<br />
|-<br />
!Brantly B2-B<br />
|1.4<br />
|gauges<br />
|n/a<br />
|1.0<br />
|<br />
|<br />
|<br />
|n/a<br />
|GPS<br />
|[[File:Green-check-32.png|18px]]<br />
|}<br />
<br />
=Equipment=<br />
<br />
<br />
<br />
{|<br />
|[[File:Square sock.png|250px|link=Airport Windsock]]<br />
|[[File:Backpack-deicer-sqr.png|250px|link=Backpack Deicer]]<br />
|[[File:Deicing-truck.png|250px|link=Deicing Truck]]<br />
|[[File:PaintWizard Square.jpg|250px|link=Paint Wizard]]<br />
|-<br />
|style="text-align:center;"|Airport Windsock<br />
|style="text-align:center;"|Backpack Deicer<br />
|style="text-align:center;"|Deicing Truck<br />
|style="text-align:center;"|Paint Wizard<br />
|}<br />
<br />
<br />
{|<br />
|[[File:Kellyfuel-square.jpg|250px|link=KellyFuel]]<br />
|[[File:Cargo-hook-kit-small.jpg|250px|link=Cargo Hook Kit]]<br />
|[[File:Helitank-bottom.png|250px|link=Helitank for S-64 Aircrane]]<br />
|[[File:Logbook-thumb.png|250px|link=Pilot Logbook]]<br />
|-<br />
|style="text-align:center;"|Kelly Fuel<br />
|style="text-align:center;"|Cargo Hook Kit<br />
|style="text-align:center;"|Helitank for S-64 Aircrane<br />
|style="text-align:center;"|Pilot Logbook<br />
|}<br />
<br />
<br />
{|<br />
|[[File:Alarm-thumb.jpg|250px|link=ELT Alarm Box]]<br />
|[[File:Floatindex-thumb.png|250px|link=EC-135 Emergency Float Kit]]<br />
|[[File:Gps-screen-thumb.jpg|250px|link=Advanced Transponder and GPS HUD]]<br />
|[[File:Kimbi-thumb.jpg|250px|link=Kimbi Bucket]]<br />
|-<br />
|style="text-align:center;"|ELT Alarm Box<br />
|style="text-align:center;"|EC-135 Emergency Float Kit<br />
|style="text-align:center;"|Advanced Transponder and GPS HUD<br />
|style="text-align:center;"|Kimbi Bucket<br />
|}<br />
<br />
<br />
{|<br />
|[[File:Transponder-thumb.jpg|250px|link=Basic Transponder HUD]]<br />
|[[File:Modkit-thumb.png|250px|link=Tail Number Modkit]]<br />
|[[File:Radar-thumb.jpg|250px|link=Airport Radar]]<br />
|[[File:Rdfhud-thumb.png|250px|link=Radio Direction Finder HUD]]<br />
|-<br />
|style="text-align:center;"|Basic Transponder HUD<br />
|style="text-align:center;"|Tail Number Modkit<br />
|style="text-align:center;"|Airport Radar<br />
|style="text-align:center;"|Radio Direction Finder HUD<br />
|}<br />
<br />
{|<br />
|[[File:Winch-thumb.png|250px|link=EC-135 Rescue Winch Kit]]<br />
|[[File:Kellbucket thumb.png|250px|link=KellBucket]]<br />
|-<br />
|style="text-align:center;"|EC-135 Rescue Winch Kit<br />
|style="text-align:center;"|KellBucket<br />
|}<br />
<br />
=Painters=<br />
[[Main Page/Painters|Painters]]<br />
<br />
=Bug Reports=<br />
<br />
[https://docs.google.com/forms/d/e/1FAIpQLSdrXLW3_Z_MMoarqUhsTksNc_4b-vCBYJPW6DBxpfwQg_iBQg/viewform?embedded=true Submit Bug Reports Here]<br />
<br />
==Bug report guidelines==<br />
<span style="color:#f00">'''READ BEFORE REPORTING ANY BUGS'''</span><br />
* Reports must be complete and detailed, vague reports, such as "____ isn't working" will not be accepted.<br />
* Issues resulting from operation outside prescribed aircraft limits, negligence, or poor judgement by the pilot are not bugs and should not be reported.<br />
* Modifications are done '''AT YOUR OWN RISK'''. Issues resulting from the modification of a product with anything other than an official Shergood addon are the responsibility of the creator of said modifications.<br />
* Bugs should be reproducible with a fresh, unmodified copy of the product in question.<br />
* Bugs should be reproducible on multiple different sims to rule out the possibility of SL region problems being the cause.<br />
<br />
=Practical Test Standards=<br />
<br />
:[[Private Helicopter PTS]]<br />
:[[Commercial Helicopter PTS]]<br />
:[[ATP Helicopter PTS]]<br />
:[[Flight Instructor Helicopter PTS]]</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=File:Md500d.jpg&diff=5680File:Md500d.jpg2023-09-02T17:47:29Z<p>Kelly: </p>
<hr />
<div></div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=Main_Page&diff=5679Main Page2023-09-02T17:47:07Z<p>Kelly: /* Aircraft */</p>
<hr />
<div>=Flying Resources=<br />
<br />
{|<br />
|[[File:Sl-hfh-cover.png|250px|link=SL_Helicopter_Flying_Handbook]]<br />
|valign=top|The SL Helicopter Flying Handbook is full of useful information on flying helicopters equipped with the [[Shergood Flight System]]. This manual includes fundamentals of helicopter aerodynamics, helicopter systems, basic and advanced flight maneuvers, and navigation in SL.<br />
|}<br />
<br />
=Aircraft=<br />
<br />
{|<br />
|[[File:S2s-promo.png|250px|link=MD-500D]]<br />
|[[File:S2s-promo.png|250px|link=Steamly S2-S]]<br />
|[[File:S58_001.png|250px|link=H-34 Choctaw]]<br />
|[[File:S61-pelican.png|250px|link=S-61R Pelican]]<br />
|-<br />
|style="text-align:center;"|MD-500D<br />
|style="text-align:center;"|Steamly S2-S<br />
|style="text-align:center;"|H-34 (S-58) Choctaw<br />
|style="text-align:center;"|S-61R Pelican<br />
|}<br />
<br />
<br />
{|<br />
|[[File:H160-square.png|250px|link=H-160]]<br />
|[[File:Chinook.png|250px|link=Chinook CH-47]]<br />
|[[File:ec135-vip.png|250px|link=EC-135]]<br />
|[[File:S64-instrument-panel.png|250px|link=S-64]]<br />
|-<br />
|style="text-align:center;"|H-160<br />
|style="text-align:center;"|Chinook CH-47<br />
|style="text-align:center;"|EC-135<br />
|style="text-align:center;"|S-64<br />
|}<br />
<br />
<br />
{|<br />
|[[File:H92.png|250px|link=H-92]]<br />
|[[File:S92.png|250px|link=S-92]]<br />
|[[File:E280c.png|250px|link=Enstrom 280C]]<br />
|[[File:Uh4.png|250px|link=UH-4 Commuter]]<br />
|-<br />
|style="text-align:center;"|H-92<br />
|style="text-align:center;"|S-92<br />
|style="text-align:center;"|Enstrom 280C<br />
|style="text-align:center;"|UH-4 Commuter<br />
|}<br />
<br />
{|<br />
|[[File:B305.jpg|250px|link=Brantly 305]]<br />
|[[File:New b2b-sqr.jpg|250px|link=Brantly B2-B]]<br />
|-<br />
|style="text-align:center;"|Brantly 305<br />
|style="text-align:center;"|Brantly B2-B<br />
|}<br />
<br />
<div style='clear: both;'></div><br />
<br />
=Aircraft Feature Comparison=<br />
{|class=wikitable<br />
!Aircraft<br />
!SA-FE Ver.<br />
!Instruments<br />
!Onboard<br />
!Weather<br />
!Hooks<br />
!Hoist<br />
!Rappel<br />
!Autopilot<br />
!Nav.<br />
!Floats<br />
|-<br />
!Steamly S2-S<br />
|1.4<br />
|gauges<br />
|n/a<br />
|n/a<br />
|<br />
|<br />
|<br />
|n/a<br />
|GPS<br />
|n/a<br />
|-<br />
!H-34 (S-58) Choctaw<br />
|1.4.1<br />
|gauges<br />
|swap<br />
|2.0<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|limited<br />
|VOR<br />
|add-on<br />
|-<br />
!S-61R Pelican<br />
|1.4<br />
|gauges<br />
|full<br />
|2.0<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|integrated<br />
|FMS+GPS+VOR<br />
|[[File:Green-check-32.png|18px]]<br />
|-<br />
!H-160-UTL<br />
|1.3.5<br />
|glass<br />
|swap<br />
|1.0<br />
|<br />
|<br />
|<br />
|integrated<br />
|FMS+GPS<br />
|emergency<br />
|-<br />
!H-160-VIP<br />
|1.3.5<br />
|glass<br />
|swap<br />
|1.0<br />
|<br />
|<br />
|<br />
|integrated<br />
|FMS+GPS<br />
|emergency<br />
|-<br />
!H-160-EMS<br />
|1.3.5<br />
|glass<br />
|swap<br />
|1.0<br />
|<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|integrated<br />
|FMS+GPS<br />
|emergency<br />
|-<br />
!Chinook CH-47<br />
|1.3<br />
|gauges<br />
|full<br />
|1.0<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|<br />
|integrated<br />
|FMS+GPS*<br />
|[[File:Green-check-32.png|18px]]<br />
|-<br />
!EC-135-EMS<br />
|1.3<br />
|glass<br />
|n/a<br />
|1.0<br />
|<br />
|add-on<br />
|<br />
|stand-alone<br />
|GPS<br />
|add-on<br />
|-<br />
!EC-135-VIP<br />
|1.3<br />
|glass<br />
|n/a<br />
|1.0<br />
|<br />
|<br />
|<br />
|stand-alone<br />
|GPS<br />
|add-on<br />
|-<br />
!EC-135-POL<br />
|1.3<br />
|glass<br />
|n/a<br />
|1.0<br />
|<br />
|<br />
|[[File:Green-check-32.png|18px]]<br />
|stand-alone<br />
|GPS<br />
|add-on<br />
|-<br />
!S-64<br />
|1.3<br />
|gauges<br />
|n/a<br />
|n/a<br />
|(cargo hoist)<br />
|<br />
|<br />
|stand-alone<br />
|GPS<br />
|n/a<br />
|-<br />
!H-92<br />
|1.3<br />
|glass<br />
|full<br />
|n/a<br />
|<br />
|[[File:Green-check-32.png|18px]]<br />
|<br />
|stand-alone<br />
|GPS<br />
|emergency<br />
|-<br />
!S-92<br />
|1.3<br />
|glass<br />
|full<br />
|n/a<br />
|<br />
|<br />
|<br />
|stand-alone<br />
|GPS<br />
|emergency<br />
|-<br />
!Enstrom 280C<br />
|1.2<br />
|gauges<br />
|n/a<br />
|n/a<br />
|<br />
|<br />
|<br />
|n/a<br />
|GPS<br />
|n/a<br />
|-<br />
!UH-4 Commuter<br />
|1.2<br />
|gauges<br />
|n/a<br />
|n/a<br />
|<br />
|<br />
|<br />
|n/a<br />
|n/a<br />
|n/a<br />
|-<br />
!Brantly 305<br />
|1.1<br />
|gauges<br />
|n/a<br />
|n/a<br />
|<br />
|<br />
|<br />
|n/a<br />
|GPS<br />
|n/a<br />
|-<br />
!Brantly B2-B<br />
|1.4<br />
|gauges<br />
|n/a<br />
|1.0<br />
|<br />
|<br />
|<br />
|n/a<br />
|GPS<br />
|[[File:Green-check-32.png|18px]]<br />
|}<br />
<br />
=Equipment=<br />
<br />
<br />
<br />
{|<br />
|[[File:Square sock.png|250px|link=Airport Windsock]]<br />
|[[File:Backpack-deicer-sqr.png|250px|link=Backpack Deicer]]<br />
|[[File:Deicing-truck.png|250px|link=Deicing Truck]]<br />
|[[File:PaintWizard Square.jpg|250px|link=Paint Wizard]]<br />
|-<br />
|style="text-align:center;"|Airport Windsock<br />
|style="text-align:center;"|Backpack Deicer<br />
|style="text-align:center;"|Deicing Truck<br />
|style="text-align:center;"|Paint Wizard<br />
|}<br />
<br />
<br />
{|<br />
|[[File:Kellyfuel-square.jpg|250px|link=KellyFuel]]<br />
|[[File:Cargo-hook-kit-small.jpg|250px|link=Cargo Hook Kit]]<br />
|[[File:Helitank-bottom.png|250px|link=Helitank for S-64 Aircrane]]<br />
|[[File:Logbook-thumb.png|250px|link=Pilot Logbook]]<br />
|-<br />
|style="text-align:center;"|Kelly Fuel<br />
|style="text-align:center;"|Cargo Hook Kit<br />
|style="text-align:center;"|Helitank for S-64 Aircrane<br />
|style="text-align:center;"|Pilot Logbook<br />
|}<br />
<br />
<br />
{|<br />
|[[File:Alarm-thumb.jpg|250px|link=ELT Alarm Box]]<br />
|[[File:Floatindex-thumb.png|250px|link=EC-135 Emergency Float Kit]]<br />
|[[File:Gps-screen-thumb.jpg|250px|link=Advanced Transponder and GPS HUD]]<br />
|[[File:Kimbi-thumb.jpg|250px|link=Kimbi Bucket]]<br />
|-<br />
|style="text-align:center;"|ELT Alarm Box<br />
|style="text-align:center;"|EC-135 Emergency Float Kit<br />
|style="text-align:center;"|Advanced Transponder and GPS HUD<br />
|style="text-align:center;"|Kimbi Bucket<br />
|}<br />
<br />
<br />
{|<br />
|[[File:Transponder-thumb.jpg|250px|link=Basic Transponder HUD]]<br />
|[[File:Modkit-thumb.png|250px|link=Tail Number Modkit]]<br />
|[[File:Radar-thumb.jpg|250px|link=Airport Radar]]<br />
|[[File:Rdfhud-thumb.png|250px|link=Radio Direction Finder HUD]]<br />
|-<br />
|style="text-align:center;"|Basic Transponder HUD<br />
|style="text-align:center;"|Tail Number Modkit<br />
|style="text-align:center;"|Airport Radar<br />
|style="text-align:center;"|Radio Direction Finder HUD<br />
|}<br />
<br />
{|<br />
|[[File:Winch-thumb.png|250px|link=EC-135 Rescue Winch Kit]]<br />
|[[File:Kellbucket thumb.png|250px|link=KellBucket]]<br />
|-<br />
|style="text-align:center;"|EC-135 Rescue Winch Kit<br />
|style="text-align:center;"|KellBucket<br />
|}<br />
<br />
=Painters=<br />
[[Main Page/Painters|Painters]]<br />
<br />
=Bug Reports=<br />
<br />
[https://docs.google.com/forms/d/e/1FAIpQLSdrXLW3_Z_MMoarqUhsTksNc_4b-vCBYJPW6DBxpfwQg_iBQg/viewform?embedded=true Submit Bug Reports Here]<br />
<br />
==Bug report guidelines==<br />
<span style="color:#f00">'''READ BEFORE REPORTING ANY BUGS'''</span><br />
* Reports must be complete and detailed, vague reports, such as "____ isn't working" will not be accepted.<br />
* Issues resulting from operation outside prescribed aircraft limits, negligence, or poor judgement by the pilot are not bugs and should not be reported.<br />
* Modifications are done '''AT YOUR OWN RISK'''. Issues resulting from the modification of a product with anything other than an official Shergood addon are the responsibility of the creator of said modifications.<br />
* Bugs should be reproducible with a fresh, unmodified copy of the product in question.<br />
* Bugs should be reproducible on multiple different sims to rule out the possibility of SL region problems being the cause.<br />
<br />
=Practical Test Standards=<br />
<br />
:[[Private Helicopter PTS]]<br />
:[[Commercial Helicopter PTS]]<br />
:[[ATP Helicopter PTS]]<br />
:[[Flight Instructor Helicopter PTS]]</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=Chinook_CH-47&diff=5650Chinook CH-472022-09-30T03:34:06Z<p>Kelly: </p>
<hr />
<div>{| class=sa-infobox style="float: right;"<br />
|<br />
<div style='text-align: center; line-height: 130%;'><br />
<span style="font-size: 150%">'''Chinook CH-47'''</span><br><br />
</div><br />
|-<br />
|<br />
[[File:Chinook.png|350px]]<br />
|-<br />
|<br />
----<br />
|-<br />
|<br />
<br />
{| class=sa-infotable<br />
|Role||Heavy-lift Transport<br />
|-<br />
|Manufacturer||Boeing Defense<br />
|-<br />
|RL First Flight||21 September 1961<br />
|-<br />
|RL Introduction||1962<br />
|-<br />
|SL First Flight||October 2017<br />
|-<br />
|SL Introduction||03 May 2018<br />
|-<br />
|GTFO Code||KSCHINOOK<br />
|}<br />
<br />
|}<br />
<br />
This virtual CH-47D is a reproduction of the Boeing Chinook tandem rotor heavy-lift helicopter. Work on the Chinook began by Vertol in 1957 with the first helicopters entering service in 1962. With a tripple hook cargo system, the CH-47D can carry external payloads up to 26,000 pounds. The CH-47D is also ideal for carrying cargo or personel.<br />
<br />
This virtual CH-47 from Shergood Aviation has the most advanced systems model of any helicopter in Second Life. Features include:<br />
{|<br />
| style="width: 50%; vertical-align: text-top; padding-right: 50px;"|<br />
* [[Shergood Flight System]]<br />
* Compatible with GTFO<br />
* OnBoard system allows crew to walk around cabin in flight<br />
* Fully functioning cockpit<br />
* Nearly 100 functioning switches/knobs<br />
* Start sequence based on (and nearly identical to) the RL Chinook<br />
* Six fuel tanks with both gravity and single-point refueling systems<br />
* Five transmission systems with independent fluid tracking and monitoring instruments<br />
| style="width: 50%; vertical-align: text-top;"|<br />
* Three separate hydraulic systems with independent fluid tracking and monitoring instruments<br />
* Functioning maintenance panel<br />
* Three hook external cargo system<br />
* Rescue hoist system<br />
* Simulated failures<br />
* AFCS (Autopilot)<br />
* GPS Navigation<br />
* Instrument Approaches<br />
|}<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Master Contents</div><br />
----<br />
<br />
<div style="font-size: 130%;"><br />
{|<br />
|style="width: 50%; vertical-align: text-top;"|<br />
# [[Chinook CH-47/General|General]]<br />
# [[Chinook CH-47/Systems|Systems]]<br />
# [[Chinook CH-47/Avionics|Avionics]]<br />
# [[Chinook CH-47/Mission|Mission]]<br />
# [[Chinook CH-47/Limits|Limits]]<br />
# [[Chinook CH-47/Weight_and_Balance|Weight and Balance]]<br />
|style="width: 50%; vertical-align: text-top;"|<br />
# <li value="7"> [[Chinook CH-47/Normal_Procedures|Normal Procedures]]<br />
# [[Chinook CH-47/Emergency_Procedures|Emergency Procedures]]<br />
# [[Chinook CH-47/Servicing|Servicing]]<br />
# [[Chinook CH-47/SL_Features|SL Features]]<br />
# [[Chinook CH-47/Appendices|Appendices ]]<br />
# [[Chinook CH-47/Painting_Resources|Painting Resources]]<br />
|}<br />
</div><br />
<br />
<div style='font-size: 200%; font-family: serif;'>Video Tutorials</div><br />
----<br />
<br />
{|<br />
|[[File:Ch47-preflight-video.jpg|250px|link=https://www.youtube.com/watch?v=uW4Dle7BmCw]]<br />
|[[File:Ch47-startup-video.jpg|250px|link=https://www.youtube.com/watch?v=dYK8MD2fu1U]]<br />
|[[File:Ch47-gpu-video.jpg|250px|link=https://www.youtube.com/watch?v=UnVg09IEVS0 ]]<br />
|[[File:Ch47-cargo-video.jpg|250px|link=https://www.youtube.com/watch?v=Hy7JD-YL53M]]<br />
|-<br />
|style="text-align:center;"|Preflight<br />
|style="text-align:center;"|Start-Up/Shutdown<br />
|style="text-align:center;"|Transponder & GPS<br />
|style="text-align:center;"|Cargo/Hoist<br />
|}<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Known Bugs</div><br />
----<br />
<br />
* Selecting "Set All" in @Realism will cause fluids to burn very quickly. Use "Clear All" to fix the issue and select the desired realism options individually.<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Credits</div><br />
----<br />
* Aircraft research, model parameter tuning, SL aircraft feature design and curation, aircraft testing - Tsukino Usagi<br />
* Sounds - Lorin Tone<br />
* Tutorial Videos - JC Pax<br />
* Mesh, Textures, Scripting - Kelly Shergood<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Links</div><br />
----<br />
* [[Chinook CH-47/Release Notes|Release Notes]]<br />
* [[Chinook CH-47/Known Bugs and Planned features|Known Bugs and Planned features]]</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=Chinook_CH-47/SL_Features&diff=5649Chinook CH-47/SL Features2022-09-30T03:31:05Z<p>Kelly: /* Options Menu */</p>
<hr />
<div><span class=sa-section>SECTION 10. SL FEATURES</span><br />
=== General ===<br />
This section describes functions and features of the Shergood Chinook that are specific to SL.<br />
<br />
=== HUDS ===<br />
==== Main HUD ====<br />
<br />
The main HUD attaches in the lower right corner by default. When not sitting in an aircraft, the HUD will be dark with the word "Disconnected" showing on it. You can connect to a helicopter by sitting in it in the pilot or co-pilot seat. If the HUD fails to connect, or becomes disconnected for some reason, you can click on the aircraft window and choose "HUD Connect" from the main menu. The HUD consists of a core part with the flight controls, and two pop-out instrument sets.<br />
<br />
The core of the HUD includes the following elements:<br />
* Thrust Control - Analogous to the collective in a single rotor helilcopter, this lever controls the total thrust the helicopter is producing. Drag the red dot with the mouse to move the thrust control.<br />
* Cyclic - Red dot shows the current position of the cyclic which moves in 2-dimensions.<br />
* Directional Pedals - The pedals are used to control the yaw of the helicopter. Use the mouse in the horizontal bar to set pedal position, or use the Left/Right arrow keys to control them. The pedals should be used for turns during hovering flight, and for trim using the inclinometer while in cruise flight.<br />
* Crossing Status - Indicator dot in upper left corner shows green when the HUD is active, and yellow when inactive for a region crossing.<br />
* Tail Number - The tail number of the aircraft the HUD is connected to.<br />
* HOBBS - The HOBBS time (total operating time) of the aircraft the HUD is connected to.<br />
<br />
On the left is a popout set of the following six instruments: Percent Torque, Airspeed, Radar Altimeter, Rotor RPM, Vertical Speed Indicator, and Altimeter. On the right is a popout for the fuel gauges. Click on the tabs on the sides of the HUD core to pop out or retract the instrument clusters.<br />
<br />
<br />
==== Advanced HUD ====<br />
<br />
[[File:Ch47-advancedHUD.png|thumb|200px|right|<br />
<figure id="fig:advancedHUD"><caption>Advanced HUD</caption></figure><br />
]]<br />
<br />
A third optional flight HUD is the "Advanced HUD". The Advanced HUD operated independently of the regular or mini HUD and is displayed as an overlay (see <xr id="fig:advancedHUD" /> ). The advanced HUD can be useful when flying in outside view to give some of the same critical data that is available in the cockpit.<br />
<br />
==== Hoist HUD ====<br />
<br />
A hoist HUD is provided as an alternate means to control the hoist and hook release. Details on the hoist HUDare included at the end of [[Chinook_CH-47/SECTION 4 - Mission]].<br />
<br />
=== Failure System ===<br />
The Shergood Chinook supports random or passive failures that can be turned on through the @Options menu using the "Failures" setting. There are five possible settings.<br />
*N - No Failures - No random failures, and no progression of partial failures.<br />
*P - Passive Only - Only failures caused by mishandling of the aircraft or progression of partial failures.<br />
*L - Low Random - Passive failures plus 50% chance of failure per hour.<br />
*M - Medium Random - Passive failures plus 50% chance of failure per 30 min.<br />
*H - High Random - Passive failures plus 50% chance of failure per 5 min.<br />
<br />
The types of failures that can occur are:<br />
<br />
{| class=wikitable<br />
!Failure<br />
!Description<br />
!Possible Causes<br />
!Proper Response<br />
|-<br />
|Engine ||Engine fails or catchs fire. ||Overspeeding Engine. Operating with insufficient oil levels. ||Shut down engine and/or deploy fire suppression.<br />
|-<br />
|Transmission ||Faults may manifest in any of the five transmission systems. ||Operating with insufficient oil levels. ||Land as soon as possible.<br />
|-<br />
|Hydraulics ||Hydraulic pump failure or low system pressure. ||Operating with insufficient hydraulic fluid levels. ||Land as soon as possible.<br />
|-<br />
|Generator ||Generator fails to produce power. ||Overheating of oil cooled generators. ||Land as soon as possible.<br />
|}<br />
<br />
=== Seating Access Control ===<br />
For the purpose of access control, there are three classes of seats: pilot, crew and passenger. In the Chinook, only the "co-pilot" seat is considered "crew" for access control purposes. All other seats are considered "passenger" and can be controlled through the passneger access class. When a class is set to "restricted", only the owner or avatars who have been added to the registered crew list can use that class of seat.<br />
<br />
The access controls are found in the @Admin menu which is accessible only by the owner. Each of the three class will be shown with a preceding "R" to show it is in restricted mode or "G" for guest mode. Also in the @Admin menu are buttons to Add, Remove and List registered crew members.<br />
<br />
=== Menus ===<br />
<br />
Menus are only available to the owner and registered or guest pilots of the aircraft. In general button options beginning with an "@" are sub-menus, and options beginning with "( )" or "(*)" are options that can be toggled. <br />
<br />
==== Main Menu ====<br />
<br />
The buttons on the main menu are:<br />
{| class="wikitable sa-buttontable"<br />
!Button<br />
!Description<br />
|-<br />
|<span>Park/Unpark</span> ||Make the aircraft non-physical/physical. Normally this occurs automatically when you sit in the aircraft, but this option can be used to control this manually.<br />
|-<br />
|<span>Eject</span> ||Select an occupant to eject<br />
|-<br />
|<span>Safe Unsit</span> ||Slide avatar outside aircraft before unseating them. Useful when aircraft is physical.<br />
|-<br />
|<span>@Options</span> ||Control various flight option settings.<br />
|-<br />
|<span>@Get</span> ||Get various things include HUD and manual/help notecards<br />
|-<br />
|<span>HUD Connect</span> ||Reestablish connectivity between helicopter and HUD if it becomes disconnected, or if you wear HUD while already seated.<br />
|-<br />
|<span>@Admin</span> ||Access owner-only options<br />
|-<br />
|<span>@Cheat</span> ||Displays the "Cheat" menu with options to bypass various procedures. See "CHEATS" below for more details.<br />
|-<br />
|<span>@Realism</span> ||Enable or disable "realism" features of the aircraft flight characteristics.<br />
|-<br />
|<span>@REGISTER</span> ||Access the aircraft registration menu. This button will only appear on the main menu if an N number had not yet been assigned. (aircraft must be parked/non-physical)<br />
|}<br />
<br />
=== Admin Menu ===<br />
The admin menu contains options only available to the aircraft owner. Buttons/Options are:<br />
<br />
{| class="wikitable sa-buttontable"<br />
!Button<br />
!Description<br />
|-<br />
|<span>Recal. W&B</span> ||If you make any changes to the linkset, you should use this option to recalibrate the weight & balance for the scripts.<br />
|-<br />
|<span>(?) Pilot</span> ||Set pilot seat to guest (G) or restricted (M)<br />
|-<br />
|<span>(?) Crew</span> ||Set copilot seat to guest (G) or restricted (M)<br />
|-<br />
|<span>(?) Passenger</span> ||Set passenger seats to guest (G) or restricted (M)<br />
|-<br />
|<span>Add Crew</span> ||Add an authorized crew member. A maximum of 12 crew members can be registered. The crew member to be added should stand within 10m of aircraft to be recognized by the system.<br />
|-<br />
|<span>Remove Crew</span> ||Remove a crew member from the authorized crew member list.<br />
|-<br />
|<span>List Crew</span> ||List the authorized crew members.<br />
|-<br />
|<span>@REGISTER</span> ||Assign or changer your aircraft's registration. See "N-NUMBER ASSIGNMENT" in Section 1 for more details. (aircraft must be parked/non-physical)<br />
|-<br />
|<span>@Paint</span> ||Change the color/markings of your aircraft. See "PAINTKIT SYSTEM" below for more details. (aircraft must be parked/non-physical)<br />
|}<br />
<br />
=== Paintkit System ===<br />
The paintkit system allows you to change the appearance of your helicopter. It is accessed through the @Paint sub-menu found on the @Admin menu. On this menu there are several built-in colors, and a "Custom" button to load a paint set from a separate "paintkit" prim. For custom designs you can either use a paintkit from a 3rd party vendor, or load your own texture set into the paint kit that came with your helicopter. To apply a paintkit, simply rez the paintkit near your helicopter and select "*Custom" from the @Paint menu. The helicopter will search for nearby paintkits and allow you to choose which you want to apply. Instructions on how to create your own custom paintkits can be found in the paintkit object.<br />
<br />
=== Options Menu ===<br />
The options menu is accessed from the @Options button on the main menu and is available to any registered pilot.<br />
<br />
{| class="wikitable sa-buttontable"<br />
!Button<br />
!Description<br />
|-<br />
|<span>(?) Chat</span> ||If enabled, information chat messages will be disaplayed. If disabled, all informational chat messages will be suppressed.<br />
|-<br />
|<span>(?) Controls</span> ||Select a control scheme. Control schemes are discussed in the CONTROLS section near the beginning of this document.<br />
|-<br />
|<span>(?) Failures</span> ||Enabled/disable the random failure system.<br />
|-<br />
|<span>(?) Fragile</span> ||If enabled, a crash will cause helicopter to burst into flames and become non-responsive. Resets after a set time (or until ELT is turned off).<br />
|-<br />
|<span>(?) Copilot</span> ||Enable or disabled copilot controls<br />
|-<br />
|<span>(?) Int-Menu</span> ||Disables access to menu from clicks on the internal surface of the window.<br />
|-<br />
|<span>(?) Alerts</span> ||If enabled, alert messages about collisions or other unsafe conditions will be given. If disabled, no alert messages will be issued.<br />
|-<br />
|<span>(?) Dust</span> ||If enabled, dust effects are produced when the aircraft is near the ground, water, or over a prim.<br />
|}<br />
<br />
=== Cheats Menu ===<br />
The cheats menu accessed from the @Cheat button on the main menu allows you to access functions to bypass several of the normal procedures.<br />
<br />
{| class="wikitable sa-buttontable"<br />
!Button<br />
!Description<br />
|-<br />
|<span>Charge Bat.</span> ||Charge the battery to full.<br />
|-<br />
|<span>Fill Fluids</span> ||Sets all non-fuel fluids to full.<br />
|-<br />
|<span>Fast Start/Stop</span> ||Use this button to start or stop your helicopter without going through the full procedure. You will still need to wait for the rotors to come to full speed when using Fast Start.<br />
|-<br />
|<span>Repair</span> ||Repairs all accumulated damage and failures.<br />
|-<br />
|<span>Ramp Up</span> ||Forces ramp to up position.<br />
|-<br />
|<span>Ramp Down</span> ||Forces ramp to down position.<br />
|-<br />
|<span>@Fuel</span> ||Accesses a sub-menu that lets you set the fuel level to a specific level.<br />
|}<br />
<br />
=== Realism Menu ===<br />
The realism menu lets you enable or disable some of the RL helicopter flight characteristics. The features that can be enabled/disabled are:<br />
<br />
{| class="wikitable sa-buttontable"<br />
!Button<br />
!Description<br />
|-<br />
|<span>Battery</span> ||If disabled, the battery will not run out.<br />
|-<br />
|<span>Fluids</span> ||If disabled, fluids (oil, etc.) will not be consumed as helicopter runs.<br />
|-<br />
|<span>Density</span> ||If enabled, density altitude will have an effect on aircraft performance. This comes in play when operating at high altitudes. At high altitudes hover height and climb rate will be reduced from their values at lower altitudes.<br />
|-<br />
|<span>ETL</span> ||If enabled, additional lift/performance is gained when forward airspeed goes above about 20 knots due to the main rotors constantly moving into clean air. When disabled, the additional performance is always available.<br />
|-<br />
|<span>Low RPM</span> ||When enabled, pulling excessive collective can result in decay of main rotor RPM. <br />
|-<br />
|<span>Vortex</span> ||When enabled, the helicopter can be subject to "vortex ring state" also known as "settling with power". This can occur when the helicopter is in a vertical descent of more than 300 feet/min with a forward speed of less than 30 knots while collective is at more than 50%. When vortex ring state occurs, the helicopter will experience a loss of lift and begin descending rapidly, even if additional collective is pulled.<br />
|-<br />
|<span>Translate</span> ||If enabled, the effects and compensation for translating tendency are disabled.<br />
|}</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=Kimbi_Bucket&diff=5638Kimbi Bucket2022-09-14T15:37:48Z<p>Kelly: </p>
<hr />
<div>{| class=sa-infobox style="float: right;"<br />
|<br />
<div style='text-align: center; line-height: 130%;'><br />
<span style="font-size: 150%">'''Kimbi Bucket'''</span><br><br />
</div><br />
|-<br />
|<br />
[[File:Kimbi-thumb.jpg|350px]]<br />
|}<br />
{| style="clear: both; float: right"<br />
|__TOC__<br />
|}<br />
<br />
<br />
The Kimbi Bucket is designed as a modkit specifically for the Shergood Aviation Chinook CH-47. The Kimbi Bucket system is comprised of the bucket and cables for suspending it; a hook on the belly of the aircraft; an internal control panel; and a hud version of the control panel. Chat commands can also be used to control the bucket.<br />
<br />
Features include:<br />
<br />
*2600 gallon capacity with HD Fire compatability<br />
*Fillable with system water, or from SA dip tank<br />
*Configurable number of drops (up to 4)<br />
*Configurable flow rate<br />
*Confiurable max fill level<br />
*Water weight affects helicopter handling<br />
*Configurable foam concentration<br />
*110 gallon foam bladder compatable with SA foam totes.<br />
*Control through internal control panel, chat commands or HUD<br />
*Linked system ensures bucket can be used in or flown through no-entry parcels<br />
*"On ground" mode for bucket for servicing and during pick-up/set-down procedures<br />
*Animated cable during bucket pick-up<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Manual</div><br />
----<br />
===OVERVIEW===<br />
==== Installation ====<br />
<br />
To install the Kimbi Bucket modkit, perform the following steps:<br />
*Rez a fresh CH-47 (v1.1 or later) without the modkit. Ensure power is off and that there are no occupants.<br />
*Rez the "SA - CH-37 Kimbi Bucket Kit" object within 10m of the aircraft.<br />
*Copy the *sa-ch47-bucket-installer script from the crate to your inventory, then drag it on to your ch-47<br />
*Grant link privileges to the modkit.<br />
*Wait for installation to complete.<br />
<br />
NOTE: Once you drop the installer script on the aircraft, the aircraft will be in a non-functional state until the modkit installation is complete.<br />
<br />
====HD FIRE COMPATIBILITY====<br />
This system is designed to be compatible with HD Fire v2016.06.21 or later. Kimbi Bucket may work partially with older versions of HD Fire, but may not be as effective.<br />
====PRODUCT UPDATES====<br />
Product updates are checked when rezzing the helicopter with the bucket attached to it.<br />
<br />
===OPERATION===<br />
====DEPLOYING/HIDING BUCKET====<br />
The bucket is deployed using the "fb show" chat command, and hidden using the "fb hide" command. If the helicopter is on the ground when the show command is issued, the bucket will be deployed in "ground" mode several meters in front of the aircraft. While in ground mode, the foam reservoir may be serviced. If the aircraft is greater than about 90 feet (30 meters), the bucket will be deployed while in the hanging state. Attempting to show the bucket while not on the ground, but at less than 90 feet will result in an error message.<br />
<br />
====CONTROL PANEL AND HUD====<br />
<br />
[[File:kb-controlPanel.png|thumb|right|<br />
<figure id="fig:controlPanel"><caption>Kimbi Bucket Control Panel</caption></figure>]]<br />
<br />
The control panel and HUD have the exact same layout and functionality. The control/panel HUD layout is shown in <xr id='fig:controlPanel'/> . The upper left corner of the panel shows the basic state of the bucket including the water level, the foam reservoir level and the current valve position. Under the bucket diagram are soft buttons for opening/closing the valve, and for turning the power pumps on/off. Below the bucket soft buttons is a readout showing the current volume of water in gallons contained by the bucket.<br />
<br />
The remainder of the display shows various bucket configuration options. Left to right these are:<br />
<br />
* '''Maximum Fill Level''' - This is the maximum capacity to which the bucket should be filled. The maximum fill level can be set to any level between 25% and 100%. Touching the bar scale will set a fill level directly. Touching the soft button under the bar will increase the max fill level to the next 25% increment (cycling back to 25%). When the bucket has been filled beyond the configured maximum fill level, the valve will automatically open when the bucket has been overfilled to shed the excess water until it has fallen to the set level.<br />
* '''Drop Count''' - This is the number of drops to be performed with the water held in the bucket. Pressing the softbutton allows the number of drops to be cycled through values between 1 and 4. The bar graph shows the number of configured drops, and which drops have been used. When more than one drop has been configured, the valve will automatically close at the end of the drop (except that the valve will remain open after the final drop). The size of the drops is based on the amount of water in the bucket when the drop count is configured. The "used" drops on the display are reset when any water is added to the bucket, or the drop count is changed.<br />
* '''Coverage''' - This is the amount by which the valve is opened during a drop. Coverage may be set to any value between 10% and 100%. Pressing the bar scale will set coverage to an exact value, and pressing the soft button under the bar will increment the coverage to the next 10% increment (cycling back to 10%). Note coverage setting does not affect the valve position when shedding water to meet the configured maximum fill level.<br />
* '''Foam Mixture''' - Sets the percent of foam concentrate to be added to water dropped from the bucket. The concentration can be configured between 0% and 1%. Pressing the bar scale will set foam mixture to an exact value, and pressing the soft button under the bar will increment the mixture to the next 0.1% increment (cycling back to 0%). Note: The cap on the foam outlet must be removed before flight in order to use the foam system. See the SERVICING section for details.<br />
<br />
====PICKING UP WATER====<br />
Water can be picked up either from Linden system water, or from the included dip tank. There are three mechanisms by which the bucket can be filled:<br />
* '''Total submersion''' - Totally submerging the bucket below the level of the rim will allow water to flow over the edge into the bucket.<br />
* '''Open Valve''' - If the valve is open when submerging the bucket, water can enter the bucket through the bottom. If the bucket is only partially submerged, the bucket will be filled to match the level of the surrounding water. Keeping the valve open when fully submerged can decrease the time needed to fill the bucket.<br />
* '''Power Pumps''' - The Kimbi Bucket is equipped with power pumps to help fill the bucket in shallow water. The pumps are located on the bottom of the bucket and can operate with only the valve submerged. When using in shallow water, the valve should be closed while using the pumps. The pumps can also be used in part of a normal fill to further decrease the time to fill.<br />
<br />
====DROPPING WATER====<br />
Water is dropped by pressing the DROP button on the panel, or with the "fb drop" chat command. A drop can drop the full bucket, or depending on settings in up to four drops per bucketfull. Because the HD Fire system depends on dropping physical objects on the fire, you must be in a place you are allowed to rez to fight HD fires. If a drop is performed in a no-rez area, particle and other effects will continue to operate normally, but no HD Fire features will work.<br />
====USING THE DIP TANK====<br />
The dip tank can be useful when there are no Linden water sources near by. The tank holds approximately 10,000 gallons, with each bucket-full being 2600 gallons. Just dip the bucket into the tank to pick up some water. With each pick up, the level in the tank will go down slightly. To refill the tank, click the tank to get the menu, then choose [Level], then the desired water level for the tank. There is also an [Access] menu that lets you select who is allowed to set the water level in the tank (owner, group or public).<br />
<br />
Bucket Pick-Up from Ground<br />
====GROUND PICK-UP AND SET-DOWN====<br />
<br />
[[File:kb-pickUp.jpg|thumb|right|<br />
<figure id="fig:pickUp"><caption>Bucket Pick-Up from Ground</caption></figure>]]<br />
<br />
The Kimbi Bucket system allows you to pick-up and set-down the bucket to/from the ground. Note that the pick-up/set-down features of this bucket assume that it is being used from a large flat surface. To perform a pick-up, use the "fb show" command while the helicopter is on the ground. As the helicopter picks up, the bucket will remain in place on the ground and the cable prims will automatically adjust to drape between the bucket and the helicopter. Once the helicopter is high enough over the bucket, the bucket will pick up off the ground. The bucket must be picked up within 30 degrees of vertical, or the cable will break if stretched too far.<br />
<br />
=====Pick Up=====<br />
Recommended procedure for picking up the bucket are as follows:<br />
#Begin with bucket in front of helicopter with the placement used when giving the "fb show" command.<br />
#Pick up to an approximately 25 foot hover (use the radar altimeter).<br />
#Hover the helicopter forward over the bucket.<br />
#Pick up vertically with collective to approximately 125 feet. The bucket should break contact with the ground at approximately 90 to 100 feet.<br />
#Enter forward flight maintaining at least 125 feet above the ground.<br />
<br />
=====Set down=====<br />
Recommended procedure for setting the bucket down are as follows:<br />
#Fly an approach to a high (150-125 foot) hover over the landing position.<br />
#Begin a slow vertical descent to about 50 feet.<br />
#At 50 feet continue descending to about 25 feet while slowing backing up.<br />
#At approximately 25 feet, stop descent and continue slow backward motion until bucket is visible.<br />
#Once bucket is visible, slowly descent vertically to the ground.<br />
<br />
====CHAT COMMANDS====<br />
Most of the Kimbi Bucket functionality can be performed using chat commands. All bucket commands begin with "fb". The usable commands are:<br />
<br />
{|class=wikitable<br />
!Command<br />
!Description<br />
|-<br />
|fb show ||Show the bucket<br />
|-<br />
|fb hide ||Hide the bucket<br />
|-<br />
|fb dump ||Do a dump (same as pressing button)<br />
|-<br />
|fb fillto ''n'' ||Set the max fill level for the bucket<br />
|-<br />
|fb foam ''n'' ||Set the foam mixture for the bucket<br />
|-<br />
|fb dropcount ''n'' ||Set the number of drops (1-4)<br />
|-<br />
|fb coverage ''n'' ||Set the coverage level (0-100)<br />
|-<br />
|fb fast ||Place bucket in fast drop mode (coverage 100%)<br />
|-<br />
|fb slow ||Place bucket in slow drop mode (coverage 50%)<br />
|-<br />
|fb pump ||Toggle pumps on/off<br />
|-<br />
|fb fill ||Backdoor command to fill bucket<br />
|}<br />
<br />
===SERVICING===<br />
<br />
====Foam Bladder====<br />
<br />
[[File:kb-foamBlader.jpg|thumb|right|<br />
<figure id="fig:foamBlader"><caption>Foam Bladder</caption></figure>]]<br />
<br />
A 110 gallon foam bladder is located in a pouch attached to the inner wall of the bucket. The bladder may be accessed and serviced while the bucket is resting on the ground. You can used the "fb show" command while sitting in the helicopter on the ground to make the bucket visible in ground mode. The bladder has two yellow caps. The one facing up is for filling the bladder, and the one facing down is the foam outlet. The foam outlet cap must be removed before flight in order to use foam.<br />
<br />
To fill the foam bladder, use the following procedure:<br />
<br />
Place an "SA - Class A Foam Tote" within 10m of the bucket<br />
#Open the yellow filler cap on the foam bladder inside the bucket.<br />
#Click the tote and select "*Scan".<br />
#When you are given a list of tail numbers, choose your tail number.<br />
#Totes contain a total of 250 gallons. Once a tote has been depleted, you must rez a new tote.</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=Kimbi_Bucket&diff=5637Kimbi Bucket2022-09-14T15:37:21Z<p>Kelly: Created page with "{| class=sa-infobox style="float: right;" | <div style='text-align: center; line-height: 130%;'> <span style="font-size: 150%">'''Kimibi Bucket for CH-47'''</span><br> </div>..."</p>
<hr />
<div>{| class=sa-infobox style="float: right;"<br />
|<br />
<div style='text-align: center; line-height: 130%;'><br />
<span style="font-size: 150%">'''Kimibi Bucket for CH-47'''</span><br><br />
</div><br />
|-<br />
|<br />
[[File:Kimbi-thumb.jpg|350px]]<br />
|}<br />
{| style="clear: both; float: right"<br />
|__TOC__<br />
|}<br />
<br />
<br />
The Kimbi Bucket is designed as a modkit specifically for the Shergood Aviation Chinook CH-47. The Kimbi Bucket system is comprised of the bucket and cables for suspending it; a hook on the belly of the aircraft; an internal control panel; and a hud version of the control panel. Chat commands can also be used to control the bucket.<br />
<br />
Features include:<br />
<br />
*2600 gallon capacity with HD Fire compatability<br />
*Fillable with system water, or from SA dip tank<br />
*Configurable number of drops (up to 4)<br />
*Configurable flow rate<br />
*Confiurable max fill level<br />
*Water weight affects helicopter handling<br />
*Configurable foam concentration<br />
*110 gallon foam bladder compatable with SA foam totes.<br />
*Control through internal control panel, chat commands or HUD<br />
*Linked system ensures bucket can be used in or flown through no-entry parcels<br />
*"On ground" mode for bucket for servicing and during pick-up/set-down procedures<br />
*Animated cable during bucket pick-up<br />
<br />
<div style='font-size: 200%; font-family: serif;'>Manual</div><br />
----<br />
===OVERVIEW===<br />
==== Installation ====<br />
<br />
To install the Kimbi Bucket modkit, perform the following steps:<br />
*Rez a fresh CH-47 (v1.1 or later) without the modkit. Ensure power is off and that there are no occupants.<br />
*Rez the "SA - CH-37 Kimbi Bucket Kit" object within 10m of the aircraft.<br />
*Copy the *sa-ch47-bucket-installer script from the crate to your inventory, then drag it on to your ch-47<br />
*Grant link privileges to the modkit.<br />
*Wait for installation to complete.<br />
<br />
NOTE: Once you drop the installer script on the aircraft, the aircraft will be in a non-functional state until the modkit installation is complete.<br />
<br />
====HD FIRE COMPATIBILITY====<br />
This system is designed to be compatible with HD Fire v2016.06.21 or later. Kimbi Bucket may work partially with older versions of HD Fire, but may not be as effective.<br />
====PRODUCT UPDATES====<br />
Product updates are checked when rezzing the helicopter with the bucket attached to it.<br />
<br />
===OPERATION===<br />
====DEPLOYING/HIDING BUCKET====<br />
The bucket is deployed using the "fb show" chat command, and hidden using the "fb hide" command. If the helicopter is on the ground when the show command is issued, the bucket will be deployed in "ground" mode several meters in front of the aircraft. While in ground mode, the foam reservoir may be serviced. If the aircraft is greater than about 90 feet (30 meters), the bucket will be deployed while in the hanging state. Attempting to show the bucket while not on the ground, but at less than 90 feet will result in an error message.<br />
<br />
====CONTROL PANEL AND HUD====<br />
<br />
[[File:kb-controlPanel.png|thumb|right|<br />
<figure id="fig:controlPanel"><caption>Kimbi Bucket Control Panel</caption></figure>]]<br />
<br />
The control panel and HUD have the exact same layout and functionality. The control/panel HUD layout is shown in <xr id='fig:controlPanel'/> . The upper left corner of the panel shows the basic state of the bucket including the water level, the foam reservoir level and the current valve position. Under the bucket diagram are soft buttons for opening/closing the valve, and for turning the power pumps on/off. Below the bucket soft buttons is a readout showing the current volume of water in gallons contained by the bucket.<br />
<br />
The remainder of the display shows various bucket configuration options. Left to right these are:<br />
<br />
* '''Maximum Fill Level''' - This is the maximum capacity to which the bucket should be filled. The maximum fill level can be set to any level between 25% and 100%. Touching the bar scale will set a fill level directly. Touching the soft button under the bar will increase the max fill level to the next 25% increment (cycling back to 25%). When the bucket has been filled beyond the configured maximum fill level, the valve will automatically open when the bucket has been overfilled to shed the excess water until it has fallen to the set level.<br />
* '''Drop Count''' - This is the number of drops to be performed with the water held in the bucket. Pressing the softbutton allows the number of drops to be cycled through values between 1 and 4. The bar graph shows the number of configured drops, and which drops have been used. When more than one drop has been configured, the valve will automatically close at the end of the drop (except that the valve will remain open after the final drop). The size of the drops is based on the amount of water in the bucket when the drop count is configured. The "used" drops on the display are reset when any water is added to the bucket, or the drop count is changed.<br />
* '''Coverage''' - This is the amount by which the valve is opened during a drop. Coverage may be set to any value between 10% and 100%. Pressing the bar scale will set coverage to an exact value, and pressing the soft button under the bar will increment the coverage to the next 10% increment (cycling back to 10%). Note coverage setting does not affect the valve position when shedding water to meet the configured maximum fill level.<br />
* '''Foam Mixture''' - Sets the percent of foam concentrate to be added to water dropped from the bucket. The concentration can be configured between 0% and 1%. Pressing the bar scale will set foam mixture to an exact value, and pressing the soft button under the bar will increment the mixture to the next 0.1% increment (cycling back to 0%). Note: The cap on the foam outlet must be removed before flight in order to use the foam system. See the SERVICING section for details.<br />
<br />
====PICKING UP WATER====<br />
Water can be picked up either from Linden system water, or from the included dip tank. There are three mechanisms by which the bucket can be filled:<br />
* '''Total submersion''' - Totally submerging the bucket below the level of the rim will allow water to flow over the edge into the bucket.<br />
* '''Open Valve''' - If the valve is open when submerging the bucket, water can enter the bucket through the bottom. If the bucket is only partially submerged, the bucket will be filled to match the level of the surrounding water. Keeping the valve open when fully submerged can decrease the time needed to fill the bucket.<br />
* '''Power Pumps''' - The Kimbi Bucket is equipped with power pumps to help fill the bucket in shallow water. The pumps are located on the bottom of the bucket and can operate with only the valve submerged. When using in shallow water, the valve should be closed while using the pumps. The pumps can also be used in part of a normal fill to further decrease the time to fill.<br />
<br />
====DROPPING WATER====<br />
Water is dropped by pressing the DROP button on the panel, or with the "fb drop" chat command. A drop can drop the full bucket, or depending on settings in up to four drops per bucketfull. Because the HD Fire system depends on dropping physical objects on the fire, you must be in a place you are allowed to rez to fight HD fires. If a drop is performed in a no-rez area, particle and other effects will continue to operate normally, but no HD Fire features will work.<br />
====USING THE DIP TANK====<br />
The dip tank can be useful when there are no Linden water sources near by. The tank holds approximately 10,000 gallons, with each bucket-full being 2600 gallons. Just dip the bucket into the tank to pick up some water. With each pick up, the level in the tank will go down slightly. To refill the tank, click the tank to get the menu, then choose [Level], then the desired water level for the tank. There is also an [Access] menu that lets you select who is allowed to set the water level in the tank (owner, group or public).<br />
<br />
Bucket Pick-Up from Ground<br />
====GROUND PICK-UP AND SET-DOWN====<br />
<br />
[[File:kb-pickUp.jpg|thumb|right|<br />
<figure id="fig:pickUp"><caption>Bucket Pick-Up from Ground</caption></figure>]]<br />
<br />
The Kimbi Bucket system allows you to pick-up and set-down the bucket to/from the ground. Note that the pick-up/set-down features of this bucket assume that it is being used from a large flat surface. To perform a pick-up, use the "fb show" command while the helicopter is on the ground. As the helicopter picks up, the bucket will remain in place on the ground and the cable prims will automatically adjust to drape between the bucket and the helicopter. Once the helicopter is high enough over the bucket, the bucket will pick up off the ground. The bucket must be picked up within 30 degrees of vertical, or the cable will break if stretched too far.<br />
<br />
=====Pick Up=====<br />
Recommended procedure for picking up the bucket are as follows:<br />
#Begin with bucket in front of helicopter with the placement used when giving the "fb show" command.<br />
#Pick up to an approximately 25 foot hover (use the radar altimeter).<br />
#Hover the helicopter forward over the bucket.<br />
#Pick up vertically with collective to approximately 125 feet. The bucket should break contact with the ground at approximately 90 to 100 feet.<br />
#Enter forward flight maintaining at least 125 feet above the ground.<br />
<br />
=====Set down=====<br />
Recommended procedure for setting the bucket down are as follows:<br />
#Fly an approach to a high (150-125 foot) hover over the landing position.<br />
#Begin a slow vertical descent to about 50 feet.<br />
#At 50 feet continue descending to about 25 feet while slowing backing up.<br />
#At approximately 25 feet, stop descent and continue slow backward motion until bucket is visible.<br />
#Once bucket is visible, slowly descent vertically to the ground.<br />
<br />
====CHAT COMMANDS====<br />
Most of the Kimbi Bucket functionality can be performed using chat commands. All bucket commands begin with "fb". The usable commands are:<br />
<br />
{|class=wikitable<br />
!Command<br />
!Description<br />
|-<br />
|fb show ||Show the bucket<br />
|-<br />
|fb hide ||Hide the bucket<br />
|-<br />
|fb dump ||Do a dump (same as pressing button)<br />
|-<br />
|fb fillto ''n'' ||Set the max fill level for the bucket<br />
|-<br />
|fb foam ''n'' ||Set the foam mixture for the bucket<br />
|-<br />
|fb dropcount ''n'' ||Set the number of drops (1-4)<br />
|-<br />
|fb coverage ''n'' ||Set the coverage level (0-100)<br />
|-<br />
|fb fast ||Place bucket in fast drop mode (coverage 100%)<br />
|-<br />
|fb slow ||Place bucket in slow drop mode (coverage 50%)<br />
|-<br />
|fb pump ||Toggle pumps on/off<br />
|-<br />
|fb fill ||Backdoor command to fill bucket<br />
|}<br />
<br />
===SERVICING===<br />
<br />
====Foam Bladder====<br />
<br />
[[File:kb-foamBlader.jpg|thumb|right|<br />
<figure id="fig:foamBlader"><caption>Foam Bladder</caption></figure>]]<br />
<br />
A 110 gallon foam bladder is located in a pouch attached to the inner wall of the bucket. The bladder may be accessed and serviced while the bucket is resting on the ground. You can used the "fb show" command while sitting in the helicopter on the ground to make the bucket visible in ground mode. The bladder has two yellow caps. The one facing up is for filling the bladder, and the one facing down is the foam outlet. The foam outlet cap must be removed before flight in order to use foam.<br />
<br />
To fill the foam bladder, use the following procedure:<br />
<br />
Place an "SA - Class A Foam Tote" within 10m of the bucket<br />
#Open the yellow filler cap on the foam bladder inside the bucket.<br />
#Click the tote and select "*Scan".<br />
#When you are given a list of tail numbers, choose your tail number.<br />
#Totes contain a total of 250 gallons. Once a tote has been depleted, you must rez a new tote.</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=Main_Page&diff=5636Main Page2022-09-14T15:37:04Z<p>Kelly: /* Equipment */</p>
<hr />
<div>=Flying Resources=<br />
<br />
{|<br />
|[[File:Sl-hfh-cover.png|250px|link=SL_Helicopter_Flying_Handbook]]<br />
|valign=top|The SL Helicopter Flying Handbook is full of useful information on flying helicopters equipped with the [[Shergood Flight System]]. This manual includes fundamentals of helicopter aerodynamics, helicopter systems, basic and advanced flight maneuvers, and navigation in SL.<br />
|}<br />
<br />
=Aircraft=<br />
<br />
{|<br />
|[[File:S2s-promo.png|250px|link=Steamly S2-S]]<br />
|[[File:S58_001.png|250px|link=H-34 Choctaw]]<br />
|[[File:S61-pelican.png|250px|link=S-61R Pelican]]<br />
|[[File:H160-square.png|250px|link=H-160]]<br />
|-<br />
|style="text-align:center;"|Steamly S2-S<br />
|style="text-align:center;"|H-34 (S-58) Choctaw<br />
|style="text-align:center;"|S-61R Pelican<br />
|style="text-align:center;"|H-160<br />
|}<br />
<br />
<br />
{|<br />
|[[File:Chinook.png|250px|link=Chinook CH-47]]<br />
|[[File:ec135-vip.png|250px|link=EC-135]]<br />
|[[File:S64-instrument-panel.png|250px|link=S-64]]<br />
|[[File:H92.png|250px|link=H-92]]<br />
|-<br />
|style="text-align:center;"|Chinook CH-47<br />
|style="text-align:center;"|EC-135<br />
|style="text-align:center;"|S-64<br />
|style="text-align:center;"|H-92<br />
|}<br />
<br />
<br />
{|<br />
|[[File:S92.png|250px|link=S-92]]<br />
|[[File:E280c.png|250px|link=Enstrom 280C]]<br />
|[[File:Uh4.png|250px|link=UH-4 Commuter]]<br />
|[[File:B305.jpg|250px|link=Brantly 305]]<br />
|-<br />
|style="text-align:center;"|S-92<br />
|style="text-align:center;"|Enstrom 280C<br />
|style="text-align:center;"|UH-4 Commuter<br />
|style="text-align:center;"|Brantly 305<br />
|}<br />
<br />
{|<br />
|[[File:New b2b-sqr.jpg|250px|link=Brantly B2-B]]<br />
|-<br />
|style="text-align:center;"|Brantly B2-B<br />
|}<br />
<br />
<div style='clear: both;'></div><br />
<br />
=Aircraft Feature Comparison=<br />
{|class=wikitable<br />
!Aircraft<br />
!SA-FE Ver.<br />
!Instruments<br />
!Onboard<br />
!Weather<br />
!Hooks<br />
!Hoist<br />
!Rappel<br />
!Autopilot<br />
!Nav.<br />
!Floats<br />
|-<br />
!Steamly S2-S<br />
|1.4<br />
|gauges<br />
|n/a<br />
|n/a<br />
|<br />
|<br />
|<br />
|n/a<br />
|GPS<br />
|n/a<br />
|-<br />
!H-34 (S-58) Choctaw<br />
|1.4.1<br />
|gauges<br />
|swap<br />
|2.0<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|limited<br />
|VOR<br />
|add-on<br />
|-<br />
!S-61R Pelican<br />
|1.4<br />
|gauges<br />
|full<br />
|2.0<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|integrated<br />
|FMS+GPS+VOR<br />
|[[File:Green-check-32.png|18px]]<br />
|-<br />
!H-160-UTL<br />
|1.3.5<br />
|glass<br />
|swap<br />
|1.0<br />
|<br />
|<br />
|<br />
|integrated<br />
|FMS+GPS<br />
|emergency<br />
|-<br />
!H-160-VIP<br />
|1.3.5<br />
|glass<br />
|swap<br />
|1.0<br />
|<br />
|<br />
|<br />
|integrated<br />
|FMS+GPS<br />
|emergency<br />
|-<br />
!H-160-EMS<br />
|1.3.5<br />
|glass<br />
|swap<br />
|1.0<br />
|<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|integrated<br />
|FMS+GPS<br />
|emergency<br />
|-<br />
!Chinook CH-47<br />
|1.3<br />
|gauges<br />
|full<br />
|1.0<br />
|[[File:Green-check-32.png|18px]]<br />
|[[File:Green-check-32.png|18px]]<br />
|<br />
|integrated<br />
|FMS+GPS*<br />
|[[File:Green-check-32.png|18px]]<br />
|-<br />
!EC-135-EMS<br />
|1.3<br />
|glass<br />
|n/a<br />
|1.0<br />
|<br />
|add-on<br />
|<br />
|stand-alone<br />
|GPS<br />
|add-on<br />
|-<br />
!EC-135-VIP<br />
|1.3<br />
|glass<br />
|n/a<br />
|1.0<br />
|<br />
|<br />
|<br />
|stand-alone<br />
|GPS<br />
|add-on<br />
|-<br />
!EC-135-POL<br />
|1.3<br />
|glass<br />
|n/a<br />
|1.0<br />
|<br />
|<br />
|[[File:Green-check-32.png|18px]]<br />
|stand-alone<br />
|GPS<br />
|add-on<br />
|-<br />
!S-64<br />
|1.3<br />
|gauges<br />
|n/a<br />
|n/a<br />
|(cargo hoist)<br />
|<br />
|<br />
|stand-alone<br />
|GPS<br />
|n/a<br />
|-<br />
!H-92<br />
|1.3<br />
|glass<br />
|full<br />
|n/a<br />
|<br />
|[[File:Green-check-32.png|18px]]<br />
|<br />
|stand-alone<br />
|GPS<br />
|emergency<br />
|-<br />
!S-92<br />
|1.3<br />
|glass<br />
|full<br />
|n/a<br />
|<br />
|<br />
|<br />
|stand-alone<br />
|GPS<br />
|emergency<br />
|-<br />
!Enstrom 280C<br />
|1.2<br />
|gauges<br />
|n/a<br />
|n/a<br />
|<br />
|<br />
|<br />
|n/a<br />
|GPS<br />
|n/a<br />
|-<br />
!UH-4 Commuter<br />
|1.2<br />
|gauges<br />
|n/a<br />
|n/a<br />
|<br />
|<br />
|<br />
|n/a<br />
|n/a<br />
|n/a<br />
|-<br />
!Brantly 305<br />
|1.1<br />
|gauges<br />
|n/a<br />
|n/a<br />
|<br />
|<br />
|<br />
|n/a<br />
|GPS<br />
|n/a<br />
|-<br />
!Brantly B2-B<br />
|1.4<br />
|gauges<br />
|n/a<br />
|1.0<br />
|<br />
|<br />
|<br />
|n/a<br />
|GPS<br />
|[[File:Green-check-32.png|18px]]<br />
|}<br />
<br />
=Equipment=<br />
<br />
<br />
<br />
{|<br />
|[[File:Square sock.png|250px|link=Airport Windsock]]<br />
|[[File:Backpack-deicer-sqr.png|250px|link=Backpack Deicer]]<br />
|[[File:Deicing-truck.png|250px|link=Deicing Truck]]<br />
|[[File:PaintWizard Square.jpg|250px|link=Paint Wizard]]<br />
|-<br />
|style="text-align:center;"|Airport Windsock<br />
|style="text-align:center;"|Backpack Deicer<br />
|style="text-align:center;"|Deicing Truck<br />
|style="text-align:center;"|Paint Wizard<br />
|}<br />
<br />
<br />
{|<br />
|[[File:Kellyfuel-square.jpg|250px|link=KellyFuel]]<br />
|[[File:Cargo-hook-kit-small.jpg|250px|link=Cargo Hook Kit]]<br />
|[[File:Helitank-bottom.png|250px|link=Helitank for S-64 Aircrane]]<br />
|[[File:Logbook-thumb.png|250px|link=Pilot Logbook]]<br />
|-<br />
|style="text-align:center;"|Kelly Fuel<br />
|style="text-align:center;"|Cargo Hook Kit<br />
|style="text-align:center;"|Helitank for S-64 Aircrane<br />
|style="text-align:center;"|Pilot Logbook<br />
|}<br />
<br />
<br />
{|<br />
|[[File:Alarm-thumb.jpg|250px|link=ELT Alarm Box]]<br />
|[[File:Floatindex-thumb.png|250px|link=EC-135 Emergency Float Kit]]<br />
|[[File:Gps-screen-thumb.jpg|250px|link=Advanced Transponder and GPS HUD]]<br />
|[[File:Kimbi-thumb.jpg|250px|link=Kimbi Bucket]]<br />
|-<br />
|style="text-align:center;"|ELT Alarm Box<br />
|style="text-align:center;"|EC-135 Emergency Float Kit<br />
|style="text-align:center;"|Advanced Transponder and GPS HUD<br />
|style="text-align:center;"|Kimbi Bucket<br />
|}<br />
<br />
<br />
{|<br />
|[[File:Transponder-thumb.jpg|250px|link=Basic Transponder HUD]]<br />
|[[File:Modkit-thumb.png|250px|link=Tail Number Modkit]]<br />
|[[File:Radar-thumb.jpg|250px|link=Airport Radar]]<br />
|[[File:Rdfhud-thumb.png|250px|link=Radio Direction Finder HUD]]<br />
|-<br />
|style="text-align:center;"|Basic Transponder HUD<br />
|style="text-align:center;"|Tail Number Modkit<br />
|style="text-align:center;"|Airport Radar<br />
|style="text-align:center;"|Radio Direction Finder HUD<br />
|}<br />
<br />
{|<br />
|[[File:Winch-thumb.png|250px|link=EC-135 Rescue Winch Kit]]<br />
|[[File:Kellbucket thumb.png|250px|link=KellBucket]]<br />
|-<br />
|style="text-align:center;"|EC-135 Rescue Winch Kit<br />
|style="text-align:center;"|KellBucket<br />
|}<br />
<br />
=Practical Test Standards=<br />
<br />
:[[Private Helicopter PTS]]<br />
:[[Commercial Helicopter PTS]]<br />
:[[ATP Helicopter PTS]]<br />
:[[Flight Instructor Helicopter PTS]]</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=S-61R_Pelican/Release_Notes&diff=5635S-61R Pelican/Release Notes2022-09-14T01:55:23Z<p>Kelly: /* V1.1 Release Notes (2022.02.18) */</p>
<hr />
<div>== V1.2 Release Notes (2022.09.13) ==<br />
* Updated for compatibility with kimbi bucket.<br />
<br />
== V1.1 Release Notes (2022.02.18) ==<br />
* Fixed Engines fail to flame out when fuel is exhausted<br />
* Fixed Starting engines without the apu running fails to cause transmission wear<br />
* Adjusted engine oil temps. when operating single-engine<br />
* Heater now consumes fuel<br />
* Reduced the Frequency of patient health state changes<br />
* Allowed radar altitude autopilot hover<br />
* Fixed gps commands top/bottom/down/up<br />
* Knobs now switchable by clicking backing<br />
* Added gps route command<br />
* Added working radios<br />
* Added weather 2.0<br />
* Added icing<br />
* Added deicing mechanisms<br />
* Added ILS approaches<br />
* Added HSI/NAV instruments to HUD<br />
* Added retreating blade stall effects<br />
* Moved severed rescue hoist cable repair to the workbench<br />
* Added slip indicator to HUD<br />
* Reworked AFCS to improve stability when transitioning to autohover<br />
<br />
== V1.0 Release Notes (2020.08.21) ==<br />
<br />
* Fixed bug in marker Beacons<br />
* Fixed GPS chat command bugs<br />
* Added searchlight chat commands<br />
* Made qstart set transponder to Normal<br />
* Added patient health change messages<br />
* Ignoring collisions with seated avi to avoid messages with the new LL region crossing code.<br />
* Integrated ramps into onboard<br />
* Added backboard and headblocks for stokes<br />
* Added checklist HUD<br />
* Added missing command summary notecard.<br />
<br />
== V0.9.3 Release Notes (2020.07.26) ==<br />
<br />
* Removed unnecessary tint on tail rotor.<br />
* Added "wx" commands for controlling ceiling.<br />
* Fixed "start" command message.<br />
* Added sounds for engine/apu fires.<br />
* Added more failure rates.<br />
* Fixed activating cable shear in "cargo" version causes bad behavior.<br />
* Added burned textures for the engines and apu<br />
* Added burned out bulbs for warning lights<br />
* Added box of replacement bulbs on workbench.<br />
* Fixed "Repair all resets the air bottle used flag but does not refill bottle"<br />
* Updated Emergency Fuel Control Levers checklist page<br />
<br />
== V0.9.2 Release Notes (2020.07.10) ==<br />
<br />
* Fixed "engine dies when engine controller fails"<br />
* Added engine chip lights<br />
* Updated scripts for "cargo conversion kit" compatibility.<br />
* Added "extra" textures<br />
* Added cargo conversion kit<br />
* Added covers<br />
* Fixed "starter/igniter sounds don't work when there are any failures"<br />
* Fixed "wheels keep spinning if A/C goes non-physical while in ground motion"<br />
<br />
== V0.9.1 Release Notes (2020.07.03) ==<br />
<br />
* Improved Emergency Fuel Lever Handling<br />
* Fixed "Turning off fluid consumption sets APU accumulator level to 0 and prevents APU starting"<br />
* Fixed "Tail rotor strikes damage main rotor instead"<br />
* Fixed "Anchoring too close to a sim edge can cause the aircraft to be flung around if it crosses the sim edge while anchored" (will auto unanchor on crossing)<br />
* Improved handling on water with wind.<br />
* Checklist fixes (e.g., missing diagrams)<br />
* Improved HD water bullet detection for engine fire suppression<br />
* Fixed "workbench does not clear fire detect flag on engine replacement"<br />
<br />
== V0.9.0 Release Notes (2020.06.26) ==<br />
* Initial public beta release.</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=Chinook_CH-47/Release_Notes&diff=5634Chinook CH-47/Release Notes2022-09-13T21:25:31Z<p>Kelly: /* V1.2 Release Notes (TBD) */</p>
<hr />
<div>== V1.2 Release Notes (TBD) ==<br />
* Fixed intermittent failure of animation script on crossing<br />
* Bucket support functionality updated<br />
* Updated communications with server<br />
* User configurable no-collision-detected prims<br />
* Fixed some improperly configured busses for lighting.<br />
** Instrument and overhead lights moved to AC1<br />
** Dome light moved to DC1<br />
** Form light moved to AC1<br />
** Copilot instrument and overhead lights moved to AC1<br />
** Pilot instrument and overhead lights moved to AC2<br />
** Center console lights moved to AC1<br />
* Starters now require utility hydraulics<br />
* Reduced burn rate of various fluids<br />
* Added updated autorotation code<br />
* Adjusted Cyclic response<br />
* Updated HUD to newer style</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5630KellyFuel/Creator Instructions2022-09-07T14:57:55Z<p>Kelly: /* Programming Fuel Port Positions */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use the KellyFuel pump with their aircraft. You may choose to implement the full KellyFuel system, or simply set the position of fuel ports on your aircraft.<br />
<br />
== KellyFuel Protocol ==<br />
<br />
KellyFuel operates over an agreed upon channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose on the Shergood web page (coming soon). KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
[[File:Fuel Port Edit Menu.png|thumb|right|<br />
<figure id="fig:editMenu"><caption><br />
Fuel Pump Edit Menu</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump to bring up the main menu. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type. An example of the edit menu is shown in <xr id='fig:editMenu'/>. However, the "*SetPortPos" and "*DelPort" options will appear only if a specific port has first been selected from the main menu.<br />
<br />
Before performing edit operations, you should acquire the edit tools from the pump. Use the option "*Get Setup" from the edit menu. This will give you a folder with the following tools:<br />
<br />
* <tt>sa-kf-ground-setup</tt> - Indicates the position of the ground wire clip<br />
* <tt>sa-kf-nozzle-setup</tt> - Indicates the position of a standard gravity fed nozzle<br />
* <tt>sa-kf-pressNozzle-setup</tt> - Indicates the position of a pressure refueling nozzle<br />
<br />
The following sections will describe how to use these tools.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the "AddPort" option from the Edit menu. This will bring up a text box into which you can type the name of a tank/port on your aircraft. If the aircraft has only one tank, it is recommended that you use the name "main" for the tank. Once the port has been added, follow the directions in the next section to set the position of the nozzle for that port.<br />
<br />
=== Setting Nozzle Position for a Port ===<br />
<br />
To set the position of a port, first rez the appropriate nozzle tool you received from the "*Get Setup" option. There are two nozzle types. One type is the <tt>sa-kf-nozzle-setup</tt> nozzle which is used for gravity-fed fuel system (similar to a car fuel pump nozzle). The second type is the <tt>sa-kf-pressNozzle-setup</tt> nozzle which is used for high-speed pressure-fed fuel systems (normally only used on large aircraft with high-capacity tanks). To register the port position:<br />
<br />
# Edit the tool to the position on your aircraft where your fuel port is located.<br />
# Make sure you have selected the port for which you want register a position from the main menu.<br />
# Select "*SetPortPos" from the *Edit menu. This will record the position of the fuel tool (relative to the aircraft) on the server.<br />
<br />
=== Deleting a Port ===<br />
<br />
To delete a port, select it from the main menu, then choose "*DelPort" from the Edit menu.<br />
<br />
=== Renaming a Port ===<br />
<br />
To rename a port, simply delete the port and add it with the new name. You will need to set its position again if you have already set it.<br />
<br />
=== Setting Ground Wire Clip Position ===<br />
<br />
To set the ground wire position:<br />
<br />
# Rez the <tt>sa-kf-ground-setup</tt> tool near your aircraft<br />
# Edit the tool to the position where you want the ground wire to attach<br />
# Select "*SetGrndPos" from the Edit menu.<br />
<br />
== Sample Fuel Script ==<br />
<br />
<pre><br />
//<br />
// This is a sample kelly-fuel protocol script. Adapt as necessary for your aircraft.<br />
//<br />
<br />
integer FUEL_CHAN = 123; // Port number to use for fuel system (as registered on web site)<br />
string FUEL_TYPE = "jeta"; // Fuel type of this aircraft. Should be "jeta", "100ll".<br />
list TANK_NAMES = ["tank1","tank2"]; // Names of the tanks used by this aircraft (if only one tank, it is suggested it be called "main")<br />
list FUEL_MAX = [30,60]; // Maximum capacities in gallons of the tanks<br />
<br />
list fuel_levels = [0,0]; // Current fuel levels of each tank<br />
integer fuel_taint = 0; // Bit mask of fuel taint status in each tank<br />
<br />
//<br />
// Return 1 if tank #index is tainted with the incorrect fuel type.<br />
//<br />
integer is_tainted(integer index)<br />
{<br />
return (fuel_taint&(1<<index)) != 0;<br />
}<br />
<br />
//<br />
// Show fuel levels of all tanks in hover text<br />
//<br />
showLevels()<br />
{<br />
integer n = llGetListLength(TANK_NAMES);<br />
integer i;<br />
<br />
list lines;<br />
for (i = 0;i < n;i++) {<br />
string text = llList2String(TANK_NAMES,i)+": "+llList2String(fuel_levels,i)+" / "+llList2String(FUEL_MAX,i);<br />
if (is_tainted(i))<br />
text += " *tainted*";<br />
lines += [text];<br />
}<br />
llSetText(llDumpList2String(lines,"\n"),<1,1,1>,1);<br />
}<br />
<br />
default<br />
{<br />
state_entry()<br />
{<br />
//<br />
// Listen on the fuel channel (in aircraft, you can open this channel only while fuel cap is removed to reduce open channels)<br />
//<br />
llListen(FUEL_CHAN,"",NULL_KEY,"");<br />
showLevels();<br />
}<br />
<br />
touch_start(integer n) {<br />
//<br />
// Clear fuel tanks and any fuel taint<br />
//<br />
integer n = llGetListLength(TANK_NAMES);<br />
integer i;<br />
fuel_levels = [];<br />
fuel_taint = 0;<br />
for (i = 0;i < n;i++) {<br />
fuel_levels += [0];<br />
}<br />
showLevels();<br />
}<br />
<br />
listen(integer chan,string name,key id,string data) {<br />
//<br />
// Show received command for debuging<br />
//<br />
llOwnerSay("KF: "+data);<br />
<br />
//<br />
// Parse line into words. If the first word is not "@refuel" it is not a kellyfuel command (so ignore it)<br />
//<br />
list decoded_line = llParseString2List(data,[" "],[]);<br />
string prefix = llList2String(decoded_line,0);<br />
if (prefix != "@refuel") return;<br />
string command = llList2String(decoded_line,1);<br />
<br />
if (command == "check") {<br />
//<br />
// Check the levels of all tanks<br />
//<br />
integer n = llGetListLength(TANK_NAMES);<br />
integer i;<br />
for (i = 0;i < n;i++) {<br />
llRegionSayTo(id,FUEL_CHAN,"@ack 2 check "+llList2String(fuel_levels,i)+" "+llList2String(FUEL_MAX,i)+" "<br />
+llList2String(TANK_NAMES,i)+" "+(string)is_tainted(i));<br />
}<br />
} else if (command == "look") {<br />
//<br />
// Check the level of a specific tank<br />
//<br />
string tank = llList2String(decoded_line,2);<br />
integer tank_index = llListFindList(TANK_NAMES,[tank]);<br />
if (tank_index >= 0) {<br />
llRegionSayTo(id,FUEL_CHAN,"@ack look "+llList2String(fuel_levels,tank_index)+" "+llList2String(FUEL_MAX,tank_index)+" "<br />
+llList2String(TANK_NAMES,tank_index)+" "+(string)is_tainted(tank_index));<br />
} else {<br />
llRegionSayTo(id,FUEL_CHAN,"@error Unknown fuel tank");<br />
}<br />
} else if (command == "full") {<br />
//<br />
// Set all tanks to full<br />
//<br />
integer n = llGetListLength(TANK_NAMES);<br />
integer i;<br />
fuel_levels = FUEL_MAX;<br />
llRegionSayTo(id,FUEL_CHAN,"@ack full");<br />
showLevels();<br />
} else if (command == "add") {<br />
//<br />
// Add fuel to a tank<br />
//<br />
string tank = llList2String(decoded_line,2); // Get name of tank<br />
integer tank_index = llListFindList(TANK_NAMES,[tank]); // Get index of tank<br />
if (tank_index >= 0) {<br />
float amount = (float)llList2String(decoded_line,3); // Get amount of fuel to add<br />
string type = llList2String(decoded_line,4); // Get the fuel type<br />
<br />
if (type != "" && type != FUEL_TYPE) // If a fuel type is given, but incorrect for this<br />
fuel_taint = fuel_taint | (1<<tank_index); // aircraft, mark that tank as tainted.<br />
<br />
float current = llList2Float(fuel_levels,tank_index); // Get current fuel level in selected tank<br />
float new_level = current + amount; // Calculate new fuel level in selected tank<br />
float max = llList2Float(FUEL_MAX,tank_index); // Get max fuel level in selected tank<br />
float added = amount; // Set the amount of fuel added<br />
<br />
if (new_level > max) { // If the new fuel level is greater than the<br />
added = max-current; // maxmium tank capacity, adjust the amount<br />
new_level = max; // added and the new tank level.<br />
}<br />
<br />
//<br />
// Acknowledge to pump the actual fuel added<br />
//<br />
llRegionSayTo(id,FUEL_CHAN,"@ack add "+(string)amount+" "+(string)added);<br />
<br />
fuel_levels = llListReplaceList(fuel_levels,[new_level],tank_index,tank_index);<br />
showLevels();<br />
} else {<br />
llRegionSayTo(id,FUEL_CHAN,"@error Unknown fuel tank");<br />
}<br />
}<br />
}<br />
}<br />
</pre></div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5628KellyFuel/Creator Instructions2022-08-27T03:53:55Z<p>Kelly: /* Setting Ground Wire Clip Position */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use the KellyFuel pump with their aircraft. You may choose to implement the full KellyFuel system, or simply set the position of fuel ports on your aircraft.<br />
<br />
== KellyFuel Protocol ==<br />
<br />
KellyFuel operates over an agreed upon channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose on the Shergood web page (coming soon). KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
[[File:Fuel Port Edit Menu.png|thumb|right|<br />
<figure id="fig:editMenu"><caption><br />
Fuel Pump Edit Menu</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump to bring up the main menu. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type. An example of the edit menu is shown in <xr id='fig:editMenu'/>. However, the "*SetPortPos" and "*DelPort" options will appear only if a specific port has first been selected from the main menu.<br />
<br />
Before performing edit operations, you should acquire the edit tools from the pump. Use the option "*Get Setup" from the edit menu. This will give you a folder with the following tools:<br />
<br />
* <tt>sa-kf-ground-setup</tt> - Indicates the position of the ground wire clip<br />
* <tt>sa-kf-nozzle-setup</tt> - Indicates the position of a standard gravity fed nozzle<br />
* <tt>sa-kf-pressNozzle-setup</tt> - Indicates the position of a pressure refueling nozzle<br />
<br />
The following sections will describe how to use these tools.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the "AddPort" option from the Edit menu. This will bring up a text box into which you can type the name of a tank/port on your aircraft. If the aircraft has only one tank, it is recommended that you use the name "main" for the tank. Once the port has been added, follow the directions in the next section to set the position of the nozzle for that port.<br />
<br />
=== Setting Nozzle Position for a Port ===<br />
<br />
To set the position of a port, first rez the appropriate nozzle tool you received from the "*Get Setup" option. There are two nozzle types. One type is the <tt>sa-kf-nozzle-setup</tt> nozzle which is used for gravity-fed fuel system (similar to a car fuel pump nozzle). The second type is the <tt>sa-kf-pressNozzle-setup</tt> nozzle which is used for high-speed pressure-fed fuel systems (normally only used on large aircraft with high-capacity tanks). To register the port position:<br />
<br />
# Edit the tool to the position on your aircraft where your fuel port is located.<br />
# Make sure you have selected the port for which you want register a position from the main menu.<br />
# Select "*SetPortPos" from the *Edit menu. This will record the position of the fuel tool (relative to the aircraft) on the server.<br />
<br />
=== Deleting a Port ===<br />
<br />
To delete a port, select it from the main menu, then choose "*DelPort" from the Edit menu.<br />
<br />
=== Renaming a Port ===<br />
<br />
To rename a port, simply delete the port and add it with the new name. You will need to set its position again if you have already set it.<br />
<br />
=== Setting Ground Wire Clip Position ===<br />
<br />
To set the ground wire position:<br />
<br />
# Rez the <tt>sa-kf-ground-setup</tt> tool near your aircraft<br />
# Edit the tool to the position where you want the ground wire to attach<br />
# Select "*SetGrndPos" from the Edit menu.</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5627KellyFuel/Creator Instructions2022-08-27T03:53:47Z<p>Kelly: /* Renaming a Port */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use the KellyFuel pump with their aircraft. You may choose to implement the full KellyFuel system, or simply set the position of fuel ports on your aircraft.<br />
<br />
== KellyFuel Protocol ==<br />
<br />
KellyFuel operates over an agreed upon channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose on the Shergood web page (coming soon). KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
[[File:Fuel Port Edit Menu.png|thumb|right|<br />
<figure id="fig:editMenu"><caption><br />
Fuel Pump Edit Menu</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump to bring up the main menu. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type. An example of the edit menu is shown in <xr id='fig:editMenu'/>. However, the "*SetPortPos" and "*DelPort" options will appear only if a specific port has first been selected from the main menu.<br />
<br />
Before performing edit operations, you should acquire the edit tools from the pump. Use the option "*Get Setup" from the edit menu. This will give you a folder with the following tools:<br />
<br />
* <tt>sa-kf-ground-setup</tt> - Indicates the position of the ground wire clip<br />
* <tt>sa-kf-nozzle-setup</tt> - Indicates the position of a standard gravity fed nozzle<br />
* <tt>sa-kf-pressNozzle-setup</tt> - Indicates the position of a pressure refueling nozzle<br />
<br />
The following sections will describe how to use these tools.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the "AddPort" option from the Edit menu. This will bring up a text box into which you can type the name of a tank/port on your aircraft. If the aircraft has only one tank, it is recommended that you use the name "main" for the tank. Once the port has been added, follow the directions in the next section to set the position of the nozzle for that port.<br />
<br />
=== Setting Nozzle Position for a Port ===<br />
<br />
To set the position of a port, first rez the appropriate nozzle tool you received from the "*Get Setup" option. There are two nozzle types. One type is the <tt>sa-kf-nozzle-setup</tt> nozzle which is used for gravity-fed fuel system (similar to a car fuel pump nozzle). The second type is the <tt>sa-kf-pressNozzle-setup</tt> nozzle which is used for high-speed pressure-fed fuel systems (normally only used on large aircraft with high-capacity tanks). To register the port position:<br />
<br />
# Edit the tool to the position on your aircraft where your fuel port is located.<br />
# Make sure you have selected the port for which you want register a position from the main menu.<br />
# Select "*SetPortPos" from the *Edit menu. This will record the position of the fuel tool (relative to the aircraft) on the server.<br />
<br />
=== Deleting a Port ===<br />
<br />
To delete a port, select it from the main menu, then choose "*DelPort" from the Edit menu.<br />
<br />
=== Renaming a Port ===<br />
<br />
To rename a port, simply delete the port and add it with the new name. You will need to set its position again if you have already set it.<br />
<br />
== Setting Ground Wire Clip Position ==<br />
<br />
To set the ground wire position:<br />
<br />
# Rez the <tt>sa-kf-ground-setup</tt> tool near your aircraft<br />
# Edit the tool to the position where you want the ground wire to attach<br />
# Select "*SetGrndPos" from the Edit menu.</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5626KellyFuel/Creator Instructions2022-08-27T03:53:37Z<p>Kelly: /* Deleting a Port */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use the KellyFuel pump with their aircraft. You may choose to implement the full KellyFuel system, or simply set the position of fuel ports on your aircraft.<br />
<br />
== KellyFuel Protocol ==<br />
<br />
KellyFuel operates over an agreed upon channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose on the Shergood web page (coming soon). KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
[[File:Fuel Port Edit Menu.png|thumb|right|<br />
<figure id="fig:editMenu"><caption><br />
Fuel Pump Edit Menu</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump to bring up the main menu. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type. An example of the edit menu is shown in <xr id='fig:editMenu'/>. However, the "*SetPortPos" and "*DelPort" options will appear only if a specific port has first been selected from the main menu.<br />
<br />
Before performing edit operations, you should acquire the edit tools from the pump. Use the option "*Get Setup" from the edit menu. This will give you a folder with the following tools:<br />
<br />
* <tt>sa-kf-ground-setup</tt> - Indicates the position of the ground wire clip<br />
* <tt>sa-kf-nozzle-setup</tt> - Indicates the position of a standard gravity fed nozzle<br />
* <tt>sa-kf-pressNozzle-setup</tt> - Indicates the position of a pressure refueling nozzle<br />
<br />
The following sections will describe how to use these tools.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the "AddPort" option from the Edit menu. This will bring up a text box into which you can type the name of a tank/port on your aircraft. If the aircraft has only one tank, it is recommended that you use the name "main" for the tank. Once the port has been added, follow the directions in the next section to set the position of the nozzle for that port.<br />
<br />
=== Setting Nozzle Position for a Port ===<br />
<br />
To set the position of a port, first rez the appropriate nozzle tool you received from the "*Get Setup" option. There are two nozzle types. One type is the <tt>sa-kf-nozzle-setup</tt> nozzle which is used for gravity-fed fuel system (similar to a car fuel pump nozzle). The second type is the <tt>sa-kf-pressNozzle-setup</tt> nozzle which is used for high-speed pressure-fed fuel systems (normally only used on large aircraft with high-capacity tanks). To register the port position:<br />
<br />
# Edit the tool to the position on your aircraft where your fuel port is located.<br />
# Make sure you have selected the port for which you want register a position from the main menu.<br />
# Select "*SetPortPos" from the *Edit menu. This will record the position of the fuel tool (relative to the aircraft) on the server.<br />
<br />
=== Deleting a Port ===<br />
<br />
To delete a port, select it from the main menu, then choose "*DelPort" from the Edit menu.<br />
<br />
== Renaming a Port ==<br />
<br />
To rename a port, simply delete the port and add it with the new name. You will need to set its position again if you have already set it.<br />
<br />
== Setting Ground Wire Clip Position ==<br />
<br />
To set the ground wire position:<br />
<br />
# Rez the <tt>sa-kf-ground-setup</tt> tool near your aircraft<br />
# Edit the tool to the position where you want the ground wire to attach<br />
# Select "*SetGrndPos" from the Edit menu.</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5625KellyFuel/Creator Instructions2022-08-27T03:53:30Z<p>Kelly: /* Setting Nozzle Position for a Port */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use the KellyFuel pump with their aircraft. You may choose to implement the full KellyFuel system, or simply set the position of fuel ports on your aircraft.<br />
<br />
== KellyFuel Protocol ==<br />
<br />
KellyFuel operates over an agreed upon channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose on the Shergood web page (coming soon). KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
[[File:Fuel Port Edit Menu.png|thumb|right|<br />
<figure id="fig:editMenu"><caption><br />
Fuel Pump Edit Menu</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump to bring up the main menu. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type. An example of the edit menu is shown in <xr id='fig:editMenu'/>. However, the "*SetPortPos" and "*DelPort" options will appear only if a specific port has first been selected from the main menu.<br />
<br />
Before performing edit operations, you should acquire the edit tools from the pump. Use the option "*Get Setup" from the edit menu. This will give you a folder with the following tools:<br />
<br />
* <tt>sa-kf-ground-setup</tt> - Indicates the position of the ground wire clip<br />
* <tt>sa-kf-nozzle-setup</tt> - Indicates the position of a standard gravity fed nozzle<br />
* <tt>sa-kf-pressNozzle-setup</tt> - Indicates the position of a pressure refueling nozzle<br />
<br />
The following sections will describe how to use these tools.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the "AddPort" option from the Edit menu. This will bring up a text box into which you can type the name of a tank/port on your aircraft. If the aircraft has only one tank, it is recommended that you use the name "main" for the tank. Once the port has been added, follow the directions in the next section to set the position of the nozzle for that port.<br />
<br />
=== Setting Nozzle Position for a Port ===<br />
<br />
To set the position of a port, first rez the appropriate nozzle tool you received from the "*Get Setup" option. There are two nozzle types. One type is the <tt>sa-kf-nozzle-setup</tt> nozzle which is used for gravity-fed fuel system (similar to a car fuel pump nozzle). The second type is the <tt>sa-kf-pressNozzle-setup</tt> nozzle which is used for high-speed pressure-fed fuel systems (normally only used on large aircraft with high-capacity tanks). To register the port position:<br />
<br />
# Edit the tool to the position on your aircraft where your fuel port is located.<br />
# Make sure you have selected the port for which you want register a position from the main menu.<br />
# Select "*SetPortPos" from the *Edit menu. This will record the position of the fuel tool (relative to the aircraft) on the server.<br />
<br />
== Deleting a Port ==<br />
<br />
To delete a port, select it from the main menu, then choose "*DelPort" from the Edit menu.<br />
<br />
== Renaming a Port ==<br />
<br />
To rename a port, simply delete the port and add it with the new name. You will need to set its position again if you have already set it.<br />
<br />
== Setting Ground Wire Clip Position ==<br />
<br />
To set the ground wire position:<br />
<br />
# Rez the <tt>sa-kf-ground-setup</tt> tool near your aircraft<br />
# Edit the tool to the position where you want the ground wire to attach<br />
# Select "*SetGrndPos" from the Edit menu.</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5624KellyFuel/Creator Instructions2022-08-27T03:52:46Z<p>Kelly: /* KellyFuel Protocol */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use the KellyFuel pump with their aircraft. You may choose to implement the full KellyFuel system, or simply set the position of fuel ports on your aircraft.<br />
<br />
== KellyFuel Protocol ==<br />
<br />
KellyFuel operates over an agreed upon channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose on the Shergood web page (coming soon). KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
[[File:Fuel Port Edit Menu.png|thumb|right|<br />
<figure id="fig:editMenu"><caption><br />
Fuel Pump Edit Menu</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump to bring up the main menu. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type. An example of the edit menu is shown in <xr id='fig:editMenu'/>. However, the "*SetPortPos" and "*DelPort" options will appear only if a specific port has first been selected from the main menu.<br />
<br />
Before performing edit operations, you should acquire the edit tools from the pump. Use the option "*Get Setup" from the edit menu. This will give you a folder with the following tools:<br />
<br />
* <tt>sa-kf-ground-setup</tt> - Indicates the position of the ground wire clip<br />
* <tt>sa-kf-nozzle-setup</tt> - Indicates the position of a standard gravity fed nozzle<br />
* <tt>sa-kf-pressNozzle-setup</tt> - Indicates the position of a pressure refueling nozzle<br />
<br />
The following sections will describe how to use these tools.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the "AddPort" option from the Edit menu. This will bring up a text box into which you can type the name of a tank/port on your aircraft. If the aircraft has only one tank, it is recommended that you use the name "main" for the tank. Once the port has been added, follow the directions in the next section to set the position of the nozzle for that port.<br />
<br />
== Setting Nozzle Position for a Port ==<br />
<br />
To set the position of a port, first rez the appropriate nozzle tool you received from the "*Get Setup" option. There are two nozzle types. One type is the <tt>sa-kf-nozzle-setup</tt> nozzle which is used for gravity-fed fuel system (similar to a car fuel pump nozzle). The second type is the <tt>sa-kf-pressNozzle-setup</tt> nozzle which is used for high-speed pressure-fed fuel systems (normally only used on large aircraft with high-capacity tanks). To register the port position:<br />
<br />
# Edit the tool to the position on your aircraft where your fuel port is located.<br />
# Make sure you have selected the port for which you want register a position from the main menu.<br />
# Select "*SetPortPos" from the *Edit menu. This will record the position of the fuel tool (relative to the aircraft) on the server.<br />
<br />
== Deleting a Port ==<br />
<br />
To delete a port, select it from the main menu, then choose "*DelPort" from the Edit menu.<br />
<br />
== Renaming a Port ==<br />
<br />
To rename a port, simply delete the port and add it with the new name. You will need to set its position again if you have already set it.<br />
<br />
== Setting Ground Wire Clip Position ==<br />
<br />
To set the ground wire position:<br />
<br />
# Rez the <tt>sa-kf-ground-setup</tt> tool near your aircraft<br />
# Edit the tool to the position where you want the ground wire to attach<br />
# Select "*SetGrndPos" from the Edit menu.</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5623KellyFuel/Creator Instructions2022-08-27T03:51:59Z<p>Kelly: </p>
<hr />
<div>This section is intended for aircraft creators who wish to use the KellyFuel pump with their aircraft. You may choose to implement the full KellyFuel system, or simply set the position of fuel ports on your aircraft.<br />
<br />
== KellyFuel Protocol ==<br />
<br />
KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
[[File:Fuel Port Edit Menu.png|thumb|right|<br />
<figure id="fig:editMenu"><caption><br />
Fuel Pump Edit Menu</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump to bring up the main menu. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type. An example of the edit menu is shown in <xr id='fig:editMenu'/>. However, the "*SetPortPos" and "*DelPort" options will appear only if a specific port has first been selected from the main menu.<br />
<br />
Before performing edit operations, you should acquire the edit tools from the pump. Use the option "*Get Setup" from the edit menu. This will give you a folder with the following tools:<br />
<br />
* <tt>sa-kf-ground-setup</tt> - Indicates the position of the ground wire clip<br />
* <tt>sa-kf-nozzle-setup</tt> - Indicates the position of a standard gravity fed nozzle<br />
* <tt>sa-kf-pressNozzle-setup</tt> - Indicates the position of a pressure refueling nozzle<br />
<br />
The following sections will describe how to use these tools.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the "AddPort" option from the Edit menu. This will bring up a text box into which you can type the name of a tank/port on your aircraft. If the aircraft has only one tank, it is recommended that you use the name "main" for the tank. Once the port has been added, follow the directions in the next section to set the position of the nozzle for that port.<br />
<br />
== Setting Nozzle Position for a Port ==<br />
<br />
To set the position of a port, first rez the appropriate nozzle tool you received from the "*Get Setup" option. There are two nozzle types. One type is the <tt>sa-kf-nozzle-setup</tt> nozzle which is used for gravity-fed fuel system (similar to a car fuel pump nozzle). The second type is the <tt>sa-kf-pressNozzle-setup</tt> nozzle which is used for high-speed pressure-fed fuel systems (normally only used on large aircraft with high-capacity tanks). To register the port position:<br />
<br />
# Edit the tool to the position on your aircraft where your fuel port is located.<br />
# Make sure you have selected the port for which you want register a position from the main menu.<br />
# Select "*SetPortPos" from the *Edit menu. This will record the position of the fuel tool (relative to the aircraft) on the server.<br />
<br />
== Deleting a Port ==<br />
<br />
To delete a port, select it from the main menu, then choose "*DelPort" from the Edit menu.<br />
<br />
== Renaming a Port ==<br />
<br />
To rename a port, simply delete the port and add it with the new name. You will need to set its position again if you have already set it.<br />
<br />
== Setting Ground Wire Clip Position ==<br />
<br />
To set the ground wire position:<br />
<br />
# Rez the <tt>sa-kf-ground-setup</tt> tool near your aircraft<br />
# Edit the tool to the position where you want the ground wire to attach<br />
# Select "*SetGrndPos" from the Edit menu.</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5622KellyFuel/Creator Instructions2022-08-27T03:48:22Z<p>Kelly: /* Setting Ground Wire Clip Position */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
[[File:Fuel Port Edit Menu.png|thumb|right|<br />
<figure id="fig:editMenu"><caption><br />
Fuel Pump Edit Menu</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump to bring up the main menu. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type. An example of the edit menu is shown in <xr id='fig:editMenu'/>. However, the "*SetPortPos" and "*DelPort" options will appear only if a specific port has first been selected from the main menu.<br />
<br />
Before performing edit operations, you should acquire the edit tools from the pump. Use the option "*Get Setup" from the edit menu. This will give you a folder with the following tools:<br />
<br />
* <tt>sa-kf-ground-setup</tt> - Indicates the position of the ground wire clip<br />
* <tt>sa-kf-nozzle-setup</tt> - Indicates the position of a standard gravity fed nozzle<br />
* <tt>sa-kf-pressNozzle-setup</tt> - Indicates the position of a pressure refueling nozzle<br />
<br />
The following sections will describe how to use these tools.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the "AddPort" option from the Edit menu. This will bring up a text box into which you can type the name of a tank/port on your aircraft. If the aircraft has only one tank, it is recommended that you use the name "main" for the tank. Once the port has been added, follow the directions in the next section to set the position of the nozzle for that port.<br />
<br />
== Setting Nozzle Position for a Port ==<br />
<br />
To set the position of a port, first rez the appropriate nozzle tool you received from the "*Get Setup" option. There are two nozzle types. One type is the <tt>sa-kf-nozzle-setup</tt> nozzle which is used for gravity-fed fuel system (similar to a car fuel pump nozzle). The second type is the <tt>sa-kf-pressNozzle-setup</tt> nozzle which is used for high-speed pressure-fed fuel systems (normally only used on large aircraft with high-capacity tanks). To register the port position:<br />
<br />
# Edit the tool to the position on your aircraft where your fuel port is located.<br />
# Make sure you have selected the port for which you want register a position from the main menu.<br />
# Select "*SetPortPos" from the *Edit menu. This will record the position of the fuel tool (relative to the aircraft) on the server.<br />
<br />
== Deleting a Port ==<br />
<br />
To delete a port, select it from the main menu, then choose "*DelPort" from the Edit menu.<br />
<br />
== Renaming a Port ==<br />
<br />
To rename a port, simply delete the port and add it with the new name. You will need to set its position again if you have already set it.<br />
<br />
== Setting Ground Wire Clip Position ==<br />
<br />
To set the ground wire position:<br />
<br />
# Rez the <tt>sa-kf-ground-setup</tt> tool near your aircraft<br />
# Edit the tool to the position where you want the ground wire to attach<br />
# Select "*SetGrndPos" from the Edit menu.</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5621KellyFuel/Creator Instructions2022-08-27T03:47:18Z<p>Kelly: /* Setting Ground Wire Clip Position */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
[[File:Fuel Port Edit Menu.png|thumb|right|<br />
<figure id="fig:editMenu"><caption><br />
Fuel Pump Edit Menu</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump to bring up the main menu. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type. An example of the edit menu is shown in <xr id='fig:editMenu'/>. However, the "*SetPortPos" and "*DelPort" options will appear only if a specific port has first been selected from the main menu.<br />
<br />
Before performing edit operations, you should acquire the edit tools from the pump. Use the option "*Get Setup" from the edit menu. This will give you a folder with the following tools:<br />
<br />
* <tt>sa-kf-ground-setup</tt> - Indicates the position of the ground wire clip<br />
* <tt>sa-kf-nozzle-setup</tt> - Indicates the position of a standard gravity fed nozzle<br />
* <tt>sa-kf-pressNozzle-setup</tt> - Indicates the position of a pressure refueling nozzle<br />
<br />
The following sections will describe how to use these tools.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the "AddPort" option from the Edit menu. This will bring up a text box into which you can type the name of a tank/port on your aircraft. If the aircraft has only one tank, it is recommended that you use the name "main" for the tank. Once the port has been added, follow the directions in the next section to set the position of the nozzle for that port.<br />
<br />
== Setting Nozzle Position for a Port ==<br />
<br />
To set the position of a port, first rez the appropriate nozzle tool you received from the "*Get Setup" option. There are two nozzle types. One type is the <tt>sa-kf-nozzle-setup</tt> nozzle which is used for gravity-fed fuel system (similar to a car fuel pump nozzle). The second type is the <tt>sa-kf-pressNozzle-setup</tt> nozzle which is used for high-speed pressure-fed fuel systems (normally only used on large aircraft with high-capacity tanks). To register the port position:<br />
<br />
# Edit the tool to the position on your aircraft where your fuel port is located.<br />
# Make sure you have selected the port for which you want register a position from the main menu.<br />
# Select "*SetPortPos" from the *Edit menu. This will record the position of the fuel tool (relative to the aircraft) on the server.<br />
<br />
== Deleting a Port ==<br />
<br />
To delete a port, select it from the main menu, then choose "*DelPort" from the Edit menu.<br />
<br />
== Renaming a Port ==<br />
<br />
To rename a port, simply delete the port and add it with the new name. You will need to set its position again if you have already set it.<br />
<br />
== Setting Ground Wire Clip Position ==<br />
<br />
To set the <br />
<br />
# Rez the <tt>sa-kf-ground-setup</tt> tool near your aircraft<br />
# Edit the tool to the position where you want the ground wire to attach<br />
# Select "*SetGrndPos" from the Edit menu.</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5620KellyFuel/Creator Instructions2022-08-27T03:45:40Z<p>Kelly: /* Programming Fuel Port Positions */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
[[File:Fuel Port Edit Menu.png|thumb|right|<br />
<figure id="fig:editMenu"><caption><br />
Fuel Pump Edit Menu</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump to bring up the main menu. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type. An example of the edit menu is shown in <xr id='fig:editMenu'/>. However, the "*SetPortPos" and "*DelPort" options will appear only if a specific port has first been selected from the main menu.<br />
<br />
Before performing edit operations, you should acquire the edit tools from the pump. Use the option "*Get Setup" from the edit menu. This will give you a folder with the following tools:<br />
<br />
* <tt>sa-kf-ground-setup</tt> - Indicates the position of the ground wire clip<br />
* <tt>sa-kf-nozzle-setup</tt> - Indicates the position of a standard gravity fed nozzle<br />
* <tt>sa-kf-pressNozzle-setup</tt> - Indicates the position of a pressure refueling nozzle<br />
<br />
The following sections will describe how to use these tools.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the "AddPort" option from the Edit menu. This will bring up a text box into which you can type the name of a tank/port on your aircraft. If the aircraft has only one tank, it is recommended that you use the name "main" for the tank. Once the port has been added, follow the directions in the next section to set the position of the nozzle for that port.<br />
<br />
== Setting Nozzle Position for a Port ==<br />
<br />
To set the position of a port, first rez the appropriate nozzle tool you received from the "*Get Setup" option. There are two nozzle types. One type is the <tt>sa-kf-nozzle-setup</tt> nozzle which is used for gravity-fed fuel system (similar to a car fuel pump nozzle). The second type is the <tt>sa-kf-pressNozzle-setup</tt> nozzle which is used for high-speed pressure-fed fuel systems (normally only used on large aircraft with high-capacity tanks). To register the port position:<br />
<br />
# Edit the tool to the position on your aircraft where your fuel port is located.<br />
# Make sure you have selected the port for which you want register a position from the main menu.<br />
# Select "*SetPortPos" from the *Edit menu. This will record the position of the fuel tool (relative to the aircraft) on the server.<br />
<br />
== Deleting a Port ==<br />
<br />
To delete a port, select it from the main menu, then choose "*DelPort" from the Edit menu.<br />
<br />
== Renaming a Port ==<br />
<br />
To rename a port, simply delete the port and add it with the new name. You will need to set its position again if you have already set it.<br />
<br />
== Setting Ground Wire Clip Position ==</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5619KellyFuel/Creator Instructions2022-08-27T03:44:11Z<p>Kelly: /* Deleting a Port */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
[[File:Fuel Port Edit Menu.png|thumb|right|<br />
<figure id="fig:editMenu"><caption><br />
Fuel Pump Edit Menu</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump to bring up the main menu. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type. An example of the edit menu is shown in <xr id='fig:editMenu'/>. However, the "*SetPortPos" and "*DelPort" options will appear only if a specific port has first been selected from the main menu.<br />
<br />
Before performing edit operations, you should acquire the edit tools from the pump. Use the option "*Get Setup" from the edit menu. This will give you a folder with the following tools:<br />
<br />
* sa-kf-ground-setup - Indicates the position of the ground wire clip<br />
* sa-kf-nozzle-setup - Indicates the position of a standard gravity fed nozzle<br />
* sa-kf-pressNozzle-setup - Indicates the position of a pressure refueling nozzle<br />
<br />
The following sections will describe how to use these tools.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the "AddPort" option from the Edit menu. This will bring up a text box into which you can type the name of a tank/port on your aircraft. If the aircraft has only one tank, it is recommended that you use the name "main" for the tank. Once the port has been added, follow the directions in the next section to set the position of the nozzle for that port.<br />
<br />
== Setting Nozzle Position for a Port ==<br />
<br />
To set the position of a port, first rez the appropriate nozzle tool you received from the "*Get Setup" option. There are two nozzle types. One type is the <tt>sa-kf-nozzle-setup</tt> nozzle which is used for gravity-fed fuel system (similar to a car fuel pump nozzle). The second type is the <tt>sa-kf-pressNozzle-setup</tt> nozzle which is used for high-speed pressure-fed fuel systems (normally only used on large aircraft with high-capacity tanks). To register the port position:<br />
<br />
# Edit the tool to the position on your aircraft where your fuel port is located.<br />
# Make sure you have selected the port for which you want register a position from the main menu.<br />
# Select "*SetPortPos" from the *Edit menu. This will record the position of the fuel tool (relative to the aircraft) on the server.<br />
<br />
== Deleting a Port ==<br />
<br />
To delete a port, select it from the main menu, then choose "*DelPort" from the Edit menu.<br />
<br />
== Renaming a Port ==<br />
<br />
To rename a port, simply delete the port and add it with the new name. You will need to set its position again if you have already set it.<br />
<br />
== Setting Ground Wire Clip Position ==</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5618KellyFuel/Creator Instructions2022-08-27T03:43:32Z<p>Kelly: /* Setting Nozzle Position for a Port */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
[[File:Fuel Port Edit Menu.png|thumb|right|<br />
<figure id="fig:editMenu"><caption><br />
Fuel Pump Edit Menu</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump to bring up the main menu. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type. An example of the edit menu is shown in <xr id='fig:editMenu'/>. However, the "*SetPortPos" and "*DelPort" options will appear only if a specific port has first been selected from the main menu.<br />
<br />
Before performing edit operations, you should acquire the edit tools from the pump. Use the option "*Get Setup" from the edit menu. This will give you a folder with the following tools:<br />
<br />
* sa-kf-ground-setup - Indicates the position of the ground wire clip<br />
* sa-kf-nozzle-setup - Indicates the position of a standard gravity fed nozzle<br />
* sa-kf-pressNozzle-setup - Indicates the position of a pressure refueling nozzle<br />
<br />
The following sections will describe how to use these tools.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the "AddPort" option from the Edit menu. This will bring up a text box into which you can type the name of a tank/port on your aircraft. If the aircraft has only one tank, it is recommended that you use the name "main" for the tank. Once the port has been added, follow the directions in the next section to set the position of the nozzle for that port.<br />
<br />
== Setting Nozzle Position for a Port ==<br />
<br />
To set the position of a port, first rez the appropriate nozzle tool you received from the "*Get Setup" option. There are two nozzle types. One type is the <tt>sa-kf-nozzle-setup</tt> nozzle which is used for gravity-fed fuel system (similar to a car fuel pump nozzle). The second type is the <tt>sa-kf-pressNozzle-setup</tt> nozzle which is used for high-speed pressure-fed fuel systems (normally only used on large aircraft with high-capacity tanks). To register the port position:<br />
<br />
# Edit the tool to the position on your aircraft where your fuel port is located.<br />
# Make sure you have selected the port for which you want register a position from the main menu.<br />
# Select "*SetPortPos" from the *Edit menu. This will record the position of the fuel tool (relative to the aircraft) on the server.<br />
<br />
== Deleting a Port ==<br />
<br />
== Renaming a Port ==<br />
<br />
To rename a port, simply delete the port and add it with the new name. You will need to set its position again if you have already set it.<br />
<br />
== Setting Ground Wire Clip Position ==</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5617KellyFuel/Creator Instructions2022-08-27T03:40:17Z<p>Kelly: /* Programming Fuel Port Positions */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
[[File:Fuel Port Edit Menu.png|thumb|right|<br />
<figure id="fig:editMenu"><caption><br />
Fuel Pump Edit Menu</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump to bring up the main menu. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type. An example of the edit menu is shown in <xr id='fig:editMenu'/>. However, the "*SetPortPos" and "*DelPort" options will appear only if a specific port has first been selected from the main menu.<br />
<br />
Before performing edit operations, you should acquire the edit tools from the pump. Use the option "*Get Setup" from the edit menu. This will give you a folder with the following tools:<br />
<br />
* sa-kf-ground-setup - Indicates the position of the ground wire clip<br />
* sa-kf-nozzle-setup - Indicates the position of a standard gravity fed nozzle<br />
* sa-kf-pressNozzle-setup - Indicates the position of a pressure refueling nozzle<br />
<br />
The following sections will describe how to use these tools.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the "AddPort" option from the Edit menu. This will bring up a text box into which you can type the name of a tank/port on your aircraft. If the aircraft has only one tank, it is recommended that you use the name "main" for the tank. Once the port has been added, follow the directions in the next section to set the position of the nozzle for that port.<br />
<br />
== Setting Nozzle Position for a Port ==<br />
<br />
To set the position of a port, first rez the appropriate nozzle tool you received from the "*Get Setup" option. There are two nozzle types. One type is the <tt>sa-kf-nozzle-setup</tt> nozzle which is used for gravity-fed fuel system (similar to a car fuel pump nozzle). The second type is the <tt>sa-kf-pressNozzle-setup</tt> nozzle which is used for high-speed pressure-fed fuel systems (normally only used on large aircraft with high-capacity tanks). To register the port position:<br />
<br />
# Edit the tool to the position on your aircraft where your fuel port is located.<br />
# Make sure you have selected the port for which you want register a position from the main menu.<br />
# Select <br />
<br />
== Deleting a Port ==<br />
<br />
== Renaming a Port ==<br />
<br />
To rename a port, simply delete the port and add it with the new name. You will need to set its position again if you have already set it.<br />
<br />
== Setting Ground Wire Clip Position ==</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5616KellyFuel/Creator Instructions2022-08-27T03:24:57Z<p>Kelly: /* Adding A Port */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
[[File:Fuel Port Edit Menu.png|thumb|right|<br />
<figure id="fig:editMenu"><caption><br />
Fuel Pump Edit Menu</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump to bring up the main menu. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type. An example of the edit menu is shown in <xr id='fig:editMenu'/>. However, the "*SetPortPos" and "*DelPort" options will appear only if a specific port has first been selected from the main menu.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the "AddPort" option from the Edit menu. This will bring up a text box into which you can type the name of a tank/port on your aircraft. If the aircraft has only one tank, it is recommended that you used the name "main" for the tank.<br />
<br />
T<br />
<br />
<br />
Once you have added a fuel tank, you can use either the sa-kf-nozzle-setup or the sa-kf-pressNozzle-setup tool to indicate where on your aircraft a refueling nozzle should be positioned. Use the sa-kf-nozzle-setup if it is a standard gravity-fed tank, and use sa-kf-pressNozzle-setup if it is a high-speed pressure refueling port (normally only used on large aircraft).</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5615KellyFuel/Creator Instructions2022-08-27T03:15:34Z<p>Kelly: /* Programming Fuel Port Positions */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
[[File:Fuel Port Edit Menu.png|thumb|right|<br />
<figure id="fig:editMenu"><caption><br />
Fuel Pump Edit Menu</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump to bring up the main menu. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type. An example of the edit menu is shown in <xr id='fig:editMenu'/>. However, the "*SetPortPos" and "*DelPort" options will appear only if a specific port has first been selected from the main menu.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the "AddPort" option. This will bring up a text box into which you can type the name of a tank/port on your aircraft. If the aircraft has only one tank, it is recommended that you used the name "main" for the tank.<br />
<br />
The Setup tool folder contains the following tools:<br />
<br />
* sa-kf-ground-setup - Indicates the position of the ground wire clip<br />
* sa-kf-nozzle-setup - Indicates the position of a standard gravity fed nozzle<br />
* sa-kf-pressNozzle-setup - Indicates the position of a pressure refueling nozzle<br />
<br />
<br />
<br />
<br />
Once you have added a fuel tank, you can use either the sa-kf-nozzle-setup or the sa-kf-pressNozzle-setup tool to indicate where on your aircraft a refueling nozzle should be positioned. Use the sa-kf-nozzle-setup if it is a standard gravity-fed tank, and use sa-kf-pressNozzle-setup if it is a high-speed pressure refueling port (normally only used on large aircraft).</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=File:Fuel_Port_Edit_Menu.png&diff=5614File:Fuel Port Edit Menu.png2022-08-27T03:10:48Z<p>Kelly: </p>
<hr />
<div></div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5613KellyFuel/Creator Instructions2022-08-27T03:09:02Z<p>Kelly: /* Programming Fuel Port Positions */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. <br />
<br />
After connecting the aircraft, click the pump. If you have admin privileges for the aircraft, in addition to the currently configured tank names, you should see a button labeled "*Edit" (see <xr id='fig:mainMenu'/>). This option is used for editing the aircraft type information on the servers. The prompt part of the menu includes information about the selected aircraft, its type, and the fuel system designated for that type.<br />
<br />
=== Adding A Port ===<br />
<br />
To add a port/tank to an aircraft use the <br />
<br />
Use the "AddPort" option to add a fuel tank/port to the aircraft type description stored on the server. This will bring up a text box into which you can type the name<br />
<br />
The Setup tool folder contains the following tools:<br />
<br />
* sa-kf-ground-setup - Indicates the position of the ground wire clip<br />
* sa-kf-nozzle-setup - Indicates the position of a standard gravity fed nozzle<br />
* sa-kf-pressNozzle-setup - Indicates the position of a pressure refueling nozzle<br />
<br />
<br />
<br />
<br />
Once you have added a fuel tank, you can use either the sa-kf-nozzle-setup or the sa-kf-pressNozzle-setup tool to indicate where on your aircraft a refueling nozzle should be positioned. Use the sa-kf-nozzle-setup if it is a standard gravity-fed tank, and use sa-kf-pressNozzle-setup if it is a high-speed pressure refueling port (normally only used on large aircraft).</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5612KellyFuel/Creator Instructions2022-08-27T03:05:22Z<p>Kelly: /* Adding A Port */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. Once the aircraft is connected to the pump, you can perform the actions in the following sections.<br />
<br />
=== Adding A Port ===<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
<br />
and select "*Edit" from the main menu. If no tank is currently selected, this will bring up a sub-menu with the options:<br />
<br />
* AddPort - Add port to aircraft.<br />
* Get Setup - Get tools for port positioning.<br />
* SetGrndPos - Record ground clip position.<br />
<br />
Use the "AddPort" option to add a fuel tank/port to the aircraft type description stored on the server. This will bring up a text box into which you can type the name<br />
<br />
The Setup tool folder contains the following tools:<br />
<br />
* sa-kf-ground-setup - Indicates the position of the ground wire clip<br />
* sa-kf-nozzle-setup - Indicates the position of a standard gravity fed nozzle<br />
* sa-kf-pressNozzle-setup - Indicates the position of a pressure refueling nozzle<br />
<br />
<br />
<br />
<br />
Once you have added a fuel tank, you can use either the sa-kf-nozzle-setup or the sa-kf-pressNozzle-setup tool to indicate where on your aircraft a refueling nozzle should be positioned. Use the sa-kf-nozzle-setup if it is a standard gravity-fed tank, and use sa-kf-pressNozzle-setup if it is a high-speed pressure refueling port (normally only used on large aircraft).</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5611KellyFuel/Creator Instructions2022-08-27T03:05:13Z<p>Kelly: /* Adding A Port */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. Once the aircraft is connected to the pump, you can perform the actions in the following sections.<br />
<br />
=== Adding A Port ===<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
<br />
and select "*Edit" from the main menu. If no tank is currently selected, this will bring up a sub-menu with the options:<br />
<br />
* AddPort - Add port to aircraft.<br />
* Get Setup - Get tools for port positioning.<br />
* SetGrndPos - Record ground clip position.<br />
<br />
Use the "AddPort" option to add a fuel tank/port to the aircraft type description stored on the server. This will bring up a text box into which you can type the name<br />
<br />
The Setup tool folder contains the following tools:<br />
<br />
* sa-kf-ground-setup - Indicates the position of the ground wire clip<br />
* sa-kf-nozzle-setup - Indicates the position of a standard gravity fed nozzle<br />
* sa-kf-pressNozzle-setup - Indicates the position of a pressure refueling nozzle<br />
<br />
<br />
<br />
<br />
Once you have added a fuel tank, you can use either the sa-kf-nozzle-setup or the sa-kf-pressNozzle-setup tool to indicate where on your aircraft a refueling nozzle should be positioned. Use the sa-kf-nozzle-setup if it is a standard gravity-fed tank, and use sa-kf-pressNozzle-setup if it is a high-speed pressure refueling port (normally only used on large aircraft).</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5610KellyFuel/Creator Instructions2022-08-27T03:04:20Z<p>Kelly: /* Adding A Port */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. Once the aircraft is connected to the pump, you can perform the actions in the following sections.<br />
<br />
=== Adding A Port ===<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right|<br />
<figure id="fig:mainMenu"><caption><br />
Fuel Pump Main Menu (Admin)</caption></figure><br />
]]<br />
<br />
After connecting the aircraft, click the pump and select "*Edit" from the main menu. If no tank is currently selected, this will bring up a sub-menu with the options:<br />
<br />
* AddPort - Add port to aircraft.<br />
* Get Setup - Get tools for port positioning.<br />
* SetGrndPos - Record ground clip position.<br />
<br />
Use the "AddPort" option to add a fuel tank/port to the aircraft type description stored on the server. This will bring up a text box into which you can type the name<br />
<br />
The Setup tool folder contains the following tools:<br />
<br />
* sa-kf-ground-setup - Indicates the position of the ground wire clip<br />
* sa-kf-nozzle-setup - Indicates the position of a standard gravity fed nozzle<br />
* sa-kf-pressNozzle-setup - Indicates the position of a pressure refueling nozzle<br />
<br />
<br />
<br />
<br />
Once you have added a fuel tank, you can use either the sa-kf-nozzle-setup or the sa-kf-pressNozzle-setup tool to indicate where on your aircraft a refueling nozzle should be positioned. Use the sa-kf-nozzle-setup if it is a standard gravity-fed tank, and use sa-kf-pressNozzle-setup if it is a high-speed pressure refueling port (normally only used on large aircraft).</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5609KellyFuel/Creator Instructions2022-08-27T03:02:46Z<p>Kelly: /* Adding A Port */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. Once the aircraft is connected to the pump, you can perform the actions in the following sections.<br />
<br />
=== Adding A Port ===<br />
<br />
[[File:Fuel_Pump_Main_Menu.png|thumb|right]]<br />
<br />
After connecting the aircraft, click the pump and select "*Edit" from the main menu. If no tank is currently selected, this will bring up a sub-menu with the options:<br />
<br />
* AddPort - Add port to aircraft.<br />
* Get Setup - Get tools for port positioning.<br />
* SetGrndPos - Record ground clip position.<br />
<br />
Use the "AddPort" option to add a fuel tank/port to the aircraft type description stored on the server. This will bring up a text box into which you can type the name<br />
<br />
The Setup tool folder contains the following tools:<br />
<br />
* sa-kf-ground-setup - Indicates the position of the ground wire clip<br />
* sa-kf-nozzle-setup - Indicates the position of a standard gravity fed nozzle<br />
* sa-kf-pressNozzle-setup - Indicates the position of a pressure refueling nozzle<br />
<br />
<br />
<br />
<br />
Once you have added a fuel tank, you can use either the sa-kf-nozzle-setup or the sa-kf-pressNozzle-setup tool to indicate where on your aircraft a refueling nozzle should be positioned. Use the sa-kf-nozzle-setup if it is a standard gravity-fed tank, and use sa-kf-pressNozzle-setup if it is a high-speed pressure refueling port (normally only used on large aircraft).</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=File:Fuel_Pump_Main_Menu.png&diff=5608File:Fuel Pump Main Menu.png2022-08-27T03:02:11Z<p>Kelly: </p>
<hr />
<div></div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5607KellyFuel/Creator Instructions2022-08-27T03:01:48Z<p>Kelly: /* Programming Fuel Port Positions */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==<br />
<br />
This section describes how to program the fuel pump for use with your aircraft. The RP aspects of refueling can be greatly enhanced when the pump knows what fuel tanks your aircraft has, and the location of the filler ports. The creator of an aircraft and their designated assistant has the ability to use the port configuration options of the KellyFuel pump. These options allow you to Add, Edit or Remove a tank/port from your aircraft.<br />
<br />
To program an aircraft, begin by rezing your aircraft near a KellyFuel 3.0 pump. Click the pump and select the aircraft by object name (or by tail number if you are using the Shergood registration system). If your aircraft is not detected, you can add it yourself on the Shergood web site at https://shergoodaviation.com/aircraft.php , or if you are a new creator contact Kelly Shergood to be added as a creator on the site. Once the aircraft is connected to the pump, you can perform the actions in the following sections.<br />
<br />
=== Adding A Port ===<br />
<br />
After connecting the aircraft, click the pump and select "*Edit" from the main menu. If no tank is currently selected, this will bring up a sub-menu with the options:<br />
<br />
* AddPort - Add port to aircraft.<br />
* Get Setup - Get tools for port positioning.<br />
* SetGrndPos - Record ground clip position.<br />
<br />
Use the "AddPort" option to add a fuel tank/port to the aircraft type description stored on the server. This will bring up a text box into which you can type the name<br />
<br />
The Setup tool folder contains the following tools:<br />
<br />
* sa-kf-ground-setup - Indicates the position of the ground wire clip<br />
* sa-kf-nozzle-setup - Indicates the position of a standard gravity fed nozzle<br />
* sa-kf-pressNozzle-setup - Indicates the position of a pressure refueling nozzle<br />
<br />
<br />
<br />
<br />
Once you have added a fuel tank, you can use either the sa-kf-nozzle-setup or the sa-kf-pressNozzle-setup tool to indicate where on your aircraft a refueling nozzle should be positioned. Use the sa-kf-nozzle-setup if it is a standard gravity-fed tank, and use sa-kf-pressNozzle-setup if it is a high-speed pressure refueling port (normally only used on large aircraft).</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5606KellyFuel/Creator Instructions2022-08-27T02:29:02Z<p>Kelly: /* Chat Commands */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).<br />
<br />
== Programming Fuel Port Positions ==</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5605KellyFuel/Creator Instructions2022-08-27T01:43:10Z<p>Kelly: /* Add Fuel to Tank */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detects when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5604KellyFuel/Creator Instructions2022-08-27T01:11:09Z<p>Kelly: /* Add Fuel to Tank */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed intervals to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detected when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5603KellyFuel/Creator Instructions2022-08-27T01:10:49Z<p>Kelly: /* Add Fuel to Tank */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The pump will typically send multiple <tt>add</tt> commands over timed interval to simulate the time needed to refuel. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detected when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5602KellyFuel/Creator Instructions2022-08-27T01:09:54Z<p>Kelly: /* Add Fuel to Tank */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detected when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledges 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5601KellyFuel/Creator Instructions2022-08-27T01:09:23Z<p>Kelly: /* Add Fuel to Tank */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detected when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledge 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5600KellyFuel/Creator Instructions2022-08-27T01:06:41Z<p>Kelly: /* Chat Commands */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels. The pump uses <tt>llRegionSayTo</tt> to send commands to a specific aircraft. It is recommended that the aircraft also reply using <tt>llRegionSayTo</tt> to the object from which it received the request.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detected when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledge 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5599KellyFuel/Creator Instructions2022-08-27T01:05:31Z<p>Kelly: /* Fuel Taint */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detected when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledge 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can optionally be used to implement handling of misfueling in your aircraft. If your aircraft has a piston (jet) engine and you receive an <tt>add</tt> query with a fuel type other 100ll (jeta), then you can mark an internal flag in your aircraft to indicate the fuel is tainted. You are free to implement any symptoms of misfueling you choose including failure to start, or failure of engine after a time interval (in RL, engine failure from misfueling often occurs after takeoff once all the clean fuel in the fuel lines have been consumed). You are also free to implement a method of clearing the taint flag (e.g., by draining the tank).</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5598KellyFuel/Creator Instructions2022-08-27T01:01:43Z<p>Kelly: /* Add Fuel to Tank */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detected when fueling is complete.<br />
<br />
<b>Example:</b> The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledge 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can be used to implement handling of misfueling in your aircraft. If the</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5597KellyFuel/Creator Instructions2022-08-27T01:01:25Z<p>Kelly: /* Add Fuel to Tank */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detected when fueling is complete.<br />
<br />
Example: The left fuel tank (named "left") in your Cessna 172 holds a maximum of 21.5 gallons, and currently contains 18 gallons of fuel. The following would be the expected exchange between the pumps and the aircraft:<br />
<br />
Pump: <tt>@refuel add left 10 100ll</tt><br />
Aircraft: <tt>@ack add 10 3.5</tt><br />
<br />
The pump command requests to add 10 gallons of 100ll fuel to the left tank. The reply from the aircraft acknowledge 10 gallons was requested, but only 3.5 gallons could be added to the tank (the remaining capacity of the tank).<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can be used to implement handling of misfueling in your aircraft. If the</div>Kellyhttps://shergoodaviation.com/wiki/index.php?title=KellyFuel/Creator_Instructions&diff=5596KellyFuel/Creator Instructions2022-08-27T00:56:32Z<p>Kelly: /* Fuel Taint */</p>
<hr />
<div>This section is intended for aircraft creators who wish to use KellyFuel in their build. KellyFuel operates over a channel to send and receive commands to your helicopter. You can configure a private channel to use for this purpose. KellyFuel identifies the aircraft being refueled by checking the creator name and the object name against a database. Since users often rename the aircraft, partial matching is used on the object name looking for specific key parts of the name. As a creator, you can edit the object name matching criteria for your aircraft on the SA website.<br />
<br />
== Chat Commands ==<br />
<br />
This section describes the basic commands sent by the pump and the expected replies from the aircraft. All communication is on your configured channel. Aircraft creators may optionally choose to open the chat listener for fuel only then the fuel cap on their aircraft is removed to limit the number of open channels.<br />
<br />
=== Aircraft Tank Query ===<br />
<br />
Pump: <tt>@refuel check</tt><br><br />
Aircraft: <tt>@ack 2 check <i>cur-level</i> <i>max-level</i> <i>tank-name</i></tt><br />
<br />
This command is used to query which tanks on an aircraft are ready for fueling. In the aircraft response, "2" is the protocol-number, <i>cur-level</i> is the current number of gallons in a tank, <i>max-level</i> is the maximum number of gallons in the tank, and <i>tank-name</i> is the name of the tank. If the aircraft has only one tank, the name "main" should be used for the tank. If the aircraft has multiple tanks, an "@ack" command should be sent for each tank.<br />
<br />
=== Fuel Level Query ===<br />
<br />
Pump: <tt>@refuel look <i>name</i></tt></br><br />
Aircraft: <tt>@ack look <i>cur-level</i> <i>max-level</i> <i>tank-name</i> <i>taint-status</i></tt><br />
<br />
This command is used to "look" into a tank. It is similar to the "check" command except that it includes a specific tank name in the query. The response elements are the same as the "check" command but includes and additional <i>taint-status</i> value. The taint status should be 0 if fuel in that tank is clean, and 1 if it is tainted. See the discussion on the "add" command for information on fuel tainting.<br />
<br />
=== Fill Tank to Full ===<br />
<br />
Pump: <tt>@refuel full</tt><br><br />
Aircraft: <tt>@ack full</tt><br />
<br />
This command requests that all tanks be completely filled. This command is sent when a user chooses "Auto Fill" from the menu bypassing the normal RP elements.<br />
<br />
=== Add Fuel to Tank ===<br />
<br />
Pump: <tt>@refuel add <i>tank-name</i> <i>amount</i> <i>type</i></tt></br><br />
Aircraft: <tt>@ack add <i>amount</i> <i>actual</i></tt><br />
<br />
This command incrementally adds fuel to a tank. The query specifies the name of the tank, the number of gallons to add, and a fuel type. Note the fuel type may be omitted by pumps prior to Version 3.0. The fuel type can be one of:<br />
<br />
* 100ll - Aviation fuel used by piston aircraft<br />
* jeta - Fuel for most jet and turbo-prop aircraft<br />
* fueloil - Fuel used by certain vintage/steampunk aircraft<br />
<br />
The aircraft response should include the amount requested to be added, and the actual amount added to the tank. If the amount requested to be added is more than the remaining capacity of the tank, the <i>actual</i> value should be the remaining capacity. If the tank is full, 0 should be returned for <i>actual</i>. It is important to return accurate values as detecting when <i>actual</i> is less than <i>requested</i> is how the pump detected when fueling is complete.<br />
<br />
==== Fuel Taint ====<br />
<br />
The <i>fuel-type</i> parameter of the <tt>add</tt> query can be used to implement handling of misfueling in your aircraft. If the</div>Kelly