OpalKelly 5.2.1.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0dd5afa9b665b6fda7321c932671a4dc7fd6b60a0f82360d5e69dda3a89e77a
+  data.tar.gz: 27b32b57d2714f3195388f69f0debf1e90c6e0f3b17dd1dbcc37fd6f8c9e92b0
+SHA512:
+  metadata.gz: 693b1f13ca358786f79c61218b27e3e961901d030573ca97840660b8f23d428950e25f6a5eaaa1537fafaf8d38bc7be3dee27456c251831c6d08aad1574c282b
+  data.tar.gz: fc374be450c83b47889fe57b9535efb0fa3ba4cfcd7f79894baf6a1eb0ebc9c49b10ba7e102857e73e4a2b77d0ba55d4c9b4ea08f8600c66ab46bba050ddef1f

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Opal Kelly Incorporated
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+Opal Kelly Ruby Gem
+===================
+
+This gem provides access to FrontPanel API from Ruby. In order to use this
+extension, you must have Opal Kelly FrontPanel SDK installed.
+
+Installation
+------------
+
+Ensure that FrontPanel SDK is installed and `okFP_SDK` environment variable is
+defined to point to the location of `API` subdirectory of the SDK installation.
+
+You also need to have a working C++ compiler in order to build the native
+extension which is part of this gem. Under Microsoft Windows systems, you need
+to install [RubyInstaller](https://rubyinstaller.org/downloads/) to compile
+Ruby extensions, unless you already have it. Note that when selecting the file
+to download, you should choose a version with development kit (i.e. with
+`Ruby+DevKit` in its name) unless, again, you already have a functioning MSYS2
+installation.
+
+If the requirements are satisfied, a simple
+```shell
+> gem install OpalKelly
+```
+should build the extension and install the gem. If you get any errors about
+missing headers or libraries, please check that `okFP_SDK` is defined
+correctly. If you have the `okFrontPanel.h` header or the library in some
+non-default location, you may also set `okFP_SDK_INCLUDE` and `okFP_SDK_LIBS`
+environment variables to point to them directly. Finally, you can also specify
+their locations on `gem install` command line after `--`, e.g.:
+```shell
+> gem install OpalKelly -- --with-frontpanel-include=c:/fp/inc --with-frontpanel-lib=c:/fp/lib
+```
+
+
+Use
+---
+
+Gem API parallels FrontPanel C++ API, please see the [documentation][docs] for
+more information.
+
+[docs]: https://docs.opalkelly.com/display/FPSDK/Programming+Languages
+
+Here is a very simple example which can be used to check that the gem is
+installed correctly:
+```ruby
+require 'OpalKelly'
+
+puts "Using OpalKelly SDK #{OpalKelly::GetAPIVersionString()}"
+```
+
+Please notice that Ruby programs using this gem must be able to load FrontPanel
+SDK shared library during run-time and this may require separate set up:
+
+Under Microsoft Windows systems, you need to set the special `RUBY_DLL_PATH`
+environment variable to the directory containing `okFrontPanel.dll` to allow
+recent Ruby version find this DLL. Please note that having this DLL in one of
+the directories included in the usual `PATH` variable is _not_ sufficient.
+
+Under Unix-like systems, you can simply copy the shared `libokFrontPanel.so`
+library to one of the directories searched by default (e.g. `/usr/local/lib`)
+or add `$okFP_SDK` to the standard environment variable containing the list of
+directories to search, i.e. `DYLD_LIBRARY_PATH` under macOS or
+`LD_LIBRARY_PATH` elsewhere.
+
+
+License
+-------
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).