{"id":13246,"date":"2016-06-22T10:27:50","date_gmt":"2016-06-22T15:27:50","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=13246"},"modified":"2019-05-15T15:53:22","modified_gmt":"2019-05-15T20:53:22","slug":"ippipes","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/mtr-software\/mtr-api-reference\/collection-endpoints\/ippipes\/","title":{"rendered":"ipPipes"},"content":{"rendered":"

Description: list of configured IP pipes : ARRAY<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Element<\/strong><\/td>\nType<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
_v<\/td>\nUINT<\/td>\nVersion of model [2] (automatic)<\/td>\n<\/tr>\n
activation<\/td>\nSTRING<\/td>\nThe signal to start a connection<\/td>\n<\/tr>\n
bufferTimeoutMs<\/td>\nUINT<\/td>\nTimeout after which the data will be sent to the network if the buffer is not full (in milliseconds)<\/td>\n<\/tr>\n
description<\/td>\nSTRING<\/td>\nSummary or description of the pipe<\/td>\n<\/tr>\n
enabled<\/td>\nBOOL<\/td>\nEnables or disables a pipe<\/td>\n<\/tr>\n
ip<\/td>\nSTRING<\/td>\nIP address of the remote end of the pipe<\/td>\n<\/tr>\n
mode<\/td>\nBOOL<\/td>\nSpecifies whether the local end point is a client, server, or both<\/td>\n<\/tr>\n
name<\/td>\nSTRING<\/td>\nLabel of the pipe<\/td>\n<\/tr>\n
port<\/td>\nUINT<\/td>\nPort number of the remote end point when in CLIENT mode, or listening port when in SERVER mode<\/td>\n<\/tr>\n
protocol<\/td>\nSTRING<\/td>\nSpecifies the internet protocol to use (UDP, TCP or SSL\/TLS)<\/td>\n<\/tr>\n
secondaryIp<\/td>\nSTRING<\/td>\nSpecifies the IP address of the secondary server; this server is contacted if a connection can not be made to the first, must be in CLIENT mode<\/td>\n<\/tr>\n
secondaryPort<\/td>\nSTRING<\/td>\nSpecifies the\u00a0port of the secondary server; this server is contacted if a connection cannot be made to the first, must be in CLIENT mode<\/td>\n<\/tr>\n
sequence<\/td>\nSTRING<\/td>\nCharacter or stream of characters that terminate the pipe, requires the termination mode to be SEQUENCE<\/td>\n<\/tr>\n
serialReadBufSize<\/td>\nUINT<\/td>\nSize of buffer for reading data from serial port and sending to network (in bytes)<\/td>\n<\/tr>\n
source<\/td>\nSTRING<\/td>\nSpecifies the source defined by the local device to convert data to and from IP communication<\/td>\n<\/tr>\n
termination<\/td>\nSTRING<\/td>\nMode used for terminating the pipe<\/td>\n<\/tr>\n
timeoutSeconds<\/td>\nUINT<\/td>\nAmount of inactivity allowed before the pipe closes (in seconds), requires the termination mode to be TIMEOUT<\/td>\n<\/tr>\n
type<\/td>\nSTRING<\/td>\nType of pipe, currently only serial-to-ip and bluetooth-to-ip are supported<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

Description: list of configured IP pipes : ARRAY Element Type Description _v UINT Version of model [2] (automatic) activation STRING The signal to start a connection bufferTimeoutMs UINT Timeout after which the data will be sent to the network if the buffer is not full (in milliseconds) description STRING Summary or description of the pipe […]<\/p>\n","protected":false},"author":1872,"featured_media":0,"parent":13129,"menu_order":28,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-13246","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13246","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/1872"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=13246"}],"version-history":[{"count":11,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13246\/revisions"}],"predecessor-version":[{"id":22664,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13246\/revisions\/22664"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13129"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=13246"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}