Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Here are some instructions for getting started with Safir SDK Core. For more detailed information you should read the Safir SDK Core User's Guide, which can be found at www.safirsdkcore.com/docs.
These instructions will help you install the Safir SDK Core binaries on your computer.
Download the appropriate installer from https://github.com/SafirSDK/safir-sdk-core/releases.
There are installers for 64 and 32 bit systems and for several versions of Visual Studio. The 32 bit installer works on 64 bit operating systems as well, but you should only use that combination if the system you are creating is meant to be 32 bit.
When you run the installer you will be presented with the choice of installing debugging tools, development tools and a test suite. The runtime component is always installed.
- The runtime component consists of those parts of Safir SDK Core that are needed for running a system built upon Safir SDK Core, and nothing else.
- The tools component contains a few tools for debugging Safir SDK Core systems, such as Sate and Dobexplorer.
- The development component contains development headers, libraries and tools for building your own applications on top of Safir SDK Core.
- The test suite component is a bunch of component and system tests for Safir SDK Core itself. It is very unlikely that you want to install this.
Once you have run the installer you should have some new items in your Start Menu.
To launch a mini-system you can start
dope_main (by using Win-R or Start-->Run), and then starting Sate from the Start menu (assuming you installed the tools component). If everything works ok you should have a Sate that is connected to the Dob.
Now go and read the User's Guide ;-)
On Linux we currently provide prebuilt binaries for Ubuntu 14.04 and 16.04 that can be downloaded from https://github.com/SafirSDK/safir-sdk-core/releases. If you're an Arch user there should be an up to date package in the AUR. If you're using another distro you might have to build from source yourself (look at the BUILD.Linux.txt file in the source code).
Once you've downloaded and unpacked the tarball you should have five .deb-files:
- safir-sdk-core: The runtime component which consists of those parts of Safir SDK Core that are needed for running a system built upon Safir SDK Core, and nothing else.
- safir-sdk-core-tools: The tools component which contains a few tools for debugging Safir SDK Core systems, such as Sate and Dobexplorer.
- safir-sdk-core-dev: The development component which contains development headers, libraries and tools for building your own applications on top of Safir SDK Core.
- safir-sdk-core-dbg: Debug symbols for Safir SDK Core
- safir-sdk-core-testsuite: The test suite component is a bunch of component and system tests for Safir SDK Core itself. It is very unlikely that you want to install this.
These packages can be installed from the command line with "dpkg --install ...", or from a graphical package manager of your choice.
Once you've installed the packages that you want you will need to perform one additional action before you can run Safir applications. Users that are going to run Safir applications need to be added to the "safirusers" group, which can be done with for example "usermod -aG safirusers xxxx". This is needed because otherwise the user does not have write access to some lock file directories etc.
Now you should be able to launch
sate to see a minimal system in action. If everything works ok you should have a Sate that is connected to the Dob.
Here is a quick start guide on compiling and running the example applications
And you should definitely go and read the User's Guide ;-)