Rivendellaudio/conf/rlm_serial.conf
2014-08-12 15:13:02 -04:00

130 lines
5.1 KiB
Plaintext

; rlm_serial.conf
;
; This is the sample configuration file for the 'rlm_serial' module for
; Rivendell, which can be used to output Now & Next data via one or more
; serial ports.
;
; To enable this module, add it to the 'Loadable Modules' list in
; RDAdmin->ManageHosts->RDAirPlay->ConfigureNow&Next. The 'Argument'
; field should point to the location of this file.
;
; NOTE: The serial ports configured here have NOTHING TO DO with the
; ports configured in RDAdmin! These ports are used strictly by the
; 'rlm_serial' plugin, and will not be usable by any other Rivendell
; component.
; Section Header
;
; One per serial device to be configured, starting with 'Serial1' and
; working up consecutively
[Serial1]
; Serial Device
;
; The device file that corresponds to the serial device.
Device=/dev/ttyS0
; Serial Baud Rate (in bps)
Speed=9600
; Parity (0=none, 1=even, 2=odd)
Parity=0
; Number of bits per data 'word'.
WordSize=8
; Format String. The string to be output each time RDAirPlay changes
; play state, including any wildcards as placeholders for metadata values.
; The following wildcards are available:
;
; Now Next Field
; --------------------------------------------------------------------------
; %n %N The Rivendell cart number
; %h %H Event length (in milliseconds)
; %g %G The Rivendell group name
; %t %T Title
; %a %A Artist
; %l %L Album
; %y %Y Year
; %b %B Record Label
; %c %C Client
; %e %E Agency
; %m %M Composer
; %p %P Publisher
; %r %R Conductor
; %s %S Song ID
; %u %U User Definied
; %o %O Outcue
; %i %I Description
; \r \r Carriage Return (ASCII 13)
; \n \n Linefeed (ASCII 10)
; %d(<dt>) %D(<dt>) The start date/time, formatted according to <dt>. The
; following wildcards are available for <dt>:
; d - The day as a number without a leading zero (1 to 31).
; dd - The day as a number with a leading zero (01 to 31).
; ddd - The abbreviated localized day name ('Mon' or 'Sun').
; dddd - The long localized day name ('Monday' or 'Sunday').
; M - The month as a number without a leading zero
; (1 to 12).
; MM - The month as a number with a leading zero (01 to 12).
; MMM - The abbreviated localized month name ('Jan' or 'Dec').
; MMMM - The long localized month name ("January' or
; 'December').
; yy - The last two digits of the year.
; yyyy - The full four digits of the year.
; h - The hour without a leading zero (0 - 23, or 1 - 12
; if using AM/PM display).
; hh - The hour with a leading zero (00 - 23, or 01 -12 if
; using AM/PM display).
; m - The minute without a leading zero (0 - 59).
; mm - The minute with a leading zero (00 - 59).
; s - The second without a leading zero (00 - 60).
; ss - The second with a leading zero (00 - 60).
; z - The milliseconds without a leading zero (0 - 999).
; zzz - The milliseconds with leading zeros (000 - 999).
; AP - Use AM/PM display. The 'AP' will be replaced by
; 'AM' or 'PM' as appropriate.
; ap - Use AM/PM display. The 'ap' will be replaced by
; 'am' or 'pm' as appropriate.
FormatString=NOW: %d(ddd MMM d hh:mm:ss yyyy): %t - %a\nNEXT: %D(ddd MMM d hh:mm:ss yyyy): %T - %A\n
; Encoding. Defines the set of escapes to be applied to the PAD fields.
; The following options are available:
;
; 0 - Perform no character escaping.
; 1 - "XML" escaping: Escape reserved characters as per XML-v1.0
; 2 - "Web" escaping: Escape reserved characters as per RFC 2396 Section 2.4
Encoding=0
; Null Update Handling. Defines how 'null' updates --i.e. those with a cart
; number of '0' -- should be handled.
;
; 0 - Process all updates regardless of cart values.
; 1 - Process update only if the 'now' cart is not null.
; 2 - Process update only if the 'next' cart is not null.
; 3 - Process update only if both the 'now' and 'next' carts are not null.
ProcessNullUpdates=0
; Log Selection
;
; Set the status for each log to 'Yes', 'No' or 'Onair' to indicate whether
; state changes on that log should be output on this serial port. If set
; to 'Onair', then output will be generated only if RDAirPlay's OnAir flag
; is active.
MasterLog=Yes
Aux1Log=Yes
Aux2Log=Yes
; Additional serial ports can be configured by adding new sections...
;[Serial2]
;Device=/dev/ttyS1
;Speed=9600
;Parity=0
;WordSize=8
;FormatString=%t
;ProcessNullUpdates=0
;MasterLog=Yes
;Aux1Log=No
;Aux2Log=Onair