Skip to content

Home

Jump to bottom
Bouraoui AL-Moez L.A edited this page May 7, 2020 · 2 revisions

Introduction

SerialShell is an advanced application used to send and receive data using a serial port. You can use your joystick or your keyboard as shortcut system to send predefined data or send costumed data messages. This application allows you to select your data type (string, C-Like string, float, byte, word …) and you will have a total access to your serial port device using the advanced tools.

Connecting your device:

Connection tab is used to connect to your Serial Port device, so you have to specify the port COM? Data transfer speed in BAUD and other information that your device used so be careful you have to configure your application correctly to get it work.

List of connection settings

  • Port: In this combo box you have to specify your port so if you used COM1 you have to set this field to COM1. Every time you drop down the combo box the application will scan all serial ports available for use.
  • Baud: Here you have to specify the data rate or data speed if you use another speed than the hosted port, you will lose your data when sending, so if your hosted device use a speed of 9600baud you have to set this field to 9600baud.
    The available values are: 300, 1400, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400, 250000.
    All these values are in BAUD unit.
  • Data Size: Here you specify your device sending data size 8 bits or 7 bits.
  • Stop Bits: Number of stop bits used in transferring data 1, 1.5 or 2.
  • Parity: This field is used to check if the data are correctly received so you have to specify what type of checking the data.
    The available values are: ‘Even’, ‘Odd’, ‘None’, ‘Mark’ and ‘Space’.

If you are a beginner and you don’t know what to set you can use “Beginner Configuration” so this will set the default values used in the most application:

  • Baud: 9600
  • Data Size: 8 bits
  • Stop Bits: 1
  • Parity: None

After entering the correct settings use the connect button if there is a connection error it will be displayed in the Host Monitor.

Sending data:

There is three ways to send data:

  1. Select a file and then press send button to send all the data in this file. It can be a text file or binary file.

  2. Sending custom message so every time you would like to send message you have to write it and press “ENTER” button. You can select your data type using the data type combo box.
    Also you can choose the data ending:

    • None
    • Windows (CR LF)
    • Macintosh (CR)
    • Unix (LF)

    The available data types are:

    • String
    • Verbatium string: C-Like String \0 \n \r \t …
    • Float 32 bits
    • Byte
    • Signed byte
    • Word
    • Signed word
    • Double word
    • Signed double word You can select the datatype every time you want to send or receive data.

  3. Sending predefined shortcut messages.
    The available shortcuts are:

    • For keyboard:

      • ALT+0
      • ALT+1
      • ALT+2
      • ALT+3
      • ALT+4
      • ALT+5
      • ALT+6
      • ALT+7
      • ALT+8
      • ALT+9

      For these is shortcuts you can select the data type and set your data.

    • For joystick:

      • Button 1
      • Button 2
      • Button 3
      • Button 4
      • L1
      • L2
      • L3
      • R1
      • R2
      • R3
      • Up
      • Down
      • Left
      • Right
      • Start
      • Select For these is shortcuts you can select the data type, set your data when pressing and when releasing the key. The check box repeat is used to always send data until your release the pressed key.

Empty messages are ignored.

If there is an error in sending data, the current port will be released and the error message will be displayed in the Host Monitor.

Receiving data

All received data will be displayed in the Guest Monitor.

You can select the data types (String, Float 32 bits, Byte, Signed byte, Word, Signed word, Double word, Signed double word).

You can also save the received data in a log file so the same result in the Guest Monitor will be written in a log file. This tools can be enabled or disabled using the enable button. To change the path, you can use the browse button select the destination file and confirm.

License

This project is under GPL-V2.0 for more information check the license page.

Contact:

For more information you can contact us on: [email protected]

If there is any bug, please report it and we will fix it as soon as possible.

Clone this wiki locally