sd/README_REMOTE

   1 LibreOffice Impress Remote Protocol Specification
   2
   3 Communication is over a UTF-8 encoded character stream.
   4 (Using RTL_TEXTENCODING_UTF8 in the LibreOffice portion.)
   5
   6 TCP
   7 ---
   8
   9 More TCP-specific details on setup and initial handshake to be
  10 written, but the actual message protocol is the same as for Bluetooth.
  11
  12
  13 Bluetooth
  14 ---------
  15
  16 Bluetooth communication is over RFCOMM.
  17
  18 For discovery use the "standard UUID for the Serial Port Profile"
  19 I.e. the 16-bit SerialPort UUID 0x1101,
  20 or if necessary inserted into the Bluetooth BASE_UUID:
  21 00001101-0000-1000-8000-00805F9B34FB
  22 See https://www.bluetooth.org/Technical/AssignedNumbers/service_discovery.htm
  23
  24 Message Format
  25 --------------
  26
  27 A message consists of one or more lines. The first line is the message description,
  28 further lines can add any necessary data. An empty line concludes the message.
  29
  30 I.e. "MESSAGE\n\n" or "MESSAGE\nDATA\nDATA2...\n\n"
  31
  32 You must keep reading a message until an empty line (i.e. double
  33 new-line) is reached to allow for future protocol extension.
  34
  35 Intialisation
  36 -------------
  37
  38 Once connected the server sends "LO_SERVER_SERVER_PAIRED".
  39 (I.e. "LO_SERVER_SERVER_PAIRED\n\n" is sent over the stream.)
  40
  41 Subsequently the server will send either slideshow_started if a slideshow is running,
  42 or slideshow_finished if no slideshow is running. (See below for details of.)
  43
  44 The current server implementation then proceeds to send all slide notes and previews
  45 to the client. (This should be changed to prevent memory issues, and a preview
  46 request mechanism implemented.)
  47
  48
  49 Commands (Client to Server)
  50 ---------------------------
  51
  52 The client should not assume that the state of the server has changed when a
  53 command has been sent. All changes will be signalled back to the client.
  54 (This is to allow for cases such as multiple clients requesting different changes, etc.)
  55
  56 Any lines in [square brackets] are optional, and should be omitted if not needed.
  57
  58 * transition_next
  59 * transition_previous
  60
  61 * goto_slide
  62   slide_number
  63
  64 * presentation_start
  65 * presentation_stop
  66
  67 * presentation_resume       // Resumes after a presentation_blank_screen.
  68 * presentation_blank_screen
  69   [Colour String]           // Colour the screen will show (default: black). Not
  70                             // implemented, and format hasn't yet been defined.
  71
  72 # As of gsoc2013, these commands are extended to the existing protocol, since server-end are tolerant with unknown commands, these extensions doesn't break backward compatibility
  73 * pointer_started           // create a red dot on screen at initial position (x,y)
  74   initial_x                 // This should be called when user first touch the screen
  75   initial_y                 // note that x, y are in percentage (from 0.0 to 1.0) with respect to the slideshow size
  76 * pointer_dismissed         // This dismiss the pointer red dot on screen, should be called when user stop touching screen
  77 * pointer_coordination      // This update pointer's position to current (x,y)
  78   current_x                 // note that x, y are in percentage (from 0.0 to 1.0) with respect to the slideshow size
  79   current_y                 // unless screenupdater's perfomance is significantly improved, we should consider limit the update frequency on the
  80                             // remote-end
  81
  82
  83
  84 Status/Data (Server to Client)
  85 ------------------------------
  86
  87 * slideshow_finished    // (Also transmitted if no slideshow running when started.)
  88
  89 * slideshow_started     // (Also transmitted if a slideshow is running on startup.)
  90   numberOfSlides
  91   currentSlideNumber
  92
  93 * slide_notes
  94   slideNumber
  95   [Notes]               // The notes are an html document, and may also include \n newlines,
  96                         // i.e. the client should keep reading until a blank line is reached.
  97
  98 * slide_updated         // Slide on server has changed
  99   currentSlideNumber
 100
 101 * slide_preview         // Supplies a preview image for a slide.
 102   slideNumber
 103   image                 // A Base 64 Encoded png image.
 104
 105 # As of gsoc2013, these commands are extended to the existing protocol, since remote-end also ignore all unknown commands (which is the case of gsoc2012 android implementation), backward compatibility is kept.
 106 * slideshow_info        // once paired, the server-end will send back the title of the current presentation
 107   Title