Introduction; Roku Wants Your Feedback; Ecp Basics - Roku HD1000 Manual

Introduction

The features of the Roku™ HD1000 can be controlled externally ("scripted") via a protocol
called the External Control Protocol (ECP).
HD1000 users and third-party developers can use the ECP to control HD1000 applications (and
other applications implementing the Roku ECP APIs). This document covers the basics of using
the ECP. The appendices in this document contain a complex sample script and a complete
listing of the ECP commands supported by the HD1000's built-in applications. For purposes of
this document, the image viewer will be used as the primary example.

Roku wants your feedback!

The ECP commands are provided to make life easier for third parties. If you have suggestions
for enhancements or additions to ECP support on the HD1000 (or if you find an error in this
document), please don't hesitate to write to us at support@rokulabs.com. Requests will be
considered for inclusion in later software releases.

ECP basics

ECP commands are issued from the shell by way of a helper program called (appropriately)
"ecp." There are three basic ways to issue these commands:
1. The commands may be grouped together in a standard Linux shell script. This is the
most convenient way to issue a sequence of commands that you may want to repeat
multiple times. Shell scripts may be stored on any media source accessible to the
HD1000, including the built-in storage, a flash card, or a shared folder on a networked
computer.
2. The commands may be issued at the command prompt, via the serial port. Connecting
a computer to the HD1000's serial port with a standard serial cable gives you a Linux
command shell, at which ECP commands may be entered. (The port is 9600bps, 8-N-1,
no flow control.)
3. If the HD1000 is on a network, the commands may be issued at the command prompt,
via a telnet connection. Simply use a telnet program on a networked computer to
connect as "guest" with no password. The IP address of the HD1000 can be found at
the top of the screen in the Setup feature.
Note: In order for an ECP command to be successfully processed, the program that handles
the command must first be running. For example, in order for the command 'photoApp' to be
processed, the program "photo" must be running.
Additionally, third-party developers may also issue ECP commands directly from within
their applications via the CascadeInput::DispatchECPCommand API. See the developer
documentation for more information.
Roku External Control Protocol for the HD1000
© 2003 Roku, LLC
1