KitchenGo Premium Developer Guide 1
KitchenGo Premium Developer Guide 1
KitchenGo Premium
Developer Manual
Ver 1.0
Table of Contents
KitchenGo Premium KDS Solution ................................................................................................................ 4
Settings.................................................................................................................................................... 14
General setting.................................................................................................................................... 15
Pre-message display............................................................................................................................ 23
Beeper ................................................................................................................................................. 30
Summary ............................................................................................................................................. 30
Worrying less about your kitchen printers running out paper and with live order display in the kitchen
allows your kitchen staff focus their attention on food preparation that enhance food preparing
processor.
4
System Overview
The KitchenGo Premium Android App is pre-installed in the LS8000 to provide operational features of
the kitchen display system. Orders are transmitted from the POS stations to KitchenGo Premium
through Ethernet network connection and displayed on the VGA monitor. Either a bump bar
(KB9000/KB1700) or touch monitor (LE1015/LE1015W) can be used to control operations of the
stations. Printers (LR2000) can also be connected to the LS8000 units to print out tickets in the kitchen
for dispatching with the food items.
5
For POS Development
The integration between POS and KitchenGo Premium KDS is sample and fast, all we need to do is
generated an order file that uses XML file format. Please check below for detail.
XML Description
Reserved characters
Some characters are generally reserved to indicate markup such that they cannot be used for character
data. These characters are <, >, and &. Furthermore, single and double quotes are sometimes reserved.
If you want to include such a character as below, write it as follows:
% instead of %
Please note that for node properties, you should NOT convert single or double quotes to ". For
example, version="1.0", encoding="UTF-8", BG="10",FG="255"
After you create the XML file, you may use Internet browser (such as IE, Firefox) to open it and see
whether it complies with XML standard.
Tag Description
<Transaction> </Transaction> Start & End of XML file
6
<Order> </Order> Start & End of XML order, everything inside these
two tags are order content
<ID>198</ID> Order ID or Item ID: order id must be unique in
whole system;
item id must be unique in whole order; (can be
string or integer )
condiment id must be unique in each item.
<PosTerminal>2</PosTerminal> Information on PosTerminal
<TransType>n</TransType> Tells which type the order/item is, when it is in
order level, there are 5 type total.
When n=1: Add new order;
When n=2: Delete this order, other tags can be any
value or don't need to be included;
When n=3: modify this order, simply include all
changed tag. If tag value is empty, KDS will deal
this tag as unchanged;
When n=4: transfer order to other station, see
transfer tag below;
When n=5: Ask this order's kitchen status.
7
<Transfer ToStation="1" FromStation="3"/> Transfer order to station 1 from station 3
<OrderStatus>n</OrderStatus> Tells the current status of order.
when n=0: this order is unpaid;
when n=1: this order is paid;
when n=2:this order is in process
<OrderType>string</OrderType> Tells which type the order is, when the string is
empty, it is Normal order; when string=RUSH, it is
RUSH order; When string=Fire, it is Fire order.
<ServerName></ServerName> Information on serverName(operator)
<Destination>Fast Food</Destination> Order destination
<GuestTable>S:01</GuestTable> Table information
<UserInfo>userinfo</UserInfo> Information on User, can be used to display a
message
<Parked>no</Parked> A parked order will go to parked pool and won't be
displayed on panels. Its value can be yes/no or 1/0
<IconIndex>n</IconIndex> Information on Icon(not supported yet)
<OrderMessages></OrderMessages> Start & End of order message, everything inside
these two tags are order message
<Count>n</Count> Order message count of message(PreModifier),
0<=n<=2
<S0>Order Message 0</S0> Message contents of message 0
<S1>Order Message 1</S1> Message contents of message 1
<CatDelay></CatDelay> The CatDelay tag is used to override the delay time
of the categories in Items Filter Setting
<Category Name="Grill" Delay="4"></Category> Information on category and its delay time in
minute
<Item></Item> Start & End of item, everything inside these two
tags are item content
8
<HideStation>1,3,4</HideStation> Hide item on these stations
<ItemDelay>2.3</ItemDelay> Delay timer on item in minute
<PreparationTime>2.3</PreparationTime> Item PreparationTimer in minute
<Name>Pasta Salad Supreme</Name> Item name
<Category>Hot</Category> Item category
<Quantity>1</Quantity> Item quantity
<Color BG="10" FG="255"></Color> 256 colors, background and foreground color value
<KDSStation>n:n</KDSStation> x:0 or x:1, x stands for which station you want the
order to be, 0 stands for screen 1 and 1 stands for
screen 2, support multiple station with 5:0,4:1 this
will send order to both station 4 and 5
<PreModifier> </PreModifier> Start & End of item PreModifier, everything inside
these two tags are item PreModifier
<Condiment></Condiment> Start & End of item condiment, everything inside
these two tags are item condiment
<Action>n</Action> Use in condiment, n=1 or -1 means add more
condiment or less condiment
<OrderStatus>0</OrderStatus>
<OrderType>RUSH</OrderType>
<ServerName>Jack</ServerName>
<Destination>FastFood</Destination>
<GuestTable>23</GuestTable>
<UserInfo>userinfo</UserInfo>
<OrderMessages>
<Count>2</Count>
<S0>Order Message 0</S0>
<S1>Order Message 1</S1>
</OrderMessages>
<Item>
<ID>14</ID>
<TransType>1</TransType>
9
<Name>Cheese Sandwish</Name>
<Category>Sandwish</Category>
<Quantity>2</Quantity>
<KDSStation>0</KDSStation>
<PreModifier>
<Count>2</Count>
<S0>Pre-Modifier 0</S0>
<S1>Pre-Modifier 1</S1>
</PreModifier>
<Color BG="108" FG="120"></Color>
<Condiment>
<ID>0</ID>
<PreModifier>
<Count>1</Count>
<S0>Seat 1</S0>
</PreModifier>
<TransType>1</TransType>
<Name>Spicy</Name>
<Color BG="128" FG="20"></Color>
<Action>1</Action>
</Condiment>
<Condiment>
<ID>2</ID>
<TransType>1</TransType>
<Name>tomato</Name>
<Color BG="8" FG="213"></Color>
<Action>-1</Action>
</Condiment>
</Item>
<Item>
<ID>10</ID>
<TransType>1</TransType>
<Name>Coffee</Name>
<Category>Beverages</Category>
<Quantity>1</Quantity>
10
</Item>
<Item>
<ID>11</ID>
<TransType>1</TransType>
<Name>Vege Soup</Name>
<Category>Soup</Category>
<Quantity>2</Quantity>
<Color BG="108" FG="120"></Color>
</Item>
<Item>
<ID>12</ID>
<TransType>1</TransType>
<Name>Apple Pie</Name>
<Category>Desserts</Category>
<Quantity>2</Quantity>
<Color BG="108" FG="120"></Color>
<Condiment>
<ID>0</ID>
<TransType>1</TransType>
<Name>butter</Name>
<Color BG="128" FG="20"></Color>
<Action>1</Action>
</Condiment>
<Condiment>
<ID>2</ID>
<TransType>1</TransType>
<Name>cheese</Name>
<Color BG="8" FG="213"></Color>
<Action>-1</Action>
</Condiment>
</Item>
<Item>
<ID>13</ID>
<TransType>1</TransType>
<Name>Garden salad</Name>
<Category>Salads</Category>
<Quantity>2</Quantity>
<Color BG="108" FG="120"></Color>
<Condiment>
<ID>0</ID>
<TransType>1</TransType>
<Name>Ranch</Name>
<Color BG="128" FG="20"></Color>
<Action>1</Action>
</Condiment>
<Condiment>
<ID>2</ID>
<TransType>1</TransType>
<Name>No Dressing</Name>
<Color BG="8" FG="213"></Color>
<Action>-1</Action>
</Condiment>
</Item>
</Order>
11
</Transaction>
Hardware Setup
Remove the LS8000 from its box and follow LS8000 Installation Guide to setup the LS8000 in
your environment and connect the hardware.
Connect the Bumpbar to the LS8000 using either PS/2 (RJ11 connector) or USB connection depend on
your Bumpbar connection type.
Connect VGA monitor to LS8000 VGA output.
If touch monitor operation is desired, connect the LE1015/LE1015W monitor VGA input to the LS8000
VGA output and connect USB cable between touch monitor and LS8000 USB connectors. USB mouse
and USB keyboard are recommended for application installation and setup if touch monitor is not used.
If necessary, connect the ticket printer to the LS8000 using either Serial or USB connection; you may also
connect the printer to the Ethernet router if the printer has an Ethernet connection;
Note:
Refer to "Printer setting", "Bumpbar setting" for information on how to setup the printer and the
Bumpbar.
For USB printer, only Bematech LR2000 is supported.
12
KitchenGo Premium Installation
The KitchenGo Premium KDS and KitchenGo Premium Router software app are pre-installed in the
LS8000 hardware, therefore you don't need to do any extra installation unless a update is required.
13
Settings
Settings: Go to KitchenGo Premium KDS settings;
Clear Database: Clear all data on all stations, it acts like a factory reset that clear
all data on the app but keep setting;
Show my IP : Display the IP address of LS8000;
Show active stations: Display a list of active stations;
Toggle Touch pad: Show/Hide on screen touch buttons;
Export settings: Exporting KitchenGo Premium KDS's settings&database, easiest
way for duplicate setting(E.G.: order screen setting) on a chain store without
going through all the setup again.
Import settings: Importing setting&database from selected ___location;
About KDS: Display current KitchenGo Premium KDS version.
14
General setting
Station number: Specify a must have unique ID in the system indicates which KDS station it is. Valid
volume are 0 to 99;
Order source: Specify where to get order files. Choice of "TCP/IP" & " Remote Folder" : if you are using
KitchenGo Premium Router, please keep the Data source as "TCP/IP" and leave the port 3000
unchanged;
Order source TCP port: Specify the port either your POS software or KitchenGo Premium Router will
communicate with this port for order data processing.
Order source remote folder: Specify a shared folder in the network typically on the PC where your POS
software runs;
Screen mode: This feature enables users to choose split screen which enables screen splits into two
separated order panels(sample screen below), so it will act as 2 stations.
Show log: show log on the bottom of screen;
Retrieve remote settings: get settings from other station, use for duplicating setting from one station to
other;
15
Stations relationship
A must have unique table that shows the relationship between all stations, it only needs to setup once
in one of the stations and use "Save & Update to all" button to push this stations relationship table to all
online stations over the network. User can also setup station's function here(Normal or Expeditor),
Advance Expo feature, backup station and mirror station.
ID : Stations' unique ID that uses to route order items to assigned stations; the underline number 0 in
above picture means station 0 is the station user is doing the setup in station 0;
Function: Specify the function of this station, if one station is set as Expeditor, all orders will be
automatically sent to this Expeditor station. Thus, at this station, the operator is able to quick visualize
all orders currently being processed at the kitchen and the staff at the front counter can handle different
16
items from different preparation stations. In addition, if any item/order is bumped off from a normal
station, that item/order will be marked in the Expeditor station. So waiters can check status of the
orders on the fly. This behavior is configured on the "Item display" Tab, on the section shown below.
Expo: Specify stations' Expeditor station, normally when user changes a station to Expo station, it will
add itself to the Expo column, so all normal station's item will goes to this Expo station directly. But if
users decide they don't want certain normal station's item to go to Expo station, user can simple remove
the Expo station from its Expo column; One example - Kitchen has 5 stations, Station1,2,3 are normal
stations, station4,5 are Expeditor stations, by default, all station1,2,3's order will go to both Expeditor
4&5; but let's say station 3 is a bar station, it handles all its orders, then user can remove both Expo 4&5
from its Expo column;
Mirror : The order is displayed on both stations(self station & station you put down in Mirror column).
After users bump an order from either station, the orders will bumped off on both stations;
Backup : The order will displayed on the backup station when the primary station is offline;
Status : when the status is disable, no order can go to this station;
Icons :
means current station relationship table is not saved, either there is a new change or this is a new
setup;
means there is error on station relationship table, you will need to fix it.
Order display
Customization for main order screen where you can customize main screen's properties here.
17
Screen title font: Specify the font's properties in screen title, including : font style, font size, font
foreground color & font background color;
Selected order border color: Specify the border color of selected order;
18
Show date&time in title: Display today's date and current time in title;
Screen background color: Specify the background color of order screen;
Hide navigation bar : Enable/disable the navigation on KitchenGo App;
Panel background color : Specify the background color of panel;
Text line height : Specify the font size to use in panel rows;
Panel mode: Specify how to display order panel, choices of "Horizontal expand" as fix panel size and
length & " Vertical expand" as flexible panel size and length from top left down to bottom right;
Panel rows: Specify the row of panel (1~4);
Panel columns: Specify the column of panel (2~8);
Display panel number: Enable/disable the display of panel number on order panels;
Use panel number to select: When enabled, user is able to use bump's key pad to select orders;
Starting panel number: Specify the starting panel number of first order, selection 1 is for users with
Bumpbar legend B;
Panel number background/foreground color: Specify the background/foreground color of panel number;
Sort orders : Specify how the orders should be displayed in default by choosing the order sorting
method;
Message : Specify the message to display in backup station which appear in the backup orders when its
primary station is offline;
Font : Specify the font's properties in the message for transfer orders, including : font style, font size,
font foreground color & font background color;
Smart order
This option enriches the process of food preparation at the kitchen by using a powerful delay algorithm
that allows items to be served / prepared at the right time. If users check this opinion, the KDS will
handle the order in its “smart way”. E.G.: A steak combo comes with a med-well steak + mashed potato
+ mix vege, since the times to cook steak takes more time which is 7 mins, and mashed potato takes 3
mins and mix vege takes 2 mins, the way smart order works in here is when the kitchen receive the
order, it will only display the steak first since it takes more time to cook, after 4 mins passed, the
mashed potato will come up since it takes 3mins which is the time to finish cooking the steak; then after
another minute, the mix vege will come up, since it takes only 2 mins, so with the help of smart order, all
items will finish at the same time for the steak combo.
19
Note: To have smart order working, either your POS software already support it or user will need to
configure the item filter setting in KitchenGo router.
20
Header font: Specify the font's properties of order header, including : font style, font size, font
foreground color & font background color;
Change color according to wait time: Enable/disable the color change of order header after certain time,
useful timer to alert kitchen staff how long has passed for the order, it has total three level of warning;
21
Time(Minutes): Specify the time when color change happens;
Color: Specify the color the order header will change to;
Header left content: Specify the content to display on the left position of order header;
Header center content: Specify the content to display on the center position of order header;
Header right content: Specify the content to display on the right position of order header;
Header second line enable: Enable/disable the second line for order header, if you want to display more
info on the order header, you can enable this;
Highlight properties
Customize order highlight properties for rush order, fire order, and orders with destination.
Item display
Customization for items' properties where you can also choose how to display item within orders.
22
Consolidate order items: Enable/disable combining item for same item;
Item font: Specify the items font's properties in order, including : font style, font size, font foreground
color & font background color;
Mark item with character: Enable/disable character mark for items instead of symbols;
Highlight item marks with: Specify the leading mark for highlighted items;
Bumped items marks with: Specify the leading mark for bumped items;
In expeditor, mark item bumped from normal station with: Specify the leading mark for expeditor
station items after it finished in normal station.
Condiment display
Customization for condiment's properties where you can also choose where to display condiment.
Condiment font: Specify the condiments font's properties in order, including : font style, font size, font
foreground color & font background color;
Condiment position: Specify the position to display condiment;
Pre-message display
Customization for order message &pre-modifier's properties;
23
Pre-message(Order message & item pre-modifier) font: Specify the order message & item pre-modifier
font's properties in order, including : font style, font size, font foreground color & font background color;
Footer settings
Customization for footer setting and its font;
Bumping settings
Customization for bumping options;
24
Show confirmation dialog after bumping an order: Enable/disable confirmation pop up after an order is
bumped;
Reserve bumped order for X days: Specify how many days the bumped order keeps in KDS;
Bump off with panel number: Enable/disable bumping using panel number;
Bumpbar assignment
Customization for Bumpbar key assignment;
25
Keyboard type: Specify which keyboard to use, after you change the keyboard type, the operations key
will also change according to the Bumpbar type;
Dialog: Specify the key assignment for popup dialog's "OK" and "Cancel" button;
26
Move focus to next: Select next order or move to next available option;
Move focus to prev: Select previous order or move to previous option;
Move focus to down: Select first item when order is selected or move to next available option;
Bump: After item or order is finished, press Bump to finish the order, so it will not show on current
active order screen;
Unbump: Bringing up a new windows shows all bumped orders, you can use this to recall bumped
orders back to active order screen;
Show/hide summary: Show or hide the summary panel that show total number of items on order
screen;
Transfer order to other station: Transfer selected order to a different kitchen station;
Sort orders: Sort current active orders in user's choice;
Park: Park the order in park windows for later;
Unpark: Bringing up a new windows shows all parked orders, you can use this to recall parked orders
back to active order screen;
Print: Printing out selected order if user have a printer setup;
Clear log: Clear current on-screen log if you have log enable;
Switch user focus: Switching the focus to different user if you have two user mode enabled;
Touch buttons
Customization for touch buttons;
27
Touch button font: Specify touch button's properties in order, including : font style, font size, font
foreground color & font background color;
Enable [XXX] touch button: Enable/disable this button on order screen;
Printer settings
Customization for printer setup;
28
Printer enabled: Enable/disable printer function;
Printer type: Specify the model of the printer will be used;
Printer port type : Specify the connection type of the printer;
IP address: Specify the IP address of the printer, only apply when it is a Ethernet printer;
IP port number: Specify the port of the printer, only apply when it is a Ethernet printer and it has a fix
port 9100;
Serial port number: Specify the serial port printer connects to, only apply when it is a Serial printer and it
has a fix port of COM4;
29
Baud rate: Specify the baud rate of the serial printer, please note if the baud rate in the setting doesn't
match the bard rate in the serial printer, it will not print correctly;
Characters per line: Specify the number of characters per line in the receipt;
Copies: Specify the number of copy you want for the printed receipts;
Code page: Specify the code page for the printer;
How to print order: Specify the condition to print orders;
Ticket template definition: A default template for printing orders;
Beeper
Customization for beeper setup;
Summary
Customization for summary panel;
30
Summary method: Summary panel shows total number of items on current station, user can choose to
sum item without condiments or item with condiments;
Summary position: Specify where to display summary panel;
Expeditor Alert
This feature adds a new type of item called Expeditor item, this item will only shows in Expo station but
not normal food preparing station which it will make your food preparing station "clean" with less items,
so chef only needs to focus on their dishes. If your POS software supports Expeditor alert feature, you
can customize how the Expeditor should be in here. E.G.: In some of the kitchen, certain
foods/items(salad dressings are one of the examples) are only prepared in the Expo station, they don't
need to show up in normal food prepared station, once the food dishes are ready, waiter/waitress can
then add the Expeditor item(salad dressing) into the salad.
31
Expeditor alert enabled: Enable/disable expeditor alert feature;
Change whole panel color: Enable/disable whole panel color change for expeditor alert feature, when
disable, only items' color get changed;
Change panel color to: Specify the color to use in expeditor alert;
32
33