Plugins

Introduction

The Java version of the emulator uses a plugin architecture.
The emulator can run without any plugin and will just reply to head unit commands enough to make the SPDIF input available.
The active plugins are defined in the TLCDCEmu.properties file (text file). The syntax is :
All events coming from HU are dispatched to all plugins in turn.
All plugins are given the opportunity to store a reference to the current PlayingStatus object, that they are allowed to read and modify. Warning though, if multiple Plugins are modifying that object, result is undefined

Currently available plugins

Logical Plugin 

Class

Status

Obsolete

Purpose

This plugins simulates an actual 20-track CDs of 60 minutes (20 x 3 minutes) is playing, taking passing time into account, and responds in a logical manner to HU commands (change tracks, ffwd, etc.). So if you let your HU connected to the emulator with the Logical Plugin, you'll see track increment every 3 minutes. If you press FFWD, time passes 5 times faster. If you press NEXT, the emulator skips to start of next track, etc.

Changes the playing status ?

Yes

GUI Plugin 

Class

Status

For debugging only

Purpose

This plugin opens a debug window showing received messages and allowing to fetch and display the current playing status, and modify it as well.

Changes the playing status ?

Yes

Executor Plugin

Class

Status

OK

Purpose

This plugin executes external programs (optionally with arguments) for each HU event. All commands are defined by default in the file ExecutorPlugin.properties and have the following syntax :
e.g.
(Note that backslash characters must be escaped by doubling them)
An event can be explicitely ignored by defining it as follows :

Changes the playing status ?

No

RoadRunner Plugin

Class

Status

OK

Purpose

This plugin is specifically targetted at RoadRunner, an excellent carPC front-end developed by Guino.
First, each HU event can be associated to a RoadRuner command tto be executed. All commands are defined in the file RRPlugin.properties and have the following syntax :
e.g.
Possible values for <rrcommand> are defined at the end of file "Skin Commands.txt" included with RoadRunner.
An event can be explicitely ignored by defining it as follows :
Second, the plugin also refreshes the track number of the playing status according to the position of the currently played song in Winamp.

Changes the playing status ?

Yes

Want more ?

Well, more plugins are on their way, but you can write yours too.
Simply extend the org.tlcdcemu.plugin.Plugin class and override methods as you like. The most useful one is onCommand() of course.

if you feel it deserves it...

This project is hosted by