Difference between pages "InfoCenter" and "Global Fuel System"

(Difference between pages)
imported>NelsonJenkins
 
imported>NelsonJenkins
 
Line 1: Line 1:
{{ infobox product
+
The '''Global Fuel System''' is an open-use fuel system maintained by the NTBI Group. Anybody can implement GFS into their own vehicles.
| title            = InfoCenter
 
| image            = [[File:replaceme.jpg|200px|center]]
 
| caption          = InfoCenter Display Kit vendor image.
 
| inventor        = [[Nelson Jenkins]]
 
| launch year      = 2008, upgraded in 2014
 
| company          = [[Gentek]]
 
| available        = Marketplace & In-World
 
| url              = '''Coming Soon'''
 
}}
 
  
The '''InfoCenter''' is a series of electronic text display signs (Mobile, Highway, Matrix, Personal, Notice) sold by [[Gentek]]. They are designed for transportation & commercial purposes, although have been creatively used for a wide variety of applications. They are all web-controllable and include an API for scripters and web developers.
+
<font size=3>'''[http://ntbigroup.com/updates/gimme.php?i=TlRCSSBHRlMgRnVlbCBQdW1w CLICK HERE TO GET THE GFS FUEL PUMP KIT]<br>[http://ntbigroup.com/updates/gimme.php?i=TlRCSSBHRlMgRnVlbCBDYW5z CLICK HERE TO GET THE GFS FUEL CANS]'''</font>
  
This page covers the InfoCenter Series v3 and above. For older versions, visit these pages: [[InfoCenter Mobile|Mobile]], [[InfoCenter Highway|Highway]], or [[InfoCenter Personal|Personal]]
+
If you do not have an NTBI Group account, you can also get GFS equipment through the [https://marketplace.secondlife.com/stores/133128 NTBI Group Distribution store on the Marketplace.]
  
==Models==
+
==System Outline==
The InfoCenter is made up of two separate products - the InfoCenter Display Kit, and the InfoCenter Mobile.
+
GFS is designed to act as a roleplay tool. For 7+ years, drivers have roleplayed filling up at nonfunctional fuel stations without any sense of activity or realism, or tried to work with buggy or difficult to understand fuel systems. With GFS, vehicles have an extra layer of realism, and drivers no longer have to pretend when they're pumping gas - GFS makes it visibly and audibly clear.
  
===InfoCenter Display Kit===
+
Implementing GFS into vehicles is very easy. You will need to contact us to get a GFS toolkit, but after that setup is simple and requires no oversight from us. Instructions are included with the toolkit; if you understand LSL scripting, GFS is simple to integrate.
The Display Kit includes the following models (in both standard and Duo variants, Duo typically doubling both the number of lines and characters per line, effectively quadrupling capacity):
 
* '''InfoCenter Personal''' - 16 x 1 or 32 x 2 characters. Ideal for general commercial use, and includes a variety of animated graphics for stores.
 
* '''InfoCenter Notice''' - 16 x 7 or 32 x 14 characters. The highest-capacity model, ideal for news & information. Also includes graphics for commercial & industrial purposes.
 
* '''InfoCenter Highway''' - 16 x 3 or 32 x 6 characters. Best suited for overhead gantry installations on roads, but can be used for walkway or general commercial applications.
 
* '''InfoCenter Matrix''' - 4 x 2 or 8 x 5 characters. A road sign display with many graphics for lane control, variable speed limits, hazard warning, detours, turn restrictions, and more.
 
All models, excluding the Highway, have a toggleable mounting bracket. All models are modifiable (scripts excluded) and can be resized or linked (with the caveat that they cannot be linked together).
 
  
===InfoCenter Mobile===
+
==Compatible Vehicles==
The Mobile model is used for construction & road closures. 8 x 3 characters (the Mobile does not have a Duo variant). It is a trailer unit which can be rotated for the optimum viewing angle. It also has two trailer colors (grey & orange) and the display unit can be resized to three different sizes for different use cases. Unlike other models, the InfoCenter Mobile is not modifiable.
+
The following NTBI vehicles are compatible with GFS, sorted alphabetically:
 +
* [[TPF-4 Ambulance|Astaro TPF-4 Ambulance]] - [https://marketplace.secondlife.com/p/Astaro-TPF-4-Ambulance/5038231 Buy Here]
 +
* [[Lusch Himalaya]] - [https://marketplace.secondlife.com/p/Lusch-Motors-Himalaya/4792439 Buy Here]
 +
* [[SZYM Intruder]] - [https://marketplace.secondlife.com/p/SZYM-Intruder-Police-Car-Civilian-Sedan/4297604 Buy Here]
 +
Additionally, the following third-party vehicles are compatible with GFS, sorted alphabetically:
 +
* CSM Alltrak - [https://marketplace.secondlife.com/p/CSM-ALLTRAK/5044964 Buy Here]
 +
* [http://sl-gemc.blogspot.com/2013/03/gmund-stuttgart-ferdinand-update.html GEMC Gmünd Stuttgart Ferdinand] - [https://marketplace.secondlife.com/p/GEMC-Gmund-Stuttgart-Ferdinand/4233221 Buy Here]
 +
* [http://sl-gemc.blogspot.com/2013/05/minamoto-sky-traveller-release.html GEMC Minamoto Sky Traveller] - [https://marketplace.secondlife.com/p/GEMC-Minamoto-Sky-Traveller/4918683 Buy Here]
 +
* HD NextGen Engine 51 - [https://marketplace.secondlife.com/p/HD-NextGen-Engine-51/4989933 Buy Here]
 +
* HD NextGen Engine 52 - [https://marketplace.secondlife.com/p/HD-NextGen-Engine-52/4989979 Buy Here]
 +
* HD NextGen Tanker 13 - [https://marketplace.secondlife.com/p/HD-NextGen-Tanker-13/4921784 Buy Here]
 +
Please contact us to make your vehicle GFS compatible (obviously you must be the manufacturer). '''We cannot provide support on third-party vehicles; this list is provided solely as a convenience.'''
  
Because of the Mobile's long-lasting popularity over other models, we sell it separately to reduce costs for those just interested in this model. Besides the features above, the Mobile is technically identical to all other models - it is web controllable and uses the same API.
+
==Open-Use & Usage Agreement==
 +
GFS is ''not open-source''. Manufacturers are given access to the pump API; nothing more. To retain control over the system, and in case we wish to upgrade it in the future for more features, NTBI Group retains all rights over the pump and its code. You may not reverse-engineer or otherwise copy the design of the pump or its API to make your own. We distribute the pump freely and allow access to this API freely as a service to roleplayers and drivers in general - please don't fragment the market and create your own. If you have any features or suggestions you wish to add to the system, feel free to contact us and we will consider them.
  
==Setup & Use==
+
==Pump Usage==
InfoCenter devices are ready for use out of the box. You can control some cosmetic options described above, but once they are rezzed, they can be set immediately.
+
The GFS pump operates in the following manner:
 +
# Park vehicle directly in front of the pump with fuel filler door on the same side as the pump (maximum 2m away)
 +
# Click pump; it will check for the vehicle and you will be given control of the pump (basic instructions will also be sent to the user)
 +
# For some vehicles, you must select which fuel type to use by clicking the appropriate button on the pump
 +
# Click nozzle to insert it into the vehicle's fuel filler
 +
# Click nozzle again to start/stop the pump (nozzle will automatically shut off when tank is full)
 +
# Click pump again to finish (nozzle will be removed and fueling is completed)
  
All InfoCenter devices are accessible through the [http://ntbigroup.com/gentek/infocenter/ InfoCenter Manager.] If you access the Manager directly, you will have to log in - you can avoid this by clicking a sign and selecting ''Web Control''. (This will also highlight the selected sign in the manager.)
+
In some situations, fueling can be interrupted:
 +
* The vehicle cannot be detected
 +
* The vehicle is not GFS compatible (or the GFS scripts are not running correctly)
 +
* The vehicle is moved from its original position
 +
* The vehicle is put into neutral gear or otherwise made physical (this is not done automatically; it must be set up by the manufacturer)
 +
* The vehicle's engine is started (again, this must be set up by the manufacturer)
 +
* The nozzle's target position is over 3m away from the pump (this is to avoid the filler cap being on the opposite side)
 +
* The operator (user) moves over 16m away from the pump
 +
* The raycast fails (this is usually a simulator performance issue)
  
If you have not created an NTBI Group account before, you will be prompted to enter a password - do not use your SL password for this! Then, in the future, you can log in to the NTBI Group website (including the InfoCenter Manager) without even being in-world.
+
==Pump System Setup==
 +
Choose which system you want to have:
  
===Setting a Message===
+
===Single Pump - Manual Pricing===
You can set any of your InfoCenter devices from the InfoCenter Manager. Click the ''Set'' button, and you will be shown the message designer interface.
+
# Rez pump and position/rotate to fit.
 +
# Click the pump and set prices in the Man Price menu.
 +
# Done - when prices are set correctly, the pump will automatically turn on.
  
Messages are made up of slides. Each slide can either be a text slide or a graphic slide, and can be set to display for generally any length of time you want. Slides are displayed sequentially and loop when completed.
+
===Multiple Pumps - Automatic Gridwide Pricing (Global Pricing)===
 +
# Rez pumps and position/rotate to fit.
 +
# Number individual pumps by clicking them and choosing "Pump #".
 +
# Rez a price sign and position/rotate it.
 +
# Click the price sign and choose Global Price.
 +
# Click the price sign and choose Get Key. Copy the key given to you in local chat.
 +
# Click each pump, select Auto Price, and paste the key. This should automatically sync the prices.
 +
# Done - when all of your pumps are set correctly, your station is complete and ready for use.
 +
The price will automatically change to a price given by the NTBI GFS server once every 24 hours. The prices are randomized once a day on the server, and each sign randomizes the prices a bit further to allow for different prices within the same city.
  
The grey number next to the model name for the device you are setting is the maximum number of slides - this is dependent on the capacity of the display, so smaller displays can handle more slides (up to 60). Some very high capacity devices (such as the Notice Duo) can only handle a few slides.
+
===Multiple Pumps - Manual Pricing Synced to All Pumps (Local Pricing)===
 +
# Rez pumps and position/rotate to fit.
 +
# Number individual pumps by clicking them and choosing "Pump #".
 +
# Rez a price sign and position/rotate it.
 +
# Click the price sign and set prices in the Local Price menu.
 +
# Click the price sign and choose Get Key. Copy the key given to you in local chat.
 +
# Click each pump, select Auto Price, and paste the key. This should automatically sync the prices.
 +
# Done - when all of your pumps are set correctly, your station is complete and ready for use.
  
When you open the message designer, the message currently displayed on that device will be shown, so you can edit it if you wish. By default, it is a single blank slide.
+
The pump can be customized using the Pump Texture option. [http://ntbigroup.com/TEMPLATES/NTBI%20GFS%20Pump%20Texture.psd PUMP PSD TEMPLATE]<br>
 +
The pump also has an optional price board which can be shown/hidden using the Show/Hide Board option.
  
* To add a text slide, type your message into the text cell input area. By default, the Amber color is used, but you can click any color in the palette below to select that color. Any new characters you type will then be in that color. When you're finished, click the ''Add Text'' button to add it to the slides.
+
The sign can be customized using the Sign Texture option. [http://ntbigroup.com/TEMPLATES/NTBI%20GFS%20Sign%20Texture.psd SIGN PSD TEMPLATE]<br>
** Because of Javascript limitations, you must release each key before typing the next one, otherwise it won't register - type slowly and carefully!
+
If you do not wish to set up a template, you can specify a logo using the Logo Texture option (logo must be 1:1 aspect ratio and should be alpha - upload as PNG - not JPG).<br>
** Some characters are not permitted as text. If that is the case, they will not be entered.
+
If you use a logo, a "blank" backing template is included at the bottom of the INSTRUCTIONS notecard.
** For a full box character, like older InfoCenter models, use the ^ (caret) character. (This will not be shown on the website - it will only appear correctly in-world.)
 
* To add a graphic slide, select a graphic from the dropdown. A preview will appear above it. To add the graphic, click ''Add Graphic''.
 
* To move slides around or delete them, click the icons next to them. Keep in mind that by default, a blank slide is included as the first slide - you may want to remove it.
 
* To change the time that a slide is shown, click ''Change'' and type in a new time (in seconds), then click ''Save''. Some high-capacity devices require longer slide times.
 
 
 
When you're finished, click ''Send To This Device''. The message will be sent and displayed immediately in-world. For information on how the ''Send To Entire Group'' button works, read '''Using Groups''' below.
 
 
 
===Using Templates===
 
Templates are a way to easily save and recall messages. Say, for example, that you have 3 different messages you plan on displaying, but only one at a time, and you don't want to retype them every time. Templates allow you to save the message and load it later on that device (or any same-model device).
 
 
 
* To save a template, design the message that you want to display, then type in a name above the ''Save As Template'' button, then click the button. If you already have a template with that name, it will be overwritten, so check first.
 
* To load a template, click the dropdown to the right and select the template you want, then click ''Load''. To permanently delete a template, click ''Delete'' instead.
 
 
 
===Using Groups===
 
Groups are an easy way to control multiple devices at once. Devices can only belong to a single group at a time, but you can have multiple groups. Each group can only support one specific model.
 
 
 
* To add a device to a group, click the ''Group'' button, then enter the name of the group you want to add it to. If the group doesn't exist, it will be created. If it does, the device will simply be added to the group.
 
* To remove a device from a group, click the ''Group'' button, delete the text in the textbox, and then click ''OK''. This will remove it from the group. If the group no longer has any members, it will be hidden, but not technically deleted - if you recreate that group with the same name, the API key will be retained. (More information on this is in the API section.)
 
* To rename a group, click the ''Rename'' button next to it, then enter a new group name. This will rename it without changing the API key, and all devices will remain in the group under the new name.
 
* To set a message on an entire group, begin by setting a message on a single group member. When you're ready, click ''Send To Entire Group''. This will send the message to all group members.
 
 
 
===Renaming & Deleting Devices===
 
When your device is first rezzed, it will be named "Unnamed" followed by a number. Not only is this not descriptive, but it is a bit dangerous - if your display is reset for any reason, it will lose its old name and API key. To rename it, simply click the ''Rename'' button and enter a new name. You can also rename it from in-world using the ''Set Disp ID'' option.
 
 
 
If your device disappears in-world, it will remain in the InfoCenter Manager. This is intended - it's to prevent accidentally deleting the device if the region is temporarily offline or there is a communication error. You can delete devices from the InfoCenter Manager by clicking ''Delete''. This will not delete it in-world - it will only disappear from the website and lose its API key. If you delete a display while it is still in-world and online, you will get a notification in-world.
 
 
 
Sometimes, you may have several devices which no longer exist, but you don't want to delete them individually. To "flush" non-responsive devices, click the link at the very bottom of the page. This will individually check each device and, if it does not respond, it will be deleted automatically. Note that if a region is offline or very laggy, devices in it may be deleted without warning, so make sure all regions are OK before doing this.
 
 
 
==API Documentation==
 
If you aren't planning on using the API as a scripter, you don't need to read this part. If you are, you'll be surprised how much you can do through the API.
 
 
 
The InfoCenter API allows you to control any sign from anywhere in-world or from any web server. You can set messages, change groups, rename things, and query for information. All you need is the API key for the display or group you want to control - you can even use API keys for displays you do not own.
 
 
 
That said, '''keep your API keys private'''! If anyone else gets a copy of your API key, they can control your device without you knowing. If this happens, you can reset your API key by clicking the ''Refresh'' link next to it - but note that you can't set your own API key, and any scripts that use the old key will no longer work.
 
 
 
The InfoCenter API is HTTP-based, and runs on this basic script function:
 
 
 
<code>
 
llHTTPRequest("<nowiki>http://ntbigroup.com/gentek/infocenter/api.php?r=type&k=apikey</nowiki>",[HTTP_METHOD,"PUT"],"content");
 
</code>
 
 
 
Invalid request types and internal errors will return <code>ERROR</code>. Although it is recommended to capture the request key and handle a response accordingly, it is not absolutely required. More information on LSL's <code>http_response</code> event is [http://wiki.secondlife.com/wiki/Http_response here.]
 
 
 
===Setting a Message===
 
You can set a message using the <code>set</code> request:
 
 
 
<code>
 
llHTTPRequest("<nowiki>http://ntbigroup.com/gentek/infocenter/api.php?r=set&k=apikey</nowiki>",[HTTP_METHOD,"PUT"],"content");
 
</code>
 
 
 
Replace ''apikey'' with the API key for the device or group you want to use, and replace ''content'' as described below. (This command will work for both devices and groups interchangeably.)
 
 
 
This request can return the following in the <code>http_response</code> event:
 
 
 
* <code>OK</code> - the message was sent to all devices succesfully
 
* <code>GROUPFAIL</code> - the message was sent to some devices in the group, but some (not all) did not respond
 
* <code>FAIL</code> - the message was not sent to any devices because none responded
 
* <code>FORMAT-SEPARATOR</code> - your content string is not separated by <code>#$</code>
 
* <code>FORMAT-SLIDES</code> - your slide data and slide time lists are not the same length, or you sent more slides than the selected device/group can handle
 
* <code>FORMAT-DATA</code> - one of your slide data strings is not the correct length
 
* <code>FORMAT-TIME</code> - one of your slide times are not valid (<1 or >3600 seconds)
 
** '''IMPORTANT:''' The API does not enforce the minimum slide times for high-capacity devices. If your slides are too fast, you may encounter problems.
 
* <code>NOTFOUND</code> - the API key you used was not found
 
 
 
====Content Format====
 
The ''content'' for a set request must be of a very specific format. InfoCenter messages are composed like this:
 
 
 
<code>HELOWRLDWWWWWWWW|HOW R U?GGGGGGGG|GRAPHIC_Blank#$3|5|3</code>
 
 
 
This looks confusing, so let's take it step by step.
 
 
 
First, there are two sections separated by <code>#$</code>. The first section is the slide data, the second section is the slide times. Slides are individually separated by <code>|</code> characters. They must be padded to fit on the display they are set on. Each slide time is in whole seconds (integers, not floats), but slide data is more confusing:
 
 
 
<code>HOW R U?GGGGGGGG</code>
 
 
 
This is a single slide for a 8-character display. It is made up of the text and color strings concatenated together, each of which must be padded to <code>columns * rows</code> characters. So this could be an 8 x 1 display, or perhaps a 4 x 2 display. Think of these two strings as different "layers" of the slide - the color "layer" moves over to cover up the text "layer", coloring those characters individually.
 
 
 
All InfoCenter devices support the same colors, each with a single-digit color code - '''R'''ed, '''O'''range, '''A'''mber, '''Y'''ellow, '''G'''reen, '''B'''lue, '''P'''urple, and '''W'''hite. Any characters used for color other than these will be interpreted as white. So, if you wanted to make a rainbow-colored line, you could do this:
 
 
 
<code>^^^^^^^^ROAYGBPW</code> (remember, the ^ character turns into a full box character)
 
 
 
Remember that these strings are concatenated separately, not line-by-line. So, for an 8 x 3 display, it would look like this:
 
 
 
<code>^^^^^^^^^^^^^^^^^^^^^^^^ROAYGBPWROAYGBPWROAYGBPW</code>
 
 
 
====Alignment & Padding====
 
For multiple-line displays, you'll want to pad out each line individually, as the text will hard wrap. For example, on an 8 x 3 display:
 
 
 
<code><nowiki>LEFT    ALIGNED TEXT    WWWWWWWWWWWWWWWWWWWWWWWW</nowiki></code>
 
 
 
<code>  I AM  CENTERED  TEXT  RRRRRRRRRRRRRRRRRRRRRRRR</code>
 
 
 
<code>  RIGHT ALIGNED    TEXTAAAAAAAAAAAAAAAAAAAAAAAA</code>
 
 
 
Below is an LSL function for aligning each line:
 
 
 
<code>
 
string align(string in, string dir, integer length, string pad)
 
{
 
    if (pad=="") pad=" ";
 
    if (llToUpper(dir)=="L")
 
    {
 
        while (llStringLength(in) < length)
 
        {
 
            in=in+pad;
 
        }
 
    }
 
    else if (llToUpper(dir)=="R")
 
    {
 
        while (llStringLength(in) < length)
 
        {
 
            in=pad+in;
 
        }
 
    }
 
    else // assume center
 
    {
 
        integer osc=0; // we have to be a little smarter here
 
        while (llStringLength(in) < length)
 
        {
 
            if (osc) in=pad+in; // this will align left, then right,
 
            else in=in+pad;    // then left, then right...
 
            osc=!osc;          // ... effectively centering the text
 
        }
 
    }
 
    return llGetSubString(in,0,length-1); // cut off any excess if we added it on accident
 
}
 
</code>
 
 
 
This function allows you to align text left, right, or centered, to a specific length (in our case, <code>columns</code>), using an optional customizable padding string. You can use this padding string for colors.
 
 
 
For example, here's how to get the same text as above using this function (remember, we are on an 8 x 3 display):
 
 
 
<code>align("LEFT","L",8,"") + align("ALIGNED","L",8,"") + align("TEXT","L",8,"") + align("","",24,"W")</code> - we can leave the padding string empty and it will default to a space
 
 
 
<code>align("I AM","",8,"") + align("CENTERED","",8,"") + align("TEXT","",8,"") + align("","",24,"R")</code> - we can leave the alignment string empty and it will default to centered
 
 
 
<code>align("RIGHT","R",8,"") + align("ALIGNED","R",8,"") + align("TEXT","R",8,"") + align("","",24,"A")</code>
 
 
 
Note that we used a trick to create the color strings - by leaving the input and alignment strings empty, the function will simply create a string duplicating the padding string until it reaches the length. In our case, we used it to fill the entire display (8 x 3) with a single color. You could also make each line a separate color, or create a rainbow effect, like so:
 
 
 
<code>align("","",24,"^") + align("","",8,"R") + align("","",8,"G") + align("","",8,"B")</code> - would make a red, green, and blue line
 
 
 
<code>align("","",24,"^") + align("","",24,"ROAYGBPW")</code> - would make rainbow stripes (note that using any length of padding is fine, because any excess will be cut off)
 
 
 
Slides must be of the correct length for the device they are set on, or they will be rejected by the API. Remember, the formula is <code>columns * rows</code> for the text and color strings - so <code>columns * rows * 2</code> for both of them combined together.
 
 
 
====Example====
 
Okay, let's start backing up. Recall that all slides are separated by the <code>|</code> character, but there was one slide - GRAPHIC_Blank - which looks odd. That's because you can set graphic slides by simply taking the name of the graphic you want and adding <code>GRAPHIC_</code> to the beginning - for example, <code>GRAPHIC_Lane Open Down</code> for the Matrix. (If the graphic isn't supported by the model you are working with, it will show up as Blank.) Because graphics aren't colorable, you don't need to worry about color strings for them.
 
 
 
Once you have your desired slides and times, you can do something like this to "finalize" them into the required format:
 
 
 
<code>
 
string makeContent(list slide_data, list slide_times)
 
{
 
    return llDumpList2String(slide_data,"|") + "#$" + llDumpList2String(slide_times,"|");
 
}
 
</code>
 
 
 
Note that the slide_data and slide_times lists must be of equal length.
 
 
 
So, using the above functions, here's how to make (and send) a 3-slide centered message - obviously you'll have to replace ''apikey'' first:
 
 
 
<code>
 
llHTTPRequest("<nowiki>http://ntbigroup.com/gentek/infocenter/api.php?r=set&k=apikey</nowiki>",[HTTP_METHOD,"PUT"],
 
    makeContent([
 
        align("I AM","",8,"") + align("CENTERED","",8,"") + align("TEXT","",8,"") + align("","",24,"W") ,
 
        align("I AM","",8,"") + align("CENTERED","",8,"") + align("RED TEXT","",8,"") + align("","",24,"R") ,
 
        align("LOOK AT","",8,"") + align("THESE","",8,"") + align("COLORS","",8,"") + align("","",24,"ROAYGBPW")
 
    ],[3,3,5])
 
);
 
</code>
 
 
 
===Setting a Device's Group===
 
You can set a device's group using the <code>grp</code> request:
 
 
 
<code>
 
llHTTPRequest("<nowiki>http://ntbigroup.com/gentek/infocenter/api.php?r=grp&k=apikey</nowiki>",[HTTP_METHOD,"PUT"],"New Group Name");
 
</code>
 
 
 
Replace ''apikey'' with the API key for the device you want to modify, and replace ''New Group Name'' with the group name that you want to add it to. To remove from a group, leave blank or enter ''NULL''.
 
 
 
This request can return the following in the <code>http_response</code> event:
 
 
 
* <code>OKNew Group Name</code> - the group was set successfully (the new group name is appended to <code>OK</code> - for example, when removing from a group, this will be <code>OKNULL</code>)
 
* <code>LENGTH</code> - your group name is too long (maximum 64 characters)
 
* <code>MISMATCH</code> - the group you want to join already exists and is for a different model
 
* <code>NOTFOUND</code> - the API key you used was not found
 
 
 
Remember, groups are never technically erased, so if adding to a group that previously existed but is currently empty, the group will be "recreated" using the old API key. This makes it possible to add devices to an empty group while knowing its API key in advance. However, it is not possible to get the group's API key through the API itself.
 
 
 
===Renaming a Device or Group===
 
You can rename a device or a group using the <code>ren</code> request:
 
 
 
<code>
 
llHTTPRequest("<nowiki>http://ntbigroup.com/gentek/infocenter/api.php?r=ren&k=apikey</nowiki>",[HTTP_METHOD,"PUT"],"New Name");
 
</code>
 
 
 
Replace ''apikey'' with the API key for the device or group you want to rename, and replace ''New Name'' as described below. (This command will work for both devices and groups interchangeably.)
 
 
 
This request can return the following in the <code>http_response</code> event:
 
 
 
* <code>OKNew Name</code> - the name was set successfully (the new name is appended to <code>OK</code>)
 
* <code>LENGTH</code> - your name is too short or too long (1-64 characters required)
 
* <code>DUPLICATE</code> - the name you want to use already exists, or the device/group is already set to that name
 
* <code>NOTFOUND</code> - the API key you used was not found
 
 
 
Note that it is possible to remove all devices from a group by renaming the group to ''NULL''. However, this will make it impossible to use the group's API key again until a device is added to it.
 
 
 
===Querying Device/Group Information===
 
You can request information about a device or a group using the <code>inf</code> request:
 
 
 
<code>
 
llHTTPRequest("<nowiki>http://ntbigroup.com/gentek/infocenter/api.php?r=inf&k=apikey</nowiki>",[HTTP_METHOD,"PUT"],"");
 
</code>
 
 
 
Replace ''apikey'' with the API key for the device or group you want to get information about. The content field is not used. (This command will work for both devices and groups interchangeably.)
 
 
 
Running this command on its own without capturing the response is worthless, so you'll want to do that.
 
 
 
This request can return the following in the <code>http_response</code> event:
 
 
 
* For devices, a <code>#$</code>-separated string with the following: OK, DEVICE, device name/ID, device owner's username, device group, device model, device columns, device rows, max supported slides, location, UUID
 
** For example: <code>OK#$DEVICE#$Unnamed 1#$nelson.jenkins#$NULL#$InfoCenter Mobile#$8#$3#$42#$Prototype (142, 228, 43)#$9794a972-0131-3f33-7059-b04fc5ad92dd</code>
 
* For groups, a <code>#$</code>-separated string with the following: OK, GROUP, group name, group owner's username, device model, device columns, device rows, max supported slides, number of devices in group
 
** For example: <code>OK#$GROUP#$Test Group#$nelson.jenkins#$InfoCenter Personal#$16#$1#$60#$2</code>
 
* <code>NOTFOUND</code> - the API key you used was not found
 
 
 
You'll probably want to make use of [http://wiki.secondlife.com/wiki/LlParseStringKeepNulls llParseStringKeepNulls] for this - although it is not technically possible for null entries to appear, don't rule out the possibility. Also, do not expect this command to return data at this length forever - we may add additional fields (however unlikely) in the future, so don't check the response list length.
 
 
 
{{Gentek}}
 

Revision as of 16:45, 15 August 2013

The Global Fuel System is an open-use fuel system maintained by the NTBI Group. Anybody can implement GFS into their own vehicles.

CLICK HERE TO GET THE GFS FUEL PUMP KIT
CLICK HERE TO GET THE GFS FUEL CANS

If you do not have an NTBI Group account, you can also get GFS equipment through the NTBI Group Distribution store on the Marketplace.

System Outline

GFS is designed to act as a roleplay tool. For 7+ years, drivers have roleplayed filling up at nonfunctional fuel stations without any sense of activity or realism, or tried to work with buggy or difficult to understand fuel systems. With GFS, vehicles have an extra layer of realism, and drivers no longer have to pretend when they're pumping gas - GFS makes it visibly and audibly clear.

Implementing GFS into vehicles is very easy. You will need to contact us to get a GFS toolkit, but after that setup is simple and requires no oversight from us. Instructions are included with the toolkit; if you understand LSL scripting, GFS is simple to integrate.

Compatible Vehicles

The following NTBI vehicles are compatible with GFS, sorted alphabetically:

Additionally, the following third-party vehicles are compatible with GFS, sorted alphabetically:

Please contact us to make your vehicle GFS compatible (obviously you must be the manufacturer). We cannot provide support on third-party vehicles; this list is provided solely as a convenience.

Open-Use & Usage Agreement

GFS is not open-source. Manufacturers are given access to the pump API; nothing more. To retain control over the system, and in case we wish to upgrade it in the future for more features, NTBI Group retains all rights over the pump and its code. You may not reverse-engineer or otherwise copy the design of the pump or its API to make your own. We distribute the pump freely and allow access to this API freely as a service to roleplayers and drivers in general - please don't fragment the market and create your own. If you have any features or suggestions you wish to add to the system, feel free to contact us and we will consider them.

Pump Usage

The GFS pump operates in the following manner:

  1. Park vehicle directly in front of the pump with fuel filler door on the same side as the pump (maximum 2m away)
  2. Click pump; it will check for the vehicle and you will be given control of the pump (basic instructions will also be sent to the user)
  3. For some vehicles, you must select which fuel type to use by clicking the appropriate button on the pump
  4. Click nozzle to insert it into the vehicle's fuel filler
  5. Click nozzle again to start/stop the pump (nozzle will automatically shut off when tank is full)
  6. Click pump again to finish (nozzle will be removed and fueling is completed)

In some situations, fueling can be interrupted:

  • The vehicle cannot be detected
  • The vehicle is not GFS compatible (or the GFS scripts are not running correctly)
  • The vehicle is moved from its original position
  • The vehicle is put into neutral gear or otherwise made physical (this is not done automatically; it must be set up by the manufacturer)
  • The vehicle's engine is started (again, this must be set up by the manufacturer)
  • The nozzle's target position is over 3m away from the pump (this is to avoid the filler cap being on the opposite side)
  • The operator (user) moves over 16m away from the pump
  • The raycast fails (this is usually a simulator performance issue)

Pump System Setup

Choose which system you want to have:

Single Pump - Manual Pricing

  1. Rez pump and position/rotate to fit.
  2. Click the pump and set prices in the Man Price menu.
  3. Done - when prices are set correctly, the pump will automatically turn on.

Multiple Pumps - Automatic Gridwide Pricing (Global Pricing)

  1. Rez pumps and position/rotate to fit.
  2. Number individual pumps by clicking them and choosing "Pump #".
  3. Rez a price sign and position/rotate it.
  4. Click the price sign and choose Global Price.
  5. Click the price sign and choose Get Key. Copy the key given to you in local chat.
  6. Click each pump, select Auto Price, and paste the key. This should automatically sync the prices.
  7. Done - when all of your pumps are set correctly, your station is complete and ready for use.

The price will automatically change to a price given by the NTBI GFS server once every 24 hours. The prices are randomized once a day on the server, and each sign randomizes the prices a bit further to allow for different prices within the same city.

Multiple Pumps - Manual Pricing Synced to All Pumps (Local Pricing)

  1. Rez pumps and position/rotate to fit.
  2. Number individual pumps by clicking them and choosing "Pump #".
  3. Rez a price sign and position/rotate it.
  4. Click the price sign and set prices in the Local Price menu.
  5. Click the price sign and choose Get Key. Copy the key given to you in local chat.
  6. Click each pump, select Auto Price, and paste the key. This should automatically sync the prices.
  7. Done - when all of your pumps are set correctly, your station is complete and ready for use.

The pump can be customized using the Pump Texture option. PUMP PSD TEMPLATE
The pump also has an optional price board which can be shown/hidden using the Show/Hide Board option.

The sign can be customized using the Sign Texture option. SIGN PSD TEMPLATE
If you do not wish to set up a template, you can specify a logo using the Logo Texture option (logo must be 1:1 aspect ratio and should be alpha - upload as PNG - not JPG).
If you use a logo, a "blank" backing template is included at the bottom of the INSTRUCTIONS notecard.