{"id":4916,"date":"2019-08-26T08:22:34","date_gmt":"2019-08-26T15:22:34","guid":{"rendered":"https:\/\/visualgdb.com\/w\/?p=4916"},"modified":"2019-08-26T08:22:34","modified_gmt":"2019-08-26T15:22:34","slug":"using-the-serial-port-on-teensy-boards-from-arduino-code","status":"publish","type":"post","link":"https:\/\/visualgdb.com\/tutorials\/arduino\/teensy\/serial\/","title":{"rendered":"Using the Serial Port on Teensy boards from Arduino code"},"content":{"rendered":"

This tutorial shows how to use the serial port on the Teensy boards to communicate with the Arduino code running on it. We will create a basic Teensy project with Visual Studio and modify it to input and output data via the USB serial port provided by the Teensy Arduino core.<\/p>\n

Before you begin, follow our basic Teensy tutorial<\/a> to get started with Teensy and VisualGDB.<\/p>\n

    \n
  1. Start Visual Studio and open the VisualGDB Arduino Project Wizard:\"\"<\/a><\/li>\n
  2. On the first page of the wizard select Create a new “Blinking LED”<\/strong> project: \"\"<\/a><\/li>\n
  3. On the next page select your Teensy board. If the Teensy targets do not appear, follow our basic Teensy tutorial<\/a> to import the Teensy files into VisualGDB:\"\"<\/a><\/li>\n
  4. As the Teensy boards to not support JTAG\/SWD debugging, select “Debug Methods -> Built-in GDB Simulator” on the Debug Method page. This will allow continuing the wizard, although the simulator won’t be able to emulate the Teensy board:\"\"<\/a><\/li>\n
  5. Press “Finish” to create the project. Once it is created and loaded, open VisualGDB Project Properties and locate the “USB Type” setting:\"\"<\/a>The Teensy board is capable of emulating numerous different USB peripherals and their combinations. In this tutorial we will only use the virtual serial port, so ensure “Serial” is selected as the USB type.<\/li>\n
  6. VisualGDB will automatically scan the code of the Teensy core and configure IntelliSense accordingly. E.g. it will suggest the available serial ports and their methods: \"\"<\/a><\/li>\n
  7. We will now use the low-level write()<\/strong> method of the Serial<\/strong> object to output some text. Replace the loop() function with the code below:\n
    void loop()\r\n{\r\n    Serial.write(\"On\\r\\n\", 4);\r\n    digitalWrite(LED_BUILTIN, HIGH);\r\n    delay(1000);\r\n    Serial.write(\"Off\\r\\n\", 5);\r\n    digitalWrite(LED_BUILTIN, LOW);\r\n    delay(1000);\r\n}<\/pre>\n
    \"\"<\/a><\/li>\n
  8. Build the code and program it into the Teensy board by pressing the programming button (see the basic Teensy tutorial<\/a> for more details). Once the programming is complete, the board will get recognized as a USB-based COM port. Open VisualGDB Project Properties and select the port in the “COM port for uploading the sketch” field: \"\"<\/a><\/li>\n
  9. Close VisualGDB Project Properties, right-click in Solution Explorer and select “Open Serial Terminal”:\"\"<\/a><\/li>\n
  10. VisualGDB will open a terminal window showing the output from the loop()<\/strong> function:\"\"<\/a><\/li>\n
  11. Now we will demonstrate some more high-level serial port API:\n
      \n
    1. The readStringUntil()<\/strong> method will be used to read the input line-by-line.<\/li>\n
    2. The printf()<\/strong> method will be used to write formatted text output<\/li>\n<\/ol>\n
      \"\"<\/a><\/li>\n
    3. Replace the contents of the loop() function with the code below:\n
      \u00a0       Serial.print(\"Write something:\\r\\n\");\r\n        auto line = Serial.readStringUntil('\\n');\r\n        Serial.printf(\"You wrote \\\"%s\\\"\\r\\n\", line.c_str());\r\n<\/pre>\n
      Then program the board and reconnect the serial terminal:\"\"<\/a>You will observe that the printf()<\/strong> method works as expected, however the readStringUntil()<\/strong> method times out.<\/li>\n
    4. The lack of a hardware debugging interface makes it harder to understand what is going on, so we will rely on VisualGDB’s code jumps to quickly navigate the function call chains: \"\"<\/a><\/li>\n
    5. Go to the timedRead<\/strong>() function and note code that checks the _timeout<\/strong> variable: \"\"<\/a><\/li>\n
    6. Hover the mouse over the _timeout<\/strong> word and select “Code\/Data Relations”. VisualGDB will immediately show that the timeout is set by the setTimeout()<\/strong> method and read by 4 other methods:\"\"<\/a><\/li>\n
    7. Add a call to setTimeout()<\/strong> before calling readStringUntil().\u00a0<\/strong>The example will now work as expected, waiting for you to enter the entire line of text:\"\"<\/a><\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"
      This tutorial shows how to use the serial port on the Teensy boards to communicate with the Arduino code running<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[169],"tags":[170,53,183],"_links":{"self":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/4916"}],"collection":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/comments?post=4916"}],"version-history":[{"count":1,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/4916\/revisions"}],"predecessor-version":[{"id":4934,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/4916\/revisions\/4934"}],"wp:attachment":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/media?parent=4916"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/categories?post=4916"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/tags?post=4916"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}