Skip to content
Benjamin Cronin edited this page Aug 22, 2019 · 4 revisions

Welcome to the ArduinoCommLogger wiki!

Information about the usage of this software can be found in this wiki. Users are welcome and encouraged to contribute any information they have about the software, bugfixes for any problems, help pages, and to raise issues or feature requests.

The software

The software is contained simply in the .exe file, which should be distributed with the license and source code along side.

Usage

The software will start up and present some information about itself and the current time, and begin requesting information about the communication it will be logging.

COM Port

Enter the COM port of the Arduino as it is recognized by the PC. You can enter the COM port in three forms:

  • com#
  • COM#
  • #
    where # represents the COM port number. The software will parse your input and continue as long as it matches one of these three forms.

Communication Speed (baud)

Enter an integer representing the communication speed of the serial connection. Arduino-supported values are 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 31250, 38400, 57600, and 115200.

File Path

Enter the complete file path to a folder to save the log file in. Examples are C:/Users/BobSmith/Desktop/Logs/ or E:/logs/.

Time

Enter an positive or negative letter, word, or phrase to indicate a decision on inclusion of timestamps in the .csv log file. A positive answer will prefix every line with [TIME], , while a negative answer will simply record the serial communications without a timestamp. Acceptable answers are as follows, and list is subject to change and expansion.

Accepted Positive Answers

"y", "yes", "yeah", "sure", "okay", "ok", "fine", "why not"

Accepted Negative Answers

"n", "no", "nah", "nope", "no man", "not today"

Comma Separated Commands

Enter a list of comma separated commands to send to the Arduino device directly after connection and lopsided handshake have occurred (See ArduinoCommLogger Communication Protocol). Examples: 1, 3 on, start
Commands will be issued sequentially at the greatest possible speed and as soon as possible after opening the serial port with the Arduino.

Warning!

At this time, multi word commands (such as stop production, begin cycle) are unable to be issued properly.

During Run

The software will begin to log all serial communications into a file in the provided folder with a name following the format log_[TIME]_[DATE].csv. The file will not be saved until the software has safely exited.
You can press the enter key at any time to save the log file and exit the program. Closing the program with the X at the upper right (Windows) or the red dot in the upper left (Mac) will not save the log file.

Future Development

  • Safe saving: preserve log files in their current state after program crash or unexpected shutdown.
  • Multi-word startup commands.
  • Intra-run commands: send serial commands to the Arduino during logging.
  • File type choice: save as a .log or .txt instead of strictly as a .csv.
  • Expand control over logging: Initial Arduino lopsided handshake can be either saved and written to the log or discarded, choose to record the response to initial commands.

This open source software is licensed under the GNU General Public License v3.0.