Serial

Connect any serial device like Arduino and communicate with it

Parameters

• Protocol : This is a way to easily parse incoming messages depending on the protocol you chose.

  • Lines : This will consider new data every time a new line character is received. Most Arduino users use new lines as messages split, so it's the default.

  • Raw : If you want to get every byte separately, you can choose Raw, which won't do any parsing of incoming data.

  • Data255 : This will consider new data every time a byte with value of 255 is received. This is a personal and very efficient protocol if you don't care about loosing one byte precision, and only want to send single bytes as it obviously doesn't work for sending float or 32-bit integers.

  • COBS : This is parsing the data accordingly to the COBS mechanism. If you don't know what that is, check out the Wikipedia page. **

• Auto Add : This will automatically add values when data is received. Keep it checked if you want to always convert the received data to values, otherwise if you want to only receive some data, uncheck it when you don't wan't to automatically add more values anymore **

• Message structure : This decides how every message should be parsed. It depends on the protocol you chose. **

• First value is the name : If checked, messages will be expected in the format of 2 arguments : the first one is the name and the second one is the actual value. **

• Port : The serial port to connect to. **

• Baud rate : The speed of the device to connect to. This is set inside the device. In Arduino code this is the parameter passed in the Serial.begin(<baudrate>); function. **

• Is connected : Whether the device is connected or not.

• Pass-through : This section allows you to directly transfer the incoming data to other Streaming modules, i.e. Serial, UDP, TCP Client and TCP Server. This allow for fast, optimized data transfer through modules, even for data that are not handled by Chataigne.

Disabling this module will actually disconnect the Serial device, meaning that you don't need to close Chataigne or remove the module if you want to connect it to another software. For instance, if you want to upload a new sketch onto an Arduino board, you can just disable the module, upload the sketch, and enable the module again.

By activating "Log Incoming", you can actually use Chataigne as a very fast and simple Serial logger !