You are on page 1of 31

SAE J1708/J1587

INTERFACE SPECIFICATION

For use on Vehicle Area Network (VAN)

Ref

SAE J1708 Rev. OCT93


SAE J1587 Rev. JUL98

Revisions Approvals Unless Otherwise Specified


SYM ECO No APVD Date Drwn Engr DIMENSIONS ARE IN INCHES / (mm) AND APPLY
A 20-205 AFTER HEAT TREAT AND PLATING
Date Date
DO NOT SCALE DRAWING
Chkd Apvd TOLERANCES ON:
FRAC 2PL DEC 3PL DEC ANGLE EX NO. SCALE
Date Date
±1/64 ±.01 ±.005 ±0-30’ SHT 1 of 31

K
TITLE DWG NO

SAE J1708/J1587 INTERFACE SPECIFICATION A23409-0002

Copyright © GFI GENFARE 2000.


This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
SCOPE
This document defines the GFI Genfare Farebox interface to the SAE
J1708/J1587 Vehicle Area Network. It identifies the subset of Parameter
Definitions (PIDs) supported, and addresses the characteristics of that
support.

APPLICABLE DOCUMENTS
SAE J1708 Rev. OCT93 SURFACE VEHICLE RECOMMENDED PRACTICE

SERIAL DATA COMMUNICATIONS BETWEEN MICROCOMPUTER


SYSTEMS IN HEAVY-DUTY VEHICLE APPLICATIONS

SAE J1587 Rev. JUL98 SURFACE VEHICLE RECOMMENDED PRACTICE

JOINT SAE/TMC ELECTRONIC DATA INTERCHANGE BETWEEN


MICROCOMPUTER SYSTEMS IN HEAVY-DUTY VEHICLE
APPLICATIONS

INTENT
The Farebox shall support the relevant subset of PIDs in a manner fully
compliant with SAE J1708 Rev. OCT93. Such compliance specifically includes
full adherence to:

Section 3.0 Electrical Parameters,


Section 4.2 Network Access, and
Section 5.0 Protocol

Furthermore, this interface shall implement the required subset of SAE


J1587 Rev. JUL98 in a compliant, consistent, and extensible manner across
contracts.

SHT 2 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
COMMON DEFINITIONS

< MID > := Message Identification Number

< Fbx > := MID, Farebox = 196

< Mid > := MID, Generic Module other than Farebox, e.g., 188

< Src > := MID, Generic Source

< Dst > := MID, Generic Destination

< PID > := Parameter Identification Number

< Pg1 > := PID, Generic Page 1, i.e., 0 <= Pg1 <= 254

< Pg2 > := PID, Generic Page 2, i.e., 256 <= Pg2 <= 510

< ddd > := Segment Data, 1 to 15 bytes

< Csm > := 8 bit 2's complement checksum

SHT 3 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
DATA REQUEST PIDs

The SAE J1587 specification provides four (4) PIDs that enable the farebox
to request specific data elements from other networked components and,
similarly, enable those units to make requests of the Farebox. These are
divided into two categories: (1) component-specific requests, i.e.,
requests made of a specific component on the network, and (2) requests made
of the network as a whole. While all four PIDs are briefly described below,
only the component-specific PIDs 128 and 384 are supported for transit-
related messaging.

PID 0 Page 1 Parameter Request


Format: <Src> 0 <pid> <Csm> , where

<pid> := PID requested, range 0 to 255

Comments: See SAE J1587 Revised JUL 1998, Appendix A.0


PID 128 should be employed for all transit-related messaging.

PID 128 Component-Specific Page 1 Parameter Request


Format: <Src> 128 <pid> <Dst> <Csm> , where

<pid> := PID requested, range 0 to 255

Comments: See SAE J1587 Revised JUL 1998, Appendix A.128

PID 256 Page 2 Parameter Request


Format: <Src> 255 0 <pid> <Csm> , where

<pid> := PID requested, range 256 to 511

Comments: See SAE J1587 Revised JUL 1998, Appendix A.255


PID 384 should be employed for all transit-related messaging.

PID 384 Component-Specific Page 2 Parameter Request


Format: <Src> 255 128 <pid> <Dst> <Csm> , where

<pid> := PID requested, range 0 to 255

Comments: See SAE J1587 Revised JUL 1998, Appendix A.384

SHT 4 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 192 Page 1 Multisection Parameter

Format: <Src> 192 <Cnt> <Pg1> <s/s> <cnt>|<ddd> <Csm> , where

<s/s> := total and current section

where Bits 8-5 := total number of sections minus one (n-1)


Bits 4-1 := current section (base 0)

<cnt> := unsigned short, total byte count of original data

<ddd> := segment data, 1-13 bytes in packet 1 else 1-14 bytes

Comments: See SAE J1587 Revised JUL 1998, Appendix A.192

Attempts to request PID 192 information from the Farebox are not
supported.

In practice, this PID would only be required to send PID 234


Software Identification, and only when the combination of route,
run, and block information (including delimiters) exceeds 16
characters.

Note: This PID will be further discussed following the entries


for PID 234, Software Identification.

SHT 5 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 194 Transmitter System Diagnostic Code and Occurrence Count Table
Format: <Src> 194 <Cnt> <Csm> , where

<Cnt> := 0, see comments below

Comments: See SAE J1587 Revised JUL 1998, Appendix A.194

The specification states: "If the Diagnostic code PID is


requested and there are no diagnostic codes, the response would
be a PID 194 with the n [i.e., <Cnt>] set 0." This is the only
case supported by Farebox Software.

Note: The request for PID 194 data was initially proposed as a
means of polling the Farebox, i.e., as a way of determining that
the Farebox was on line. While still supported, the preferred
approach is to issue a component specific request for PID 378
Fare Collection Unit Status. Please see PID 378 for further
details.

EXAMPLE: Network-wide request for PID 194

Request: <Mid> 128 194 <Fbx> <Csm>


Response: <Fbx> 194 0 <Csm>

EXAMPLE: Component-specific request for PID 194

Request: <Mid> 128 194 <Fbx> <Csm>


Response: <Fbx> 194 0 <Csm>

SHT 6 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 206 Farebox Probe Identification
Format: <Fbx> 206 <Cnt> <aaa> <Csm> , where

<aaa> := ASCII, Farebox probe identification

Comments: Proposed and approved 13 May 2002

Farebox Probe Identification is sent in response to a component-


specific request. It will also be broadcast, along with Farebox
Probe Type (PID 347) and the appropriate PID 378 Fare Collection
Status message, at the start of probing.

Given: Assume a Farebox Probe Identification of “9876”, then

EXAMPLE: Broadcast (see also: PID 378 - EXAMPLE 2, Case 3)

Farebox: <Fbx> 206 4 ‘9’ ‘8’ ‘7’ ‘6’ <Csm>

EXAMPLE: Component-specific request for PID 206

Request: <Mid> 128 206 <Fbx> <Csm>


Response: <Fbx> 206 4 ‘9’ ‘8’ ‘7’ ‘6’ <Csm>

SHT 7 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 207 Cashbox Information
Format: <Fbx> 207 <cbx> <rev> <Csm> , where

<cbx> := cashbox number, unsigned short, binary identification


<rev> := cashbox revenue, unsigned long, revenue in cents

Comments: Proposed and approved 13 May 2002

Cashbox information sent in response to a component-specific


request. It will also be broadcast, along the appropriate PID 378
Fare Collection Status message, upon detecting a change in the
cashbox identification number.

EXAMPLE: Broadcast (see also: PID 378 - EXAMPLE 2, Case 2)

Farebox: <Fbx> 207 <cbx> <rev> <Csm>

EXAMPLE: Component-specific request for PID 207

Request: <Mid> 128 207 <Fbx> <Csm>


Response: <Fbx> 207 <cbx> <rev> <Csm>

SHT 8 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 233 Unit Number (Power Unit)
Format: <Fbx> 233 <Cnt> <aaa> <Csm> , where

<aaa> := ASCII, Bus number

Comments: See SAE J1587 Revised JUL 1998, Appendix A.234

Note that the term “Power Unit” is used in J1587 to distinguish


between the ‘powered’ vehicle/bus and any trailer that might be
associated with it.

Bus number is sent in response to a component-specific request.

Given: Assume a Bus Number (Unit Number) of “876”, then

EXAMPLE: Component-specific request for PID 233

Request: <Mid> 128 233 <Fbx> <Csm>


Response: <Fbx> 233 3 ‘8’ ‘7’ ‘6’ <Csm>

SHT 9 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 234 Software Identification
Format: <Src> 234 <Cnt> <aaa> [ '*' <bbb> [ ‘*’ <ccc> … ]] <Csm> , where

<aaa> := ASCII, Farebox software identification


'*' := optional field delimiter
<bbb> := ASCII, Operator Control Unit software identification
<ccc> := ASCII, TriM software identification

Comments: See SAE J1587 Revised JUL 1998, Appendix A.234

PID 234 data is transmitted upon request. The examples shown


below assume a Farebox software version of “333”, an Operator
Control Unit version of "222" and a TRiM software version of
"111".

EXAMPLE: Component-specific request for PID 234

Request: <Mid> 128 234 <Fbx> <Csm>


Response: <Fbx> 234 11 ‘3’ ‘3’ ‘3’ ‘*’ ‘2’ ‘2’ ‘2’ ‘*’ ‘1’ ‘1’ ‘1’ <Csm>

SHT 10 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 234 Software Identification (sent via PID 192)
Format: <Src> 192 <Cnt> <Pg1> <s/s> <cnt>|<ddd> <Csm> , where

<s/s> := section information


Bits 8-5 := total number of sections minus one (n-1)
Bit 4-1 := current section (base 0)
<cnt> := unsigned short, total byte count of original data
<ddd> := segment data, 1-13 bytes in packet 1 else 1-14 bytes

Comments: As previously noted, this PID would be required to send PID 234,
Software Identification, if the combination of Farebox, Operator
Control Unit, and TRiM Software Identification (including
delimiters) were to exceed 17 characters. This is because all
Page 1 variable length messages require 4 bytes of overhead (MID,
PID, Cnt, & Csm), and no message may exceed 21 bytes under normal
operation.

In the example below, the Farebox is initialized such that the


Transit Route Identification requires 17 bytes (including the 2
‘*’ delimiters). Note, also, that the Driver number has been
initialized.

Given: For the following examples, assume

Farebox Identification = "111111"


Operator Control Unit Identification = “222222”
TRiM Identification = "333333”

EXAMPLE: Broadcast

Reference: MID 192 Cnt Pg1 s/s cnt ddd ddd ddd ddd ddd ddd ddd ddd
========= === === === === === === === === === === === === === ===

Section 1: <Src> 192 17 234 16 20 ‘1’ ‘1’ ‘1’ ‘1’ ‘1’ ‘1’ ‘*’ ‘2’
‘2’ ‘2’ ‘2’ ‘2’ ‘2’ ‘*’ <Csm>

Section 2: <Src> 192 8 234 17 ‘3’ ‘3’ ‘3’ ‘3’ ‘3’ ‘3’ <Csm>

Note that the Section 1 <s/s> field is set to 16 (0x10 hex) to


mark the first section of a 2-section transmission. Similarly,
the Section 2 <s/s> field is set to 17 (or 0x11 hex) to signal
the section of this 2-section message.

SHT 11 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 239 Position
Format: <Src> 239 <Cnt> <lat> <lon> <alt> <Csm> , where

<lat> := latitude, signed long, 10-6 degrees/bit


positive = North
negative = South

<lat> := longitude, signed long, 10-6 degrees/bit


positive = East
negative = West

<alt> := altitude, signed int, 0,5 feet/bit

Comments: See SAE J1587 Revised JUL 1998, Appendix A.239

The specification identifies three formats, such that …

<Cnt> := 2; altitude transmitted


<Cnt> := 8; latitude and longitude transmitted
<Cnt> := 10; latitude, longitude, and altitude transmitted

The Farebox ignores altitude information if sent.

The Farebox will store Position PID broadcasts.

In those systems where the source of position data is unable to


detect a ‘bus stopped / door open’ condition, the Farebox will
repeatedly poll for position, logging the last set of coordinates
received prior to the onset of passenger processing. Polling will
then cease until such time as a predetermined lull in passenger
activity is detected.

Attempts to request PID 239 position data from the Farebox are
ignored unless issued by the data’s source in an effort to
confirm reception.

EXAMPLE: Broadcast

Source: <Mid> 239 10 <lat> <lon> <alt> <Csm>

EXAMPLE: Component-specific request for PID 239

Request: <Fbx> 128 239 <Mid> <Csm>


Response: <Mid> 239 10 <lat> <lon> <alt> <Csm>

SHT 12 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 251 Clock - Standard Time Message
Format: <Src> 251 <Cnt> <aaa> <bbb> <ccc> <Csm> , where

<Cnt> := 3
<aaa> := seconds, unsigned short, 0.25 seconds/bit
<bbb> := minutes, unsigned short, 1 minute/bit
<ccc> := hours, unsigned short, hour/bit

Comments: See SAE J1587 Revised JUL 1998, Appendix A.251

Attempts to request PID 251 clock data from the Farebox are not
supported.

EXAMPLE: Broadcast

Source: <Mid> 251 3 <aaa> <bbb> <ccc> <Csm>

SHT 13 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 252 Date
Format: <Src> 252 <Cnt> <aaa> <bbb> <ccc> <Csm> , where

<Cnt> := 3
<aaa> := day, unsigned short, 0.25 days/bit
<bbb> := month, unsigned short, 1 month/bit
<ccc> := year - 1985, unsigned short, 1 year/bit

Comments: See SAE J1587 Revised JUL 1998, Appendix A.252

Attempts to request PID 252 date information from the Farebox are
not supported.

EXAMPLE: Broadcast

Source: <Mid> 252 3 <aaa> <bbb> <ccc> <Csm>

SHT 14 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 344 Driver Logon Status
Format: <Fbx> 255 88 <bin> <Csm> , where

<bin> := type, unsigned short, 0 = logon validated


1 – 255 = exception

Comments: Proposed and approved 13 May 2002

Driver Logon Status is a response sent to the Farebox to indicate


the validity of its Driver and Run/Block logon state. A non-zero
value is used to register an application-defined error condition
exception. The farebox alerts the Driver to all such occurrences.

EXAMPLE: Broadcast

Farebox: <Mid> 255 88 <bin> <Csm>

EXAMPLE: Component-specific request for PID 344

Request: <Fbx> 255 128 88 <Fbx> <Csm>


Response: <Mid> 255 88 <bin> <Csm>

SHT 15 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 347 Farebox Probe Type
Format: <Fbx> 255 91 <bin> <Csm> , where

<bin> := type, unsigned short, 0 = garage data system


1 = portable data unit
2 = portable probe
3 – 255 = undefined

Comments: Proposed and approved 13 May 2002

Farebox Probe Type is sent in response to a component-specific


request. It will also be broadcast, along with Farebox Probe
Information (PID 206) and the appropriate PID 378 Fare Collection
Status message, at the start of probing.

EXAMPLE: Broadcast (see also: PID 378 - EXAMPLE 2, Case 3)

Farebox: <Fbx> 255 91 <bin> <Csm>

EXAMPLE: Component-specific request for PID 347

Request: <Mid> 255 128 91 <Fbx> <Csm>


Response: <Fbx> 255 91 <bin> <Csm>

SHT 16 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 378 Fare Collection Unit Status
Format: <Fbx> 255 122 <map> <Csm> , where

<map> := 8-bit bit-mapped status,

where Bits 7–1 := Alarm identifier; see below


Bit 8 := Emergency flag, 0 = non-emergency
1 = emergency condition

The SAE J1587 specification currently

provides specific definitions for alarm identifiers 0-25


designates identifiers 26-96 as “reserved – to be assigned”
designates 97-127 as “Agency defined”.

The following predefined alarms are supported (broadcast) by the


Farebox and transmitted upon a change in status:

{ 2, Flag: 0} = 2 := probe started


{ 3, Flag: 0} = 3 := probe complete
{ 4, Flag: 0} = 4 := cashbox removed
{ 4 Flag: 1} = 132 := cashbox removed, unauthorized
{ 5, Flag: 0} = 5 := cashbox restored
{ 5, Flag: 1} = 133 := cashbox restored, unauthorized
{ 6, Flag: 1} = 134 := cashbox door timeout
{ 7, Flag: 0} = 7 := cashbox door opened, authorized
{ 7, Flag: 1} = 135 := cashbox door opened, unauthorized
{ 9, Flag: 0} = 9 := coin box 75% full
{10, Flag: 1} = 138 := coin box full
{11, Flag: 0} = 11 := currency box 75% full
{13, Flag: 1} = 141 := currency box full
{18, Flag: 1} = 146 := coin mech placed in manual bypass
{19, Flag: 0} = 19 := coin mech reset to normal operation
{24, Flag: 0} = 24 := * maintenance access, logged off
{24, Flag: 1} = 152 := * maintenance access, logged on

This is a default or provisional list. Additional alarms may be


required and broadcast at the request of the Authority. Specific
transit authorities may also differ as to what constitutes an
‘emergency’ condition. Thus, for example, the coin mech bypass
status message could be sent with bit 8 reset to zero, i.e., as
alarm designator 18 rather than 146.

As part of this latter category, GFI Genfare defines status


indicators 126 and 127 as follows:

126 := No Traffic Response, Farebox in Revenue Service


127 := No Traffic Response, Farebox Out Of Service

These enable the Farebox to respond to component-specific queries


for PID 378 data when no alarm condition exists. Such a request
can be used as a means to determine if the farebox is on line.

These values will also be broadcast by the Farebox upon going


into and out of revenue service. Note that, in some cases, this
means that two Farebox Status messages will be sent: the first to
indicate a change in status and the second to announce that this
reported change caused the Farebox go in or out of service.
SHT 17 of 31 DWG NO A23409-0002
Copyright © GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 378 Fare Collection Unit Status -- continued
It is possible for the Farebox to query another unit for Farebox
Status to confirm that the previous Farebox Status broadcast was
properly received. This is depicted in the examples shown below.

(*) Note: SAE J1587, PID 378 defines the status byte value of 24
as indicating “maintenance access - in service, and a status byte
value of 25 as indicating “maintenance access - out of service”.
The Farebox, however, knows only that it is in a “logged on” or
“logged off” state. Rather than have “logged on” and “logged off”
serve as a proxy for “in service” and “out of service”, transit
industry experts, in consultation with GFI Genfare, resolved
that:

status byte 24 is to be employed for all cases of maintenance


access, and
the alarm flag (bit-8) is to be asserted when such access
occurs while the Farebox is in the “logged on” state.

EXAMPLE 1: Component-specific request for PID 378

Case 1: Farebox on line and in revenue service with


no alarm condition to report.

Request: <Mid> 255 128 122 <Fbx> <Csm>


Response: <Fbx> 255 122 126 <Csm>

Case 2: Farebox on line and in logoff state with


no alarm condition to report.

Request: <Mid> 255 128 122 <Fbx> <Csm>


Response: <Fbx> 255 122 127 <Csm>

EXAMPLE 2: Broadcast

Case 1: Broadcast (Alarm = 146; coin mech bypass)


Query to confirm reception

Farebox: <Fbx> 255 122 146 <Csm>

Request: <Fbx> 255 128 122 <Mid> <Csm>


Response: <Mid> 255 122 146 <Csm>

Case 2: Broadcast (Alarm = 4; cashbox removed - authorized)


Message linked to PID 207 Cashbox Information data
Query to confirm reception

Farebox: <Fbx> 207 <cbx> <rev> 255 122 4 <Csm>

Request: <Fbx> 255 128 122 <Mid> <Csm>


Response: <Mid> 255 122 4 <Csm>

SHT 18 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 378 Fare Collection Unit Status -- continued

Case 3: Broadcast (Alarm = 2; probing started)


Message linked to PID 206 Farebox Probe Identification
Message linked to PID 347 Farebox Probe Type
Query to confirm reception

Given: Probe ID = “987”; Type = 0 (Garage Data System)

Farebox: <Fbx> 206 3 ‘9’ ‘8’ ‘7’ 255 91 0 122 2 <Csm>

Request: <Fbx> 255 128 122 <Mid> <Csm>


Response: <Mid> 255 122 2 <Csm>

SHT 19 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 448 Page 2 Multisection Parameter

Format: <Src> 255 192 <Cnt> <Pg2> <s/s> <cnt>|<ddd> <Csm> , where

<s/s> := total and current section

where Bits 8-5 := total number of sections minus one (n-1)


Bits 4-1 := current section (base 0)

<cnt> := unsigned short, total byte count of original data

<ddd> := segment data, 1-13 bytes in packet 1 else 1-14 bytes

Comments: See SAE J1587 Revised JUL 1998, Appendix A.448

Attempts to request PID 448 information from the Farebox are not
supported.

In practice, this PID would only be required to send PID 508


Transit Route Identification, and only when the combination of
route, run, and block information (including delimiters) exceeds
16 characters.

Note: This PID will be further discussed following the entries


for PID 507, Driver Identification, and PID 508, Transit Route
Identification.

SHT 20 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 502 Fare Collection Unit – Service Detail
PID 503 Fare Collection Unit – Point of Sale

Comments: See SAE J1587 Revised JUL 1998, Appendix A.502 and A.503

PID 502 and PID 503 are not supported. These two PIDs define
relatively complex, application specific multi-parameter message
structures which prove to be inappropriate and/or unworkable as
standard mechanisms for conveying the data elements covered.

Most damaging is the PID 502 requirement that: “If this parameter
is received by the farebox, values shall be accepted the same as
if entered at the farebox control panel.” Unfortunately, while
PID 502 declares 10 distinct data elements, it provides no means
for assigning values to a subset of these elements. It is
impossible, for example, to assign direction via PID 502 bit-
mapped character 1 without (inadvertently) reassigning fare
preset along with 8 other attributes.

Should J1587 transmission of one or more of the PID 502/503 data


elements prove necessary, GFI will take all necessary steps to
define an appropriate PID and petition for its acceptance.

SHT 21 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 507 Driver Identification
Format: <Src> 255 251 <Cnt> <aaa> '*' <ccc> <Csm> , where

<aaa> := ASCII, driver identification field


'*' := required field delimiter
<ccc> := ASCII, optional driver data

Comments: See SAE J1587 Revised JUL 1998, Appendix A.507

A driver logoff state is indicated (represented) by having the


driver number set to zero. Driver logoff takes one of two forms,
and each is recorded in the <ccc> field as follows:

<ccc> = “1” := Manual Logoff, established by the driver


entering a Driver ID of zero (0), and,
<ccc> = “2” := Automatic Logoff, established via time-out.

Whenever the Farebox detects a driver logoff state, it will poll


for driver number until such time as it is set via the Farebox
driver interface or over the J1708 network.

Given: Assume a Driver's ID of "123", then

EXAMPLE: Broadcast – Driver ID

Source: <Mid> 255 251 4 '1' '2' '3' '*' <Csm>

EXAMPLE: Broadcast – Manual Logoff

Source: <Mid> 255 251 3 '0' ‘*' ‘1’ <Csm>

EXAMPLE: Component-specific Farebox query

Request: <Fbx> 255 128 251 <Mid> <Csm>


Response: <Mid> 255 251 4 '1' '2' '3' '*'<Csm>

EXAMPLE: Component-specific request

Request: <Mid> 255 128 251 <Fbx> <Csm>


Response: <Fbx> 255 251 4 '1' '2' '3' '*'<Csm>

SHT 22 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 508 Transit Route Identification
Format: <Src> 255 252 <Cnt> <Rte> '*' <Run> '*' <Blk> <Csm> , where

<Rte> := ASCII, assigned route


<Run> := ASCII, assigned run
<Blk> := ASCII, assigned block
'*' := required field delimiter

Comments: See SAE J1587 Revised JUL 1998, Appendix A.508

Given: For the following examples, assume

assigned Route = "4444"


assigned Run = “55555”
assigned Block = "55555”

EXAMPLE: Broadcast

Source: <Src> 255 252 16 '4' '4' '4' ‘4’ '*'


'5' '5' '5' ‘5’ ‘5’ ‘*’
‘5’ ‘5’ ‘5’ ‘5’ ‘5’ <Csm>

EXAMPLE: Component-specific request

Request: <Mid> 255 128 252 <Fbx> <Csm>

Response: <Fbx> 255 252 16 '4' '4' '4' ‘4’ '*'


'5' '5' '5' ‘5’ ‘5’ ‘*’
‘5’ ‘5’ ‘5’ ‘5’ ‘5’ <Csm>

SHT 23 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 508 Transit Route Identification (sent via PID 448)
Format: <Src> 255 192 <Cnt> <Pg2> <s/s> <cnt>|<ddd> <Csm> , where

<s/s> := section information


Bits 8-5 := total number of sections minus one (n-1)
Bit 4-1 := current section (base 0)
<cnt> := unsigned short, total byte count of original data
<ddd> := segment data, 1-13 bytes in packet 1 else 1-14 bytes

Comments: As previously noted, PID 448 would be required to send PID 508,
Transit Route Identification, if the combination of route, run,
and block information (including delimiters) were to exceed 16
characters. This is because all Page 2 variable length messages
require 5 bytes of overhead (MID, 255, PID, Cnt, & Csm), and no
message may exceed 21 bytes under normal operation.

In the example below, the Farebox is initialized such that the


Transit Route Identification requires 17 bytes (including the 2
‘*’ delimiters). Note, also, that the Driver number has been
initialized.

Given: For the following examples, assume

Driver Identification = “12345”


assigned Route = "4444"
assigned Run = “55555”
assigned Block = "666666”

EXAMPLE: Broadcast

Reference: MID 255 192 Cnt Pg2 s/s cnt ddd ddd ddd ddd ddd ddd ddd
========= === === === === === === === === === === === === === ===

Section 1: <Src> 255 192 16 252 16 17 ‘4' '4' '4' ‘4’ '*' '5' '5'
‘5' ‘5’ ‘5’ ‘*’ ‘6’ ‘6’ <Csm>

Section 2: <Src> 255 192 14 252 17 ‘6’ ‘6’ ‘6’ ‘6’ 251 6 ‘1’
‘2’ ‘3’ ‘4’ ‘5’ ‘*’ <Csm>

Note that the Section 1 <s/s> field is set to 16 (0x10 hex) to


mark the first section of a 2-section transmission. Similarly,
the Section 2 <s/s> field is set to 17 (or 0x11 hex) to signal
the section of this 2-section message.

Finally, note that the PID 507 Driver Identification message has
been included at the end of Section 2. This is possible because

its inclusion does not result in an invalid packet size,


i.e., a packet greater than 21 bytes, and
the Section 1 <cnt> field states that the sectioned parameter
contains 17 bytes of data; this, and the Section 2 <Cnt> of
14, informed the receiver that the byte value “251” shown
above refers to a Page-2 PID (i.e., PID 507).

SHT 24 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 509 Milepost/Stop Identification
Format: <Src> 255 253 <Cnt> <aaa> <Csm> , where

<aaa> := ASCII, stop identification

Comments: See SAE J1587 Revised JUL 1998, Appendix A.509

Given: Assume a Stop ID of "1234", then

EXAMPLE: Broadcast

Source: <Mid> 255 253 4 '1' '2' '3' '4' <Csm>

EXAMPLE: Component-specific request

Request: <Mid> 255 128 253 <Fbx> <Csm>


Response: <Fbx> 255 253 4 '1' '2' '3' '4'<Csm>

SHT 25 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 254 GFI DATA ESCAPE MESSAGES
Pursuant to SAE J1587, proprietary messaging employs PID 254 and the
following format …

Format: <Src> 254 <Dst> {DATA} <Csm> , where {DATA} is vendor defined.

For GFI Data Escape Messages, the first two bytes of this {DATA} stream are
specified to contain escape message type (Emt) and data byte count (Cnt)
information, resulting in the following generic format …

Format: <Src> 254 <Dst> <Cnt> <Emt> {type-specific data} <Csm>, where

<Cnt> := unsigned short, number of subsequent data bytes

Emt ‘0’ Transmit Fare Set & Direction

Format: <Src> 254 <Dst> <Cnt> <Emt> <f/s> '*' <dir> <Csm> , where

<Cnt> := unsigned short, number of subsequent data bytes


<Emt> := ‘0’

<f/s> := ASCII, fare set (‘0’ – ‘9’, zero based)


<dir> := ASCII, direction, where

‘0’ = North
‘1’ = South
‘2’ = East
‘3’ = West
‘4’ = Inbound
‘5’ = Outbound
‘?’ = not set

'*' := required field delimiter

Comments: See SAE J1587 Revised JUL 1998, Appendix A.254

The message <Src> may transmit fare set, direction or both. In


all cases the field delimiter is required.

The Farebox will always send fare set but will not send direction
if that feature is not implemented.

EXAMPLE: Driver sets Farebox to Fare #2 (1-based), direction not used.

Source: <Fbx> 254 <Dst> 3 ’0’ ’1’ '*' <Csm>

EXAMPLE: Driver sets Farebox to Fare #3 (1-based), direction not set.

Source: <Fbx> 254 <Dst> 4 ’0’ ’2’ '*' ’?’ <Csm>

EXAMPLE: Driver sets direction to Outbound with fare set unchanged.

Source: <Fbx> 254 <Dst> 4 ’0’ ’2’ '*' ’5’ <Csm>

SHT 26 of 31 DWG NO A23409-0002


Copyright © GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 254 GFI DATA ESCAPE MESSAGES: Emt ‘0’ -- continued

EXAMPLE: Farebox reconfigured to Fare #6 (1-based), North.

Source: <Src> 254 <Fbx> 4 ’0’ ’5’ '*' ’0’ <Csm>

EXAMPLE: Farebox reconfigured Fare #3 (1-based), direction not changed.

Source: <Src> 254 <Fbx> 3 ’0’ ’2’ '*' <Csm>

EXAMPLE: Farebox reconfigured to Outbound, fare set not changed.

Source: <Src> 254 <Fbx> 3 ’0’ '*' ’5’ <Csm>

Emt ‘1’ Request Fare Set & Direction

Format: <Src> 254 <Dst> <Cnt> <Emt> <Csm> , where

<Cnt> := 1
<Emt> := ‘1’

Comments: See SAE J1587 Revised JUL 1998, Appendix A.254

EXAMPLE: Request

Source: <Src> 254 <Fbx> 1 ’1’ <Csm>

Emt ‘2’ Transmit Origin/Destination Zones

Format: <Src> 254 <Dst> <Cnt> <Emt> <Org> '*' <Dst> <Csm> , where

<Cnt> := unsigned short, number of subsequent data bytes


<Emt> := ‘2’

<Org> := ASCII, origination zone


<Dst> := ASCII, destination zone

The zones are in the range of 0-15 but are or’d with an
ASCII ‘0’ to be transmitted in a hex range from 0x30-0x3f

'*' := required field delimiter

SHT 27 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
PID 254 GFI DATA ESCAPE MESSAGES: Emt ‘2’ -- continued

Comments: See SAE J1587 Revised JUL 1998, Appendix A.254

The message <Src> may transmit either or both zones. In all cases
the field delimiter is required.

The Farebox will always send both zones.

EXAMPLE: Driver sets Origination Zone to 2, and destination to 4.

Source: <Fbx> 254 <Dst> 4 ’2’ ’2’ '*' ‘4’ <Csm>

EXAMPLE: Driver sets Origination Zone to 3, but does not change the
destination which is still ‘4’.

Source: <Fbx> 254 <Dst> 4 ’2’ ’3’ '*' ’4’ <Csm>

EXAMPLE: Driver sets destination zone to 5 but does not change the
origination zone which is still 3.

Source: <Fbx> 254 <Dst> 4 ’2’ ’3’ '*' ’5’ <Csm>

EXAMPLE: Farebox reconfigured to origination zone to 1 and destination


zone to 5.

Source: <Src> 254 <Fbx> 4 ’2’ ’1’ '*' ’5’ <Csm>

EXAMPLE: Farebox reconfigured origination zone to 3.

Source: <Src> 254 <Fbx> 3 ’2’ ’3’ '*' <Csm>

EXAMPLE: Farebox reconfigured to destination zone to 6.

Source: <Src> 254 <Fbx> 3 ’2’ '*' ’6’ <Csm>

Emt ‘3’ Request Zones

Format: <Src> 254 <Dst> <Cnt> <Emt> <Csm> , where

<Cnt> := 1
<Emt> := ‘3’

Comments: See SAE J1587 Revised JUL 1998, Appendix A.254

SHT 28 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
EXAMPLE: Request

Source: <Src> 254 <Fbx> 1 ’3’ <Csm>

SHT 29 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
WIRING DIAGRAM FOR TALL ODYSSEY FAREBOX

WIRING DIAGRAM FOR SUPER SHORT ODYSSEY FAREBOX

The external wiring and connector to connect to the base casting terminal
block will be provided by the Transit Authority or the AVL system integrator.

SHT 30 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.
FAREBOX CONFIGURATION:
The following data in the gfi.ini file is used to enable and configure the J1708/J1587
interface.

J1708Mid: The device MID the farebox will interface with on the J1708.
Range 128 – 255

OptionFlags3: Contains six flags, which will enable the J1708 and determine what data
is sent. The following is a definition of the flags:
bit definition
0 J1708/J1587 enabled
1 Store J1708/J1587 diagnostic date transaction
(transaction is saved and sent to the data system, for
GFI use only)
2 ignore date/time data received
3 send any driver/route data changes
4 send farebox alarms
5 store transaction if a bad time/date received
(GFI use only)
NOTE: If the configuration for RUN is set for BLOCK in the gfi.ini file
for the farebox, then the BLOCK sent/received on the J1708 will be
for the RUN. If the RUN is configured for RUN then the BLOCK
sent/received on the J1708 will be used in the TRIP field in the
farebox.

J1708Poll: Contains three flags and a time period of how often to poll the
farebox is to poll for position
bit definition
0 – 4 Poll time in multiples of 10 seconds (i.e. 6 = 60 sec)
5 Poll for stop (unused at this time)
6 Poll for position
7 request data that was just sent by farebox
(Used to confirm data sent by farebox was received)

Logon: One bit (bit 6) in this flag used to determine if PID 254 is to be used
to send/receive fareset/direction.

Hourlyevent: Contains two flags. One flag (bit 3) is used to select if the
“IDLE LINE DETECT” is used to detect the end of an incoming message.
If the “IDLE LINE DEETEC” is used, some messages will be concatenated by
the farebox when sending data on the J1708 port. If the “IDLE LINE
DETECT” is not used, the farebox will not concatenated any messages and
will assume all messages received will also not be concatenated.
The second flag (bit 5) is used to delay the request for route for
about 20 seconds after the farebox has just sent the route data. (Used
in conjunction with J1708Poll (see J1708Poll-bit 7).

RevStatus: Contains one flag (bit4) that is used to determine if PID 501 is to be
used. This is a special feature added for one costumer and should not
be set because the farebox may modify the current route or run based on
information received.

OptionFlags7: One bit (bit 0) in flag is used to see if the Zone System is enabled to
determine if zone data is to be sent/received via PID 254.

OptionFlags6: Four bits (bits 12-15) used as a timer in minutes to reset the J1708 com
port after no activity. Range is from 0 to 15 minutes. A zero disables
disables the timer.

(end of document)

SHT 31 of 31 DWG NO A23409-0002


Copyright© GFI GENFARE 2000.
This document, in whole or in part, may not be reproduced or transferred to other documents or disclosed to others for any purpose except as authorized by GFI GENFARE.

You might also like