Application Programming Interface (API) Reference Implementation


The Advanced Transportation Controller (ATC) Standards are intended to provide an open architecture hardware and software platform that can support a wide variety of Intelligent Transportation Systems (ITS) applications including traffic management, safety, security and other applications. The ATC Standards are being developed and maintained under the direction of the ATC Joint Committee (JC) which is made up of representatives from the American Association of State Highway and Transportation Officials (AASHTO), the Institute of Transportation Engineers (ITE), and the National Electrical Manufacturers Association (NEMA).

The ATC Application Programming Interface (API) Standard is one of four ATC standards efforts. It defines a software platform that operates on an ATC controller unit (as defined by the ATC Controller Standard). The API software provides management capabilities and functional interfaces for the ATC controller's Front Panel, the controller cabinet's Field Input/Output Devices, and the controller's Time. When combined with the ATC controller's operating sysThe Advanced Transportation Controller (ATC) standards program has been developed to meet the current and future needs for transportation field equipment. At the heart of this program are the ATC 5201 Advanced Transportation Controller Standard and the ATC 5401 Application Programming Interface Standard. These standards are characterized as being open architecture, modular, multi-process, multi-application, designed to leverage new technologies, able to operate in legacy transportation field cabinet systems (TFCSs) and to be central to developing new TFCS designs.

ATC 5201 specifies a controller architecture where the computational components reside on a single (5” x 4”) printed circuit board (PCB), called the “Engine Board,” with standardized connectors and pinout. It is made up of a central processing unit (CPU), a Linux operating system (O/S) and device drivers, memory, external and internal interfaces, and other associated hardware necessary to create an embedded transportation computing platform. ATC 5401 defines both user interface facilities and programmatic interfaces for ATC controller units that are not provided through ATC 5201 or the standard Linux O/S. The user interface facilities of ATC 5401 include a windowing system that allows operational users to interact with concurrently operating application programs (which in turn have their own user interfaces) and system-wide configuration management utilities. The programmatic interfaces of ATC 5401 provide C language function definitions that allow software developers to create application programs that share resources of the ATC controller unit including the front panel, field I/O equipment and real-time clock. When used with the Linux O/S and device drivers of the Engine Board, ATC 5401 provides for a software environment that allows application programs to be portable (runs on any ATC manufacturer’s equipment), compatible (will run concurrently with other application programs), and interchangeable (assuming they perform the same function) on a single ATC controller unit.

The ATC 5401 Standard was developed by the API WG a technical subcommittee of the ATC JC. The API WG is made up of technical experts in transportation applications, software development and hardware development from both the public and private sectors (including manufacturers).

The primary objectives of this project are to: a) establish and maintain cohesive project management  and implementation plan; b) develop an API Reference Implementation (APIRI) which is software representative of the ATC 5401 Standard; c) develop an API Validation Suite (APIVS) which is to test software and hardware capable of validating the APIRI on an ATC Engine Board; d) perform integrated testing of the APIRI and APIVS; e) establish an open source software (OSS) environment for the software and documents produced during the project; and f) deliver final versions of the software, test documentation and test results.

 

Project Schedules

  • APIRI Project v0107 10/31/16                       PDF
  • APIRI Project v0107 10/31/16 (compact)       PDF
    [Project schedules are updated on or about the second Thursday of each month.]

 

Tracking APIRI Progress Through the Project Tasks

Project
Task #

Project Task Name

Status

Start Date

Completion
Date

1

Project Management

Completed

11/6/13

1/27/14

1.1

Implementation Plan

APIRI Project Management Plan v01.01 PDF
APIRI Systems Engineering Management Plan v01.01 PDF | DOCX

Completed

11/6/13

1/10/14

1.2

         USDOT JPO Authorization to Perform

Completed

1/27/14

1/27/14

2

Develop APIRI Software

Completed

1/28/14

10/20/16 

2.1

        Develop APIRI Software Design Description (SDD)

        APIRI Software Design Description v01.03    PDF | DOCX
        APIRI SDD Comments Report 06/09/14        PDF | XLXS

        APIRI Software Design Description v01.01    DOCX
        APIRI Software Design Description v01.02    DOCX
        APIRI SDD Walkthrough Workbook v01.00   DOCX
        
APIRI SDD Walkthrough Workbook v01.01   DOCX

        APIRI Proposal Document v01    DOCX
        APIRI Proposal Document v02    DOCX
        APIRI Proposal Document v03    DOCX

        API WG Teleconference 02/12/14       PDF | DOCX
        API WG Meeting 03/11/14                   PDF | DOCX
        API WG Teleconference 03/21/14       PDF | DOCX
        API WG Teleconference 03/28/14       PDF | DOCX
        API WG Teleconference 05/09/14       PDF | DOCX
        API WG Teleconference 05/30/14       PDF | DOCX
        API WG Teleconference 06/04/14       PDF | DOCX

Completed

1/28/14

6/25/14

2.2

Develop Draft APIRI Software

Go to  https://github.com/apiriadmin/APIRI

Completed

5/23/14

12/31/14

2.3

         Develop APIRI User's Manual

APIRI User Manual v01.03         PDF | DOCX
APIRI Software User Manual v01.04             DOCX
API WG Teleconference 05/04/16                 PDF | DOCX
APIRI/APIVS Manual Comments 05/04/16     PDF | XLSX

Completed

1/2/15

10/20/16 

3

Develop API Validation Suite (APIVS) (Test Version)

Completed

2/26/14

10/21/16 

3.1

         Develop APIVS Concept of Operations (ConOps)

APIVS Concept of Operations v02.04    PDF | DOCX

Completed

2/26/14

5/30/14

3.2

         Develop APIVS Software Requirements Specification (SRS)

APIVS Software Requirements Specification v02.03    PDF | DOCX
API WG Teleconference 07/01/14                 PDF | DOCX
APIVS Software Requirements Specification v02.00    PDF | DOCX
APIVS SRA Walkthrough Workbook v01.01                DOCX
API WG Teleconference 07/23/14                                PDF | DOCX

Completed

6/1/14

7/27/14

3.3

Project Re-Scope

APIRI Project Management Plan v01.02     PDF | DOCX

Completed

8/7/14

11/24/14

3.4

        Develop APIVS Software Design Description (SDD)

APIVS Software Design Description v01.02     PDF | DOCX
APIVS SDD Walkthrough Workbook v01.03    PDF | DOCX
API WG Teleconference 01/05/15                 PDF | DOCX
API WG Teleconference 01/08/15                 PDF | DOCX

Completed

11/25/14

5/29/15

3.5

        Develop Draft APIVS Software and Preliminary Test Scripts

Go to  https://github.com/apiriadmin/APIRVS

Completed

3/3/15

6/25/15

3.6

         Develop APIVS User's Manual

APIVS User Manual v01.01          PDF | DOCX
APIVS Software User Manual v01.02           DOCX
(See Task 2.3 for API WG Meeting 05/04/16 and Comments)

Completed

10/14/15

10/21/16

4

Integrated APIRI and APIVS Testing

API WG Teleconference 08/25/16  PDF | DOCX

API WG Teleconference (Test Readiness Review) 08/04/16  PDF | DOCX
USDOT Test Documentation Review 07/20/16  DOCX
APIRI and APIVS Software Test Documentation 07/14/16  ZIP
APIRI XML Scripts 07/14/16  ZIP

API WG Meeting 03/22/16  PDF | DOCX
APIRI Policies and Procedures Presentation 03/22/16   PDF
API WG Teleconference 10/21/15                 PDF | DOCX
API WG Teleconference 11/23/15                 PDF | DOCX

Completed

1/2/15 

 10/24/16

4.1

        Integrated APIVS Testing

APIVS Test Plan / Test Design Specification v01.01 11/08/15  DOCX
APIVS Test Case Specification v01.01 11/08/15                      DOCX
APIVS Test Procedure Specification v01.01 11/08/15              DOCX
APIVS Test Plan and Test Design Specifications v01.00    DOCX
APIVS Test Case Specifications v01.00     DOCX
APIVS Test Procedure Specifications v01.00     DOCX

Completed

6/22/15

10/24/16

4.2

        Integrated APIRI Testing

APIRI Test Plan / Test Design Specification v01.01 11/08/15  DOCX
APIRI Test Case Specification v01.00 11/08/15                      DOCX
APIRI Test Procedure Specification v01.01 11/08/15              DOCX
APIRI XML Test Scripts v01.00 02/22/16                               ZIP
APIRI Test Plan and Test Design Specifications v01.00    DOCX
APIRI Test Procedure Specifications v01.00     DOCX

Completed

1/2/15

10/24/16

5

Establish Open Source Software (OSS) Environment

Completed

2/11/14

10/4/16 

5.1

         Develop Concept Paper

APIRI Open Operating System Concept Paper   PDF | DOCX

Completed

2/11/14

8/15/14

5.2

         Implement OSS Environment

Completed

8/18/14

7/29/16

5.3

         APIRI and APIVS Outreach

API WG Teleconference 10/04/16            PDF | DOCX
APIRI Policies, Processes and Procedures 10/04/16     PDF | DOCX

APIRI Demonstration and Training Workshop Flyer     PDF | DOCX
APIRI Demonstration and Training Workshop Agenda PDF | DOCX
APIRI Demonstration and Training Workshop Presentation PDF
ATC/API Application Development Presentation PDF

APIRI Demonstration and Training Workshop Photos PDF

Completed

7/27/15

10/4/16

6

Deliver Software and Final Testing Documentation

Completed 

 09/06/16

 10/31/16

6.1

         Package APIRI and APIVS for USDOT Delivery

Completed

10/01/16

10/31/16

6.2

         Finalize Testing Documentation

Completed

09/06/16

10/24/16

6.3

         Deliver Software and Final Testing Documentation (APIRI SW/TP/TDSs/TCSs/TPSs/Test Scripts and APIVS SW/TP/TDSs/TCSs/TPSs/Test Scripts)

Completed

10/31/16

10/31/16


Institute of Transportation Engineers
1627 Eye Street, NW, Suite 600 | Washington, DC 20006 USA
Telephone: +1 202-785-0060 | Fax: +1 202-785-0609
ite_staff@ite.org

Facebook Twitter LinkedIn YouTube Google+ Instagram Pintrest

ITE Canon of Ethics
2017 Institute of Transportation Engineers