GPS/Status Devices: Difference between revisions

Revision as of 20:00, 6 December 2024

Device Aggregator and Server Installation

Start command prompt as administartor
From command prompt run the following commands:

"c:\Program Files (x86)\GivenHansco\keystone\bin\ccdeviceserver.exe" -install

"c:\Program Files (x86)\GivenHansco\keystone\bin\CCDeviceAggregator.exe" -install

Start Services
Verify that both Keystone Device Server and Keystone Device Aggregator are set to start automatically and are running.

Device Server Properties

Right Click Tray Icon
Device Server ID: DS1

Device Maintenance Setup

Description: GPS
Type: GPS/Status
Dev Server ID: DS1 (default name)

PROTOCOL=GHGPS
IPPORT=52241
KEEPALIVE=N
EOLHEX=04
USESERVERTIME=Y

Custom Truck Modes

Introduced in Keystone 2.7.19, custom truck modes allow miscellaneous truck status information to be gathered from the GPS system and presented on the Dispatch Schedule screen. These modes must be defined in the GPS setup for the GPS device as well as in the Keystone DITCUSTSTAT table. To specify a custom truck mode use the following syntax in Device Maintenance for the GPS device:

CUSTOM_EVENT_<n>=<xxx>

where <n> represents the custom truck mode (integer) and <xxx> represents the custom truck mode value from the GPS device (string.)

The DITCUSTSTAT table maps the integer custom truck mode value to a short alphanumeric code and a longer description as follows:

Field Name	Field Type	Description
CUSTOM_STATUS	Integer	Custom Truck Mode Identifier
STATUS_CODE	String(6)	Short code which appears on Dispatch Schedule truck grid
DESCRIPTION	String(35)	Description which appears on Dispatch Schedule status pop-up
STATUS_COLOR	Integer (color)	Color used to display STATUS_CODE and DESCRIPTION on Dispatch Schedule
SCHEDULE_SEQ	Integer	Determines sequence of custom truck modes on schedule screen negative # = highest priority 0 = no mode positive # = lowest priority
CLEAR_STATUS_COL	String(100)	Specifies statuses that will clear this custom truck mode NULL = never clear * = clear on all statuses except 13 (travel) 12*3 = clear on status 1, 2 or 3

Protocol Choices

Protocol	Device	Documentation	Comm Link Type	Keystone Version
GHNEXTEL2	Keystone GPS/(Keystone Nextel Phone)		UDP Server
KEYSTONEGPS	Keystone GPS (identical to GHNEXTEL2)		UDP Server
TRIMBLEXML	Trimble (XML)	Trimble XML Integration Interface	MSMQ Server
INTEGRAXML	TrakIt (Integra XML)	Integra XML Technical Specification	MSMQ Server
DIGITALFLEETXML	Digital Fleet (CALIFORNIA PREVAILING WAGE ONLY -- ONLY USE THIS FOR FROM_DISPATCH DEVICE)		MSMQ Server
TRAKITLEGACY	TrakIt (Legacy Output)		UDP Server
TRIMBLELEGACY	Trimble (Legacy Output)		Serial Server
GHGPS	FileMaker GPS		TCP Server
GHNEXTEL	Nextel Phone		UDP Server
DINET	Dinet Status Box		Serial Server
GHARGO	KEYSTONE GPS w/Argo Modem		TCP Server
GHBLUETREE	KEYSTONE GPS w/BlueTree Modem		UDP Server
GHDATAREMOTE	KEYSTONE GPS w/DataRemote Modem		UDP Server
VERIFI	Verifi Truck Status (XML)	Verifi Truck Status XML Interface Verifi Truck Status XML Response	Polled REST Server	3.4.5.6
ROADKING	RoadKing GPS (JSON)		HTTP Server	3.6.15.5
OSHKOSH	Oshkosh Begin/End Pour and Post Pour Wash (JSON)	Oshkosh AssetReportEvents API	Polled REST Server	4.1.2.2

Protocol Notes

Integra XML Configuration (TrakIt)

Windows Message Queuing Services must be installed on the PC running Keystone Device Server. In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is CHECKED):

fromdispatch
todispatch

The PC running TrakitWare must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrakitWare.) If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions: http://support.microsoft.com/kb/183293

Trimble XML Configuration

Windows Message Queuing Services must be installed on the PC running Keystone Device Server. In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is UNCHECKED):

from_dispatch
to_dispatch

The PC running TrimExchange must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrimExchange.) If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions: http://support.microsoft.com/kb/183293

Filemaker GPS Startup

Double Click the GPS Shortcut
LOGIN: GPS
Click: Connect
Minimize

Bluetree GPS Modem

Diagnostics:

TELNET <modem_ip> 6070

Command to see IP address that modem is connecting to:

AT+BRPRDS?

RoadKing GPS Sample JSON Content

{
  "TruckEvent": {
    "OrderNumber": "117393",
    "TruckNumber": "108",
    "Date": "2020/07/30",
    "Time": "15:50:34",
    "EventCode": "9"
  }
}

Oshkosh Begin/End Pour Sample JSON Content

[
    {
        "AssetId": 42490,
        "ReportEventTypeId": 7,
        "AssetName": "TEST001",
        "Vin": "99999BEN1HTEST001",
        "Timestamp": "2020-10-22T01:16:22",
        "Latitude": 43.981525,
        "Longitude": -88.545744
    },
    {
        "AssetId": 42490,
        "ReportEventTypeId": 8,
        "AssetName": "TEST001",
        "Vin": "99999BEN1HTEST001",
        "Timestamp": "2020-10-22T02:15:20",
        "Latitude": 43.98158,
        "Longitude": -88.545723
    }
]

Sample Configurations

Common Device Parameters

USESERVERTIME=0                  ;0=Use time from status message, 1=Substitute current clock time in status message
USEGEOFENCING=0                  ;0=Disable geofencing, 1=Use geofencing to determine on job/at plant status
USEODOMETER=1                    ;0=Estimate odometer using distance formula, 1=Use odometer field from status message
USEPLANTNO=0                     ;0=Ignore plant number from status message, 1=Use plant number from Arrive Plant/In Service status message
ONJOBSTOPTIME=6                  ;0=Disable on job stop time, 1=Move to on job status if truck stopped more than x minutes
GPSCOMPANIES=<CoId>[,<CoId>]*    ;if truck is not found in current company, check each of the listed companies
; To stop bad signals from showing up on the map, add the following lines.  The Lat and Long are for the plant
; and the Radius is in miles.  If more than on plant, set the Lat and Long in the center of all the plants.
VALIDLAT=41.98765  
VALIDLONG=-78.97650
VALIDRADIUS=150
SETORDERLOCFROMGPS=0             ;0=Ignore GPS coordinates from status message, 1=Set Order GPS coordinates from On Job, Begin Pour, End Pour status messages
ALLOWRETCONC=1 (3.4+)            ;0=Ignore returned concrete from status message, 1=Process returned concrete from status message
TRUCKFILTER=<TruckId> (3.5+)     ;only statuses for the specified Truck Id will be processed, all other trucks will be ignored (diagnostics)
; Events that can be configured are as follows
EVENT_BEGINLOAD=
EVENT_ENDLOAD=
EVENT_TOJOB=
EVENT_ONJOB=
EVENT_BEGINPOUR=
EVENT_ENDPOUR=
EVENT_RETURNING=
EVENT_ARRIVEPLANT=
EVENT_INSERVICE=
EVENT_OUTOFSERVICE=
EVENT_CLOCKIN=
EVENT_CLOCKOUT=
EVENT_GPS=
EVENT_PRETICKET=
EVENT_DRIVER_CLOCKIN=  (2.7+)
EVENT_DRIVER_CLOCKOUT=  (2.7+)
EVENT_RETCONC=  (3.4+)
EVENT_ADDWATER=  (3.4+)
; Custom Truck Modes
;   where n = custom truck mode (integer) - defined in DITCUSTSTAT table
;         xxx = custom truck mode value from GPS (string)
CUSTOM_EVENT_n=xxx

Keystone GPS

This is the modern Windows / Web Version of Keystone GPS used since 2008. Based on the Keystone Nextel system of early 2000s.

PROTOCOL=KEYSTONEGPS
; The following parameters default to the values shown
IPPORT=7002
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15 
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20

TrakIt (Integra XML)

PROTOCOL=INTEGRAXML
MSMQFORMATNAME=DIRECT=OS:.\private$\todispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=1
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=9
EVENT_OUTOFSERVICE=10

Trimble (XML)

PROTOCOL=TRIMBLEXML
MSMQFORMATNAME=DIRECT=OS:.\private$\to_dispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=LDS
EVENT_ENDLOAD=LDC
EVENT_TOJOB=TJB
EVENT_ONJOB=AJB
EVENT_BEGINPOUR=POU
EVENT_ENDPOUR=EPR
EVENT_RETURNING=TPL
EVENT_ARRIVEPLANT=IYD
EVENT_INSERVICE=ISV
EVENT_OUTOFSERVICE=OSV

When setting up Trimble (XML), you need to also do the following in Windows:

Ensure that the Windows Message Queuing Server is installed.

Error creating thumbnail: /bin/bash: /usr/bin/convert: No such file or directory Error code: 127

Create the necessary message queues to interface with Trimble.

Error creating thumbnail: /bin/bash: /usr/bin/convert: No such file or directory Error code: 127

Set the properties for the Trimble message queues.

Error creating thumbnail: /bin/bash: /usr/bin/convert: No such file or directory Error code: 127

TrakIt (Legacy Output)

PROTOCOL=TRAKITLEGACY
IPPORT=???
; Event Defaults are shown below
EVENT_ENDLOAD=4
EVENT_TOJOB=5
EVENT_ONJOB=6
EVENT_BEGINPOUR=7
EVENT_ENDPOUR=8
EVENT_RETURNING=9
EVENT_ARRIVEPLANT=3
EVENT_CLOCKIN=1
EVENT_CLOCKOUT=11

Nextel Phone

PROTOCOL=GHNEXTEL
IPPORT=52242
; Event Defaults are shown below
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=1
EVENT_GPS=0

Trimble (Legacy Output)

PROTOCOL=TRIMBLELEGACY
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0A
TIMEOUT=500
; Event Defaults are shown below
EVENT_ENDLOAD=1
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=0

Dinet Status Box

PROTOCOL=DINET
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0D
TIMEOUT=500
; Event Defaults are shown below
EVENT_BEGINLOAD=0
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=1
EVENT_OUTOFSERVICE=9

KEYSTONE GPS w/Argo Modem

PROTOCOL=GHARGO
IPPORT=52243
EOLHEX=23
; Event Defaults are shown below
EVENT_INSERVICE=511
EVENT_BEGINPOUR=521
EVENT_ENDPOUR=531
EVENT_GPS=602

KEYSTONE GPS w/BlueTree Modem

PROTOCOL=GHBLUETREE
IPPORT=52242
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=1

KEYSTONE GPS w/DataRemote Modem

PROTOCOL=GHDATAREMOTE
IPPORT=52243
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=0

FileMaker GPS

PROTOCOL=GHGPS
IPPORT=52241
EOLHEX=0D0A
KEEPALIVE=Y
; Event Defaults are shown below
EVENT_TOJOB=4
EVENT_ONJOB=5
EVENT_BEGINPOUR=1
EVENT_ENDPOUR=2
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=7
EVENT_INSERVICE=3
EVENT_OUTOFSERVICE=8
EVENT_GPS=0

Verifi Truck Status

PROTOCOL=VERIFI
ROOTURL=https://portal.verificoncrete.com/rs/api/1.0/
VERIFIUSER=givenhansco@company.com
VERIFIUSERPASS=********************

RoadKing GPS Status

PROTOCOL=ROADKING
; The following parameters default to the values shown
URL=/roadking/gps
IPPORT=7003
KEEPALIVE=1
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15 
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20

Oshkosh Begin/End Pour and Post Pour Wash

PROTOCOL=OSHKOSH
TIMEOUT=60000
; The following parameters default to the values shown
ROOTURL=https://api.lhptelematics.com/v2/
AUTHUSERNAME=********************
AUTHPASSWORD=********************
MAXPOURMINS=120
; Event Defaults are shown below
EVENT_BEGINPOUR=8
EVENT_ENDPOUR=9
EVENT_BEGINPOSTPOURWASH=10
EVENT_ENDPOSTPOURWASH=11

Keystone ODBC Configuration (for Keystone GPS support)

NOTE ODBC is no longer used by Keystone GPS. Keystone GPS now uses a REST call. Remove Old ODBC connections where possible.

Install the InterBase ODBC Driver.

Use the 32-bit version of the Windows ODBC Administrator. (On 64-bit Windows you must run the ODBCAD32.EXE located in C:\Windows\SysWOW64.)

Create a new System DSN by clicking the "Add" button.

Enter the appropriate configuration information. Be sure to check the "read" box in the Transaction Options group.

Click the "Test connection" button before saving to verify that the database connection is valid.

@@ Line 113: / Line 113: @@
 | [[Media:Integra_XML_V2.5.pdf|Integra XML Technical Specification]]
 | MSMQ Server
 |-
 | DIGITALFLEETXML

GPS/Status Devices: Difference between revisions

Revision as of 20:00, 6 December 2024

Contents

Device Aggregator and Server Installation

Device Server Properties

Device Maintenance Setup

Custom Truck Modes

Protocol Choices

Protocol Notes

Integra XML Configuration (TrakIt)

Trimble XML Configuration

Filemaker GPS Startup

Bluetree GPS Modem

RoadKing GPS Sample JSON Content

Oshkosh Begin/End Pour Sample JSON Content

Sample Configurations

Common Device Parameters

Keystone GPS

TrakIt (Integra XML)

Trimble (XML)

TrakIt (Legacy Output)

Nextel Phone

Trimble (Legacy Output)

Dinet Status Box

KEYSTONE GPS w/Argo Modem

KEYSTONE GPS w/BlueTree Modem

KEYSTONE GPS w/DataRemote Modem

FileMaker GPS

Verifi Truck Status

RoadKing GPS Status

Oshkosh Begin/End Pour and Post Pour Wash

Keystone ODBC Configuration (for Keystone GPS support)

Navigation menu