{"id":3348,"date":"2025-04-18T05:18:51","date_gmt":"2025-04-18T05:18:51","guid":{"rendered":"https:\/\/webprojects.cloud\/wordpress\/splatco\/?post_type=spl_knowledgebase&#038;p=3348"},"modified":"2025-06-16T08:45:20","modified_gmt":"2025-06-16T08:45:20","slug":"tutorial-debugging-splatware-using-serial-data","status":"publish","type":"spl_knowledgebase","link":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-debugging-splatware-using-serial-data\/","title":{"rendered":"Tutorial: Debugging SPLatWare using serial data"},"content":{"rendered":"\n<p>With the advent of a&nbsp;<a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/serial-communications\/user-programmable-protocol\/\">user programmable serial protocol<\/a>&nbsp;capability, and with the inclusion of a serial&nbsp;<a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/splat-pc-programming-software\/terminal-for-serial-comms-testing\/\">terminal function<\/a>, a very powerful technique has become practicable for debugging SPLat programs. This tutorial will show you some useful techniques using these resources.<\/p>\n\n\n\n<p>Note: Since this tutorial was written we have developed&nbsp;<a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-simplehmi-programming-of-splat-controllers\/\">SimpleHMI<\/a>, an alternative way of interacting with a running SPLat program via the serial port. For certain uses&nbsp;<a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-simplehmi-programming-of-splat-controllers\/\">SimpleHMI<\/a>&nbsp;can offer a better capability.<\/p>\n\n\n\n<p>The serial terminal (this tutorial) is the right choice if you are developing serial communications to fit a 3rd party device such as a motion control board or a weigh-scale, which has its own predetermined message formats (protocol).<\/p>\n\n\n\n<p>As a powerful tool for general program debugging&nbsp;<a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-simplehmi-programming-of-splat-controllers\/\">SimpleHMI<\/a>&nbsp;offers a different set of features. SimpleHMI is also easier to program because it uses&nbsp;<a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/instructions-arranged-by-function\/hash-commands-and-functions\/\">hash commands<\/a>.<\/p>\n\n\n\n<p>This is mainly about debugging techniques. That said, it will equip you for any challenge that involves generating arbitrary serial data out of a SPLat controller.<\/p>\n\n\n\n<h6 class=\"wp-block-heading\">Target audience<\/h6>\n\n\n\n<p>This tutorial is designed to inspire and inform SPLat users who have never had any experience of squirting debug data out of a spare port. If the previous sentence make perfect sense to you, you probably needn&#8217;t continue. Just study the communications instructions, read up on the&nbsp;<a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/splat-pc-programming-software\/terminal-for-serial-comms-testing\/\">terminal function in SPLat\/PC<\/a>, and you are good to go. (That said, you may find a few new ideas in here).<\/p>\n\n\n\n<p>If you have never used any debug tools beyond what SPLat\/PC has offered in the past (prior to November 2011), then this could be a very good thing to study.<\/p>\n\n\n\n<p>You probably also need to be developing well-structured programs of some complexity to make this (serial port debugging) worth the effort.<\/p>\n\n\n\n<h6 class=\"wp-block-heading\">Outcomes (what you will get out of this tutorial)<\/h6>\n\n\n\n<ul class=\"wp-block-list\">\n<li>An understanding of how to generate outgoing (transmit) data on the serial port.<\/li>\n\n\n\n<li>Some useful tricks for debugging simple&nbsp;<em>and<\/em>&nbsp;complex programs.<\/li>\n<\/ul>\n\n\n\n<h6 class=\"wp-block-heading\">Prerequisites (what you should know before you start):<\/h6>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Solid SPLat programming skills. This is not for beginners. You will basically be creating your own debug resources on an&nbsp;<em>ad-hoc<\/em>&nbsp;basis, so you shouldn&#8217;t see writing 5 ot 10 lines of extra code here or there as a big burden.<\/li>\n\n\n\n<li>Knowledge of the SPLat&nbsp;<a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/instructions-arranged-by-function\/communications-instructions\/\">communications instructions<\/a>, particularly the ones for transmitting data (those with keywords starting in&nbsp;<code>ii<\/code>&nbsp;and containing&nbsp;<code>Print<\/code>&nbsp;(for example&nbsp;<code>iiPrintText<\/code>&nbsp;and&nbsp;<code>iifPrintWFW<\/code>).<\/li>\n\n\n\n<li>A good working knowledge of&nbsp;<a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-multitrack\/\">MultiTrack<\/a>.<\/li>\n\n\n\n<li>Experience with connecting a SPLat controller to your PC and programming it with SPLat\/PC<\/li>\n\n\n\n<li>Prior reading of the&nbsp;<a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/splat-pc-programming-software\/terminal-for-serial-comms-testing\/\">terminal function<\/a>&nbsp;in the SPLat\/PC documentation.<\/li>\n\n\n\n<li>Very useful, if not essential: Skills with&nbsp;<a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/splat-pc-programming-software\/splat-pc-builder\/\">Builder<\/a>, so you can turn debug code on or off at will.<\/li>\n\n\n\n<li>Some understanding of&nbsp;<a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/non-volatile-extended-memory-nvem-users-guide\/\">NVEM<\/a>.<\/li>\n<\/ul>\n\n\n\n<h6 class=\"wp-block-heading\"><a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/glossary-of-terms\/#o371\">Hardware<\/a>&nbsp;and software requirements<\/h6>\n\n\n\n<ul class=\"wp-block-list\">\n<li>A SPLat controller with dialect 28 or later. Check your board&#8217;s documentation for available firmware updates (<a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/support-resources\/reflash-updating-the-firmware-in-your-controllers\/reflash-what-is-it\/\">reFlash<\/a>&nbsp;files), if necessary.<\/li>\n\n\n\n<li>SPLat\/PC&nbsp;<a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/glossary-of-terms\/#o5366\">Build<\/a>&nbsp;146 or later<\/li>\n\n\n\n<li>Power supply<\/li>\n\n\n\n<li>Connection cable to SPLat\/PC.<\/li>\n\n\n\n<li>Some easy way of turning input on and off (a MMi202, MS120 or HD8 is ideal, as they have push buttons. A CC18 with a CCBB breakout board is also good)<\/li>\n<\/ul>\n\n\n\n<p>________________________________________________<\/p>\n\n\n\n<h6 class=\"wp-block-heading\">Related topics<\/h6>\n\n\n\n<p><a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-simplehmi-programming-of-splat-controllers\/\" target=\"_blank\" rel=\"noreferrer noopener\">SimpleHMI<\/a>\u00a0<a href=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/serial-communications\/\" target=\"_blank\" rel=\"noreferrer noopener\">Serial communication<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"<p>With the advent of a&nbsp;user programmable serial protocol&nbsp;capability, and with the inclusion of a serial&nbsp;terminal function, a very powerful technique has become practicable for debugging&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":886,"menu_order":3,"template":"","class_list":["post-3348","spl_knowledgebase","type-spl_knowledgebase","status-publish","hentry"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v25.6 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Tutorial: Debugging SPLatWare using serial data - SPLat Controls<\/title>\n<meta name=\"robots\" content=\"noindex, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Tutorial: Debugging SPLatWare using serial data - SPLat Controls\" \/>\n<meta property=\"og:description\" content=\"With the advent of a&nbsp;user programmable serial protocol&nbsp;capability, and with the inclusion of a serial&nbsp;terminal function, a very powerful technique has become practicable for debugging...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-debugging-splatware-using-serial-data\/\" \/>\n<meta property=\"og:site_name\" content=\"SPLat Controls\" \/>\n<meta property=\"article:modified_time\" content=\"2025-06-16T08:45:20+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-debugging-splatware-using-serial-data\/\",\"url\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-debugging-splatware-using-serial-data\/\",\"name\":\"Tutorial: Debugging SPLatWare using serial data - SPLat Controls\",\"isPartOf\":{\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#website\"},\"datePublished\":\"2025-04-18T05:18:51+00:00\",\"dateModified\":\"2025-06-16T08:45:20+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-debugging-splatware-using-serial-data\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-debugging-splatware-using-serial-data\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-debugging-splatware-using-serial-data\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Tutorials, application notes and white papers\",\"item\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Tutorial: Debugging SPLatWare using serial data\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#website\",\"url\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/\",\"name\":\"SPLat Controls\",\"description\":\"OEM Embedded Machine Controllers\",\"publisher\":{\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#organization\",\"name\":\"SPLat Controls\",\"url\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-content\/uploads\/2024\/10\/logo.svg\",\"contentUrl\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-content\/uploads\/2024\/10\/logo.svg\",\"caption\":\"SPLat Controls\"},\"image\":{\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Tutorial: Debugging SPLatWare using serial data - SPLat Controls","robots":{"index":"noindex","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"og_locale":"en_US","og_type":"article","og_title":"Tutorial: Debugging SPLatWare using serial data - SPLat Controls","og_description":"With the advent of a&nbsp;user programmable serial protocol&nbsp;capability, and with the inclusion of a serial&nbsp;terminal function, a very powerful technique has become practicable for debugging...","og_url":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-debugging-splatware-using-serial-data\/","og_site_name":"SPLat Controls","article_modified_time":"2025-06-16T08:45:20+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-debugging-splatware-using-serial-data\/","url":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-debugging-splatware-using-serial-data\/","name":"Tutorial: Debugging SPLatWare using serial data - SPLat Controls","isPartOf":{"@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#website"},"datePublished":"2025-04-18T05:18:51+00:00","dateModified":"2025-06-16T08:45:20+00:00","breadcrumb":{"@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-debugging-splatware-using-serial-data\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-debugging-splatware-using-serial-data\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/tutorial-debugging-splatware-using-serial-data\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webprojects.cloud\/wordpress\/splatco\/"},{"@type":"ListItem","position":2,"name":"Tutorials, application notes and white papers","item":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/tutorials-application-notes-and-white-papers\/"},{"@type":"ListItem","position":3,"name":"Tutorial: Debugging SPLatWare using serial data"}]},{"@type":"WebSite","@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#website","url":"https:\/\/webprojects.cloud\/wordpress\/splatco\/","name":"SPLat Controls","description":"OEM Embedded Machine Controllers","publisher":{"@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/webprojects.cloud\/wordpress\/splatco\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#organization","name":"SPLat Controls","url":"https:\/\/webprojects.cloud\/wordpress\/splatco\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#\/schema\/logo\/image\/","url":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-content\/uploads\/2024\/10\/logo.svg","contentUrl":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-content\/uploads\/2024\/10\/logo.svg","caption":"SPLat Controls"},"image":{"@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/spl_knowledgebase\/3348","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/spl_knowledgebase"}],"about":[{"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/types\/spl_knowledgebase"}],"author":[{"embeddable":true,"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/users\/1"}],"up":[{"embeddable":true,"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/spl_knowledgebase\/886"}],"wp:attachment":[{"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/media?parent=3348"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}