Difference between revisions of "Developer:LPEC"
| Line 1: | Line 1: | ||
= Introduction<br> = | = Introduction<br> = | ||
| − | This article provides the specification of the ''Linn Protocol for Eventing and Control'' | + | This article provides the specification of the ''Linn Protocol for Eventing and Control'', which is a TCP/IP point-2-point protocol that can be used to control Linn's home network products (e.g. DS players).<br> |
| − | + | The primary means of control for such products is, of course, UPnP. But LPEC provides an alternative mechanism for accessing UPnP services over a basic "telnet-like" protocol. | |
The UPnP architecture subdivides product control into smaller named units called "services". A DS player, for instance, will provide some standard UPnP AV services:<br> | The UPnP architecture subdivides product control into smaller named units called "services". A DS player, for instance, will provide some standard UPnP AV services:<br> | ||
| Line 18: | Line 18: | ||
* Ui | * Ui | ||
| − | + | By opening a raw TCP/IP socket connection to port 23 of a Bute (or later) home network product, these same services can be controlled using ''Linn Protocol for Eventing and Control''.<br> | |
| − | |||
| − | |||
The rest of this article describes the format of the messages that LPEC expects and delivers. Examples are given.<br> | The rest of this article describes the format of the messages that LPEC expects and delivers. Examples are given.<br> | ||
Revision as of 11:57, 1 July 2008
Contents
Introduction
This article provides the specification of the Linn Protocol for Eventing and Control, which is a TCP/IP point-2-point protocol that can be used to control Linn's home network products (e.g. DS players).
The primary means of control for such products is, of course, UPnP. But LPEC provides an alternative mechanism for accessing UPnP services over a basic "telnet-like" protocol.
The UPnP architecture subdivides product control into smaller named units called "services". A DS player, for instance, will provide some standard UPnP AV services:
- AVTransport
- RenderingControl
- ConnectionManager
and additional Linn-specific services, such as:
- Ds
- Volkano
- Product
- Ui
By opening a raw TCP/IP socket connection to port 23 of a Bute (or later) home network product, these same services can be controlled using Linn Protocol for Eventing and Control.
The rest of this article describes the format of the messages that LPEC expects and delivers. Examples are given.
Connection
LPEC can be accessed by connecting a raw socket session to port 23 of the device.
Control
Each service contains actions, which are like methods that can be called on the device with input and output arguments.
An action can be perfomed by sending a message of the following form:
ACTION [sub-device]/[type] [version] [action] "[inarg1]" "[inarg2]" ... "[inargn]"
e.g.
ACTION MediaRenderer/RenderingControl 1 SetVolume "0" "Master" "50"
All messages sent using LPEC get a response. The response to an ACTION message is a RESPONSE message that reports the values of all the output arguments:
RESPONSE "[outarg1]" "[outarg2]" ... "[outargn]"
The SetVolume example given above has no output arguments, so the message received will simply be a <CR><LF> terminated RESPONSE message.
The following subsequent interaction better illustrates the RESPONSE message:
ACTION MediaRenderer/RenderingControl 1 GetVolume "0" "Master"
RESPONSE "50"
It should be mentioned that all input and output arguments are escaped according to XML escaping rules and enclosed in double-quotes.
Eventing
In order to subscribe to a service's events, issue a SUBSCRIBE message of the following form:
SUBSCRIBE [sub-device]/[type]
The device responds with:
SUBSCRIBE [subscription-id]
and follows this with an initial event message, which contains the current state of all the service's evented variables:
EVENT [subscription-id] 0 [var1-name] "[var1]" [var2-name] "[var2]" ... [varn-name] "[varn]"
e.g
SUBSCRIBE Ds/Product
SUBSCRIBE 49
EVENT 49 0 ProductName "Sneaky Music DS" ProductRoom "Main Room" ProductStandby "true" ProductSourceIndex "0"
Subsequent changes to the service's evented variables cause unsolicited EVENT messages to be sent from the device of the form:
EVENT [subscription-id] [sequence-no] [var1-name] "[var1]" [var2-name] "[var2]" ... [varn-name] "[varn]"
Only those variables that have changed value are reported.
The sequence number is a 32-bit unsigned number which increments with each event message and wraps around to 1.
A sequence number of 0 is reserved for the initial EVENT message, which contains the current state of all the services' evented variables (see above)
By issuing multiple SUBSCRIBE messages, it is possible to subscribe to up to 16 services simultaneously.
In order to unsubscribe from a service, send an UNSUBSCRIBE message of the form:
UNSUBSCRIBE [subscription-id]
alternatively:
UNSUBSCRIBE [sub-device]/[type]
or, to unsubscribe from all previous subscriptions, just:
UNSUBSCRIBE
In all instances, the response will be:
UNSUBSCRIBE [subscription-id]
When using the form that unsubscribes from all previous subscriptions, multiple UNSUBSCRIBE responses may be received.
e.g.
UNSUBSCRIBE
UNSUBSCRIBE 62
UNSUBSCRIBE 61
Discovery
Although LPEC does not include a mechanism for discovering devices across a home network, it does contain a mechanism for knowing about the sub-devices within a single product.
When an LPEC connection is made, the device sends an ALIVE messages for each sub-device that is currently available:
ALIVE [sub-device] [udn]
e.g. (from a Sneaky Music DS)
ALIVE Ds 4c494e4e-0050-c221-71e5-df000003013f
ALIVE Preamp 4c494e4e-0050-c221-71e5-df0000030133
ALIVE MediaRenderer 4c494e4e-0050-c221-71e5-df0000030171
It is possible for these sub-devices to be disabled and enabled during the normal operation of a product. If this occurs, further BYEBYE and ALIVE messages are issued accordingly.
If a device is rebooted, the appropriate BYEBYE messages are sent and the LPEC connection is closed by the device.
When a sub-device is disabled, all subscriptions to the services on that sub-device are forcibly revoked. A BYEBYE message may therefore have a number of unsolicited UNSUBSCRIBE messages preceding it.
Errors
After sending an ACTION, SUBSCRIBE, or UNSUBSCRIBE message, it is possible to receive an ERROR message of the form:
ERROR [code] "[description]"
The following errors are defined:
ERROR 101 "Command not recognised"
ERROR 102 "Service not specified"
ERROR 103 "Service not found"
ERROR 104 "Version invalid"
ERROR 105 "Version not specified"
ERROR 106 "Version not supported"
ERROR 107 "Method not specified"
ERROR 108 "Method execution exception"
ERROR 201 "Boolean argument invalid"
ERROR 202 "String argument invalid"
ERROR 203 "Unsigned numeric argument invalid"
ERROR 204 "Signed numeric invalid"
ERROR 205 "Binary argument invalid"
ERROR 206 "Invalid argument escaping"
ERROR 301 "Argument list incomplete"
ERROR 302 "Argument not quoted"
ERROR 303 "Argument incomplete"
ERROR 401 "Already subscribed"
ERROR 402 "Client has too many subscriptions"
ERROR 403 "Service has too many subscriptions"
ERROR 404 "Subscription not found"
ERROR 405 "Service not subscribed"
ERROR 406 "Invalid XML escaping"
Action-specific error messages may also be sent.
Examples
Play, Pause, Skip a DS player using the UPnP AVTransport service:
ACTION MediaRenderer/AVTransport 1 Play "0" "1"
ACTION MediaRenderer/AVTransport 1 Pause "0"
ACTION MediaRenderer/AVTransport 1 Next "0"
ACTION MediaRenderer/AVTransport 1 Previous "0"
Get the volume of a Linn pre-amplifier using the Linn Preamp service
ACTION Preamp/Preamp 1 Volume
RESPONSE "40"
Set mute on a Linn pre-amplifier using the Linn Preamp service
ACTION Preamp/Preamp 1 SetMute "true"
RESPONSE
Other Considerations
If a control point closes an LPEC session, all outstanding subscriptions are automatically cleaned up by the device.
Each product supports only one concurrent LPEC session.
