gustavojm / rema_proxy

REMA Proxy

An interface for a Multipurpose Cartesian XYZ robot for Heat Exchangers

Installing

apt install ./rema_proxy.deb

Open a web browser

http://127.0.0.1:4321/static/index.html#

Change initial connection settings by modifying config.json if required

For Developers

Requirements

Dependencies resolved by vcpkg

Install vcpkg:

git clone https://github.com/microsoft/vcpkg

Add VCPKG_ROOT variable to ~/.bashrc

echo "export VCPKG_ROOT=/path_to_vcpkg" >> ~/.bashrc

cd vcpkg
./vcpkg integrate install

Open3D cannot be installed by vcpkg

apt install libopen3d-dev

Installing

It is fairly easy to install the project, all you need to do is clone if from GitHub

git clone https://github.com/gustavojm/rema_proxy

After finishing getting a copy of the project...

Building the project

To build the project, all you need to do

cmake -S . -B ./build/
cmake --build ./build/

Change project settings, specify CMAKE_INSTALL_PREFIX

ccmake ./build

Generate a distributable .deb package

create_deb_pkg.sh

Install the generated deb package

apt install ./rema-proxy.deb

Run the installed project

cd ~/REMA_Proxy
./REMA_Proxy

Open a web browser

http://127.0.0.1:4321/static/index.html#

Generating the documentation

In order to generate documentation for the project, you need to configure the build to use Doxygen. This is easily done, by modifying the workflow shown above as follows:

ccmake ./build
cmake --build . --target doxygen-docs

Note: This will generate a docs/ directory in the project's root directory.