Update documentation and README

README.md

@@ -1,8 +1,16 @@
-# Arb
+# arb-ex
 
-A NIF for controlling the ABACOM CH341A relay board ([documentation](https://hexdocs.pm/fritz_api)).
+An Elixir NIF for controlling the ABACOM CH341A relay board ([documentation](https://hexdocs.pm/arb)).
 
-## Installation
+## Getting started
+
+### Requirements
+
+In order to compile a recent version of `rust` must be installed (tested with 1.25). Also, the native [libusb](https://github.com/libusb/libusb) library is required. On Debian-based distributions install `libusb-1.0-0-dev`.
+
+### Installation
+
+**Note:** this package is still in beta and thus not yet available on Hex.
 
 Add `:arb` to your list of dependencies:
 
@@ -30,3 +38,7 @@ iex> Arb.get_active()
 docker build -t arb-ex .
 docker run --privileged -it arb-ex
 ```
+
+## See also
+
+* [abacom-relay-board](https://github.com/adriankumpf/abacom-relay-board)

lib/arb.ex

@@ -8,6 +8,9 @@ defmodule Arb do
   @doc """
   Given a list of ids turns on the corresponding relays. An empty list turns off all relays.
 
+  The relays are labeled from 1 to 8 according to the
+  [data sheet](http://www.abacom-online.de/div/ABACOM_USB_LRB.pdf).
+
   ## Options
 
   The accepted options are:
@@ -28,7 +31,7 @@ defmodule Arb do
   def activate(_ids, _opts), do: {:error, :invalid_args}
 
   @doc """
-  Returns a list of ids whose relays are active.
+  Returns ids of active relays.
 
   ## Examples
 

mix.exs

@@ -22,12 +22,6 @@ defmodule Arb.MixProject do
     ]
   end
 
-  def application do
-    [
-      # extra_applications: [:logger]
-    ]
-  end
-
   defp deps do
     [
       {:rustler, "~> 0.16.0"}

native/arb/Cargo.toml

@@ -12,4 +12,4 @@ crate-type = ["dylib"]
 rustler = "0.16.0"
 rustler_codegen = "0.16.0"
 lazy_static = "0.2"
-abacom-relay-board = { git = "https://github.com/adriankumpf/abacom-relay-board" }
+arb = { git = "https://github.com/adriankumpf/abacom-relay-board", tag = 'v0.1.0' }

native/arb/src/lib.rs

@@ -5,7 +5,7 @@ extern crate rustler;
 #[macro_use]
 extern crate rustler_codegen;
 
-extern crate abacom_relay_board;
+extern crate arb;
 
 use rustler::{NifEncoder, NifEnv, NifResult, NifTerm, types::NifListIterator};
 
@@ -33,8 +33,8 @@ struct Options {
     pub verify: bool,
 }
 
-fn arb_error_to_term<'a>(env: NifEnv<'a>, err: abacom_relay_board::Error) -> NifTerm<'a> {
-    use abacom_relay_board::Error;
+fn arb_error_to_term<'a>(env: NifEnv<'a>, err: arb::Error) -> NifTerm<'a> {
+    use arb::Error;
 
     let error = match err {
         Error::NotFound => atoms::not_found().encode(env),
@@ -64,7 +64,7 @@ fn activate<'a>(env: NifEnv<'a>, args: &[NifTerm<'a>]) -> NifResult<NifTerm<'a>>
 
     let options: Options = args[1].decode()?;
 
-    match abacom_relay_board::switch_relays(relays, options.verify, options.port) {
+    match arb::set_status(relays, options.verify, options.port) {
         Err(err) => Ok(arb_error_to_term(env, err)),
         Ok(()) => Ok(atoms::ok().encode(env)),
     }
@@ -73,7 +73,7 @@ fn activate<'a>(env: NifEnv<'a>, args: &[NifTerm<'a>]) -> NifResult<NifTerm<'a>>
 fn get_active<'a>(env: NifEnv<'a>, args: &[NifTerm<'a>]) -> NifResult<NifTerm<'a>> {
     let port: Option<u8> = args[0].decode()?;
 
-    let result = match abacom_relay_board::get_relays(port) {
+    let result = match arb::get_status(port) {
         Err(err) => return Ok(arb_error_to_term(env, err)),
         Ok(inner) => inner,
     };