Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • CHANGE_METER_COUNTER_VALUE_RESP (Message type: Control) – this message is sent from client to server to response on message CHANGE_METER_COUNTER_VALUE_REQ. If request is accepted by client response should have status ok. If not, response should contain error.   

    • Payload:   

      • status – <bool> if message was accepted by client it should be true, if error status should be false   

      • Error code - <int> if message was accepted by client it should be 0, if error occurred, error code should be on of available error codes   

      • error - <string> if message was accepted by client it should be empty, if error occurred, error should contain error description.   

    • Example message (json):   

      • {\"header\":{\"messageId\":20,\"messageName\":\"CHANGE_METER_COUNTER_VALUE_RESP\",\"messageType\":\"CONTROL\"},\"payload\":{\"error\":\"\",\"errorCode\":0,\"status\":true}}  

  • CHANGE_TOTAL_METER_COUNTER_VALUE_REQ (Message type: Control) – same as CHANGE_METER_COUNTER_VALUE_REQ, but for total meter counter

    • Payload:   

      • value – <double> new meter counter value   

      • unit – <string> unit of meter counter can be “ft” or “m”   

  • CREATE_FREE_TEXT (Message type: OSD) – this message is sent from client to server to display free text using software OSD on the live video stream in ProTouch.  

    • Payload:  

      • text: <string> content of the message, 

      • x: <number> integer informing about the column in which the text should appear, 

      • y: <number> integer informing about the row in which the text should appear, 

      • visible: <number> range [1;100] informing about the time that value should display for, 

      • textColor: <Color> color of text, 

      • backColor: <Color> color of background.  

    • Example message (json):  

      • {\"header\":{\"messageId\":2,\"messageName\":\"CREATE_FREE_TEXT \",\"messageType\":\"OSD\"},\"payload\":{\"text\":\"messageText76\",\"x\":2,\"y\":4,\”visible\":6,\"textColor\":\"black\",\"backColor\":\"white\"}} 

...