Connect!

The following page details establishing a connection between your PC and Lumorphix.

Setup

To establish a connection between your PC and Lumorphix follow the steps outlined below.

Linux or Mac OS

1. Launch your preferred serial terminal emulator. See Serial Terminal Setup for more information.

2. Check your FTDI kernel module is loaded (on Linux it is built into the kernel, so is likely already loaded):

user@pc> lsmod | grep ftdi_sio

3. If not, load it:

user@pc> sudo modprobe -v ftdi_sio

4. If that failed, see here for installation instructions (VCP driver).

5. A USB device should now be present in /dev/ :

user@pc> ls /dev/ | grep USB1
ttyUSB1

6. Connect with baud=921600 bps, data bits=8, stop bits=1, parity=none and flow control=none. The recommended tio command line is as follows:

user@pc> sudo tio -b 921600 --output-delay 5 /dev/ttyUSB1

7. You're good to go! See section ‘Test’ below, if you wish to test the connection.

On some flavours of Linux, we've found that the device must be forced to baud 921600, prior to establishing a serial connection (step 6).

.

BASH

user@pc> stty -F /dev/ttyUSB1 921600

 On some flavours of Mac OSX, we've found that the number of stop bits must be set to two, as part of establishing a serial connection (i.e. step 6).

.

BASH

user@pc> sudo tio -b 921600 --output-delay 5 /dev/ttyUSB1 -s 2

Windows

1. Launch 'Device Manager' (click 'Windows Start Button', start typing 'Device Manager').

2. Scroll down to 'Ports (COM & LPT), and expand it.

3. Note COM port number of entry 'USB Serial Port (COM<port number>). If there are multiple, unplug-plug Lumorphix to see which is the relevant port

4. Launch your serial client program (i.e. Putty).

5. Set 'Connection Type' to 'Serial', 'Serial line' to COM<Lumorphix port number> and 'Speed' to 921600.

If required, additional serial configuration is: data bits = 8, stop bits = 1, parity = none and flow control = none.

6. Open connection. You're good to go! See section ‘Test’ below, if you wish to test the connection.

Test

After powering on the board and completing step outlined above in the ‘Setup’ section, you are now connected to Lumorphix in its default mode (REPL Mode). In this mode, the user is presented with a Lua REPL (Read-Eval-Print-Loop). For more information on this mode, see REPL Mode.

To confirm this, simply press ‘enter’ on your keyboard, this will refresh the REPL prompt (it will print again, on a newline e.g. same as a Bash terminal, Python REPL etc.)

To review the boot log (which details various Lumorphix hardware and software configuration metadata) simply leave the connection open, and hard reset the board. The steps to perform a hard reset vary per hardware target - see the child page of Hardware Targets that corresponds to your current hardware.

For a detailed description of the boot log, see section ‘Boot Log Description’ of page Boot Information.

Once you have established a serial connection to the board, you can print a help manual by simply typing ‘help' in REPL Mode or 'list|help’ in Command Mode.

Additional Setup

The only other software you will require, if you are going to develop and upload programs (as opposed to just use the REPL) is:

• The program upload script, available here.

• A Python installation.

Python installation

Linux or Mac OS

1. Launch your favourite terminal emulator.

2. Install Python.

user@pc> sudo apt install python3

3. Install PySerial.

user@pc> sudo pip install pyserial 

Windows

1. The Python installer for windows is available here.

2. Ensure that you select 'Customize installation'-'Next' then tick 'Add Python to environment variables' and 'Precompile standard library'.

Ensure that you also install pyserial (after you've install Python, run the following command in Windows Powershell):

PS C:> pip install pyserial

Not all Beta releases support program upload - see Beta Release Info for more information.