Code Monkey home page Code Monkey logo

rs-sdk's Introduction

Rugged Science logo

The Rugged Science SDK is a set of cross platform libraries and utilities for controlling the hardware on Rugged Science embedded PCs. This SDK is not model dependent meaning it will function the same across all supported Rugged Science models. This is acheived by having individual XML files that contain hardware specific information. The correct file must be passed to the libraries and utilities for the libraries to know how to interact with the underlying hardware.

Passing the incorrect XML file will result in undefined behaviour and may harm the PC!

The latest prebuilt release can be found HERE.

API References

Building

Prerequesites

The build process relies on the CMake utility. This can be easily installed on most Linux distributions using sudo apt install cmake or sudo yum install cmake. For Windows, you can find the latest downloads HERE. Be sure to add the CMake directory to your PATH or use the full path when calling the cmake command.

Getting Started

For best results, create a seperate build folder inside the root of this SDK.

mkdir build
cd build

From inside of that folder run the following commands.

cmake ..
cmake --build .

For static builds add the -DBUILD_SHARED_LIBS=OFF flag. Useful when you are just looking to build the control utilities (rspoectl and rsdioctl).

cmake .. -DBUILD_SHARED_LIBS=OFF

Windows requires 64-bit builds due to driver limitations. To do this you will need to specify the generator and architecture using the "-G" switch.

cmake -G "Visual Studio 15 2017 Win64" ..
cmake --build .

The Windows drivers must be installed prior to using this SDK. They can be found in the latest release under Windows\X64\Drivers\.

Debug and Release

Windows and Linux each behave a bit different in regards to the build type. Visual Studio will default to debug builds while gcc defaults to release builds.

To have Visual Studio build a release you will need to add the --config release flag as shown below.

cmake -G "Visual Studio 15 2017 Win64" ..
cmake --build . --config release

In most other situations you will need to use the -DCMAKE_BUILD_TYPE switch shown below.

cmake -DCMAKE_BUILD_TYPE=Debug ..
cmake --build .

Intalling

Use the -DCMAKE_INSTALL_PREFIX= option in the first command to set the installation location. Then use --target install during the build command. Default locations:
Windows: "C:\Program Files\rssdk"
Linux: "/usr/local"

cmake .. -DCMAKE_INSTALL_PREFIX=../install
cmake --build . --target install

By default the control utilities are installed to ${CMAKE_INSTALL_PREFIX}/bin. This can be turned off with -DINSTALL_UTILITIES=OFF.

Once the build process is finished, you will find a copy of the libraries and examples inside of the build directory or the install directory you supplied.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.