Page Comparison

Table of contents:

...

Message names

Messages in grey are not released yet and work on them is in progress.

...

METER_COUNTER_STATUS_IND (Message type: Monitoring) – this message is sent from client to server to update meter counter value when meter counter’s value on client side has changed.
- Payload:
  - value – <float> meter counter value in specified unit – meter or feet
  - unit – <text> unit of value - "meter" or "feet"
  - isLateral - <bool> is meter counter lateral (Since Api: V2)
- Example message (json):
  - {\"header\":{\"messageId\":102,\"messageName\":\"METER_COUNTER_STATUS_IND\",\"messageType\":\"MONITORING\"},\"payload\":{\"value\":320, \"unit\":\"meter\"}}

TOTAL_METER_COUNTER_STATUS_IND (Message type: Monitoring) - same purpose as METER_COUNTER_STATUS_IND, but for total meter counter.
- Payload:
  - value – <float> meter counter value in specified unit – meter or feet
  - unit – <text> unit of value - "meter" or "feet"

INCLINATION_VALUE_STATUS_IND (Message type: Monitoring) (Required Api: V2) - this message is sent to update value of inclination in ProTouch.
- Payload:
  - value - <float>
  - unit - <string> possible units: “rad”, “deg”, “percent”

...

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\"}}
SET_LINES_PER_SCREEN (Message type: OSD) - this message is sent from client to server to change the size of text displayed by software OSD, measured by (approximate) number of lines that should fit in entire screen height.
- Payload:
  - value – <int> number of OSD text lines to fit in total screen height (valid values range from 20 to 60 and exceeding values are clamped to that range; NOTE, that the lower value of linesPerScreen, the larger size of the text).
- Example message (json):
  - Code Block
    language json
    { "header": { "messageName": "SET_LINES_PER_SCREEN", "messageType": "OSD" }, "payload": { "value": 50 } }
TEXT_OBJECT_SET_TEXT (Message type: OSD) - Used for setting text for one of Text Objects. See OSD:Text Object paragraph for more information.
- Payload:
  - id: <int>
  - text: <string>
TEXT_OBJECT_SET_POSITION (Message type: OSD) - Used for setting position in pixels for one of Text Objects. See OSD:Text Object paragraph for more information.
- Payload:
  - id: <int>
  - x: <int>
  - y: <int>
TEXT_OBJECT_SET_VISIBILITY (Message type: OSD) - Used for setting visibility for one of Text Objects. See OSD:Text Object paragraph for more information.
- Payload:
  - id: <int>
  - visible: <bool>
TEXT_OBJECT_SET_TEXT_COLOR (Message type: OSD) - Used for setting text color for one of Text Objects. See OSD:Text Object paragraph for more information.
- Payload:
  - id: <int>
  - color: <string> in format “#RRGGBB”
TEXT_OBJECT_SET_BACK_COLOR (Message type: OSD) - Used for setting background color for one of Text Objects. See OSD:Text Object paragraph for more information.
- Payload:
  - id: <int>
  - color: <string> in format “#RRGGBB”

START_VIDEO_STREAMING_REQ (Message type: Video) – this message is sent from client to server when client wants to start UDP video streaming on ProTouch.  
- Payload:  
  - port – <int> port for video streaming   
- Example message (json):  
  - {{\"header\":{\"messageName\":\"START_VIDEO_STREAMING_REQ\",\"messageType\":\"VIDEO\"},\"payload\":{\"port\":5000}}

...

SETTING_INFO_IND (Message type: Setting) - this message is sent from ProTouch when particular application setting has been changed.
- Payload:
  - setting - <string> what setting has been changed, supported now: “cameraResolution”, “language”, “linesPerScreen”
  - width - <optional int> camera resolution’s width
  - height - <optional int> camera resolution’s height
  - value - depending on setting:
    - for language: <optional string> language_country string (lowercase two-letter ISO 639 language, underscore, uppercase two- or three-letter ISO 3166 country code)
    - for applicationVersion: <optional string> version string
    - for linesPerScreen: <optional int> parameter determining size of OSD text (see SET_LINES_PER_SCREEN message for more info)
SETTING_INFO_REQ (Message type: Setting) - this message is sent to ProTouch to query setting, ex. because application has started and there was no change to being indicate via SETTING_INFO_IND
- Payload:
  - setting - <string> supported now: “cameraResolution”, “language”, “applicationVersion” or “linesPerScreen”
SETTING_INFO_RESP (Message type: Setting) - this is response on SETTING_INFO_REQ
- Payload - exactly the same as SETTING_INFO_IND

...

REMOTE_INFO_IND (Message type: Setting) - once this message will be received, there will be new tab available in Settings/Help with System Status label, which will contain content of last REMOTE_INFO_IND
- Payload:
  - text - <string> can be multiline according to escape rules in standard JSON
APPLICATION_CLOSED (Message type: Status) - this message is sent from ProTouch when application is about to close, e.g. User presses X (closing button) and accepts the prompt.
- Payload: none

ARRAY (Message type: BULK) - this message is used for send multiple messages at once.

Payload:
- messages - <array> array of messages

Example message:

Code Block

language	json

{
	"header": {
		"messageType": "BULK",
		"messageName": "ARRAY"
	},
	"payload": {
		"messages": [
			{
				"header": {
					"messageType": "OSD",
					"messageName": "TEXT_OBJECT_SET_POSITION"
				},
				"payload": {
					"id": 7,
					position: {
						"x": 10,
						"y": 20
					}
				}
			},
			{
				"header": {
					"messageType": "OSD",
					"messageName": "TEXT_OBJECT_SET_TEXT"
				},
				"payload": {
					"id": 7,
					"text": "sample text"
				}
			},
			{
				"header": {
					"messageType": "OSD",
					"messageName": "TEXT_OBJECT_SET_VISIBILITY"
				},
				"payload": {
					"id": 7,
					"visible": true
				}
			},
			{
				"header": {
					"messageType": "OSD",
					"messageName": "TEXT_OBJECT_SET_TEXT_COLOR"
				},
				"payload": {
					"id": 7,
					"color": "#00FF00"
				}
			},
			{
				"header": {
					"messageType": "OSD",
					"messageName": "TEXT_OBJECT_SET_BACK_COLOR"
				},
				"payload": {
					"id": 7,
					"color": "#FFFFFF"
				}
			}
		]
	}
}

...

Code Block

type Color = "Black" | "DarkBlue" | "DarkGreen" | "DarkCyan" |
 "DarkRed" | "DarkMagenta" | "Brown" | "Gray" | "DarkGray" | "Blue" 
 | "Green" | "Cyan" | "Red" | "Magenta" | "Yellow" | "White 

type CreateFreeText = { 
    header: { 
        messageName: "CREATE_FREE_TEXT" 
        messagetType: "OSD" 
    }, 
    payload: { 
        text: string, 
        x: number, //integer 
        y: number, 
        visible: number //range [1;100] 
        textColor: Color 
        backColor: Color 
    }

OSD:Text Objects

Additionally there are 20 text objects that can be freely edited in terms of content, position, visibility and colors. By default they are not visible in unspecified state, so make sure to initialize every property on first use of given identifier. You can use identifiers from 0 to 19. Colors can be any from #000000 to #FFFFFF.

Configuration is not saved between ProTouch restarts, so you need to reinitialize it on every start.

Video

Video message is the one that is being used for configuration and management of video streaming in ProTouch. 

...

Versions Compared

Old Version 12

New Version 13

Key

Message names

Video