{"id":317,"date":"2016-02-07T22:29:15","date_gmt":"2016-02-07T22:29:15","guid":{"rendered":"\/?post_type=ht_kb&p=317"},"modified":"2018-03-10T20:01:59","modified_gmt":"2018-03-10T20:01:59","slug":"adding-serial-uart-data-streams","status":"publish","type":"ht_kb","link":"https:\/\/www.use-snip.com\/kb\/knowledge-base\/adding-serial-uart-data-streams\/","title":{"rendered":"Adding a Serial UART Data Stream"},"content":{"rendered":"

\"SNIPwSerialFlow\"<\/a>SNIP<\/strong> <\/span>allows adding data from one or more serial ports as data streams to the Caster. Here is how to set up a serial port connected to your GNSS device.\u00a0 This eliminates the need for the NTRIP Server<\/a> element as SNIP<\/strong> <\/span>becomes both the NTRIP Caster<\/a> and and performs the NTRIP Server<\/a> function in this case.\u00a0 The Lite<\/strong><\/em><\/span> version of SNIP allows up to three such connections, while other levels <\/a>allow more slots for more simultaneous connections.<\/p>\n

There are three general steps to adding a new device to a serial slot.<\/p>\n

    \n
  1. Serial Port Configuration<\/strong>\u00a0 Establishing the comm port, baud rate, etc.<\/li>\n
  2. Serial Commands<\/strong>\u00a0\u00a0 Sending any setup commands to the device, an optional step.<\/li>\n
  3. Edit the Caster Entry <\/strong>Enter the mountPt data, so the caster can advertise it to others.<\/li>\n<\/ol>\n

    Each of these are quickly covered below, with additional detailed information about each dialog presented in other articles in the knowledge base.\u00a0 Once any setup data about a port has been entered, it is retained and will be used when SNIP<\/strong><\/span> next powers up.\u00a0 Hint:<\/strong><\/span> If you have enabled the Auto Start<\/em> check-box, then all your serial streams will be automatically restarted without further intervention.<\/p>\n

    For the purposes of this example we will connect to a UART port of a common uBlox 6T type device, using a DB9-pin to USB adapter.\u00a0 [We could have connected to its native USB port as well]\u00a0 In this simple example setup, SNIP<\/strong> <\/span>will serve the device’s proprietary data stream out under the mountPt name “uBlox6T”<\/p>\n

    \"uBlox6Tcube-crop2\"<\/a><\/p>\n

    Aside<\/strong><\/span>:\u00a0 A common alternative with this type of inexpensive device is to use a tool like RTKLIB and its StrSvr (Stream Server) tool to convert from the proprietary message formats of the device to RTCM3 messages, and then feed the resulting data stream to SNIP<\/strong><\/span>, either by serial port or having StrSvr act as an NTRIP Caster.\u00a0 This is a popular way to create a very low cost L1-only reference station suitable for many short baseline uses.\u00a0 Here is an article<\/a> to set that up on SNIP <\/strong><\/span>using PUSH-In<\/a> streams. This connection method has the added advantage that the RTKLIB can be remote from the SNIP<\/strong><\/span> machine location.<\/p>\n

    \n

     <\/p>\n

    Getting Started<\/h4>\n

    Start with an empty (unused) serial slot you will see in the image below.\u00a0 Right click on the slot (or the Add New Stream<\/em><\/strong> button) and you will see four commands which are unique to serial stream data, as well as the same common menu controls used in other streams. You can also see (in the right boxed label) that no caster table information (the mountPt and other details) has yet been set up for the serial stream slot.<\/p>\n

    \"FirstSerialPortSetUp\"<\/a>Hint<\/strong><\/span>: If you already have created a serial setup in a slot, simply edit it to reflect the new data settings and SNIP<\/strong><\/span> will copy over it.<\/p>\n

    Serial Port Configuration…<\/h4>\n

    The serial port dialog allows setting the UART port parameters in the normal way.\u00a0 For many devices, only the Baud rate needs to be set.\u00a0 If you do not see any ports to select from, be sure the device was plugged in BEFORE launching the dialog and that there are suitable working device drivers installed for your operating system. In general, if any other tool can connect to the device, so can SNIP<\/strong><\/span>.\u00a0 Be sure to select a baud rate that will support the data you wish to send.<\/p>\n

    Here we have used the dialog and selected com5\u00a0 in a Windows device (port 5), where a Prolific USB to serial device is located.\u00a0 We have used a Baud rate of 19.2 kbps, which experience has taught us works well on this device.<\/p>\n

    \"SerialPortSetUp-UART\"<\/a>Had we elected to connect to the native USB port of the uBlox device, the description and the manufacturer text would differ, (as well as the port used) displaying the text below.\u00a0 This raises an important point that the driver text displayed reflects the driver<\/em><\/strong>, which may or may not be the name of the GNSS maker<\/em><\/strong>.\u00a0 Often it is the name of an intermediary firm which provided the driver software to the GNSS device or to the serial-USB cable \/ converter.<\/p>\n

    \"SerialPortSetUp-UART-4uBloxDrivers\"<\/a><\/p>\n

    For additional Information on using the serial connection wizard for this, click here<\/a>.\u00a0 Also, this article<\/a> has some practical advice on serial and USB adapters you may need to obtain.<\/p>\n

    Serial Commands…<\/h4>\n

    If you have already set up your device to output the correct message types needed, you can skip this step.<\/p>\n

    Often tools provided by the vendor are the best to establish the correct setup commands\u00a0 On many GNSS devices these can be saved into device memory for further use between connections and\/or power cycles.\u00a0 Other devices require this information to be provided with every power cycle, so SNIP provides a means to send sequences of such commands to the device to put it into a known state at both setup and shutdown times.<\/p>\n

    For a uBlox device the free tool uCenter provides this control functionality. It is common to connect to uCenter with the USB port for general control while sending selected raw data to another device (such as SNIP, RTKLIB, etc.) on the provided 9 pin serial port (UART0).<\/p>\n

    The basic operation of the serial command dialog is to select an existing file that has the commands to be sent. Once selected, the file can be edited and saved within the dialog window to facilitate small changes. Checking the Show Send<\/em> check-box causes a verbose log of each command (and its reply) to be shown to assist in debugging.\u00a0\u00a0 Otherwise, only a summary of the commands and replies is shown.\u00a0 A basic set of command files for several popular devices is provided with SNIP<\/strong><\/span>.\u00a0 In the absence of a selected valid file, no commands are sent.<\/p>\n

    \"SerialPortSetUp-Commands\"<\/a><\/p>\n

    Current Status<\/strong><\/span>: At this time command files are only supported for uBlox device models 6T and M8T and for Hemisphere Eclipse models. The Hemisphere method support a common “one line of text” command style used by most of the world’s other vendors. Other devices can be added as requested.<\/p>\n

    For additional Information, click here<\/a>.<\/p>\n

    Edit the Caster Table Entry…<\/h4>\n

    Every Data Stream has its own Entry in the Caster table.\u00a0 This table allows each user to see what the Caster offers and select the best data stream for their needs.<\/p>\n

    The new data stream must have a locally unique Mount Pt name to differentiate it from other streams.\u00a0 It is also customary to provide additional informative data about the stream such as its gross location, GNSS types<\/a>, its data contents, and a few details regarding how to connect to it.\u00a0 This information, formatted with one line per data stream, makes up one of the the Caster Table entries.\u00a0 This table is sent to clients on request, or when the clients attempt to mount a caster that is not valid.\u00a0 Many NTRIP Clients also can use this data to provide visual maps of the caster holdings to the user in the field similar to what SNIP<\/strong><\/span> does on the desktop.<\/p>\n

    It is not essential that all this information be present; only the Mount Pt is required<\/span>.\u00a0 The Mount Pt must be a single word and must not contain certain characters.\u00a0 The Mount Pt “uBlox6T” was used in the below example. And it is best to remember that case matters<\/span>. The tool will check the entry for you to ensure that it is unique and will provide various corrective hints for the different data entries when needed. It will prevent duplicate mountPt strings, creating an alias if required.\u00a0 If you enter (under user preferences) your home town and location, this information will be filled in each time for you for any new ports.<\/p>\n

    \"CasterDialog_ManualSet_uBlox\"<\/p>\n

    If your data consists of common RTCM-3<\/a> messages, then as best practice, the data format “Auto Detect \/wParse<\/strong>” is to be preferred.\u00a0 No other details then need to be set, SNIP<\/strong><\/span> will do the rest.<\/p>\n

    In this mode, SNIP<\/strong><\/span> will perform an initial analysis your data steam when it first starts and then correctly fill in the Caster Table entry for you, including the types and rates of the messages, the gross location of the Base Station, the GNSS types (GPS,GLO,etc.), signal types (L1\/L2\/L5), and the other details.<\/p>\n

    Here are two typical images of a high grade Base Station with a serial port setup.\u00a0 The one shown on the right<\/span> has every data item set by hand, similar to the uBlox example above.\u00a0 The one on the left<\/span> uses SNIP<\/strong><\/span>‘s ability to do stream analysis on RTCM 3.x messages to produce the same resulting caster table entry.<\/p>\n

    \"CasterDialog_2up\"<\/p>\n

    You can also elect to “hide” this data stream from being added to the published Caster Table entries by checking the indicated box.\u00a0 This feature (which is not available on the Lite<\/strong><\/em><\/span> model of SNIP<\/strong><\/span>) has some value when you do not wish other parties to see the full set of data streams which your copy of SNIP<\/strong><\/span> supports.<\/p>\n

    Running the Serial Stream<\/h4>\n

    Because in this example we are NOT using any RTCM-3 messages (rather we are using uBlox raw data), we also need to uncheck the “Parse<\/strong>” command.\u00a0 This control setting instructs SNIP<\/strong> <\/span>to simply rebroadcast whatever the data source provides.<\/p>\n

    In general, processing the RTCM-3 messages provides other advantages such as monitoring and plotting the message flow.\u00a0 We also will log the data file for record keeping.\u00a0 Note<\/strong><\/span>: The default setting with all new streams is to parse<\/span> the data and to log<\/span> it.\u00a0 Any changes which you make to these settings are recorded and kept in the INI file for the next use. [Changes which cause the display of messages, raw data, various chart plotting, or decoded RTCM3 data are discarded on restart to keep the the display less cluttered.]<\/p>\n

    Ready to start?\u00a0<\/strong> Right click the “Connect” menu comment and the process will begin.\u00a0 You will see a summary of the connection details, mountPt and the console log. In the example below, an incoming client connection was made to this stream a few moments later. If a sequence of setup commands was sent, a summary of that would also be shown.<\/p>\n

    After a few minutes of operation your Serial Streams<\/em> tab will look similar to this. The example below shows that the uBLox6T mount point (in serial slot index #S00) has 1 current active client connection (of 1 in total over its lifetime), and has served out 2.631 MBytes of data over >24 minutes, while logging about 100k more (the log started first, then the single\u00a0 client connected about ~100k after that).<\/p>\n

    The details of the caster table entry are shown in the label on the right.\u00a0 And, because Auto Start is checked, this port will be restarted when SNIP is restarted to allow unattended operation. The white area to the right of the slot summary is where any additional serial streams would be displayed. The green color, following the pattern of the other tabs, indicates a current state of error free operation.<\/p>\n

    That’s it!\u00a0 Your GNSS device is now connected to a fully functional Caster which can serve the serial devices’ data stream to the users you allow to connect.\u00a0 See this <\/a>article for how to add and control your subscribers (user accounts).<\/p>\n

    Update<\/strong>:\u00a0 SNIP<\/strong><\/span> now has a serial port wizard<\/a> that will lead you over the same steps.<\/p>\n

     <\/p>\n

    Problems with your setup?<\/h4>\n

    To understand and connect all the physical cables<\/strong>, this article<\/a> covers the hardware side.<\/p>\n

    To understand issues with device drivers<\/strong>, see the article: Problems with USB \/ Serial Drivers<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

    SNIP allows adding data from one or more serial ports as data streams to the Caster. Here is how to set up a serial port connected to your GNSS device.\u00a0 This eliminates the need for the NTRIP Server element as SNIP becomes both the NTRIP Caster and and performs the […]<\/p>\n","protected":false},"author":13,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"_exactmetrics_skip_tracking":false,"_exactmetrics_sitenote_active":false,"_exactmetrics_sitenote_note":"","_exactmetrics_sitenote_category":0,"footnotes":""},"ht-kb-category":[115],"ht-kb-tag":[],"class_list":["post-317","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-getting-started"],"_links":{"self":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb\/317","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/users\/13"}],"replies":[{"embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/comments?post=317"}],"version-history":[{"count":53,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb\/317\/revisions"}],"predecessor-version":[{"id":5116,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb\/317\/revisions\/5116"}],"wp:attachment":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/media?parent=317"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb-category?post=317"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb-tag?post=317"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}

    \"SerialPortSetUpExample-running\"<\/a><\/p>\n