Parker PHD28, User Manual, Page: 79 / 157

1
Overview
1 Introduction
PHD API Reference
1 Introduction
These instructions are to be used as a reference tool for the vehicle manufacturer’s design,
production, and service personnel.
The user of these instructions should have basic knowledge in the handling of electronic
equipment.
Overview
The PHD family of displays are general purpose color displays with capacitive
touchscreens suitable for a wide range of industry applications.
The PHD software platform consists of various levels of software that support each other
to create a complete working system. Access to the lower level functionality of this system
is provided to end users via the Dynamic Communications Platform (DCP).
This document details the events provided to the Crank Storyboard Engine via the
PHD_API_events.evt file. This file, when placed into a Crank Storyboard Designer
project’s events folder makes those events available to application developers working
within the Crank Storyboard Designer.
This document also details all the events available to UI developers for interacting with
the system. They are grouped by Storyboard Engine IO channel which also serves to
divide them into functional groups.
Simple Lua function examples are provided. For most of these examples, validation of
input parameters is not given, as this is simple to do, but would bloat out the examples
needlessly. Any Lua variables referenced in sample functions that do not seem to be
defined in the function can be assumed to be defined at a higher scope. There would also
be opportunity, in a larger project, to combine a lot of these Lua functions into more
generic event sending or receiving functions with logic to handle multiple events.
The platform software is consistent across PHD28, PHD50 and PHD70. Where it is not,
those differences are called out. In all cases, all events are available across all platforms,
but may never occur (for externally generated events) or may be ignored when sent on
platforms where they are not supported.
Definitions
The terminology used in this manual are defined in the following table.
Abbreviation Explanation
Channel A channel is an input mechanism for Storyboard IO applications, via which
they can receive events.
Crank Storyboard
Designer A desktop development suite that enables user interface designers to easily
prototype the look and feel of a product and then deploy it to a target
equipped with the Crank Storyboard Engine.