KellyFuel/Creator Instructions - Revision history

Kelly: /* Programming Fuel Port Positions */

2022-09-07T14:57:55Z

‎Programming Fuel Port Positions

Kelly: /* Setting Ground Wire Clip Position */

2022-08-27T03:53:55Z

‎Setting Ground Wire Clip Position

Kelly: /* Renaming a Port */

2022-08-27T03:53:47Z

‎Renaming a Port

Kelly: /* Deleting a Port */

2022-08-27T03:53:37Z

‎Deleting a Port

Kelly: /* Setting Nozzle Position for a Port */

2022-08-27T03:53:30Z

‎Setting Nozzle Position for a Port

Kelly: /* KellyFuel Protocol */

2022-08-27T03:52:46Z

‎KellyFuel Protocol

Kelly at 03:51, 27 August 2022

2022-08-27T03:51:59Z

Kelly: /* Setting Ground Wire Clip Position */

2022-08-27T03:48:22Z

‎Setting Ground Wire Clip Position

Kelly: /* Setting Ground Wire Clip Position */

2022-08-27T03:47:18Z

‎Setting Ground Wire Clip Position

Kelly: /* Programming Fuel Port Positions */

2022-08-27T03:45:40Z

‎Programming Fuel Port Positions

← Older revision		Revision as of 14:57, 7 September 2022
Line 105:		Line 105:
	# Edit the tool to the position where you want the ground wire to attach		# Edit the tool to the position where you want the ground wire to attach
	# Select "*SetGrndPos" from the Edit menu.		# Select "*SetGrndPos" from the Edit menu.
		+
		+	== Sample Fuel Script ==
		+
		+	<pre>
		+	//
		+	// This is a sample kelly-fuel protocol script. Adapt as necessary for your aircraft.
		+	//
		+
		+	integer FUEL_CHAN = 123; // Port number to use for fuel system (as registered on web site)
		+	string FUEL_TYPE = "jeta"; // Fuel type of this aircraft. Should be "jeta", "100ll".
		+	list TANK_NAMES = ["tank1","tank2"]; // Names of the tanks used by this aircraft (if only one tank, it is suggested it be called "main")
		+	list FUEL_MAX = [30,60]; // Maximum capacities in gallons of the tanks
		+
		+	list fuel_levels = [0,0]; // Current fuel levels of each tank
		+	integer fuel_taint = 0; // Bit mask of fuel taint status in each tank
		+
		+	//
		+	// Return 1 if tank #index is tainted with the incorrect fuel type.
		+	//
		+	integer is_tainted(integer index)
		+	{
		+	return (fuel_taint&(1<<index)) != 0;
		+	}
		+
		+	//
		+	// Show fuel levels of all tanks in hover text
		+	//
		+	showLevels()
		+	{
		+	integer n = llGetListLength(TANK_NAMES);
		+	integer i;
		+
		+	list lines;
		+	for (i = 0;i < n;i++) {
		+	string text = llList2String(TANK_NAMES,i)+": "+llList2String(fuel_levels,i)+" / "+llList2String(FUEL_MAX,i);
		+	if (is_tainted(i))
		+	text += " tainted";
		+	lines += [text];
		+	}
		+	llSetText(llDumpList2String(lines,"\n"),<1,1,1>,1);
		+	}
		+
		+	default
		+	{
		+	state_entry()
		+	{
		+	//
		+	// Listen on the fuel channel (in aircraft, you can open this channel only while fuel cap is removed to reduce open channels)
		+	//
		+	llListen(FUEL_CHAN,"",NULL_KEY,"");
		+	showLevels();
		+	}
		+
		+	touch_start(integer n) {
		+	//
		+	// Clear fuel tanks and any fuel taint
		+	//
		+	integer n = llGetListLength(TANK_NAMES);
		+	integer i;
		+	fuel_levels = [];
		+	fuel_taint = 0;
		+	for (i = 0;i < n;i++) {
		+	fuel_levels += [0];
		+	}
		+	showLevels();
		+	}
		+
		+	listen(integer chan,string name,key id,string data) {
		+	//
		+	// Show received command for debuging
		+	//
		+	llOwnerSay("KF: "+data);
		+
		+	//
		+	// Parse line into words. If the first word is not "@refuel" it is not a kellyfuel command (so ignore it)
		+	//
		+	list decoded_line = llParseString2List(data,[" "],[]);
		+	string prefix = llList2String(decoded_line,0);
		+	if (prefix != "@refuel") return;
		+	string command = llList2String(decoded_line,1);
		+
		+	if (command == "check") {
		+	//
		+	// Check the levels of all tanks
		+	//
		+	integer n = llGetListLength(TANK_NAMES);
		+	integer i;
		+	for (i = 0;i < n;i++) {
		+	llRegionSayTo(id,FUEL_CHAN,"@ack 2 check "+llList2String(fuel_levels,i)+" "+llList2String(FUEL_MAX,i)+" "
		+	+llList2String(TANK_NAMES,i)+" "+(string)is_tainted(i));
		+	}
		+	} else if (command == "look") {
		+	//
		+	// Check the level of a specific tank
		+	//
		+	string tank = llList2String(decoded_line,2);
		+	integer tank_index = llListFindList(TANK_NAMES,[tank]);
		+	if (tank_index >= 0) {
		+	llRegionSayTo(id,FUEL_CHAN,"@ack look "+llList2String(fuel_levels,tank_index)+" "+llList2String(FUEL_MAX,tank_index)+" "
		+	+llList2String(TANK_NAMES,tank_index)+" "+(string)is_tainted(tank_index));
		+	} else {
		+	llRegionSayTo(id,FUEL_CHAN,"@error Unknown fuel tank");
		+	}
		+	} else if (command == "full") {
		+	//
		+	// Set all tanks to full
		+	//
		+	integer n = llGetListLength(TANK_NAMES);
		+	integer i;
		+	fuel_levels = FUEL_MAX;
		+	llRegionSayTo(id,FUEL_CHAN,"@ack full");
		+	showLevels();
		+	} else if (command == "add") {
		+	//
		+	// Add fuel to a tank
		+	//
		+	string tank = llList2String(decoded_line,2); // Get name of tank
		+	integer tank_index = llListFindList(TANK_NAMES,[tank]); // Get index of tank
		+	if (tank_index >= 0) {
		+	float amount = (float)llList2String(decoded_line,3); // Get amount of fuel to add
		+	string type = llList2String(decoded_line,4); // Get the fuel type
		+
		+	if (type != "" && type != FUEL_TYPE) // If a fuel type is given, but incorrect for this
		+	fuel_taint = fuel_taint \| (1<<tank_index); // aircraft, mark that tank as tainted.
		+
		+	float current = llList2Float(fuel_levels,tank_index); // Get current fuel level in selected tank
		+	float new_level = current + amount; // Calculate new fuel level in selected tank
		+	float max = llList2Float(FUEL_MAX,tank_index); // Get max fuel level in selected tank
		+	float added = amount; // Set the amount of fuel added
		+
		+	if (new_level > max) { // If the new fuel level is greater than the
		+	added = max-current; // maxmium tank capacity, adjust the amount
		+	new_level = max; // added and the new tank level.
		+	}
		+
		+	//
		+	// Acknowledge to pump the actual fuel added
		+	//
		+	llRegionSayTo(id,FUEL_CHAN,"@ack add "+(string)amount+" "+(string)added);
		+
		+	fuel_levels = llListReplaceList(fuel_levels,[new_level],tank_index,tank_index);
		+	showLevels();
		+	} else {
		+	llRegionSayTo(id,FUEL_CHAN,"@error Unknown fuel tank");
		+	}
		+	}
		+	}
		+	}
		+	</pre>

@@ Line 98: / Line 98: @@
 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.
-== Setting Ground Wire Clip Position ==
+=== Setting Ground Wire Clip Position ===
 To set the ground wire position:

@@ Line 94: / Line 94: @@
 To delete a port, select it from the main menu, then choose "*DelPort" from the Edit menu.
-== Renaming a Port ==
+=== Renaming a Port ===
 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.

@@ Line 90: / Line 90: @@
 # Select "*SetPortPos" from the *Edit menu.  This will record the position of the fuel tool (relative to the aircraft) on the server.
-== Deleting a Port ==
+=== Deleting a Port ===
 To delete a port, select it from the main menu, then choose "*DelPort" from the Edit menu.

@@ Line 82: / Line 82: @@
 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.
-== Setting Nozzle Position for a Port ==
+=== Setting Nozzle Position for a Port ===
 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:

@@ Line 3: / Line 3: @@
 == KellyFuel Protocol ==
-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.
+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.
 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.

@@ Line 1: / Line 1: @@
-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.
+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.
-== Chat Commands ==
+== KellyFuel Protocol ==
 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.

← Older revision		Revision as of 03:47, 27 August 2022
Line 97:		Line 97:

	== Setting Ground Wire Clip Position ==		== Setting Ground Wire Clip Position ==
		+
		+	To set the
		+
		+	# Rez the <tt>sa-kf-ground-setup</tt> tool near your aircraft
		+	# Edit the tool to the position where you want the ground wire to attach
		+	# Select "*SetGrndPos" from the Edit menu.

@@ Line 70: / Line 70: @@
 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:
-* sa-kf-ground-setup - Indicates the position of the ground wire clip
+* <tt>sa-kf-ground-setup</tt> - Indicates the position of the ground wire clip
-* sa-kf-nozzle-setup - Indicates the position of a standard gravity fed nozzle
+* <tt>sa-kf-nozzle-setup</tt> - Indicates the position of a standard gravity fed nozzle
-* sa-kf-pressNozzle-setup - Indicates the position of a pressure refueling nozzle
+* <tt>sa-kf-pressNozzle-setup</tt> - Indicates the position of a pressure refueling nozzle
 The following sections will describe how to use these tools.