Home > Room Engine > Room Engine Communication Protocol (RETCPComm)

Room Engine Communication Protocol (RETCPComm)

An explanation of RETCPComm
By 14/01/11 [Last Edited by Joseph 18/01/11]
BOOKMARK
LOGIN
REGISTER
The Room Engine Communication Protocol (RETCPComm) is a character-based communication protocol over TCP/IP used between the Room Engine Server (REServ) and any interface modules, such as the Speech Module or the iPhone Web App.

Protocol Outline

A 5-part string delimited with full stops in the form of x.x.x.x.x is a command string sent from the interface to REServ. REServ will return a simple, single string or character per line feed. A character based protocol was chosen for ease of formatting data for transmission, and to make life easier when dealing with PHP.
  • connection.
    • close
    • getuser
    • getusernum
    • getremotehost
    • echo.text
    • speech
  • board.
    • check
    • sendoutput.output_byte
    • getoutput
    • getindvoutput.appliance_id
    • toggle.appliance_id
  • settings.
    • buzzwords.
      • get.appliance_number
      • set.appliance_number.new_buzzword
    • password.
      • set.new_password
    • triggerword.
      • get
      • set.new_triggerword
    • failover.
      • get
      • set.new_failover_state
  • schedules.
    • get.schedule_id.appliance_id
    • set.schedule_id.appliance_id.appliance_state
    • getenabled.schedule_id
    • setenabled.schedule_id.enabled
    • gettime.schedule_id
    • settime.schedule_id.time