INSTALL.md

Installation

prepare

you need the following software to build and run this project:

• git: https://git-scm.com/book/de/v2/Erste-Schritte-Git-installieren
• python3: https://www.python.org/downloads/ (allready installed on most systems)
• make: https://learn.microsoft.com/en-us/windows/package-manager/winget/ (allready installed on most systems)
• PlatformIO Core: https://platformio.org/install (optional for the Ethernet-Board)
• oss-cad-suite-build: https://github.com/YosysHQ/oss-cad-suite-build (NOTE: there are some bugs in this software, please use: 2023-07-20)

get the Sources

git clone https://github.com/multigcs/LinuxCNC-RIO
cd LinuxCNC-RIO

patching the oss-cad-suite

to fix a bug in oss-cad-suite, please run this patch command:

bash files/patching-oss-cad-suite.sh PATH_TO_OSS_CAD_SUITE

in my case:

bash files/patching-oss-cad-suite.sh /opt/oss-cad-suite

copy default config to avoid errors during update

cp configs/TangNano9K/config.json configs/TangNano9K/config-mycnc.json

to update the source later, run the following command in your LinuxCNC-RIO folder:

git pull

generate the Project-Files

to generate/update all needed files in Output/TangNano9K/:

python3 buildtool.py configs/TangNano9K/config-mycnc.json

or if you want to use the optional Ethernet-Board:

python3 buildtool.py configs/TangNano9K/config-udp.json

in this case, please first flash the ethernet-board, check the IP and edit the json-file

build and load the FPGA-Bitstream

connect the TangNano9K board to your USB-Port and run:

(
cd Output/TangNano9K/Gateware
make all
sudo make load
)

this will need some time NOTE: the ..oss-cad-suite/bin/ must in you PATH enviroment variable:

export PATH=$PATH:~/Downloads/oss-cad-suite/bin/

compile and install the hal-component

please copy the folder Output/TangNano9K/LinuxCNC/Components to your target system where LinuxCNC is running, then you can compile and install the component:

sudo halcompile --install  Output/TangNano9K/LinuxCNC/Components/rio.c

sample config for LinuxCNC

there are also a sample configuration in Output/TangNano9K/LinuxCNC/ConfigSamples/rio/

you can copy this folder to your LinuxCNC machine and start it (or leave it there if you already on this machine):

linuxcnc Output/TangNano9K/LinuxCNC/ConfigSamples/rio/rio.ini

connection to the Raspberry-PI

you can use a Raspberry-PI 4 with direct SPI connection to the FPGA-Board, you can find the pinout in README.md (BOB-Adapter SPI-Pins)

build and flash the optional Ethernet-Board

https://www.olimex.com/Products/IoT/ESP32/ESP32-POE-ISO/open-source-hardware

first you have to install the PlatformIO Core: https://platformio.org/install

then go into Folder: UDP2SPI-Bridge/ESP32-PoE-ISO and run the build process:

cd UDP2SPI-Bridge/ESP32-PoE-ISO
make build

then connect the Ethernet-Board to your USB and flash the Gateware:

make upload