How to use

Green stuff is new in EtiVo 0.1.1101

Go to EtiVoWeb to see how the graphical UI looks.

Once it's up and running, you can connect to it via a simple telnet session - by default, the port it will listen on is 6969.

So after running:

telnet localhost 6969

You will get the following:

At this stage, there are a couple of commands you can execute:

Commands

Note about U-Commands. Some commands will get a "URL-Argument" - that means that it comes in the form of a URL Get parameter. The URL needs to be encoded by proper URL encoding rules. It basically looks like this:

uenq key1=val1&key2=val2&key3=val3

etc..

Command	Meaning
*del {method} {show-id}*	Deletes a show from EtiVo. Method can be either PERM, SPEC or REMOVE. PERM: Will remove the show permanently - any show with the same signature will never be re-encoded. SPEC: Will remove the show - if the show is still on TiVo, that show specifically will not be reencoded. But once a show with the same signature appears, it will be encoded (good for getting rid of bad recordings w/o deleting the show from TiVo). REMOVE: Simply removes the show. If it's on the TiVo, it will be reencoded. Example: del perm {some show}
le	Lists the available encoder files.
*list {filter}*	Lists the available shows. This may take some time if they are not currently cached. Adding a filter will return only shows who's name contains the string. Example: list simpsons
*uenq {URL-string}*	Enques a show. ShowName: The id of the show (just like the enq command) WmeFile: The Wme file to use. Example: uenq showname={...}&wmefile=wmvlow.wme
*cat*	Creates an AutoTiVo entry. Example: cat
*dat {autotivo id}*	Deletes an AutoTiVo entry. Example: dat f0ae5d18-9872-437b-8b07-c9ad1125d017
*lat*	Lists the AutoTiVo entries Example: lat
*sat {URL-string}*	Sets an AutoTiVo list. id: The id of the autotivo entry. title: The title of the show. Can be a "" wildcard. episodename: The episode name. Can be used with a "" wildcard. channel: The channel call sign. airstart, airend: Start/end of airdate (mm/dd/yyyy) compstart, compend: Start/end of the complete date (mm/dd/yyyy) active: true/false - denotes if this AutoTiVo entry is active. moveto: numeric - where to place this autotivo entry in. Example: sat id=f0ae5d18-9872-437b-8b07-c9ad1125d017&title=trek&episodename=khan Will record any show with Trek in it's name and with Khan in it's episode.
lt	Lists all titles. Example: lt
list {filter}	Lists the available shows. This may take some time if they are not currently cached. Adding a filter will return only shows who's name contains the string. Example: list simpsons
enq <item>	Enqueues a show. Note that the name of the show should be the string that appears under the ShowName element that returns from the list command. Example: enq {The Simpsons}{1995-11-05}{King-Size Homer}{KCPQ}
lq	Lists the items currently queued up for fetching or encoding.
lc	Lists the items that were complete since the EtiVo service has booted.
quit	Quits
stat	Returns statistics about the EtiVo
lr	Lists the "ready" shows - these shows have already been encoded.
prompt {promptstring}	Changes the prompt. Passing nothing for promptstring will turn the prompt to nothing.
autotivo {on\|off}	Enables or disables the autotivo feature. Typing autotivo with no parameter will return whether or not autotivo is active.
resautotivo	Resets the timer that EtiVo uses to figure out when to reset the list that the list command returns.
ln	List the notifications that are in the system.
cn	Create a new notification. Note that a created notification is empty and inactive.
sn <id> <property> <new value>	Sets a property of a notification. See Notifications instructions on how to use this feature.
dn <id>	Delete a notification.
password <password>	If your EtiVo is password protected, before doing any work in a session, you must enter the password by using this command.
pri <show name>	Running this command will give the show higher priority than other shows.

Status values

Status/Sub Status	Meaning
Not in Queue	Item is not queued at all.
Pending	Item is waiting to be fetched from TiVo.
Processing	Item is being processed (this is when you will see a sub-status).
Fetching	Item is being fetched from the TiVo currently.
Encoding	Item is being encoded.
Success	Item has been successfully processed.
Failure	Item has failed to process

List functionality

The lists that list, lc and lq display follow the following format:

<ShowQueueItem>
    <ShowName>{The Simpsons}{1995-11-05}{King-Size Homer}{KCPQ}</ShowName>
    <Source>
        {The Simpsons}{1995-11-05}{King-Size Homer}{07.30 PM Mon Mar 08, 2004}{KCPQ}
    </Source>
    <Status>NotInQueue</Status>
    <StartTime>Monday, January 01, 0001 12:00 AM</StartTime>
    <LastStatusChange>Thursday, April 29, 2004 12:40 AM</LastStatusChange>
</ShowQueueItem>

Notifications

EtiVo looks at the list of notification whenever a file completes encoding. If one of the filters set there fits, it will send an email to the address specified in the notification with show information.

The following explains how to manage notifications. EtiVoWeb gives a very easy-to-use interface for managing notifications.

Creating a notification

To create a notification, execute the cn command. The response will something like:

This is the ID of the new notification. You can now set how the notification behaves.

Setting a notification

Setting properties of a notification uses the sn command.

sn <id> <property> <new value>

So, if you want a notification to be on all shows that have the title of "The Simpsons", do the following:

sn f0ae5d18-9872-437b-8b07-c9ad1125d017 showname The Simpsons

To set what emails notifications should be sent to, use the following command:

sn f0ae5d18-9872-437b-8b07-c9ad1125d017 email me@myemailserver.com

Also, all notifications are created inactive. To make sure the notification actually works, you need to activate it:

sn f0ae5d18-9872-437b-8b07-c9ad1125d017 active true

The following table explains all the settable properties of a notification:

Property name	Explanation	Example
showname	Filter notifications by the title of the show. The example will notify on any show that is called "cops".	sn <id> showname cops
episodename	Filter notifications by the name of the episode. The example will notify on any show in which the episode is called "Troubles".	sn <id> episodename Troubles
channel	Filter notifications by a channel name. The example will notify on any show that is recorded from ESPN.	sn <id> channel ESPN
options	You can either have a notification as permanent - in which case it will keep notifying you each time a new show that fits the filter was encoded, or as a one-time thing, in which case the notification will be deleted.	sn <id> options permanent sn <id> options once
active	You can deactivate and activate notifications. Deactivated notifications are ignored. Note that when you create a new notification, it's inactive.	sn <id> active true sn <id> active false
email	You can set what email the notifications will be sent to.	sn <id> email me@somewhere.com

Listing notifications

To see the list of all notifications, simply hit "ln". This will list all of them in XML format.

Deleting a notification

To delete a notification, tell EtiVo to "dn" with the appropriate id and the notification will be deleted.

So what happens when an item is processed?

Just look here.