IDP 600 Terminal Series

User's Guide

T204, Version 01

The electronic version of this document allows

you to use the built-in Hyperlinks and
bookmarks when using Adobe Reader

© SkyWave Mobile Communications Inc.

IDP 600 Terminal Series - User's Guide

Legal Notice
This documentation is owned by SkyWave Mobile Communications Inc. (SkyWave) and protected by
applicable copyright laws and international treaty provisions. Other copyrighted names used are the property
of their respective owners. Therefore, you must treat this documentation like any other copyrighted material.
You may not make the documentation, or copies thereof, available in any manner or form, or use, copy or
transfer any part, to anyone outside your company.
If you received this documentation by electronic transmission or download, by installation or use of the
documentation, you acknowledge that you have read and understand this license agreement and agree to be
bound by its terms and conditions.
This documentation is provided on an as-is basis without any warranty of any kind. You assume the entire
risk as to the results or performance of the software. Under no circumstance shall SkyWave be held liable for
any direct, indirect, consequential, or incidental damages arising from the use or inability to use the software
or documentation.
All trademarks or registered trademarks are the property of their respective owners. INMARSAT, the
Inmarsat logo and IsatData Pro are trademarks of Inmarsat used under license by SkyWave. Inmarsat is not
responsible for the operation and regulatory compliance of the products and services referred to in this
document that connect to the Inmarsat system.
SkyWave reserves the right to make changes to products and or specifications without notice.
From www.SkyWave.com login and follow the link to the downloads section. The complete Software and
Documentation License Agreement is distributed as a part of the IDP Developer’s Toolkit.

Contact Information
SkyWave Mobile Communications Inc.
Online:
 Website www.SkyWave.com
Online Documentation:
 Login at support.skywave.com and follow the link to the downloads section
Customer Support by Email:
 [email protected]
Customer Support by Telephone:
 +1.613.836.2222

T204, Version 01 ii © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

TABLE OF CONTENTS
Legal Notice.................................................................................................................................... ii
Contact Information...................................................................................................................... ii
List of Figures .............................................................................................................................. vii
List of Tables................................................................................................................................ vii
Preface ........................................................................................................................................... ix
Purpose......................................................................................................................................... ix
Audience ...................................................................................................................................... ix
Notation ....................................................................................................................................... ix
Reference ..................................................................................................................................... ix
1 Introduction ......................................................................................................................... 1
1.1 Terminal ............................................................................................................................. 1
1.2 Programming ...................................................................................................................... 2
1.3 Pass-Through Mode............................................................................................................ 2
2 Software Architecture......................................................................................................... 3
2.1 Boot Loader ........................................................................................................................ 3
2.2 Base Firmware .................................................................................................................... 4
2.3 Lua Environment ................................................................................................................ 4
2.3.1 Lua Parser ...................................................................................................................... 5
2.3.2 Lua Services Framework ............................................................................................... 5
2.3.3 Core Services ................................................................................................................. 6
2.3.4 Lua Shell ........................................................................................................................ 6
2.4 Messaging ........................................................................................................................... 6
3 Operational Modes.............................................................................................................. 9
3.1 Normal Mode...................................................................................................................... 9
3.2 Pass-Through Mode............................................................................................................ 9
3.2.1 Exit Pass-through ......................................................................................................... 10
4 Boot Loader ....................................................................................................................... 11
4.1 Startup Sequence .............................................................................................................. 11
4.1.1 No Base Firmware Present........................................................................................... 11
4.1.2 Base Firmware Present ................................................................................................ 11
4.2 Firmware Download ......................................................................................................... 11
4.3 Boot Commands ............................................................................................................... 12
4.4 ? or help ............................................................................................................................ 12
4.5 baud .................................................................................................................................. 13
4.6 erase .................................................................................................................................. 13
4.7 info.................................................................................................................................... 14
4.8 load ................................................................................................................................... 15
4.9 passthru ............................................................................................................................. 16
4.10 reset................................................................................................................................... 17
4.11 start ................................................................................................................................... 18
5 Base Firmware .................................................................................................................. 19
5.1 Flash File System.............................................................................................................. 19

© SkyWave Proprietary iii T204, Version 01

IDP 600 Terminal Series - User's Guide

5.2 Console Commands .......................................................................................................... 19

5.3 ? or help ............................................................................................................................ 20
5.4 baud .................................................................................................................................. 21
5.5 cd ...................................................................................................................................... 21
5.6 check ................................................................................................................................. 22
5.7 copy .................................................................................................................................. 22
5.8 del ..................................................................................................................................... 23
5.9 dir...................................................................................................................................... 23
5.10 dl ....................................................................................................................................... 24
5.11 format ............................................................................................................................... 24
5.12 info.................................................................................................................................... 25
5.13 init ..................................................................................................................................... 26
5.14 listv ................................................................................................................................... 26
5.15 mem .................................................................................................................................. 27
5.16 mkdir................................................................................................................................. 28
5.17 rename .............................................................................................................................. 28
5.18 reset................................................................................................................................... 29
5.19 rmdir ................................................................................................................................. 30
5.20 start ................................................................................................................................... 31
5.21 tasks .................................................................................................................................. 32
5.22 tod ..................................................................................................................................... 33
5.23 trace .................................................................................................................................. 34
5.23.1 trace baud ..................................................................................................................... 34
5.23.2 trace channel ................................................................................................................ 35
5.23.3 trace disable ................................................................................................................. 35
5.23.4 trace enable .................................................................................................................. 35
5.23.5 trace mask .................................................................................................................... 36
5.23.6 trace msg ...................................................................................................................... 36
5.23.7 trace reset ..................................................................................................................... 37
5.24 type ................................................................................................................................... 37
5.25 ulx ..................................................................................................................................... 37
5.26 uly ..................................................................................................................................... 38
6 Lua Services Framework.................................................................................................. 39
6.1 Service Architecture ......................................................................................................... 39
6.2 Core Services .................................................................................................................... 39
6.2.1 system .......................................................................................................................... 39
6.2.2 message ........................................................................................................................ 39
6.2.3 report ............................................................................................................................ 39
6.2.4 position......................................................................................................................... 40
6.2.5 geofence ....................................................................................................................... 40
6.2.6 rs232 ............................................................................................................................ 40
6.2.7 log ................................................................................................................................ 40
6.2.8 eio ................................................................................................................................ 40
6.2.9 shell .............................................................................................................................. 40
6.2.10 filesystem ..................................................................................................................... 40
6.2.11 idp ................................................................................................................................ 40
7 Shell Commands................................................................................................................ 41
7.1 ? or help ............................................................................................................................ 41
7.2 cd ...................................................................................................................................... 42

T204, Version 01 iv © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.3 comp ................................................................................................................................. 42

7.4 copy .................................................................................................................................. 43
7.5 del ..................................................................................................................................... 43
7.6 dir...................................................................................................................................... 44
7.7 geo .................................................................................................................................... 44
7.7.1 geo show ...................................................................................................................... 45
7.8 idp ..................................................................................................................................... 46
7.8.1 idp getmetrics............................................................................................................... 47
7.8.2 idp getsreg .................................................................................................................... 47
7.8.3 idp setsreg .................................................................................................................... 48
7.8.4 idp info ......................................................................................................................... 48
7.9 info.................................................................................................................................... 49
7.10 listv ................................................................................................................................... 50
7.11 log ..................................................................................................................................... 50
7.11.1 log count ...................................................................................................................... 51
7.11.2 log filter........................................................................................................................ 52
7.11.3 log next ........................................................................................................................ 54
7.11.4 log clear........................................................................................................................ 55
7.12 lua ..................................................................................................................................... 55
7.13 mem .................................................................................................................................. 56
7.14 mkdir................................................................................................................................. 57
7.15 msg ................................................................................................................................... 57
7.15.1 msg add ........................................................................................................................ 58
7.15.2 msg cancel.................................................................................................................... 59
7.15.3 msg list ......................................................................................................................... 59
7.16 prop ................................................................................................................................... 61
7.16.1 prop get ........................................................................................................................ 62
7.16.2 prop reset...................................................................................................................... 63
7.16.3 prop revert .................................................................................................................... 64
7.16.4 prop save ...................................................................................................................... 65
7.16.5 prop set......................................................................................................................... 66
7.17 rename .............................................................................................................................. 66
7.18 report................................................................................................................................. 67
7.19 rmdir ................................................................................................................................. 68
7.20 service ............................................................................................................................... 68
7.20.1 service list .................................................................................................................... 69
7.20.2 service restart ............................................................................................................... 69
7.21 stop ................................................................................................................................... 70
7.22 threads............................................................................................................................... 71
7.23 tod ..................................................................................................................................... 71
7.24 trace .................................................................................................................................. 72
7.24.1 trace baud ..................................................................................................................... 72
7.24.2 trace channel ................................................................................................................ 73
7.24.3 trace disable ................................................................................................................. 73
7.24.4 trace enable .................................................................................................................. 73
7.24.5 trace mask .................................................................................................................... 74
7.24.6 trace msg ...................................................................................................................... 74
7.24.7 trace reset ..................................................................................................................... 75
7.25 type ................................................................................................................................... 76
8 LED Operation .................................................................................................................. 79

© SkyWave Proprietary v T204, Version 01

IDP 600 Terminal Series - User's Guide

Documentation Version............................................................................................................... 81
Acronyms/Glossary ..................................................................................................................... 82
Index… ......................................................................................................................................... 83

T204, Version 01 vi © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

List of Figures
Figure 1 IsatData Pro Communications System ........................................................................... 1
Figure 2 IDP-680 Terminal .......................................................................................................... 2
Figure 3 IDP 600 Series Software Architecture ........................................................................... 3
Figure 4 Command Line Interfaces .............................................................................................. 4
Figure 5 Message Format ............................................................................................................. 7
Figure 6 Pass-Through Mode Configuration.............................................................................. 10
Figure 7 Startup Banner ............................................................................................................. 11

List of Tables
Table 1 Command Line Interpreter ............................................................................................. 5
Table 2 Core Services ................................................................................................................. 6
Table 3 LED Flash Rates .......................................................................................................... 79
Table 4 LED Flash Sequences .................................................................................................. 79

© SkyWave Proprietary vii T204, Version 01

IDP 600 Terminal Series - User's Guide

THIS PAGE INTENTIONALLY LEFT BLANK

T204, Version 01 viii © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

Preface
Note: Refer to any Readme files available on the IDP Developer's Toolkit or
Customer Support website for firmware updates issued after the release of this
document. An Errata Sheet may also be available from the Customer Support
website after the release of this document.

Purpose
This document provides a list of all commands supported by the IDP 600 series terminal.
This document does not describe how to program user services or configure the core
services on the terminal. Users who wish to program user services or configure core
services should consult with documents [T202] and [T204].

Audience
This document is for technical readers.

Notation
This document is associated with terminal firmware version 0.0.1 and modem firmware
version 1.000.

Reference
It is recommended that you be familiar with the content of the following documents
before using this guide. These documents are available from the IDP Developer’s Toolkit
or support.skywave.com.
[N200] IsatData Pro Network Services Overview
[T200] IDP 600 Terminal Series Hardware Guide
[T202] IDP 600 Terminal Series API Reference Guide
[T203] IDP 100 Modem Series Developer's Guide
[T204] IDP 600 Terminal Series Programmer's Guide

© SkyWave Proprietary ix T204, Version 01

IDP 600 Terminal Series - User's Guide

THIS PAGE INTENTIONALLY LEFT BLANK

T204, Version 01 x © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

1 Introduction
The IDP 600 series of terminals are satellite terminals that use the IsatData Pro service to
provide bidirectional messaging services between the terminal and the IsatData Pro
Gateway via Inmarsat satellite services (Figure 1). IsatData Pro messaging capabilities
make the terminal idea for applications such as vessel and fleet management and security,
remote surveillance, telematics and SCADA. Refer to [N200] for a detailed description of
the IsatData Pro service.
Figure 1 IsatData Pro Communications System

Inmarsat
Satellite

Customer SkyWave
Support Admin
Internet
Messages

Solution Provider
IsatData Pro Land Earth
Application Servers Mobile
Gateway Station (LES) Devices

The terminal’s built-in programmability allows it to work as a stand-alone data-

messaging terminal, with built-in I/O data collection and processing capabilities. Feature-
rich software tools make programming easy and shorten the design and testing time.
This document outlines the IDP 600 series terminal command line interface. The
command lines can be used by developer's to configure the terminal. This document does
not describe how to develop applications for the terminal. Refer to [T203] for details on
programming applications for a terminal.

1.1 Terminal
The IDP 600 series has two terminal models: the IDP-680 and the IDP-690. Both
terminals are designed to be mounted outdoors on platforms such as vehicles or boats,
and are suitable for industrial and fixed applications.
All IDP 600 series terminals are functionally identical except that that the two terminals
have different antenna types. The IDP-680 provides coverage down to 20 degrees to the
satellite and the IDP-690 provides coverage down to -5 degrees to the satellite. Each
IDP 600 series terminal consists of a single environmentally sealed mechanical enclosure
containing an integral antenna, a satellite modem for communicating with the satellite, an
integral GPS, four input/output ports, an RS-232 port, and an RS-485/J1708 port.

© SkyWave Proprietary 1 T204, Version 01

IDP 600 Terminal Series - User's Guide

Figure 2 IDP-680 Terminal

Refer to [T200] for additional hardware details about the IDP 600 series terminal.

1.2 Programming
SkyWave provides developer tools to allow the Solution Provider to program the
IDP 600 series terminal to meet specific application requirements. Terminals can be
customized by configuring core services that come with the terminal or by creating new
user services. A complete list of core services and their configurable properties and
network messaging interfaces is documented in [T202].

1.3 Pass-Through Mode

The IDP 600 series terminal can operate in pass-through mode. In pass-through mode the
IDP 600 series terminal acts like a modem, providing AT commands at the RS-232 port.

T204, Version 01 2 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

2 Software Architecture
Figure 3 illustrates the software architecture for the IDP 600 series terminal. The software
architecture is composed of three components:
 Boot Loader
 Base Firmware
 Lua Environment
Both the boot loader and the base firmware run from internal program memory on the
terminal. All Lua applications are stored in a flash file and copied into RAM.
Figure 3 IDP 600 Series Software Architecture

Core User
Services Services
Lua

Lua Services Framework

Base Lua Compiler &

Lua Extensions
Firmware Interpreter

Firmware

Flash File
Kernel Drivers
Boot Loader System

Terminal Hardware

2.1 Boot Loader

The boot loader is a small firmware application whose primary purpose is to provide the
ability to serially upgrade all the terminal firmware components including the boot
loader.

© SkyWave Proprietary 3 T204, Version 01

IDP 600 Terminal Series - User's Guide

2.2 Base Firmware

The base firmware is a firmware application that provides the Lua compiler and
interpreter, Lua extensions that can be implemented more efficiently in firmware, a real
time kernel, a flash file system and drivers for the Lua services to interface with the
hardware.

2.3 Lua Environment

By default, the IDP 600 series operates with a Lua environment. The Shell service in the
Lua environment provides a command line interface for users to configure, query and
program the terminal.
The Lua shell is not the only command line interface on the IDP 600, although in most
cases it is the only command line users require. The other command lines are used for
special modes and to configure the terminal and in most case hidden from the user by
SkyWave's development tools.
Figure 4 illustrates how the command lines are implemented by the IDP 600 series
software and Table 1 describes command line formats.
Figure 4 Command Line Interfaces

Lua Lua Services

Lua Parser

Lua Lua Framework

Shell

Base
Firmware Base Firmware

Boot Boot Loader

Loader

Terminal Hardware IDP Modem

T204, Version 01 4 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

Table 1 Command Line Interpreter

Command Line Command Access Method Description
Interpreter Prompt
Boot loader boot# <CTRL-B> <CTRL-B> Boot loader to program
received during the first files
5 seconds after terminal
reset.
Base Firmware # Command from Lua Load Lua environment
shell. and file system. Only
required if Lua
No Lua environment environment gets
present. corrupted.
Lua shell shell> Default under normal Normal operational mode
operation.
Lua parser lua> Command from lua Direct access to Lua
shell interpreter for advanced
diagnostics

2.3.1 Lua Parser

The Lua parser provides direct access to the Lua interpreter. In this mode, advanced users
can write and execute Lua code from the command line. Only advanced users should use
this mode.
Refer to [T202] for more details on Lua programming

2.3.2 Lua Services Framework

The IDP 600 series terminals use a Lua based framework for application development.
Lua is a robust scripting language that makes efficient use of memory and processor
resources.
The IDP 600 series has two classes of Lua services called core services and user services.
Core services provide basic interfaces to the core functionality of the terminal. Core
services include basic functional building blocks like support for sending and receiving
messages, logging, requesting GPS information and generating various periodic reports.
Core services like geofence and report provide complete standalone applications.
User services are applications that are written by the Solution Provider. These services
can be plugged into the services framework of the terminal, allowing for simple or
advanced extensions to the terminals core service functionality.

© SkyWave Proprietary 5 T204, Version 01

IDP 600 Terminal Series - User's Guide

2.3.3 Core Services

Table 2 outlines the core services available with the IDP 600 series terminals.
Further details on the core services including their configurable properties and network
messaging interfaces is documented in [T202].
Table 2 Core Services
Service Description
System Terminal management including reset. Interface to query/set
service properties.
Message Routes incoming messages to the appropriate service and ensures
outgoing messages use the appropriate format.
Report Sends report messages that consist of properties from other
services. Messages can be sent on demand or on a preconfigured
schedule.
Position Abstracts the GPS interface and provides a mechanism to query
GPS for location and time.
Geofence Provides up to 128 geofences, configured as polygons, circles or
rectangles. This service calculates if a given position is inside or
outside a geofence.
RS232 Configures the RS-232 port.
Log Stores data in non-volatile storage. The data can be application
data that can be retrieved at later date, or diagnostic information
for troubleshooting.
EIO Configures and reports the status of the terminal's general purpose
I/O. In addition, it is used to monitor the internal temperature and
battery voltage. Alarms can be configured if thresholds are
exceeded.
Shell The command line interface for the Lua framework.
Filesystem Provides an interface for the file system which is in the base
firmware.
IDP Configures and queries the status of the IsatData Pro satellite
network.

2.3.4 Lua Shell

The Lua shell is activated, by default when the Lua environment starts up. It is possible
for the user to disable the Lua shell.
The Lua shell can be disabled to
 Restrict end user's access to the Lua environment
 Allow a user service to access the RS-232 port

2.4 Messaging
The system adds two bytes to the beginning of all messages sent or received by a service.
The message format is shown in Figure 5.

T204, Version 01 6 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

Figure 5 Message Format

SIN MIN
Payload
(8 bits) (8 Bits)

Max Length = 10,000 bytes (To-Mobile)

6,400 bytes ( From-Mobile )
The first byte is the service identification number (SIN) which is used to uniquely
identify a service. SIN values from 0 through 127 are reserved for modem and core
services, leaving 128 SINs for user services.
The second byte in the message is the message identification number (MIN) which
identifies the message type that can vary depending on the service. MINs from 1 to 127
are valid and MIN 0 is reserved.

© SkyWave Proprietary 7 T204, Version 01

IDP 600 Terminal Series - User's Guide

THIS PAGE INTENTIONALLY LEFT BLANK

T204, Version 01 8 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

3 Operational Modes
The IDP 600 series terminal can operate in pass-through mode or with the Lua
environment.

3.1 Normal Mode

Normal mode is the standard operating mode of the terminal which allows for access to
all the functionality of the Lua Services Framework, including access to the external I/O
ports and the RS-232 and RS-485 ports.
The terminal enters normal mode operation when a valid base firmware image is present
with a valid CRC. On boot, if the base firmware image passes CRC validation, the image
is executed, which in turn will start the Lua Services Framework.

3.2 Pass-Through Mode

Pass-through mode is a special configuration that the boot loader enters when the base
firmware image is not present or is invalid. A virtual connection is setup between the
internal IDP modem of the terminal and the external serial port of the modem in a
transparent manner such that the terminal behaves like a modem, as shown in Figure 6.
The terminals pins are configured as follows:
 RS-232 Rx/Tx are mapped to the modems Rx/Tx lines
 I/O 4 is configured as an output (push-pull) and mapped to the
EVENT_NOTIFICATION pin of the IDP modem.
 The MODEM_WAKEUP pin is driven by the state of the RS-232 transceiver
invalid line (HIGH if a DTE device is connected, LOW otherwise).
 The IDP modem is powered by the terminals input power.

© SkyWave Proprietary 9 T204, Version 01

IDP 600 Terminal Series - User's Guide

Figure 6 Pass-Through Mode Configuration

Terminal

Power Supply

9-32V

I/O 4
EVENT_NOTIFICATION

Connector
~INVALID MODEM_WAKEUP
RS232 Rx
Transceiver SERIAL_RX Modem
RS232 Tx
SERIAL_TX

A break condition on the terminals RS-232 Tx line exits pass-through mode and returns
to the boot loader.
An IDP 600 series terminal always invokes the boot loader on every reset or power-up.
The boot loader puts the terminal in pass-through mode when there is no base firmware
in the terminal.
In pass-through mode the internal IDP modem in the terminal is connected to the
terminal's RS-232 port. Details on the IDP modem interface are described in [T201].
Pass-through mode operates independent of the baud rate programmed on the modem. In
pass-through mode, the terminal's UART is disabled and the terminal bit arbitrates the
modem serial receive/transmit data to its RS-232 port. As a result, there is no need to
program the RS-232 port on the terminal when it is in pass-through mode.
The boot loader also supports entering pass through mode manually via the passthru
command.

3.2.1 Exit Pass-through

There are two ways to exit pass-through mode: reset the terminal (power-cycle) or create
a <BREAK> condition on the RS-232 external serial interface.

T204, Version 01 10 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

4 Boot Loader
The boot loader is a small firmware application which takes control of the system after a
reset occurs. The boot loader does the following:
 Perform basic driver initialization
 Display a startup banner if base firmware is present (Figure 7)
 Perform more hardware tests
 CRC Validation of firmware image
 Allow for break-in on serial port for serial download (if base firmware present)
 Auto-starts base firmware or enters modem pass-through mode.
Figure 7 Startup Banner
IDP-600 series terminal boot loader (Version 3.2.0 (Release))
Copyright (c) 2011 SkyWave Mobile Communications.

*** Reset reason: SOFTWARE ***

Auto-starting base firmware in 5 seconds.

.....

The boot loader configures the main RS-232 serial port to 9600 baud, 8 data bits, even
parity, and 1 stop bit.

4.1 Startup Sequence

4.1.1 No Base Firmware Present
If no base firmware image is present, the boot loader does not display the startup banner
and immediately enters pass-through mode without resetting the modem. To access the
boot loader, force a break condition on the serial port.

4.1.2 Base Firmware Present

If the base firmware image is present, the boot loader displays its banner and then output
a '.' (period) every second for 5 seconds. If the character sequence
<CTRL-B><CTRL-B> is entered, then the boot loader will enter the boot menu.

4.2 Firmware Download

From the boot loader menu, commands are available to serially download and upgrade
both the boot loader itself and the base firmware image.
It is strongly recommended that <IDP Console> from the IDP Developer's Toolkit is used
to load packages to program firmware images.

© SkyWave Proprietary 11 T204, Version 01

IDP 600 Terminal Series - User's Guide

4.3 Boot Commands

The general syntax that applies to all boot loader commands:
<command> [<args>|help|?]
For example, any command followed by a ? or the keyword help displays the parameter
usage of the command.

4.4 ? or help
Syntax
help
Description
Display a list of all the available commands and their descriptions.
Example
boot# help
General syntax: <command> [<args>|help|?]

Available commands:
? - Display this help
baud - Change baud rate
erase - Erase base firmware Image
help - Display this help
info - Display boot loader info
load - Load boot/firmware Image
passthru - Transparent pass-thru
reset - Reset terminal and/or modem
start - Start base firmware

T204, Version 01 12 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

4.5 baud
Syntax
baud [<baudRate>]
Description
Change the baud rate of the serial port.
Parameters
<baudRate>
One of 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, or 115200
Example
Change the baud rate to 115200
boot# baud 115200
Changing baud to 115200

4.6 erase
Syntax
erase force|quiet
Description
Erase the terminal base firmware image from program flash.
CAUTION This will remove the terminal firmware and disable normal
firmware operation
Parameters
force
Skip the yes/no prompt and immediately perform the erase
quiet
Suppress the output of information messages
Example
Erase the terminal firmware without a conformation prompt
boot# erase force
=== Erasing 476 KB of FLASH ===
Prompt for a y confirmation before erasing the terminal firmware image
boot# erase
Erase FLASH? (y/n)
=== Erasing 476 KB of FLASH ===
OK

© SkyWave Proprietary 13 T204, Version 01

IDP 600 Terminal Series - User's Guide

4.7 info
Syntax:
info
Description
Display the information about the last reset reason, terminal hardware, clock speeds
and loaded software versions, including build date, build time and other info about
the boot loader and the loaded terminal firmware.
Example
boot# info
Terminal info:
Manufacturing ID: ** NOT SET **
H/W Feature mask: 0x0000000000000000
H/W Revision: 3
Reset reason: SOFTWARE
RTC Clock: Ready
SYSCLK: 32 MHz
ADCCLK: 4 MHz

Boot loader info

Status: OK
Size: 24976
Software version: 3.2.0 (Release)
Build date: Jun 21 2011
Build time: 10:03:33
Boot API level: 2
Boot API version: 1
Image CRC32: 0x0AD3BF87

Base firmware info

Status: OK
Size: 246804
Software version: 3.2.0 (Release)
Build date: Jun 21 2011
Build time: 10:04:47
Boot API version: 1
Feature mask: 0x0000000000000000
Image CRC32: 0x0C060359

T204, Version 01 14 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

4.8 load
Syntax
load [force|quiet]
Description
Load terminal boot loader or base firmware image using X or Y modem serial
protocol at the current baud rate. Loading is as follows:
 The X/Y modem receiver side protocol is initiated with the output of packet
solicitation characters (C or ASCII 0x43) every 2 seconds
 The terminal aborts the protocol if no transmitter side protocol is present
after 200 seconds.
 Two <CTRL-X> characters in a row cancel the X-Modem transfer.
 When the transfer is complete, the boot loader displays details (image type,
version etc.) of the image and prompts for a confirmation to program the flash
 If the CRC is bad or invalid, the programming sequence is aborted
Parameters
force
Skips yes/no confirmation and over-rides CRC validation
quiet
Suppress the output of information messages
Example
Start the X/Y modem receive protocol with CRC validation and prompting for write
confirmation
boot# load
Start X-Modem transfer now! (CTRL-X to cancel)
CCCC

Successfully received 243484 bytes:

Type: base Firmware
Status: OK
Size: 243484
Software version: 3.1.0 (Release)
Build date: Jun 6 2011
Build time: 11:10:47
Boot API version: 1
Feature mask: 0x0000000000000000

Program FLASH? (y/n) y

=== FLASH Programming ===
Start the X/Y modem receive protocol while suppressing information output,
ignoring invalid CRC values, and skipping the flash write confirmation prompt.

© SkyWave Proprietary 15 T204, Version 01

IDP 600 Terminal Series - User's Guide

boot# load force quiet

CCCC
Start the X/Y modem receive protocol with minimum output but still prompting for
write confirmation.
boot# load quiet
CCCC
Program FLASH? (y/n) y

4.9 passthru
Syntax
passthru [reset]
Description
Enter transparent pass-thru mode with the modem. Asserting a <BREAK> condition
returns to the terminal boot loader.
Parameters
reset
Resets the modem before entering pass-through mode
Example
boot# passthru reset
Entering pass-thru mode (modem reset)

uC Loader.. HW Ver 2.0 SW Ver 2.2 RST:EXT

....
*** BREAK: Exiting pass-thru mode
boot#

Notes
Enter pass-through mode to the IDP modem after first resetting it, to allow access to the
boot loader of the modem. In this example, a <BREAK> condition was asserted,
resulting in a return to the boot loader prompt.

T204, Version 01 16 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

4.10 reset
Syntax
reset [modem|all]
Description
Reset the terminal processor and/or the IDP modem.
Parameters
modem
Reset the modem (H/W reset)
all
Reset both the modem and the terminal processor
Example
Perform a reset of the terminal applications processor.
boot# reset

*** Reset terminal ***

IDP-600 series terminal boot loader (Version 3.1.0 (Release))

Copyright (c) 2011 SkyWave Mobile Communications.

*** Reset reason: SOFTWARE ***

Auto-starting base firmware in 5 seconds.

...
Perform a reset of the IDP modem
boot# reset modem
OK
Perform a reset of the modem and the terminal applications processor
boot# reset all
OK

*** Reset terminal and modem ***

IDP-600 series terminal boot loader (Version 3.2.2 (Release))

Copyright (c) 2011 SkyWave Mobile Communications.

*** Reset reason: SOFTWARE ***

Auto-starting base firmware in 5 seconds.

...

© SkyWave Proprietary 17 T204, Version 01

IDP 600 Terminal Series - User's Guide

4.11 start
Syntax
start [nolua|force|safemode|factoryreset]
Description
Start execution of the terminal's base firmware. This command fails if a terminal base
firmware image is not present.
Parameters
nolua
Start the terminal base firmware and do NOT automatically start the Lua service
framework
force
Start the terminal base firmware even if the CRC of the image is not valid or
present
safemode
Start the terminal base firmware and start the Lua Services Framework with
default properties and no user services (temporary)
factoryreset
Start the terminal base firmware after resetting the Lua service framework to
factory defaults (persistent)
Example
Start the base firmware, if the CRC is valid
boot# start
Starting application

IDP-600 series terminal base firmware (Version 3.2.2 (Release))

Starting the Lua Services Framework
Attaching shell
shell>
Start the base firmware without starting the Lua service framework
base# start nolua
Starting application

IDP-600 series terminal base firmware (Version 3.1.0 (Release))

Copyright © 2011 SkyWave Mobile communications.
#

T204, Version 01 18 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

5 Base Firmware
5.1 Flash File System
The terminal uses serial flash file system to store the Lua Services Framework,
configuration, user services and user data.
The file system is structured as a single volume (called sys:) which is structured as
follows:
act/  Active directory
infra/  Infrastructure (SkyWave Private)
svc/  LSF Core Services (SkyWave Private)
user/  User service directory
MyService/  User service 'MyService' folder for code
svclist.lua  User service registration file

data/  Data directory

svc/  LSF Core Services data directories
eio/
filesystem/
geofence/  Default location for geofence data.
idp/
log/  Log file location
message/
position/
report/
rs232/
shell/
system/
user/
MyService/  Data directory for 'MyService'

config/
svc/
rs232.lua  Saved rs232 service property values
user/
MyService.lua  Saved user service property values

5.2 Console Commands

The general syntax that applies to all boot loader commands:
<command> [<args>|help|?]
For example, any command followed by a ? or the keyword help displays the parameter
usage of the command.

© SkyWave Proprietary 19 T204, Version 01

IDP 600 Terminal Series - User's Guide

5.3 ? or help
Description
Display a list of all the available commands and their descriptions.
Syntax
help
Example:
# help
General syntax: <command> [<args>|help|?]

Available commands:
? - Display this help
baud - Change baud rate
cd - Change the current working directory
check - Check file system integrity
copy - Copy a file
del - Delete a file
dir - Display the contents of a directory
dl - Start YMODEM download session
format - Format a file system volume
help - Display this help
info – Display terminal information
init - Initialize the file system volume
listv - List file system volumes
mem - Display current firmware memory usage
mkdir - Create a directory
rename - Rename a file/directory
reset - Reset terminal and/or modem
rmdir - Remove a directory
start - Start Lua services framework
tasks - Display kernel task information
tod - Display/set terminal time-of-day
trace - Control serial tracing
type - Display the contents of a file
ulx - X-Modem upload
uly - Y-Modem upload

T204, Version 01 20 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

5.4 baud
Description
Change the baud rate of the serial port.
Syntax
baud [<baudRate>]
Parameters
<baudRate>
One of 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, or 115200
Example:
Change the baud rate to 115200.
# baud 115200
Changing baud to 115200

5.5 cd
Description
Display the current directory or change to the specified directory.
Syntax
cd [<dirpath>]
Parameters
<dirpath>
Optional relative or absolute directory path to change to.
Example:
Perform a relative directory change to the directory act/svc.
# cd act/svc
Change to a higher directory level.
# cd ..
Change to a higher directory level.
# cd
sys:act/svc

© SkyWave Proprietary 21 T204, Version 01

IDP 600 Terminal Series - User's Guide

5.6 check
Description
Check file system integrity of the specified volume and display any problems. If no
volume is provided, the default volume (sys:) is used.
Syntax
check [<volume>]
Parameter
<volume>
Volume to check (default: sys:)
Example:
Check the default file system for integrity.
# check
OK

5.7 copy
Description
Copy one file from one location to another.
Syntax
copy <scrfile> <dstdir|dstfile>
Parameter
<scrfile>
Source file to copy
<dstdir>
Destination directory
<dstfile>
New file name
Example:
Copy the file main.lua to the directory act/svc/test.
# copy main.lua act/svc/test

T204, Version 01 22 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

5.8 del
Description
Delete a file.
Syntax
del <file>
Parameter
<file>
File to delete
Example:
Delete the file stuff.lua.
# del stuff.lua

5.9 dir
Description
Display the contents of the current or specified directory. The display includes the
type of file, the file size, creation timestamp of the file, and the file name.
Syntax
dir [<dirpath>]
Parameter
<dirpath>
Relative or absolute directory path to display
Example:
Display the contents of the current directory.
# dir
(Dir) --- 0 31/03/2011 16:50:30 act
(Dir) --- 0 01/01/1980 00:00:00 data
(Dir) --- 0 01/01/1980 00:00:00 logs

© SkyWave Proprietary 23 T204, Version 01

IDP 600 Terminal Series - User's Guide

5.10 dl
Description
Starts a Y-Modem download session.
Syntax
dl
Example:
# dl
Start Y-Modem transmit now!
CCC

5.11 format
Description
Format a volume for file system operation.
Syntax
format <volume>
Parameter
<volume>
Volume name to format
Example:
Format the main file system.
# format sys:
Formatting volume sys:

T204, Version 01 24 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

5.12 info
Description
Display the information about the last reset reason, terminal hardware, clock speeds
and loaded software versions.
Syntax
info
Example:
# info
Terminal info
Manufacturing ID: ** NOT SET **
H/W Revision: 3
Reset reason: SOFTWARE
SYSCLK: 32 MHz
ADCCLK: 4 MHz
RTC Clock: Ready
Uptime: 0 days, 0 hours, 6 mins, 21 secs

Boot loader info

Software version: 3.1.0 (Release)
Build date: Jun 6 2011
Build time: 11:08:46
Boot API level: 2
Boot API version: 1

Base firmware info

Software version: 3.1.0 (Release)
Build date: Jun 6 2011
Build time: 11:10:47
Boot API version: 1
Feature mask: 0x0000000000000000

© SkyWave Proprietary 25 T204, Version 01

IDP 600 Terminal Series - User's Guide

5.13 init
Description
Initialize the file system volume. This command verifies that the volume is formatted
and accessible.
Note: This command is used primarily by the automatic tools.
Syntax
init [<volume>]
Parameter
<volume>
Volume to init (default: sys:)
Example:
Initialize the default file system.
# init
OK

5.14 listv
Description
List the information about the current file system volumes.
Syntax
listv
Example:
# listv
Sizes Clusters Volume (bytes)
Volume Sector Cluster Total / Free Size Free Used
sys: 512 1024 3361 / 3090 3441664 3164160 8%

T204, Version 01 26 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

5.15 mem
Description
Display current firmware memory usage.
Syntax
mem
Example:
# mem
FLASH Usage: 243478 bytes of 476K (49%)

SRAM Usage:
Internal: 34199 bytes of 48K (69%)
External: 19433 bytes of 64K (29%)
External: Lua HEAP: 960K

Heap count= 3 (Max: 3)

HID Heap Name Mem Addr Size Free Allocs
0 Task Stacks 20001F80 12288 1488 4
1 GMK Objects 20004F80 1024 748 18
2 BSP Driver 20005380 5120 504 8

Pool count= 3 (Max: 5)

PID Pool Name Mem Addr Blk Size Count Free Min Free
0 Event Msgs 640028A0 8 30 30 30
1 UART Cmds 640043DC 12 20 20 20
2 UART Resp 640044D0 12 20 20 20

System IRQ stack:

CSTACK: 164 bytes of 768 (23%)

© SkyWave Proprietary 27 T204, Version 01

IDP 600 Terminal Series - User's Guide

5.16 mkdir
Description
Creates a directory. The parent directory must exist.
Syntax
mkdir <dirpath>
Parameter
<dirpath>
Path of the directory to create
Example:
Create the director test in the current directory.
# mkdir test

5.17 rename
Description
Rename a file or directory.
Syntax
rename <old><new>
Parameter
<old>
File or directory to rename
<new>
New name
Example:
Change the name of main.lua to main_old.lua.
# rename main.lua main_old.lua

T204, Version 01 28 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

5.18 reset
Description
Reset the terminal processor and/or the IDP modem.
Syntax
reset [modem|all]
Parameter
modem
Reset the IDP modem (H/W reset)
all
Reset both the IDP modem and the terminal processor
Example:
Perform a reset of the IDP modem.
# reset modem
OK
Perform a reset of the terminal applications processor
# reset
OK

*** Reset terminal @ 9600 baud ***

IDP-600 series terminal boot loader (Version 3.1.0 (Release))

Copyright (c) 2011 SkyWave Mobile Communications.

*** Reset reason: SOFTWARE ***

Auto-starting base firmware in 5 seconds.

.....
Perform a reset of the IDP modem and the terminal applications processor.
# reset all
OK

*** Reset terminal and modem @ 9600 baud ***

IDP-600 series terminal boot loader (Version 3.1.0 (Release))

Copyright (c) 2011 SkyWave Mobile Communications.

*** Reset reason: SOFTWARE ***

Auto-starting base firmware in 5 seconds.

.....

© SkyWave Proprietary 29 T204, Version 01

IDP 600 Terminal Series - User's Guide

5.19 rmdir
Description
Removes (deletes) a directory.
CAUTION Recursive removal of directories could render the terminal
inoperative.
Syntax
rmdir [-recurse] <dirpath>
Parameter
-recurse
Recursively removes all files and directories
<dirpath>
The directory path to remove
Example:
Remove the directory log.
# rmdir log
Recursively remove the act/svc directory.
# rmdir -recurse act/svc

T204, Version 01 30 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

5.20 start
Description
Start the Lua framework which is located on the flash file-system. This allows access
to the shell prompt of the shell service if it is enabled.
Syntax
start [safemode|factoryreset]
Parameter
safemode
Start the terminal base firmware and start the Lua Services Framework with
default properties and no user services (temporary)
factoryreset
Start the terminal base firmware after resetting the Lua Service Framework to
factory defaults (persistent)
Example:
Start the Lua framework.
# start
Starting the Lua services framework
Attaching shell
shell>
Start the Lua framework after resetting the configuration of all services to their
factory defaults.
# start factoryreset
Starting the Lua Services Framework
*** warning: Restoring to factory defaults
Attaching shell
shell>

© SkyWave Proprietary 31 T204, Version 01

IDP 600 Terminal Series - User's Guide

5.21 tasks
Description
Display kernel task information.
Syntax
tasks [clear]
Parameter
clear
Clear the context switch counters and CPU time counters
Example:
Display the currently running kernel tasks.
# tasks
Kernel Tasks:
Pri Name State SP Size/Used SyncObj Ctx Switches CPU Time
5 Main Rx Q 20002A40 200( 44) 20003B84 24 / 0% 1
6 Modem Rx Q 20002D64 200( 56) 20003BA0 430 / 5% 78
14 CmdLine R 20002528 1800( 632) 00000000 6824 / 93% 71494
15 Idle R 20002744 96( 20) 00000000 --- / --- 238732
Total non-idle context switches: 7278

T204, Version 01 32 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

5.22 tod
Description
Display and set the terminal UTC time-of-day. The time and date can be set
individually using the time and date options, or the time can be set as an offset from
the system EPOCH.
Syntax
tod [date <yyyy> <mm> <dd>|time <hh> <mm> <ss>|set
<offset> [force]]
Parameter
date
Change the current date
<yyyy>
Year value (2010 -)
<mm>
Month (1 – 12)
<dd>
Day (1 – 31)
time
Change the current time (24 hour format)
<hh>
Hour (0 – 23)
<mm>
Minute (0 – 59)
<ss>
Second (0 – 59)
Set: set the date/time using seconds since EPOCH
<offset>
Offset in seconds from Jan 1, 1970
[force]
Optional keyword to set the time, even if it is already set
Example:
Display the current terminal time-of-day.
# tod
16/03/2011 21:28:46.748 UTC
Set the date to January 5th, 2011.
# tod date 2011 1 5

© SkyWave Proprietary 33 T204, Version 01

IDP 600 Terminal Series - User's Guide

Set the time to 20:11:23.

# tod time 20 11 23
Set the time using seconds from Jan 1, 1970.
# tod set 1298970000
# tod
1/03/2011 09:00:02

5.23 trace
Description
Controls the serial debug tracing mechanism.
Syntax
trace [baud|channel|disable|enable|mask|msg|reset]
Example:
Display the current tracing configuration.
# trace
Status: enabled
Channel: debug
Default baud: 115200
Current trace mask: init,sys,cmd,fs,luac,luat,dbg
Supported trace masks: init,sys,cmd,fs,luac,luat,dbg

5.23.1 trace baud

Description
Configure the default baud rate of the trace channel. This baud is used if tracing is
enabled and the channel is not already opened.
Syntax
trace baud <baudRate>
Parameter
<baudRate>
One of 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, or 115200
Example:
Set the default baud rate of the trace channel to 115200.
# trace baud 115200

T204, Version 01 34 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

5.23.2 trace channel

Description
Configure the serial channel to use for tracing. If the channel is already open (i.e., the
main RS-232 channel is selected) then the baud rate of the channel is used, otherwise
the default trace baud rate is used.
Syntax
trace channel <channel>
Parameter
<channel>
One of main, debug, or rs485
Example:
Set the trace channel to the main RS-232 serial channel.
# trace channel main
Set the trace channel to the internal RS-232 debug channel.
# trace channel debug
Set the trace channel to the RS-485 I/O line.
# trace channel rs485

5.23.3 trace disable

Description
Disable serial tracing.
Syntax
trace disable

5.23.4 trace enable

Description
Enable serial tracing.
Syntax
trace enable

© SkyWave Proprietary 35 T204, Version 01

IDP 600 Terminal Series - User's Guide

5.23.5 trace mask

Description
Change the mask of trace bits which control which sub-systems are included in the
tracing output.
Syntax
trace mask default|<+|-<subsys>>
Parameter
default
Sets the mask to the default value
subsys
Specifies a subsystem which can be one of
init Firmware initialization
sys System
cmd Executed commands
fs File system operations
luac Lua C bindings
luat Lua trace() and tracef() output
dbg Internal debugging
Example:
Set the trace mask to the default value.
# trace mask default
Clear all the mask bits (using pseudo mask all) and adds the sys and init
subsystems.
# trace mask -all +sys +init

5.23.6 trace msg

Description
Inject an arbitrary string into the tracing output.
Syntax
trace msg <string>
Parameter
string
Arbitrary string
Example:
Add the string (e.g., "turning on geofence now") to the serial trace.
# trace msg turning on geofence now

T204, Version 01 36 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

5.23.7 trace reset

Description
Resets the tracing configuration to the factory default values.
Syntax
trace reset

5.24 type
Description
Display the contents of a file. If the file is a compiled Lua file, then the message
"Compiled lua file" is displayed.
Syntax
type <file>
Parameter
<file>
File to display
Example:
Display what happens when attempting to type a compiled Lua file.
# type act/svc/core.lua
Compiled lua file
Display the content of the file act/svc/user.lua.
# type act/svc/core.lua
Service(128,"test")

5.25 ulx
Description
Upload a file using the X-Modem protocol.
Syntax
ulx <file>
Parameter
<file>
File to transmit using the X-Modem
Example:
Start an X-Modem transmit session to send the file data.lua.
# ulx data.lua
Starting X-Modem upload

© SkyWave Proprietary 37 T204, Version 01

IDP 600 Terminal Series - User's Guide

5.26 uly
Description
Upload one or more files using the Y-Modem protocol.
Syntax
uly <file> [… <file>]
Parameter
<file>
File to transmit using the Y-Modem protocol
Example:
Send the files data/mylog.dat and foo.lua.
# uly data/mylog.dat foo.lua
Starting Y-Modem upload

T204, Version 01 38 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

6 Lua Services Framework

6.1 Service Architecture
Most end-user functionality on the IDP 600 series terminals is implemented by software
constructs called services. Services are self-contained, individually-addressable modules
each offering well-defined functionality. Services are written in Lua, and can optionally
define configurable properties, function interfaces, and network messaging interfaces.
There are two broad classes of services called core services and user services.
Core services are SkyWave services which provide basic interfaces to the core
functionality of the terminal. Core services include basic functional building blocks like
support for sending and receiving messages, logging, requesting GPS information and
generating various periodic reports. Core services like geofence and report provide
complete standalone applications. The configurable properties and network messaging
interfaces of all core services are documented in [T202].
User services are services that are written by the user and plugged into the services
framework of the terminal, allowing for simple or advanced extensions to the terminals
core functionality.
The terminal software allows custom application development (Lua scripting). Lua is the
scripting language used since it is a proven, robust, embedded scripting language with
many applications. Lua is a fast language engine with a small footprint that can easily be
embedded into almost any application. The application programming interface (API)
allows it to integrate with code written in other languages.

6.2 Core Services

Below is a summary of all the current core services. For more detailed information,
including all defined properties, network messages, and Lua API functions of the service,
see [T202].

6.2.1 system
The system service provides management and control of the global aspects of the
terminal including service management, terminal reset functionality and querying of
terminal state. It also provides the interface to query and set properties of all services.

6.2.2 message
The message service is responsible for making sure that any incoming messages are
routed to the appropriate service, and that outgoing messages are sent over the
appropriate transport, and in the appropriate format.

6.2.3 report
The report service sends out report messages, consisting of properties from various
services, either on-demand or following pre-configured schedules.

© SkyWave Proprietary 39 T204, Version 01

IDP 600 Terminal Series - User's Guide

6.2.4 position
The position service provides an abstract interface into the available GPS interfaces
supported by the terminal. This service provides mechanisms to request GPS fixes and
query GPS location and time.

6.2.5 geofence
The geofence service is used to configure the geofence.

6.2.6 rs232
The rs232 service is used to configure, and provide access to, the terminal's RS-232 port

6.2.7 log
The log service provides the ability to store data in non-volatile storage for history and/or
troubleshooting purposes. The data log can store any outgoing message; the debug log
stores arbitrary strings.

6.2.8 eio
The eio service provides a simple mechanism to configure the terminal's four general-
purpose external I/O ports, and provides the current values of those four ports, as well as
two analog input ports for temperature and voltage. It also allows for alarm messages to
be sent out based on the state of individual inputs.

6.2.9 shell
The shell service provides an optional command line interface on the RS-232 interface
which can be used to issue interactive commands while the framework is running.

6.2.10 filesystem
The filesystem service provides an interface to the flash file system on the terminal. This
includes mechanisms to query directory information and send/receive files.

6.2.11 idp
The idp service provides properties and functionality specific to the IsatData Pro satellite
network interface.

T204, Version 01 40 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7 Shell Commands
If the shell service is enabled via the attached property of the shell service, then the shell
prompt (shell>) is available on the RS-232 serial port. The RS-232 configuration depends
on the properties of the rs232 service, which default to 9600 baud, 8 data bits, no parity,
1 stop bit.

7.1 ? or help
Syntax
help
Description
Display a list of all the available commands and their descriptions.
Example
shell> help
Available commands:
? - Display this help
cd - Change the current working directory
comp - Compile the specified file
copy - Copy a file
del - Delete a file
dir - Display a directory
geo - Issue a geofence command
help - Display this help
idp - Issue an idp command
info - Display terminal info
listv - List file-system volumes
log - Issue a log command
lua - Execute Lua expression
mem - Display free memory
mkdir - Make a directory
msg - Issue a msg command
prop - Issue a property command
rename - Rename a file/directory
report - Generate a report
rmdir - Remove a directory
service - Issue a service command
stop - Stop the Lua environment
threads - Display spawned threads
tod - Display terminal time-of-day
type - Display the contents of a file

© SkyWave Proprietary 41 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.2 cd
Syntax
cd [<path>]
Description
Display the current directory or change to the specified directory.
Parameter
<path>
Relative or absolute directory path to change to.
Example
Perform a relative directory change to the directory act/svc.
shell> cd act/svc
Change to a higher directory level.
shell> cd ..
Change to a higher directory level.
shell> cd
sys:act/svc

7.3 comp
Syntax
comp <input file> [<output file>]
Description
Compile a Lua source file. If only an input file is specified, then the source is
replaced with the compiled version.
Parameter
<input file>
Lua source file to compile
<output file>
Optional file name of the compiled result
Example
Compile the file testcode.lua and replaces the file with the complied output.
# comp testcode.lua
Compiled "testcode.lua"

T204, Version 01 42 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.4 copy
Syntax
copy <sfile> <dpath|dfile>
Description
Copy one file from one location to another.
Parameter
<sfile>
Source file to copy
<dpath>
Destination path to copy the file to
<dfile>
New file name
Example
Copy the file main.lua to the directory act/svc/test
# copy main.lua act/svc/test

7.5 del
Syntax
del <file>
Description
Delete a file
Parameter
<file>
File to delete
Example
Delete the file stuff.lua
# del stuff.lua

© SkyWave Proprietary 43 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.6 dir
Syntax
dir [<dirpath>]
Description
Display the contents of the current or specified directory.
Parameter
<dirpath>
Relative or absolute directory path to display
Example
Display the contents of the current directory
shell> dir
D----- 0 01/01/2010 00:00:00 act
D----- 0 01/01/2010 00:00:00 data
D----- 0 01/01/2010 00:00:00 logs
Found 0 files using a total of 0 bytes.

7.7 geo
Syntax
geo ?|help|<command>
Description
Issue a geofence command.
Parameter
? or help
List the available geo commands
<command>
Geo command
Example
shell> geo ?
Available commands:
? - Display this help
help - Display this help
show - Display geofence information

T204, Version 01 44 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.7.1 geo show

Syntax
geo show [<fence number> [<fence number> …]]
Description
Displays geofence configuration information. Depending on the arguments provided,
it can show either configuration of the geofence service as a whole, or for individual
fences.
Parameter
<fence number>
The number of the fence we wish to display (0-127). If none are specified, it
displays configuration for the geofence service.
Example
Display geofence service information
shell> geo show
There are 2 fence(s) defined, of which 2 are enabled.
Next fence check in 58 seconds.
Display information for fences 0,1, and 2
shell> geo show 0 1 2
Fence #000: enabled=y type=Simple alarm=Both status=Outside
Fence #001: enabled=y type=Complex alarm=Entry status=Outside
Fence #002: not defined

© SkyWave Proprietary 45 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.8 idp
Syntax
idp ?|help|<command>
Description
Issue an IDP modem command.
Parameter
? or help
List the available IDP commands
<command>
IDP commands
Example
shell> idp ?
Available commands:
? - Display this help
getmetrics - Get a metrics block
getsreg - Get an S-register value
help - Display this help
info - Display idp information
setsreg - Set an S-register value

T204, Version 01 46 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.8.1 idp getmetrics

Syntax
idp getmetrics <class> <subclass>
Description
Query IDP modem event metrics.
Parameter
<class>
Specify the class of the event metrics
<subclass>
Specify the subclass of the event metrics
Example
shell> idp getmetrics 2 1
MTID = 26
timestamp = 0
class = 2
subclass = 1
priority = 4
metric 01 = 6
metric 02 = 768
metric 03 = 1024
metric 04 = 1024
metric 05 = 1024
metric 06 = 1024
metric 07 = 1024

7.8.2 idp getsreg

Syntax
idp getsreg <register #>
Description
Get the contents of an IDP modem S register.
Parameter
<register #>
S register number to get
Example
Get the contents of S register 3 (S03) and display it
shell> idp getsreg 3
S-register 3 = 13

© SkyWave Proprietary 47 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.8.3 idp setsreg

Syntax
idp setsreg <register #> <value>
Description
Set an IDP modem S register to a specific value.
Parameter
<register #>
S register number to set
<value>
Value to set
Example
Set S-register 0 (S0) to 1
shell> idp setsreg 0 1
S-register 0 set to 1

7.8.4 idp info

Description
Display the static information about the IDP modem.
Syntax
idp info
Example
shell> idp info
Modem Model: IsatData Pro - Modem
Firmware version: 3.003
Mobile ID: 00000026SKY56BF

T204, Version 01 48 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.9 info
Syntax
info
Description
Display the information about the terminal including hardware configuration and
framework and firmware version information.
Example
shell> info

Terminal Hardware
H/W Revision: 0
Last Reset Reason: 6 (SOFTWARE)
Memory Size: 960K
Uptime: 0 days, 0 hours, 46 mins, 46 secs

Boot loader info

Software version: 3.2.0 (Release)
Build date: Jun 21 2011
Build time: 10:03:33

Base firmware info

Software version: 3.2.0 (Release)
Build date: Jun 21 2011
Build time: 10:04:47
Lua API level: 20
Lua compatability level: 18

Lua Services Framework

Version: 3.2.2
Build date: Jul 7 2011
Build time: 11:28:00
API compatability level: 18
Uptime: 0 days, 0 hours, 45 mins, 0 secs

© SkyWave Proprietary 49 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.10 listv
Syntax
listv
Description
List the information about the current file system volumes.
Example
shell> listv
Sizes Clusters Volume (bytes)
Volume Sector Cluster Total / Free Size Free Used
sys: 512 1024 3361 / 3090 3441664 3164160 8%

7.11 log
Syntax
log ?|help|<command>
Description
Issue a log command of the log service.
Parameter
? or help
List the available log commands
<command>
Log command
Example
shell> log ?
Available commands:
? - Display this help
clear - Clear all log files for a specified log type
count - Show the number of remaining entries that match the filter
filter - Set a new query filter
help - Display this help
next – Show log entries that match the filter

T204, Version 01 50 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.11.1 log count

Syntax
log count <msg|dbg>
Description
Display the number of remaining number of log entries that match the current filter.
Parameter
<msg|dbg>
Select the message or debug log
Example
Show the number of remaining message logs
shell> log count msg
Number of matching entries : 63
First entry sequence number: 1
First entry timestamp : 1308149795 (Wed Jun 15 14:56:35 2011)
Last entry sequence number : 63
Last entry timestamp : 1308237756 (Thu Jun 16 15:22:36 2011)
Show the number of remaining message logs again after five logs have been retrieved
shell> log next type=msg maxEntries=5
...
shell> log count msg
Number of matching entries : 58
First entry sequence number: 6
First entry timestamp : 1308170026 (Wed Jun 15 20:33:46 2011)
Last entry sequence number : 63
Last entry timestamp : 1308237756 (Thu Jun 16 15:22:36 2011)

© SkyWave Proprietary 51 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.11.2 log filter

Syntax
log filter type=<msg|dbg> [option=<opt>]
Description
Sets a query filter for either the message or debug log. The filter applies to all
subsequent count or next commands form the shell for that log.
Parameter
<type>=<msg|dbg>
Apply the filter to the message or debug log
<opt>
seqStart=<N>
Filter out log records that have a sequence number smaller than N
seqEnd=<N>
Filter out log records that have a sequence number greater than N
timeStart=<N>
Filter out log records that have a timestamp smaller than N
timeEnd=<N>
Filter out log records that have a timestamp greater than N
reverse=<true|false>
Specifies the direction of the log search (default: false)
include=<sin[…,min]>
Adds the SIN and optional MIN list to the include list. Multiple includes can
be used to specify more than one SIN. This only applies for the message log
filter.
levels=<bitMask>
Specifies debug log levels (default: all). This only applies for the debug log
filter.
Example
Set the message filter to select log entries 100 through 120, in reverse order
shell> log filter type=msg seqStart=100 seqEnd=120 reverse=true
Set the message filter to select messages where sin=16, min=1, 2 or 3 after the first
1000 logs
shell> log filter type=msg seqStart=1001 include=16,1,2,3
Set the message filter to select messages where sin=16, min=1, 2 or 3, or sin=18,
min=4, 5 or 6 in the first 1000 logs
shell> log filter type=msg seqEnd=1000 include=16,1,2,3
include=18,4,5,6

T204, Version 01 52 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

Set the message filter to select all message logs where sin=20 (all min values).
shell> log filter type=msg include=20
Set the debug filter to select all debug logs for timestamps between 1308225600 and
1308229200 (12pm to 1pm on June 15th, 2011), where the level is 0, 1, 2 or 3.
shell> log filter type=dbg timeStart=1308225600 timeEnd=1308229200
levels=15
Reset the debug filter to include all debug logs
shell> log filter type=dbg

© SkyWave Proprietary 53 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.11.3 log next

Syntax
log next type=<msg|dbg> [<option>=<val>]
Description
Display the next log entry matching a specified filter.
Parameter
Type=<msg|dbg>
Apply the filter to the message or debug log
<option>
max=<val>
Sets the maximum number of entries
detail=<true|flase>
Controls whether detailed log entries are shown. Default is false.
Example
Display the next two log entries that match the message log filter
shell> log next type=msg max=2
seq#=1 time=1308149795 sin=16 min=6 dir=RETURN
seq#=2 time=1308159594 sin=16 min=6 dir=RETURN
Display the next six log entries that match the message log filter, with extra detail
shell> log next type=msg max=6 detail=true
seq#=3 time=Wed Jun 15 17:55:44 2011 svc.system:termReset(RETURN)
fields:
seq#=4 time=Wed Jun 15 18:07:41 2011 svc.system:termReset(RETURN)
fields:
seq#=5 time=Thu Jan 1 00:00:11 1970 svc.system:termReset(RETURN)
fields:
seq#=6 time=Wed Jun 15 20:33:46 2011 svc.system:termReset(RETURN)
fields:
seq#=7 time=Wed Jun 15 20:34:11 2011 svc.system:timeSync(RETURN)
fields:
time=1308170051
seq#=8 time=Wed Jun 15 20:38:38 2011 svc.system:termReset(RETURN)
fields:
Display as many log entries as possible that match the debug log filter
shell> log next type=dbg
seq#=1 time=1308230577 level=2 log="svcmgr: service 'filesystem' terminated"
seq#=2 time=1308230578 level=2 log="svcmgr: spawning filesystem.entry()"
seq#=3 time=1308234872 level=2 log="svcmgr: service 'system' terminated"
seq#=4 time=1308234873 level=2 log="svcmgr: spawning system.entry()"

T204, Version 01 54 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.11.4 log clear

Syntax
log clear <msg|dbg|both>
Description
Clear the log files associated with the given log type.
Parameter
<msg|dbg|both>
Select the message or debug log, or both

7.12 lua
Syntax
lua [<expression>]
Description
Execute a Lua expression or enter a Lua interactive environment. If an expression is
provided, it is compiled and executed immediately. If the expression is not a
complete statement, then the shell drops to the lua+ prompt to ask for more input to
complete the Lua expression.
A special operator (=) can be placed at the start of an expression which causes the
shell to execute the expression and display the returned value using the dumpvar()
utility.
Parameter
<expression>
Optional Lua expression to execute
Example
Call the Lua function dumpvar() with the Lua table svc.shell as an argument
shell> lua dumpvar(svc.shell)
["table: 6407dcc0"] = { -- table: 6407dcc0 (count= 0)
properties = { -- table: 6407d9c8 (count= 0)
};
unregister = function: 64086fd0;
_PACKAGE = "svc.";
attach = function: 640871a0;
detach = function: 640871f0;
_VERSION = "1.3.1";
_SIN = 26;
register = function: 64086fb0;
dumpHelp = function: 64086c98;
_NAME = "svc.shell";
init = function: 64087410;
entry = function: 64086cd8;
_M = ref"table: 6407dcc0";
onTermination = function: 640873d0;

© SkyWave Proprietary 55 T204, Version 01

IDP 600 Terminal Series - User's Guide

onConfigChange = function: 64086cb8;

};
Demonstrate the use of the = operator to display the result of an expression
shell> lua os.date()
shell> lua =os.date()
result = { -- table: 6403db20 (count= 1)
[1] = "Thu Mar 24 15:23:31 2011";
};

7.13 mem
Syntax
mem [gc]
Description
Displays the current size and usage of the Lua system heap.
Parameter
gc
Optionally perform a full garbage collection before displaying the memory
Example
Display the current memory usage
shell> mem
Used heap memory: 438K of 960K (46%)
Display the current memory usage after forcing a full garbage collection
shell> mem gc
Used heap memory: 433K of 960K (45%)

T204, Version 01 56 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.14 mkdir
Syntax
mkdir <path>
Description
Create a directory. The parent directory must exist.
Parameter
<path>
Path of directory to create
Example
Create the directory test in the current directory
shell> mkdir test

7.15 msg
Syntax
msg ?|help|<command>
Description
Issue a messaging command to send messages via the transport service.
Parameter
? or help
List the available msg commands
<command>
msg command
Example
shell> msg ?
Available commands:
? - Display this help
add - Add a custom message for Tx
cancel - Cancel message tranmission
help - Display this help
list - List currently queued Tx messages

© SkyWave Proprietary 57 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.15.1 msg add

Syntax
msg add [<option>=<val>] <data>
Description
Adds a custom message to the transmit queue for transmission over a transport. If
successful, the message is queued for transmit and its serial number is displayed.
A return messages with SIN=18 (message) and MIN=1 is used.
Parameter
<option>
log=<true|false>
Specifies if the message should be logged. (default: false)
priority=<n>
Sets the message priority (1 - 4) (default: 1)
retry=< true|false>
Specifies if retries are attempted (default: false)
lifetime=<N>
Specifies the lifetime of the message (1-1440 minutes) (default: 60 minutes)
<data>
Sequence of strings, quoted strings, decimal byte values, or hexadecimal byte
values prefixed with 0x.
Example
Queue "this is a test" using all the defaults
shell> msg add "this is a test"
Custom message queued, reference number is 4
Queue "hello\r\n" at priority 4 and a lifetime of 120 minutes. A copy is also logged.
shell> msg add log=true priority=4 lifetime=120 "hello" 0x0D 0x0A
Custom message queued, reference number is 5

T204, Version 01 58 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.15.2 msg cancel

Syntax
msg cancel <reference #>
Description
Cancel a message that has been queued for transmit.
Parameter
<reference #>
Reference number of the message to cancel
Example
Cancel message #5
shell> msg cancel 5
Message 5 cancelled

7.15.3 msg list

Syntax
msg list [<reference #> [<reference #> > …]]
Description
List information about a specific set of messages or all the messages in the transmit
queue along with the last 5 messages that have been completed.
The output is displayed as follows:
Ref# SIN MIN Status S L R P Life Age T Att Time
1 16 6 Success N Y N 3 60 0 0 1 07/07/11 16:38:13
2 16 8 100.00% Y N N 3 60 0 1 1 07/07/11 16:38:13
The displayed fields are as follows:
 Reference Number
 SIN
 MIN
 Message status can be one of:
 Success - message successfully transmitted
 XX.XX% or In_progress - message is currently being transmitted
 Failure - Failed to transmit the message
 Cancelled - Message was cancelled
 Invalid - Message is invalid
 Send flag (Y or N)
 Log flag (Y or N)
 Retry flag (Y or N)

© SkyWave Proprietary 59 T204, Version 01

IDP 600 Terminal Series - User's Guide

 Lifetime
 Age of the message
 Transport being used
 Transmit attempt
 Message time stamp
Parameter
<reference #> >
Reference number of the message to list
Example
List all the messages in the transmit queue along with the last 5 completed messages
shell> msg list
Ref# SIN MIN Status S L R P Life Age T Att Time
1 16 6 Success N Y N 3 60 0 0 1 01/01/70 00:00:00
2 16 8 Success Y N N 3 60 0 1 1 07/07/11 16:36:34
3 16 7 Success N Y N 3 60 0 0 1 07/07/11 16:36:18
4 18 1 Success Y N N 3 60 0 1 1 07/07/11 16:36:44
5 18 1 Cancelled Y N N 3 60 0 1 1 07/07/11 16:37:33
List the information for message #2 and #4
shell> msg list 2 4
Ref# SIN MIN Status S L R P Life Age T Att Time
2 16 8 Success Y N N 3 60 0 1 1 07/07/11 16:36:34
4 18 1 Success Y N N 3 60 0 1 1 07/07/11 16:36:44

T204, Version 01 60 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.16 prop
Syntax
prop ?|help|<command>
Description
Issue a property command
Parameter
? or help
List the available property commands
<command>
Property command
Example
shell> prop ?
Available commands:
? - Display this help
get - Get a property value
help - Display this help
reset - Reset a property to its default value
revert - Revert a property to its last saved value
save - Save modified property values
set - Set a property value

© SkyWave Proprietary 61 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.16.1 prop get

Syntax
prop get [<sin> [<pin>]]
Description
Get property values. If no arguments are provided, all properties for all SINs are
displayed. If only a SIN is given, all properties for that service are displayed.
Parameter
<sin>
Optional service name or service identification number
<pin>
Optional property identification number
Example
Display all the properties of all the services
shell> prop get
Display all the properties of the rs232 service
shell> prop get rs232
SIN=22(rs232) PIN=1(enabled) val=true
SIN=22(rs232) PIN=2(baudRate) val=9600
SIN=22(rs232) PIN=3(dataBits) val=8
SIN=22(rs232) PIN=4(parity) val=None
SIN=22(rs232) PIN=5(stopBits) val=1
SIN=22(rs232) PIN=6(tcvrMode) val=autoShutdown
SIN=22(rs232) PIN=7(DTEIsConnected) val=true
SIN=22(rs232) PIN=8(DTEAlarm) val=Disabled
SIN=22(rs232) PIN=9(DTELog) val=Disabled
SIN=22(rs232) PIN=10(DTEEdgeDetect) val=Both
SIN=22(rs232) PIN=11(DTEEdgeSampleCount) val=1000
SIN=22(rs232) PIN=12(DTEEdgeSampleError) val=20
SIN=22(rs232) PIN=13(breakAlarm) val=false
SIN=22(rs232) PIN=14(breakLog) val=false
Display property # 2 of service number 137
shell> prop get 137 2

T204, Version 01 62 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.16.2 prop reset

Syntax
prop reset [<sin> [<pin>]]
Description
Reset property values to their default values. If no arguments are provided, all
properties for all SINs are reset. If only a SIN is given, all properties for that service
are reset.
Parameter
<sin>
Optional service name or service identification number
<pin>
Optional property identification number
Example
Reset all the properties of all the services
shell> prop reset
Reset done
Reset all the properties of the service with a SIN of 128
shell> prop reset 128
Reset done
Reset the first property of the rs232 service
shell> prop reset rs232 1
Reset done

© SkyWave Proprietary 63 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.16.3 prop revert

Syntax
prop revert [<sin> [<pin>]]
Description
Revert property values to their last saved values. If no arguments are provided, all
properties for all SINs are reverted. If only a SIN is given, all properties for that
service are reverted.
Parameter
<sin>
Optional service name or service identification number
<pin>
Optional property identification number
Example
Revert all the properties of all the services
shell> prop revert
Revert done
Revert all the properties of the service with a SIN of 91
shell> prop revert 91
Revert done
Revert property #8 of the system service
shell> prop revert system 8
Revert done

T204, Version 01 64 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.16.4 prop save

Syntax
prop save [<sin> [<pin>]]
Description
Save modified property values. If no arguments are provided, all properties for all
SINs are saved. If only a SIN is given, all properties for that service are saved.
Parameter
<sin>
Optional service name or service identification number
<pin>
Optional property identification number
Example
Save all the properties of all the services
shell> prop save
Save done
Save all the properties of the service with a SIN of 130
shell> prop save 130
Save done
Save property #2 of the shell service
shell> prop save shell 2
Save done

© SkyWave Proprietary 65 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.16.5 prop set

Syntax
prop set <sin> <pin> <value>
Description
Set a property value. The value must match the type of the property. For Boolean
properties, a true or false must be provided. For enumerated ranges, the value can be
either the integer value of the range or the range element itself.
Parameter
<sin>
Service name or service identification number
<pin>
Property identification number
<value>
Value to set
Example
Configure pin 23 (port3Config) of the EIO (SIN 25) service to be InputPullUp
shell> prop set eio 23 InputPullUp
Set done
Sets the first property of the shell (enabled) to be false
shell> prop set shell 1 false

7.17 rename
Description
Rename a file or directory.
Syntax
rename <old> <new>
Parameter
<old>
File or directory to rename
<new>
New name
Example
Change the name of main.lua to main_old.lua
shell> rename main.lua main_old.lua

T204, Version 01 66 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.18 report
Syntax
report [<option>=<val>] [<SIN>] [<MIN>]
Description
Generate and query report configuration.
Parameter
<option>
send=<true|false>
Specifies if the report should be queued for transmission (default: true)
log=<true|false>
Specifies if the report should be logged. (default: false)
priority=<n>
Sets the message priority (1 - 4) (default: 1)
retry=< true|false>
Specifies if retries are attempted (default: false)
lifetime=<N>
Specifies the lifetime of the message (1 - 1440 minutes) (default: 60 minutes)
<SIN>
Optional SIM of report to send (default: 19)
<MIN>
The MIN of report to send
Example
Displays the current reporting configuration
shell> report
# SIN MIN Enabled Offset Interval Next Report
1 19 1 Yes 15 60 07/08/11 15:15:26
2 19 2 Yes 0 120 07/08/11 16:00:26
3 128 1 No 45 60 n/a
4 128 5 Yes 0 1440 07/09/11 00:00:26
Queues report 1 (simpleReport) for transmission using default values
shell> report 1
Report will be queued when position data is available. Please use
'msg list' to track the report.
Logs report 2 (fullReport) without transmitting it
shell> report send=false log=true 2
Report will be queued when position data is available. Please use
'msg list' to track the report.

© SkyWave Proprietary 67 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.19 rmdir
Syntax
rmdir [-recurse] <dirpath>
Description
Removes (deletes) a directory
CAUTION Recursive removal of directories could render the terminal
inoperative.
Parameter
[-recurse]
Recursively removes all files and directories
<dirpath>
The directory path to remove
Example
Remove the directory log
shell> rmdir log
Recursively remove the act/svc directory
shell> rmdir -recurse act/svc

7.20 service
Syntax
service ?|help|<command>
Description
Issue a service command.
Parameter
? or help
Lists the available service commands
<command>
Service command
Example
shell> service ?
Available commands:
? - Display this help
help - Display this help
list - Display a list of services
restart - Restart a service

T204, Version 01 68 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.20.1 service list

Syntax
service list
Description
List the current services defined in the system.
Example
shell> service list
SIN Name Version Started? Thread
16 system 1.2.0 YES thread: 64056e10[system_entry]
18 message 1.2.0 YES thread: 6406cf90[message_entry]
19 report 1.2.0 YES thread: 64061230[report_entry]
20 position 1.2.0 YES thread: 6405b840[position_entry]
21 geofence 1.2.0 YES thread: 64075518[geofence_entry]
22 rs232 1.2.0 YES thread: 64059d30[rs232_entry]
23 log 1.2.0 YES thread: 64058da0[log_entry]
24 filesystem 1.2.0 YES thread: 640612a0[filesystem_entry]
25 eio 1.2.0 YES thread: 6405a4e0[eio_entry]
26 shell 1.2.0 YES thread: 64040a40[shell_entry]
27 idp 1.2.0 YES thread: 64058988[idp_entry]

7.20.2 service restart

Syntax
service restart <sin>
Description
Restart a specific service.
Parameter
<sin>
Service name or service identification number (SIN)
Example
shell> service restart shell

Detaching shell
Attaching shell
shell>

© SkyWave Proprietary 69 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.21 stop
Syntax
stop [now|start|reset [now]]
Description
Stop the Lua service environment and optionally restart it or reset the terminal.
CAUTION Using the now option to force an immediate stop skips normal
shutdown procedures and could result in lost data
Parameter
now
Stops the environment immediately without a clean shutdown
start
Re-starts the environment after stopping it
reset
Resets the terminal after stopping the environment
now
Resets the terminal immediately
Example
Stop the Lua services framework
shell> stop
Gracefully restart the Lua services framework
shell> stop start
Force an immediate stop of the Lua services framework
shell> stop now
Force an immediate reset of the terminal
shell> stop reset now

T204, Version 01 70 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.22 threads
Syntax
threads
Description
Display the currently active threads being managed by the scheduler.
Example
shell> threads
thread: 6403ee18 shell_entry suspended
thread: 640637c8 log_entry suspended
thread: 6406a7c0 position_entry suspended
thread: 6406b3d0 filesystem_entry suspended
thread: 64064320 rs232_entry suspended
thread: 640a25d8 Shell Cmd Processor suspended
thread: 6406fdf8 report_entry suspended
thread: 640687c0 eio_entry suspended
thread: 6406ff70 geofence_entry suspended
thread: 64063700 message_entry suspended
thread: 6405f958 idp_entry suspended
thread: 6401a058 Shell CLI suspended
thread: 64053620 system_entry suspended
thread: 64043308 CMD:threads running

7.23 tod
Syntax
tod
Description
Display the terminal time-of-day
Example
shell> tod
Wed Mar 16 19:15:59 2011 UTC

© SkyWave Proprietary 71 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.24 trace
Syntax
trace [baud|channel|disable|enable|mask|msg|reset]
Description
Controls the serial debug tracing mechanism.
Example
Display the current tracing configuration
# trace
Status: enabled
Channel: debug
Default baud: 115200
Current trace mask: init,sys,cmd,fs,luac,luat,dbg
Supported trace masks: init,sys,cmd,fs,luac,luat,dbg

7.24.1 trace baud

Syntax
trace baud <baudRate>
Description
Configure the default baud rate of the trace channel. This baud is used if tracing is
enabled and the channel is not already opened.
Parameter
<baudRate>
One of 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, or 115200
Example
Set the default baud rate of the trace channel to 115200
# trace baud 115200

T204, Version 01 72 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.24.2 trace channel

Syntax
trace channel <channel>
Description
Configure the serial channel to use for tracing. If the channel is already open (i.e., the
main RS-232 channel is selected) then the baud rate of the channel is used, otherwise
the default trace baud rate is used.
Parameter
<channel>
One of main, debug, or rs485
Example
Set the trace channel to the main RS-232 serial channel
# trace channel main
Set the trace channel to the internal RS-232 debug channel
# trace channel debug
Set the trace channel to the RS-485 I/O line
# trace channel rs485

7.24.3 trace disable

Syntax
trace disable
Description
Disable serial tracing.

7.24.4 trace enable

Syntax
trace enable
Description
Enable serial tracing.

© SkyWave Proprietary 73 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.24.5 trace mask

Syntax
trace mask default|<+|-<subsys>>
Description
Change the mask of trace bits which control which sub-systems are included in the
tracing output.
Parameter
default
Sets the mask to the default value
subsys
Specifies a subsystem which can be one of
init Firmware initialization
sys System
cmd Executed commands
fs File system operations
luac Lua C bindings
luat Lua trace() and tracef() output
dbg Internal debugging
Example
Set the trace mask to the default value
# trace mask default
Clear all the mask bits (using pseudo mask all) and adds the sys and init subsystems
# trace mask -all +sys +init

7.24.6 trace msg

Syntax
trace msg <string>
Description
Inject an arbitrary string into the tracing output.
Parameter
string
Arbitrary string
Example
Add the string (e.g., "turning on geofence now") to the serial trace
# trace msg turning on geofence now

T204, Version 01 74 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

7.24.7 trace reset

Syntax
trace reset
Description
Resets the tracing configuration to the factory default values.

© SkyWave Proprietary 75 T204, Version 01

IDP 600 Terminal Series - User's Guide

7.25 type
Syntax
type [-hex] <file>
Description
Display the contents of a file. If the file is a compiled Lua file, then the message
"Compiled lua file" is displayed.
Parameter
[-hex]
Display the file in hexadecimal mode
<file>
File to display
Example
Display what happens when attempting to type a compiled Lua file
shell> type act/svc/svclist.lua
Compiled lua file
Display the same file in hex mode
shell> type -hex act/svc/svclist.lua
000000 1B 4C 75 61 51 00 01 04 04 04 04 04 00 00 00 00 .LuaQ...........
000010 00 00 00 00 00 00 00 00 00 00 02 03 2D 00 00 00 ............-...
000020 05 00 00 00 41 40 00 00 81 80 00 00 1C 40 80 01 ....A@..??...@?.
000030 05 00 00 00 41 C0 00 00 81 00 01 00 1C 40 80 01 ....A?..?....@?.
000040 05 00 00 00 41 40 01 00 81 80 01 00 1C 40 80 01 ....A@..??...@?.
000050 05 00 00 00 41 C0 01 00 81 00 02 00 1C 40 80 01 ....A?..?....@?.
000060 05 00 00 00 41 40 02 00 81 80 02 00 1C 40 80 01 ....A@..??...@?.
000070 05 00 00 00 41 C0 02 00 81 00 03 00 1C 40 80 01 ....A?..?....@?.
000080 05 00 00 00 41 40 03 00 81 80 03 00 1C 40 80 01 ....A@..??...@?.
000090 05 00 00 00 41 C0 03 00 81 00 04 00 1C 40 80 01 ....A?..?....@?.
0000A0 05 00 00 00 41 40 04 00 81 80 04 00 1C 40 80 01 ....A@..??...@?.
0000B0 05 00 00 00 41 C0 04 00 81 00 05 00 1C 40 80 01 ....A?..?....@?.
0000C0 05 00 00 00 41 40 05 00 81 80 05 00 1C 40 80 01 ....A@..??...@?.
0000D0 1E 00 80 00 17 00 00 00 04 08 00 00 00 53 65 72 ..?..........Ser
0000E0 76 69 63 65 00 FE 10 00 00 00 04 07 00 00 00 73 vice.?.........s
0000F0 79 73 74 65 6D 00 FE 1B 00 00 00 04 04 00 00 00 ystem.?.........
000100 69 64 70 00 FE 12 00 00 00 04 08 00 00 00 6D 65 idp.?.........me
000110 73 73 61 67 65 00 FE 17 00 00 00 04 04 00 00 00 ssage.?.........
000120 6C 6F 67 00 FE 16 00 00 00 04 06 00 00 00 72 73 log.?.........rs
000130 32 33 32 00 FE 19 00 00 00 04 04 00 00 00 65 69 232.?.........ei
000140 6F 00 FE 14 00 00 00 04 09 00 00 00 70 6F 73 69 o.?.........posi
000150 74 69 6F 6E 00 FE 13 00 00 00 04 07 00 00 00 72 tion.?.........r
000160 65 70 6F 72 74 00 FE 18 00 00 00 04 0B 00 00 00 eport.?.........
000170 66 69 6C 65 73 79 73 74 65 6D 00 FE 1A 00 00 00 filesystem.?....
000180 04 06 00 00 00 73 68 65 6C 6C 00 FE 15 00 00 00 .....shell.?....
000190 04 09 00 00 00 67 65 6F 66 65 6E 63 65 00 00 00 .....geofence...
0001A0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ..............

T204, Version 01 76 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

Display the content of the file act/user/svclist.lua

shell> type act/user/svclist.lua
Service(128,"test")

© SkyWave Proprietary 77 T204, Version 01

IDP 600 Terminal Series - User's Guide

THIS PAGE INTENTIONALLY LEFT BLANK

T204, Version 01 78 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

8 LED Operation
The LED inside the terminal casing is used as a startup indicator. There are 3 different
rates of LED flashing as shown in Table 3.
Table 3 LED Flash Rates
LED Flash On Time Period Cycles Total Time
Rate
Slow 200 milli-seconds 2 seconds 5 10 seconds
Normal 200 milli-seconds 1 second 10 10 seconds
Fast 50 milli-seconds 250 milli-seconds 40 10 seconds
Different startup conditions determine which flash rate sequence is used as shown in
Table 4.
Table 4 LED Flash Sequences
Startup Condition LED Flash Sequence
Entering pass-through mode Slow flash for 10 seconds
Normal, DTE Connected, no error Normal flash for 10 seconds
Normal, DTE Disconnected, no error Normal flash for 10 seconds
Normal, DTE Connected, Boot ERROR Fast flash for 10 seconds
Normal, DTE Connected, Base ERROR Normal Flash for 5 seconds
Fast flash for 10 seconds
Normal, DTE Disconnected, Boot ERROR Fast flash for 10 seconds
Normal, DTE Disconnected, Base ERROR Fast flash for 10 seconds

© SkyWave Proprietary 79 T204, Version 01

IDP 600 Terminal Series - User's Guide

THIS PAGE INTENTIONALLY LEFT BLANK

T204, Version 01 80 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

Documentation Version
Version Date Details
01 Aug 2011 Official customer release

© SkyWave Proprietary 81 T204, Version 01

IDP 600 Terminal Series - User's Guide

Acronyms/Glossary
API application programming interface
CRC Cyclic Redundancy Check, a type of checksum
DTE data terminal equipment (e.g., computers and serial printers)
EIO external input/output
enum enumeration/enumerated
EPOCH Jan 1st, 1970
I/O input/output
LES land earth station
LSF Lua Services Framework
Lua A robust, fast, embeddable scripting language.
NVM non-volatile memory
RTC real-time clock
Rx receive
SIN service identification number
Tx transmit
UTC Coordinated Universal Time

T204, Version 01 82 © SkyWave Proprietary

 IDP 600 Terminal Series - User's Guide

Index…

boot loader ................................................... 3 IDP-690 ...................................................... 1

boot menu .............................................. 5, 11 IsatData Pro service .................................... 1
CLI ....................See command line interface Lua
command line interface ............................... 4 environment ............................................ 4
command prompts ....................................... 5 parser ...................................................... 5
core services programming .......................................... 5
EIO .......................................................... 6 Lua Services Framework ............................ 5
file system................................................ 6 message format ........................................... 6
geofence................................................... 6 message identification number ................... 6
IDP .......................................................... 6 MIN ....... See message identification number
list of ........................................................ 6 pass-through mode ...................................... 2
log ............................................................ 6 programming .............................................. 1
message ................................................... 6 reference .................................................... ix
position .................................................... 6 service identification number ..................... 6
report ....................................................... 6 services
rs-232 ....................................................... 6 core ..................................................... 5, 6
shell ......................................................... 6 shell......................................................... 4
system ...................................................... 6 user ......................................................... 5
Customer Support ....................................... ii SIN ........... See service identification number
elevation angle ............................................. 1 software architecture................................... 3
enter boot menu ..................................... 5, 11 software tools.............................................. 1
from-mobile message terminals
maximum ................................................. 6 IDP-680 .................................................. 1
hardware ...................................................... 2 IDP-690 .................................................. 1
IDP Developer’s Toolkit ............................ ii to-mobile message
IDP-680 ....................................................... 1 maximum ................................................ 6

© SkyWave Proprietary 83 T204, Version 01

www.SkyWave.com