Logwood PiKS Integration

Logwood PiKS Integration

Introduction

GPoS can send orders to the Raspberry Pi based Logwood PiKS ("Pi Kitchen Screen") devices, allowing them to be displayed on one or more screens. An app supplied by Logwood called "KSSender" is used to take an output file from GPoS and transmit it as order data to the PiKS. The devices can be standalone, or can be configured in a master-slave system, with one unit receiving all order data and assigning it to other units, eg in a restaurant where different cook areas or a bar may be present.

Requirements

  1. Total Control Premier version 2.09.7026 or higher
  2. GPoS version 1.62.7058 or higher
  3. KSSender version 1.16

Single PiKS Unit / Multiple Standalone Units

Regardless of the number of POS terminals and PiKS units in place, each POS terminal requires its own instance of KSSender. 

KSSender Setup

Copy the KSSender folder to a suitable location, eg C:\Fidelity\KSSender . Open the ksip.ini file and edit the lines in the file as detailed below: 

Line
Description / Configuration
Primary Server
The IP address of the PiKS unit, eg 192.168.1.100
ksdir
The KSSender folder location, eg C:\Fidelity\KSSender
kstickets
The name of the file that KSSender looks for to take order details; by default, this is "tickets.dat"

Save the file, and then run KSSender.exe . A file called ksip.log will be created and appended to in the KSSender folder, which will record KSSender being started. To stop KSSender, open Task Manager and end the process KSSender.exe.

If there is a tickets.dat file in the KSSender folder, KSSender will attempt to send the orders to the PiKS using the IP address specified above.

If KSSender cannot communicate with the PiKS for whatever reason, a file called kserror.txt will be created with the text “Send Data Failed”.

GPoS Setup

Peripheral Setup

Create a new Peripheral with an appropriate name and the following settings:

Setting
Description / Configuration
Device Type
31) Logwood KSSender
Screen #
The ID number of the PiKS; by default, this is 1
Path to KSSender listen folder
The KSSender folder location, eg C:\Fidelity\KSSender
Filename
The name of the file that KSSender looks for to pull order details from; by default, this is tickets.dat

The Path to KSSender listen folder and Filename setting on this Peripheral must match the ksdir and kstickets setting as described in the KSSender Setup above. 

System Options – Peripherals

Set the required KPName System Option ( 229 - 243) to the Logwood KSSender Peripheral created above. The KPConfigName setting is not relevant for Logwood devices. 

System Options – Print

Set the Check paper end System Option ( 274 - 281) for the relevant Kitchen Printer to False.

Multiple Master-Slave Units

Typically, multiple PiKS units are set up by Logwood in a Master-Slave configuration, with one PiKS being configured as a Master. All orders are sent to the Master unit, with the Master allocating orders to the Slave(s) based on the Screen # defined in the Peripheral Setup as detailed below.

The below guide is more of a generic overview, as Logwood's configuration of the units will have an impact on the GPoS Setup depending on detailed and intricate they make the Master-Slave setup. This will of course depend on the customer requirements, so always contact Fidelity if in doubt about how to configure the GPoS Setup.

KSSender Setup

KSSender handles all orders and reads one file for the Master PIKS unit to deal with, so there is no need for multiple KSSender configurations per POS terminal.

Copy the KSSender folder to a suitable location, eg C:\Fidelity\KSSender . Open the ksip.ini file and edit the lines in the file as detailed below: 

Line Description / Configuration
Primary Server The IP address of the master PiKS unit, eg 192.168.1.100
ksdir The KSSender folder location, eg C:\Fidelity\KSSender
kstickets The name of the file that KSSender looks for to take order details; by default, this is "tickets.dat"

GPoS Setup

GPoS writes one tickets.dat file and sends all orders to one KSSender as per the KSSender section above. The Screen # defined in each Peripheral determines which PiKS unit the Master PiKS unit sends the order to.

Peripheral Setup

Create a new Peripheral with an appropriate name and the following settings:

Setting Description / Configuration
Device Type 31) Logwood KSSender
Screen # The ID number of the PiKS as defined by Logwood; this usually increments by 1 with each additional PiKS unit 
Path to KSSender listen folder The KSSender folder location, eg C:\Fidelity\KSSender
Filename The name of the file that KSSender looks for to pull order details from; by default, this is tickets.dat

The Path to KSSender listen folder and Filename setting on this Peripheral must match the ksdir and kstickets setting as described in the KSSender Setup above.

Repeat the Peripheral Setup for as many PiKS units you want to send orders to. Each PiKS must have a different Screen # as assigned by Logwood.

System Options – Peripherals

Set the required KPName System Options ( 229 - 243) to each of the Logwood KSSender Peripherals created above. The KPConfigName setting is not relevant for Logwood devices. 

System Options – Print

Set the Check paper end System Option ( 274 - 281) for the relevant Kitchen Printer to False.

Product Setup

KP Flags

In a Product’s POS Options, set the relevant Kitchen Printer flag in the Kitchen Printer section to True, to match the relevant KP number set in Systems Options – Peripherals as described in the GPoS Setup notes above.

Courses

Courses (Starters. Mains, Desserts) are set using the Group2 link, and are used to determine what order items are listed on the PiKS screen and how they are held. The exact details of how these Courses are handled by the Logwood system will be down to the configuration applied to the unit(s) by Logwood themselves.

When adding or editing a Group2 record, the Course ID drop-down is used to set the Course attached to that record:

Course ID

Course

0

Starters

1

Mains

2

Desserts

3

Beverages

In a Product’s POS Options, set the Group Link #2 option in the General section to the relevant record.

Course ID 3 (Beverages) does not currently work. If you want to use Courses for drinks, it’s recommended that you use Course ID 1 (Mains).
 

Troubleshooting

GPoS Error - File Is Not Being Processed

Before GPoS writes the tickets.dat file, it checks to see if the file already exists. If it does, this is an indication that KSSender is not processing it for whatever reason. GPoS will display the error "Logwood file is not being processed" to indicate that orders are not currently being sent to the PiKS.

Check that the PiKS is connected to the network, and that it can be seen from the POS terminal. Check that KSSender is running, and that it is configured with the correct IP address, ticket folder and filename.

    • Related Articles

    • Integration

      Integration When clicking into this section will show integrations with other software within the listing below if you are linking with e.g. Agresso, Coop Orders, Sage Accounts, Nisa orders and so on. Take you back to the Table of Contents

    • GPoS / TCP - Hostname for Comms (Applies to Gpos 1.64 / TCP 2.11 onwards)

      With the arrival of TCP 2.11 and Gpos 1.64 communications to Total Control Premier have changed. instead of the traditional method of an IP address, it now uses the hostname of the hardware. The naming is absolute and must match exactly including any ...

    • SCO Mode Welcome Screen Messages

      This article applies to GPoS version 1.62 and higher - screenshots are taken from GPoS version 1.66. GPoS SCO Mode's welcome screen has two blocks of default text - "Scan your first item or touch here to begin" on a button in the middle of the ...

    • Changing the Default Screen Page on the Till

      Changing the Default Screen Page on the Till To change the till screen so that whoever logs in will display the same page, please note if a clerk has a specific screen page login this will superceed the tills default once they login. When performing ...

    • Group 2 Shifting for Kitchen Printing

      This article will instruct you on how to use the Group 2 shift in GPoS. This can be usefull for kitchen prints to state if an order is for eat in or take out. Please note this guide will not work if you are already using Group 2's for multibuys and ...