Skip to content

Serial API

Jump to bottom
Andrew St. Yves edited this page May 15, 2018 · 15 revisions

Notes

<cr> = carriage return.

Hotel 1 refers to the plate stacker hotel furthest from the gripping arm.

Hotel 2 refers to the plate stacker hotel nearest to the gripping arm.

Port Configuration

The serial port connection needs to be configured as follows:

  • Baud Rate: 9600
  • Data Bits: 8
  • Parity: none
  • Stop Bits: 1
  • Flow Control: none

Requests

The Scorpion API has two types of requests: Commands and Querys.

Commands

Commands tell the instrument to perform a specified movement or other action. A command that is successfully sent to the instrument is responded to immediately with ok<cr>. Commands that are invalid or unsuccessfully sent to the instrument are responded to with err<cr>.

After a command is sent you can query the instrument for its status using the Status Query, until the instrument is no longer busy, before sending the next action command. IMPORTANT: It is recommended you wait 200-500 ms after sending the command before you query the instrument for its status. This gives the instrument time to update its status internally.

The following is a list of the currently supported commands. Click on the link to be taken to a page describing the command purpose and how to use it.

Queries

Queries are used to request information from the Scorpion instrument regarding its current state. A query that is successfully sent to the instrument will respond with the requested information. The format of this information depends on the query sent. Queries that are invalid or unsuccessfully sent to the instrument are responded to with err<cr>.

The two most important queries are the Status Query and Error Query as they will be used most frequently during normal operation of the instrument. A full list of queries is below.

Quick Links

Serial API

Clone this wiki locally