\\Serial control listens on COM1 with settings of 9600, 8, none, 1, No Flow Control
\\TCP port 27384

Generic Responses:
  @error, "Invalid message format.";
  @error, "Unknown message type.";

Ping
  Format:
    @ping;
  Description:
    Checks to ensure that the player is listening.  Should send an
    "@ok;" message back in response.
  Response:
    @ok;

Upload File
  Format:
    @upload,<file name>,<filesize>;<filedata>
  Description:
    Uploads a file to the player.  The destination folder for the file
    is chosen by the player based on the file extension:
       .lgsc - ".\Schedules" folder
       .lgsq - ".\Sequences" folder
       Recognized image file - ".\Logos" folder
       Other - "." (Application) folder
    The file size is specified in bytes, and the file data is sent
    unformatted after the semicolon.
  Responses:
    @ok;
    @error, "File '<filename>' could not be uploaded, bytes: <bytes read> expected: <bytes expected>";
    @error, "File '<filename>' could not be uploaded, invalid handle returned from a failed attempt to open the file for writing.";
    @error, "Missing file size.";
    @error, "Missing filename.";

Load Schedule
  Format:
    @load,<file name>;
  Description:
    Loads an existing schedule file off of the player's hard drive and
    into memory, ready to be played.
  Responses:
    @ok;
    @error, "File '<filename>' does not exist on the remote machine.";
    @error, "Invalid schedule file";
    @error, "Missing filename.";
    @warning, "Schedule sometimes exceeds the maximum simultaneous elements limit.  Items might sometimes not get drawn.";

Play Active Schedule
  Format:
    @play;
  Description:
    Plays the last schedule that was successfully loaded.
  Responses:
    @ok;
    @error, "No schedule loaded.";

Stop Active Schedule
  Format:
    @stop;
  Description:
    Stops the currently active schedule.
  Responses:
    @ok;

Update Item
  Format:
    @update,<item name>,<update type>,...;
  Description:
    Updates a specific attribute of a specific item in the
    currently active schedule.  The item name, part of the
    information in a schedule file, is used to identify the
    particular item.  Formats for setting specific attributes
    are detailed below.
  Generic Responses:
    @error, "Missing update message type.";
    @error, "Unknown update message type.";
    @error, "Missing update item name.", "Unknown update message type.";

Update Item:  Set Logo
  Format:
    @update,<item name>,logo,<file name>;
  Description:
    Changes the image/data file used for a particular item.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Invalid logo file.";
    @error, "File '<filename>' does not exist on the remote machine.";
    @error, "Missing filename.";

Update Item:  Set Sequence
  Format:
    @update,<item name>,sequence,<file name>;
  Description:
    Changes the sequence file used for a particular item.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Invalid Sequence file.";
    @error, "File '<filename>' does not exist on the remote machine.";
    @error, "Missing filename.";

Update Item:  Show
  Format:
    @update,<item name>,show;
  Description:
    Shows a particular item that was previously hidden.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @warning, "Showing item exceeds the maximum simultaneous elements limit.  Items might sometimes not get drawn.";

Update Item:  Hide
  Format:
    @update,<item name>,hide;
  Description:
    Hides a particular item.  This item will remain hidden until a show
    command is sent for this item, or the schedule is reloaded from the
    hard drive.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";

Update Item:  Set Text
  Format:
    @update,<item name>,text,<text>;
  Description:
    Changes the text for an item that was loaded from a .lgdt file.
  Response;
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Item's logo is an image, not text.";
    @error, "Missing text item.";

Update Item:  Set Font Name
  Format:
    @update,<item name>,fontname,<font name>;
  Description:
    Changes the font for an item that was loaded from a .lgdt file.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Item's logo is an image, not text.";
    @error, "Font '<font name>' does not exist on the remote machine.";
    @error, "Missing font name.";

Update Item:  Set Font Size
  Format:
    @update,<item name>,fontsize,<font size>;
  Description:
    Changes the font size for an item that was loaded from a .lgdt file.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Item's logo is an image, not text.";
    @error, "Missing font size.";

Update Item:  Set Font Bold
  Format:
    @update,<item name>,bold,<bold enabled>;
  Description:
    Changes the font bold style for an item that was loaded from a .lgdt
    file.  The <bold enabled> attribute can be either true or false.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Item's logo is an image, not text.";
    @error, "Missing bold value.";
    @error, "Unrecognized bold value.";

Update Item:  Set Font Italics
  Format:
    @update,<item name>,italics,<italics enabled>;
  Description:
    Changes the font italics style for an item that was loaded from a .lgdt
    file.  The <italics enabled> attribute can be either true or false.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Item's logo is an image, not text.";
    @error, "Missing italics value.";
    @error, "Unrecognized italics value.";

Update Item:  Set Font Underline
  Format:
    @update,<item name>,underline,<underline enabled>;
  Description:
    Changes the font underline style for an item that was loaded from a .lgdt
    file.  The <underline enabled> attribute can be either true or false.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Item's logo is an image, not text.";
    @error, "Missing underline value.";
    @error, "Unrecognized underline value.";

Update Item:  Set Font Strikethrough
  Format:
    @update,<item name>,strikethrough,<strikethrough enabled>;
  Description:
    Changes the font strikethrough style for an item that was loaded from a
    .lgdt file.  The <strikethrough enabled> attribute can be either true or
    false.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Item's logo is an image, not text.";
    @error, "Missing strikethrough value.";
    @error, "Unrecognized istrikethrough value.";

Update Item:  Set Text Vertical Alignment
  Format:
    @update,<item name>,valign,<alignment>;
  Description:
    Changes the vertical alignment for an item that was loaded from a .lgdt
    file.  The <alignment> attribute can be top, center, or bottom.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Item's logo is an image, not text.";
    @error, "Unrecognized alignment value.";
    @error, "Missing alignment value.";

Update Item:  Set Text Horizontal Alignment
  Format:
    @update,<item name>,halign,<alignment>;
  Description:
    Changes the horizontal alignment for an item that was loaded from a .lgdt
    file.  The <alignment> attribute can be left, center, or right.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Item's logo is an image, not text.";
    @error, "Unrecognized alignment value.";
    @error, "Missing alignment value.";

Update Item:  Set Foreground Color
  Format:
    @update,<item name>,forecolor,<red>,<green>,<blue>;
  Description:
    Changes the foreground color of a particular item.  The color is specified
    using the three components red, green, and blue.  Each value can range from
    0 to 255.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Missing some or all color component values.";

Update Item:  Set Foreground Opacity
  Format:
    @update,<item name>,foreopacity,<opacity>;
  Description:
    Changes the foreground opacity of a particular item.  A value of 0 is fully
    transparent, while a value of 255 is fully opaque.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Missing opacity value.";

Update Item:  Set Scale
  Format:
    @update,<item name>,scale,<x scale>,<y scale>;
  Description:
    Changes the horizontal and vertical scale of an item.  A value of 1.0 for
    each dimension will scale the item to its natural size.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Missing one or both scale values.";

Update Item:  Set Translation
  Format:
    @update,<item name>,translate,<x translate>,<y translate>,<z translate>;
  Description:
    Changes the translation of an item.  A value of 0.0 will keep the item
    in its natural location.  Positive values will translate it to the right
    or down, and negative values will translate it to the left or up.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Missing one or both translation values.";

Update Item:  Set Background Visibility
  Format:
    @update,<item name>,backvisible,<visible>;
  Description:
    Sets whether or not the solid background is visible behind the itme.
    <visible> can be either true or false.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";

Update Item:  Set Background Color
  Format:
    @update,<item name>,backcolor,<red>,<green>,<blue>;
  Description:
    Changes the background color of a particular item.  The color is specified
    using the three components red, green, and blue.  Each value can range from
    0 to 255.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Unrecognized visibility value.";
    @error, "Missing visibility value.";

Update Item:  Set Background Opacity
  Format:
    @update,<item name>,backopacity,<opacity>;
  Description:
    Changes the background opacity of a particular item.  A value of 0 is fully
    transparent, while a value of 255 is fully opaque.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Missing opacity value.";

Update Item:  Set Background Scale
  Format:
    @update,<item name>,backscale,<x scale>,<y scale>;
  Description:
    Changes the horizontal and vertical scale of the background for an item.  A
    value of 1.0 for each dimension will scale the item to its natural size.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Missing one or both scale values.";

Update Item:  Set Background Translation
  Format:
    @update,<item name>,backtranslate,<x translate>,<y translate>,<z translate>;
  Description:
    Changes the translation of the background for an item.  A value of 0.0 will
    keep the item in its natural location.  Positive values will translate it to
    the right or down, and negative values will translate it to the left or up.
  Response:
    @ok;
    @error, "Item '<item name>' does not exist in the current schedule.";
    @error, "Missing one or both translation values.";

Update Item:  Set Start Date
  Format:
    @update,<item name>,startdate,<date>;
  Description:
    Changes the start date associated with the item.  <date> is in the format
    <month>/<day>/<year>.
  Responses:
    @ok;
    @error, "Missing date value.";
    @warning, \"Adjusted date exceeds the maximum simultaneous elements limit.  Items might sometimes not get drawn.\";

Update Item:  Set End Date
  Format:
    @update,<item name>,enddate,<date>;
  Description:
    Changes the end date associated with the item.  <date> is in the format
    <month>/<day>/<year>.
  Responses:
    @ok;
    @error, "Missing date value.";
    @warning, \"Adjusted date exceeds the maximum simultaneous elements limit.  Items might sometimes not get drawn.\";

Update Item:  Set Start Time
  Format:
    @update,<item name>,starttime,<time>;
  Description:
    Changes the start time associated with the item.  <time> is in the format
    <24 hour>:<minute>:<day>.
  Responses:
    @ok;
    @error, "Missing time value.";
    @warning, \"Adjusted time exceeds the maximum simultaneous elements limit.  Items might sometimes not get drawn.\";

Update Item:  Set End Time
  Format:
    @update,<item name>,endtime,<time>;
  Description:
    Changes the end time associated with the item.  <time> is in the format
    <24 hour>:<minute>:<day>.
  Responses:
    @ok;
    @error, "Missing time value.";
    @warning, \"Adjusted time exceeds the maximum simultaneous elements limit.  Items might sometimes not get drawn.\";

Update Item:  Set Repetition Time
  Format:
    @update,<item name>,repetition,<ti>;
  Description:
    Changes the repetition time associated with the item.  <time> is in the \
    format <24 hour>:<minute>:<day>.
  Responses:
    @ok;
    @error, "Missing time value.";
    @warning, \"Adjusted time exceeds the maximum simultaneous elements limit.  Items might sometimes not get drawn.\";

Start Instant Sequence
  Format:
    @instantsequence,<logo file name>,<sequence file name>;
  Description:
    Starts an playing a logo/sequence pair instantly.  This will be the only this
    that is drawn, and will use the sequence's duration as the repetition time.
  Response:
    @ok;
    @error, "Logo File '<filename>' does not exist on the remote machine.";
    @error, "Sequence File '<filename>' does not exist on the remote machine.";
    @error, "Invalid logo file.";
    @error, "Wrong number of parameters.";
    @error, "File '<temp schedule filename>' does not exist on the remote machine.";
    @error, "Invalid schedule file.";
    @warning, "Schedule sometimes exceeds the maximum simultaneous elements limit.  Items might sometimes not get drawn.\";

Get Schedules List
  Format:
    @getschedules;
  Description:
    Returns a list of all schedule files on the remote machine.
  Responses:
    @ok, <filename>, <filename>, ..., <filename>;
    @error, "No files found.";

Get Logos List
  Format:
    @getlogos;
  Description:
    Returns a list of all logo files on the remote machine.
  Responses:
    @ok, <filename>, <filename>, ..., <filename>;
    @error, "No files found.";

Get Sequences List
  Format:
    @getsequences;
  Description:
    Returns a list of all sequence files on the remote machine.
  Responses:
    @ok, <filename>, <filename>, ..., <filename>;
    @error, "No files found.";

Start Instant Item
  Format:
    @startinstantitem,<name>,<logo file name>,<sequence file name>,<start date>,<end date>,<start time>,<end time>,<repetition>,<duration>,<hide others>;
  Description:
    Starts playing a logo/sequence pair instantly, with the specified
    parameters for timing.  Dates follow the <month>/<day>/<year> format,
    and times follow the <24 hour>:<minute>:<second> format.  The duration
    specifies how long this instant item should remain valid, after which
    it is completely forgotten.  The hide others parameter can be either
    true or false, and determines whether or not all other items are
    completely hidden while this item is drawn.
  Responses:
    @ok;
    @ok, "Previous instant item replaced with new instant item.";
    @error, "Either the logo or the sequence could not be loaded for the instant item.";
    @error, "Missing time value.";

Stop Instant Item
  Format:
    @stopinstantitem;
  Description:
    Stops a previous started instant item.
  Response:
    @ok;
    @warning, "No instant item exists to be stopped.";

Enable GPI
  Format:
    @gpi_enable;
  Description:
    Enables GPI functionality.
  Response:
    @ok;
    @ok, "GPI already enabled.";

Disable GPI
  Format:
    @gpi_disable;
  Description:
    Disables GPI funcionality.
  Responses:
    @ok;
    @ok, "GPI already disabled.";

Get GPI Enabled Status
  Format:
    @gpi_isenabled;
  Description:
    Requests whether or not the GPI funcionality is currently enabled.
  Responses:
    @ok, True;
    @ok, False;

Get GPI Pin Count
  Format:
    @gpi_getnumpins;
  Description:
    Requests the number of pins that are used for GPI.
  Responses:
    @ok, <pin count>;

Set GPI Pin Count
  Format:
    @gpi_setnumpins,<pin count>;
  Description:
    Sets the number of pins that are used for GPI.
  Responses:
    @ok;
    @error, "Number of pins must be between 0 and 8, inclusive.";
    @error, "Missing number of pins value.";

Get GPI Pin Action
  Format:
    @gpi_getpinaction,<pin index>;
  Description:
    Requests the action associated with a particular pin.
  Responses:
    @ok, <action>, <paramters>;
    @error, "Pin index must be between 0 and <pin count minus 1>, inclusive.";
    @error, "Missing pin index.";

Set GPI Pin Action
  Format:
    @gpi_setpinaction,<pin index>,<action>,<parameters>;
  Description:
    Sets the action associated with a particular pin.
  Responses:
    @ok;
    @error, "Pin index must be between 0 and <pin count minus 1>, inclusive.";
    @error, "Missing one or more parameters.";