ImplementingTheArduinoToolbox < Embedded

Tags: view all tags
---+ Implementing the Arduino toolbox
---++ The program structure

As you would probably expect, the program will consist of three parts
   * a server running on the Arduino taking commands from Xcos and accessing the GPIO hardware
   * an Xcos client implementing the Xcos blocks
   * a protocol defining the communication between client and server
There is already an Xcos system reading out several sensors and controlling several actuators, mainly motors. Unfortunately this Scilab toolbox works on Windows exclusively. It is however a good starting point for our Linux version. Using the same communication protocol and only changing the OS dependent calls to the serial driver will make both toolboxes largely compatible with each other.

I decided however to re-implement the Arduino server including better debugging features.
---++ The communication protocol

The communication protocol must be as simple and short as possible in order to increase the speed and therefore the maximum possible sampling rate.The server itself is an Arduino sketch consisting essentially of a big switch statement. The first specifies the type of action to be taken or the device to talk to. For the moment only 2 devices are implemented:
   * version: returns the version number of the protocol server on the Arduino
   * digital read or write<br />This allows to read the state of a GPIO line defined in the xcos block or to write a high or low state to this GPIO line. Before the xcos simuation (the scilab program on the PC) is started (pre-simulation) the mode of the GPIO line is set.
   * stepping motor<br />Here we set the GPIO pins associated to the stepping motor pulse to output in the pre-simulation step. The a "do one step" command is sent to the server.
Here is the basic protocol description:
---+++ Getting the server version

*V*: gets the server version code. The server answers with Vab where a is the major and b the minor version number e.g. V13 for version 1.3
---+++ Reading or writing a digital GPIO line

*Dan0* or *Dan1*: attaches GPIO line n. The last character defines if the line is input (0) or output (1). n is the GPIO pin number which can be '1' (0x31) up to '9' (0x39). For higher pin numbers just take the next ASCII characters. Having a look at the ASCII table tells us the pin number 10 will correspond to the ASCII characters with code (0x3A) which is ':', 11 corresponds to ';' and so on.<br /><b>Drn</b>: Read the state of GPIO line n<br /><b>Dwn0</b> or <b>Dwn1 </b>sets the GPIO line n to 0 or 1 respectively.

<img alt="ascii.png" height="294" src="%ATTACHURL%/ascii.png" title="ascii.png" width="637" />
---++ Controlling a stepper motor

In case of the stepper motor we need a means to define which GPIO pin is connected to which stepper motor coil. This is done with a command:

*Sanp*: Where "S" identifies for the stepper motor device, "a" stands for "attach" n is the GPIO pin and p is the pulse (N1 .. N4 or the stepping motor driver module) . The command also programs the GPIO pins as output. Sa21 will therefore attach GPIO pin 2 to the first stepping motor driver input (N1 on the driver card).

*Smfs*: m: moves the stepping motor by 1 step. The parameters f and s stand for f: forward of b: backward and s is the stepping mode which can be single phase, double phase or half step. The direction and the stepping mode can be selected in the xcos block:

<img alt="steppingModes.png" height="262" src="%ATTACHURL%/steppingModes.png" title="steppingModes.png" width="562" />

In the screen dump above half step mode in forward direction is selected.

*Sc*: Clears all coil signals to low
---++ Reading analog values

The Arduino has several 10 bit ADCs on chip which can be used to read analog voltage levels. Here is the command code:

*Ap*: reads the voltage level from analog pin p
---++ Interrupts

Normally interrupts can only be generated on pins 2 and 3 on an Arduino Uno or Nano. However, there are also so-called "PinChangeInterrupts" which allow to hook up an interrupt service routine when a signal level change on a GPIO pin happens. This can be "FALLING" or "RISING" for a falling or rising edge of the signal or it can be "CHANGE" for both edges.

Unfortunately there is a problem when using this with the !SoftSerial library because both libraries use the same interrupt vectors. Since for our debugging port we only have to send but to not receive message I use the !SendonlySoftSerial library attached to this page:

%ATTACHURL%/SendOnlySoftwareSerial.zip

These are the protocol codes sent to the Arduino:

<b>Iacup:</b>   a: attach pin p for c: change mode f: falling edge: r: rising edge, u: updown: u: up-counter, d: down-counter c: clear<br /><b>Idp: </b>    d: detach from interrupt on pin p<br /><b>Irp: </b>     r: read no of counts from interrupt counter
---++ Encoder

The rotary encoder also make use of interrupts. It uses 2 signals: clock and data to see when it is turned and in which direction it has been turned. The clock signal is connected to an interrupt and the interrupt service routine, by looking at the data signal, finds out if the encoder was turned clock-wise (a counter increments) of counter-clock-wise (a counter decrements).
| <img alt="xcosEncoder.png" height="433" src="%ATTACHURL%/xcosEncoder.png" title="xcosEncoder.png" width="467" /> | <img alt="encoderResult.png" height="400" src="%ATTACHURL%/encoderResult.png" title="encoderResult.png" width="600" /> |
The above screen dumps show an xcos diagram setting up the encoder, reading it and displaying its value in a plot.
---++ The multi-function board

In order to test digital read/write, analog read/write etc. we need an Arduino to which the corresponding hardware is connected, e.g. a switch to be read with digital read, a potentiometer for analog read or an LED for digital write... An easy solution is to use the multi-function board which has all these connections already done and which must simply be installed as a piggy back board onto e.g. an Arduino Uno.

<img alt="multi-function.png" height="393" src="%ATTACHURL%/multi-function.png" title="multi-function.png" width="431" />

As can be seen from the photo the multi-function board has
| *Device* | *Connection* |
| 4 LEDs | GPIO 10..13 |
| 2 switches | A1..A3 |
| 1 potentiometer | A0 |
| 1 seven segment display | GPIO 4,7,8 |
| 1 buzzer | GPIO 3 |
For further details please consult the circuit diagram:

%ATTACHURL%/multiFunctionBoard.pdf

I use GPIO pin 2 as TX line for a !SoftSerial port onto which I send debugging messages.
---++ The Arduino server program and the test procedure

With this information it is possible to develop the first version of the Arduino server. Since all it needs is input from the serial line we can write a simple C program to test the server. A program asking for the server version (and printing it) as well as the Arduino server are attached to this TWiki page.

The Arduino server uses debugging code which prints each character received as well as the interpretation in makes out of it to a Softserial port with Rx connected to GPIO pin 11 and Tx connected to pin 10. This Softserial port can be attached to a USB to serial adapter and the output observed with a serial emulator program like minicom. The communication between Scilab and the Arduino happens on /dev/ttyUSB0, the debugging port should therefore be connected to /dev/ttyUSB1 (minicom -D /dev/ttyUSB1).

Both, the test programs as well as the xcos toolbox, pass through the same serial library with the following calls:

<img alt="serialLib.png" height="80" src="%ATTACHURL%/serialLib.png" title="serialLib.png" width="650" />

Since the test programs and the xcos toolbox use the same communication code we can be sure that once the server is tested with the test programs it will also work on the toolbox.

Here is a screen dump of the server output when we first read the server version and then blink the builtin LED (on GPIO pin 13) 5 times:

<img alt="blink2.png" height="532" src="%ATTACHURL%/blink2.png" title="blink2.png" width="702" />

And this is the output from the Arduino server onto /dev/ttyUSB1 when running the stepper motor test:

<img alt="stepper.png" height="228" src="%ATTACHURL%/stepper.png" title="stepper.png" width="254" />

And in fact you see the motor turn when it receives the Sm commands.
---++ How to bring the demo system up

A tar archive with a Xcos toolbox containing Digital Write as well as as a basic stepper motor xcos block is attached to this page:

%ATTACHURL%/arduino-linux_1.6-src-6feb.tar.gz

This is the original [[https://atoms.scilab.org/toolboxes/arduino/1.5/][arduino_1.5-src]] archive downloaded from git which I modified to run on Linux. Only _Digital Write_ and the <i>stepper motor module </i>are working. The other modules are still part of the archive but will most probably not work. In the original archive the stepper motor block was removed from the Arduino palettes. It has been put back. The original Arduino sketches have been moved into arduino.old and a new server sketch developed which you find in the arduino folder.

To install everything please
   * create a folder /opt/ucc/scilab
   * unpack the above tar archive into this folder.
Have a look in the arduino folder where you should find the server sketch called toolbox_arduino_v0.2.ino. This sketch must be uploaded onto an Arduino. I used an Arduino Nano but an Uno or Mega should work as well. For debugging I use a Softserial port. Connect your PC via a USB to serial converter to the Arduino. GPIO pin 10 on the Arduino corresponds to the Arduino Tx line (Rx of the USB to serial adapter) and pin 11 corresponds to Arduino Rx (see also the definitions in the sketch).

In arduino/serverTest you will find test programs for the server sketch as well as interface functions in serialLib which interface the XCos block Scilab code to the serial driver. The test program,running on the PC, (have a look at blink2.c) passes through these functions and calls the driver in exactly the same way that Scilab will use. For the moment only 2 such test programs are available:
   * blink2.c reading out the server version and blinking the Arduino builtin LED on GPIO pin 13
   * stepper.c which make the stepper motor move. The coil pins on the stepping motor controller (N1 .. N4) must be connected to Arduino GPIO pins 2..5
Try to make the Arduino server sketch work with these programs first.

Then start Scilab. Load the macros
   * builder.sce
   * loader.sce
   * unloader.sce
Execute the builder.sce script.

You should see something similar to this:

<img alt="builder.png" src="%ATTACHURL%/builder.png" title="builder.png" />

If the builder exits successfully then you can start the loader adding the Arduino features into the Scilab system. This is what you should see:

<img alt="loader.png" height="189" src="%ATTACHURL%/loader.png" title="loader.png" width="543" />

Start xcos either by typing <i>xcos </i>in the command window or by clicking the Xcos icon (the one looking a bit like an oscilloscope). In the palettes box coming up you should see an Arduino entry:

<img alt="palette.png" height="350" src="%ATTACHURL%/palette.png" title="palette.png" width="527" />

Now you can create a diagram using your new Arduino blocks and run it. You can blink LEDs with the digital output block, read switches with the digital input block, read analog values or make a stepper motor move.

-- %USERSIG{UliRaich - 2019-01-07}%

---++ Comments

%COMMENT%
Attachments
Topic attachments
I	Attachment	History	Action	Size	Date	Who
zip	SendOnlySoftwareSerial.zip	r1	manage	4.3 K	2019-02-02 - 09:47	UliRaich
gz	arduino-linux_1.6-src-6feb.tar.gz	r1	manage	2658.9 K	2019-02-07 - 15:00	UliRaich
png	ascii.png	r1	manage	70.1 K	2019-01-07 - 16:49	UliRaich
png	blink.png	r1	manage	38.5 K	2019-01-07 - 16:49	UliRaich
png	blink2.png	r1	manage	61.8 K	2019-01-15 - 14:40	UliRaich
png	builder.png	r1	manage	155.3 K	2019-01-16 - 13:37	UliRaich
png	encoderResult.png	r1	manage	14.9 K	2019-02-07 - 14:56	UliRaich
png	loader.png	r1	manage	11.2 K	2019-01-16 - 13:37	UliRaich
png	multi-function.png	r1	manage	213.1 K	2019-02-02 - 09:29	UliRaich
pdf	multiFunctionBoard.pdf	r1	manage	23.3 K	2019-02-02 - 09:34	UliRaich
png	palette.png	r1	manage	29.4 K	2019-01-16 - 13:37	UliRaich
png	serialLib.png	r1	manage	22.5 K	2019-01-15 - 14:28	UliRaich
png	stepper.png	r1	manage	15.1 K	2019-01-15 - 14:28	UliRaich
png	steppingModes.png	r1	manage	24.5 K	2019-02-08 - 15:27	UliRaich
png	xcosEncoder.png	r1	manage	31.9 K	2019-02-07 - 14:56	UliRaich
Topic revision: r8 - 2019-02-08 - UliRaich