bluez-profile 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 768299afaa1258a583149f1ff896b6522159c49c2d0090d57491f144a9cfa94b
+  data.tar.gz: d69e4bb1204ceb41f3ab4710a5bfb7948407533455f54c8d7b45c375f62f67b7
+SHA512:
+  metadata.gz: 9e48632a5208e5f08973bbad6fde0ee347edf685ddff1dd2ab69db1e1edfac3f909390fe8809158bd2911945d23fcb0ebb75818676f87369fd012e130e85a4d4
+  data.tar.gz: fbd115fee66256f7115f63f11a82830e96c72387eb1528101a2562b73aad34535ead60b722afd65d906a2ce117deb6308364366e05f73e927fcaae8dd6de50cc

data/LICENCE

@@ -0,0 +1,22 @@
+Copyright (c) 2021 Clive Andrews
+
+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,189 @@
+# bluez Profile API bindings
+
+this gem allows easy creation of bluetooth services.
+For example create a serial link over to another device using bluetooth.
+
+ https://github.com/pauloborges/bluez/blob/master/doc/profile-api.txt
+
+
+Clive Andrews 2021
+
+## dependencies
+
+* Linux/Unix type system
+* bluez 5
+* glib-2 (dev)
+
+## prerequisites
+
+your bluetooth devices must be paired and trusted outside of this gem
+in order for them to communicate.
+
+use eg `bluetoothctl`
+
+## API
+
+example code:
+
+    class MyProfile < Bluez::Profile
+
+      # This method gets called when the service daemon
+      # unregisters the profile. A profile can use it to do
+      # cleanup tasks.
+
+      def release
+
+      end
+
+      # This method gets called when a new service level
+      # connection has been made and authorized.
+
+      def  connection(device, fd, fd_properties)
+
+      end
+
+      # This method gets called when a profile gets
+      # disconnected.
+      #
+      # The file descriptor is no longer owned by the service
+      # daemon and the profile implementation needs to take
+      # care of cleaning up all connections.
+      #
+      # If multiple file descriptors are indicated via
+      # NewConnection, it is expected that all of them
+      # are disconnected before returning from this
+      # method call.
+
+      def disconnection(device)
+
+      end
+
+    end
+
+    path = '/my/dbus/path'
+    uuid = '1101'
+
+    options = {
+      name: 'my profile',
+      channel: 3
+      connect: false
+    }
+
+    profile = MyProfile.new(path, uuid, options)
+    profile.run   # enters loop and blocks here.
+
+    profile.stop  # stops the loop
+
+
+path: string
+
+    the dbus object path of the profile.
+    eg: "/serial/special/profile"
+
+uuid: string
+
+    the dbus profile uuid
+
+
+Available options:
+
+        name: string
+
+          Human readable name for the profile
+
+        service: string
+
+          The primary service class UUID
+          (if different from the actual
+           profile UUID)
+
+        role: string
+
+          For asymmetric profiles that do not
+          have UUIDs available to uniquely
+          identify each side this
+          parameter allows specifying the
+          precise local role.
+
+          Possible values:
+
+              Bluez::Profile::Client
+              Bluez::Profile::Server
+
+        channel: int
+
+          RFCOMM channel number that is used
+          for client and server UUIDs.
+
+          If applicable it will be used in the
+          SDP record as well.
+
+        psm: int
+
+          PSM number that is used for client
+          and server UUIDs.
+
+          If applicable it will be used in the
+          SDP record as well.
+
+        authentication: boolean
+
+          Pairing is required before connections
+          will be established. No devices will
+          be connected if not paired.
+
+        authorization: boolean
+
+          Request authorization before any
+          connection will be established.
+
+        connect: boolean
+
+          In case of a client UUID this will
+          force connection of the RFCOMM or
+          L2CAP channels when a remote device
+          is connected.
+
+        record: string
+
+          Provide a manual SDP record.
+
+        version: int
+
+          Profile version (for SDP record)
+
+        features: int
+
+          Profile features (for SDP record)
+
+## server
+
+If a channel number is already in use your service may not be registered.
+Check that your services have been registered correctly with eg:
+
+    sudo sdptool browse local
+
+## examples
+
+See the `/examples` folder.
+
+## issues
+
+The server side of things seems to work fine.
+
+run several servers over the same serial service using different
+channel numbers
+
+on the client ( paired and trusted) connect each channel eg :
+
+    sudo rfcomm connect /dev/rfcomm0 remoteaddr channel1
+    sudo rfcomm connect /dev/rfcomm1 remoteaddr channel2
+    sudo rfcomm connect /dev/rfcomm2 remoteaddr channel3
+
+this works perfectly. each device file allows interaction with the correct server.
+
+*BUT* if on the client a profile is registered with bluez using this gem
+and a connection made to the server then things get in a muddle and output
+for the one channel gets sent to the wrong profile !!
+
+any ideas ??

data/ext/bluez/extconf.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'mkmf'
+
+pkg_config("glib-2.0")
+pkg_config("gio-2.0")
+pkg_config("gio-unix-2.0")
+
+find_header("gio/gio.h")
+
+find_library('gio-2.0','g_bus_watch_name')
+
+
+create_makefile('bluez/profile')

data/ext/bluez/profile.c

@@ -0,0 +1,448 @@
+// this ruby binding allows a profile to be registered
+// with the bluez stack.
+//
+// (c) C. Andrews 2021
+//
+// References:
+//
+// https://github.com/pauloborges/bluez/blob/master/doc/profile-api.txt
+// https://github.com/tonyespy/bluez5-spp-example
+// https://github.com/bratsche/glib/blob/master/gio/tests/gdbus-example-server.c
+
+
+#include <gio/gio.h>
+#include <gio/gunixfdlist.h>
+#include <stdlib.h>
+#include <ruby.h>
+
+#define BLUEZ_BUS_NAME                   "org.bluez"
+#define BLUEZ_BUS_PATH                   "/org/bluez"
+#define BLUEZ_INTERFACE_DEVICE1          "org.bluez.Device1"
+#define BLUEZ_INTERFACE_PROFILE1         "org.bluez.Profile1"
+#define BLUEZ_INTERFACE_PROFILEMANAGER1  "org.bluez.ProfileManager1"
+
+static VALUE mBluez;
+static VALUE cProfile;
+static VALUE eProfileError;
+
+typedef struct t_profile_data{
+    GDBusConnection* conn;
+    GDBusProxy*      proxy;
+    GDBusNodeInfo*   introspection_data;
+    guint            id;
+    GMainLoop*       loop;
+    int              running;
+    int              fd;
+} t_profile_data;
+
+
+/* Introspection data for the service we are exporting */
+static const gchar introspection_xml[] =
+  "<node>"
+  "  <interface name='org.bluez.Profile1'>"
+  "    <method name='Release'>"
+  "    </method>"
+  "    <method name='NewConnection'>"
+  "      <arg type='o' name='device' direction='in'/>"
+  "      <arg type='h' name='fd' direction='in'/>"
+  "      <arg type='a{sv}' name='fd_properties' direction='in'/>"
+  "    </method>"
+  "    <method name='RequestDisconnection'>"
+  "      <arg type='o' name='device' direction='in'/>"
+  "    </method>"
+  "  </interface>"
+  "</node>";
+
+// free the c data structure
+
+static void profile_free_data(t_profile_data* p){
+    if (p->id !=0 ) g_dbus_connection_unregister_object(p->conn, p->id);
+    if (p->introspection_data !=NULL ) g_dbus_node_info_unref (p->introspection_data);
+    if (p->proxy !=NULL ) g_object_unref (p->proxy);
+    if (p->conn !=NULL ) g_object_unref (p->conn);
+    if (p->loop !=NULL ) g_main_loop_unref(p->loop);
+    p->introspection_data = NULL;
+    p->proxy = NULL;
+    p->conn = NULL;
+    p->loop = NULL;
+    free(p);
+}
+
+// allocate the c data structure
+
+static VALUE profile_alloc_data(VALUE self){
+  VALUE obj;
+  t_profile_data* data = malloc(sizeof(t_profile_data));
+  data->conn = NULL;
+  data->proxy = NULL;
+  data->introspection_data = NULL;
+  data->loop = NULL;
+  obj = Data_Wrap_Struct(self, 0, profile_free_data, data);
+  return obj;
+}
+
+// handle object method calls    ----------------------------------------------
+static void
+handle_method_call (GDBusConnection       *connection,
+                    const gchar           *sender,
+                    const gchar           *object_path,
+                    const gchar           *interface_name,
+                    const gchar           *method_name,
+                    GVariant              *parameters,
+                    GDBusMethodInvocation *invocation,
+                    gpointer               user_data)
+{
+
+  VALUE self;
+  GDBusMessage *message;
+  GUnixFDList *fd_list;
+  GError *error = NULL;
+  gchar*      path;
+  int         fd_idx;
+  int         fd;
+  GVariantIter *list;
+
+  self = (VALUE) user_data;
+
+  if (g_strcmp0 (method_name, "Release") == 0)
+    {
+      //printf("Release Called\n");
+      rb_funcall(self,  rb_intern("release"), 0 );
+    }
+  else if (g_strcmp0 (method_name, "NewConnection") == 0)
+  // in_signature="oha{sv}"
+    {
+        g_variant_get (parameters, "(oha{sv})", &path, &fd_idx, &list);
+        message = g_dbus_method_invocation_get_message (invocation);
+        fd_list = g_dbus_message_get_unix_fd_list (message);
+        fd = g_unix_fd_list_get (fd_list, fd_idx, &error);
+        if (error!=NULL){
+          rb_raise(eProfileError, "invalid file descriptor");
+          return;
+        }
+        rb_funcall(self,  rb_intern("connection"), 2,rb_str_new2(path), INT2NUM(fd) );
+    }
+  else if (g_strcmp0 (method_name, "RequestDisconnection") == 0)
+  // in_signature="o"
+    {
+      //printf("RequestDisconnection Called\n");
+      g_variant_get (parameters, "o", &path);
+      rb_funcall(self,  rb_intern("disconnection"), 1,rb_str_new2(path) );
+    }
+
+}
+
+// static GVariant *
+// handle_get_property (GDBusConnection  *connection,
+//                      const gchar      *sender,
+//                      const gchar      *object_path,
+//                      const gchar      *interface_name,
+//                      const gchar      *property_name,
+//                      GError          **error,
+//                      gpointer          user_data)
+// {
+//   return NULL;
+// }
+//
+// static gboolean
+// handle_set_property (GDBusConnection  *connection,
+//                      const gchar      *sender,
+//                      const gchar      *object_path,
+//                      const gchar      *interface_name,
+//                      const gchar      *property_name,
+//                      GVariant         *value,
+//                      GError          **error,
+//                      gpointer          user_data)
+// {
+//   return TRUE;
+// }
+//
+
+static const GDBusInterfaceVTable vtable =
+{
+  handle_method_call,
+  NULL,
+  NULL
+};
+
+// register our profile object with dbus  --------------------------------------
+
+static guint register_object(VALUE self, t_profile_data* data, const gchar* path){
+  guint id;
+  GError *error = NULL;
+
+  id = g_dbus_connection_register_object (
+    data->conn,
+    path,
+    data->introspection_data->interfaces[0],
+    &vtable,
+    (gpointer) self, //user_data,
+    NULL, //user_data_free_func,
+    &error
+  );
+
+  return id;
+}
+
+// register our profile with bluez --------------------------------------------
+
+int register_profile(VALUE path, VALUE uuid, VALUE options, GDBusProxy *proxy){
+
+  GVariant *profile;
+  GVariantBuilder profile_builder;
+  GError *error = NULL;
+  VALUE val;
+
+  //printf("register_profile called!\n");
+
+  g_variant_builder_init(&profile_builder, G_VARIANT_TYPE("(osa{sv})"));
+
+  g_variant_builder_add (&profile_builder, "o",StringValueCStr(path));
+
+  g_variant_builder_add (&profile_builder, "s", StringValueCStr(uuid));
+
+  g_variant_builder_open(&profile_builder, G_VARIANT_TYPE("a{sv}"));
+
+  // Name
+
+  val = rb_hash_aref(options, ID2SYM(rb_intern("name")));
+  if (val != Qnil){
+    g_variant_builder_open(&profile_builder, G_VARIANT_TYPE("{sv}"));
+    g_variant_builder_add (&profile_builder, "s", "Name");
+    g_variant_builder_add (&profile_builder, "v",
+        g_variant_new_string(StringValueCStr(val) ));
+    g_variant_builder_close(&profile_builder);
+  }
+
+  // Service
+
+  val = rb_hash_aref(options, ID2SYM(rb_intern("service")));
+  if (val != Qnil){
+    g_variant_builder_open(&profile_builder, G_VARIANT_TYPE("{sv}"));
+    g_variant_builder_add (&profile_builder, "s", "Service");
+    g_variant_builder_add (&profile_builder, "v",
+        g_variant_new_string(StringValueCStr(val) ));
+    g_variant_builder_close(&profile_builder);
+  }
+
+  // Role
+
+  val = rb_hash_aref(options, ID2SYM(rb_intern("role")));
+  if (val != Qnil){
+    g_variant_builder_open(&profile_builder, G_VARIANT_TYPE("{sv}"));
+    g_variant_builder_add (&profile_builder, "s", "Role");
+    g_variant_builder_add (&profile_builder, "v",
+        g_variant_new_string(StringValueCStr(val)  ));
+    g_variant_builder_close(&profile_builder);
+  }
+
+  // Channel
+
+  val = rb_hash_aref(options, ID2SYM(rb_intern("channel")));
+  if (val != Qnil){
+    g_variant_builder_open(&profile_builder, G_VARIANT_TYPE("{sv}"));
+    g_variant_builder_add (&profile_builder, "s", "Channel");
+    g_variant_builder_add (&profile_builder, "v", g_variant_new_uint16(FIX2INT(val)));
+    g_variant_builder_close(&profile_builder);
+  }
+
+  // PSM
+
+  val = rb_hash_aref(options, ID2SYM(rb_intern("psm")));
+  if (val != Qnil){
+    g_variant_builder_open(&profile_builder, G_VARIANT_TYPE("{sv}"));
+    g_variant_builder_add (&profile_builder, "s", "PSM");
+    g_variant_builder_add (&profile_builder, "v", g_variant_new_uint16(FIX2INT(val)));
+    g_variant_builder_close(&profile_builder);
+  }
+
+  // RequireAuthentication
+
+  val = rb_hash_aref(options, ID2SYM(rb_intern("authentication")));
+  if (val != Qnil){
+    g_variant_builder_open(&profile_builder, G_VARIANT_TYPE("{sv}"));
+    g_variant_builder_add (&profile_builder, "s", "RequireAuthentication");
+    g_variant_builder_add (&profile_builder, "v", g_variant_new_boolean(RTEST(val) ));
+    g_variant_builder_close(&profile_builder);
+  }
+
+  // RequireAuthorization
+
+  val = rb_hash_aref(options, ID2SYM(rb_intern("authorization")));
+  if (val != Qnil){
+    g_variant_builder_open(&profile_builder, G_VARIANT_TYPE("{sv}"));
+    g_variant_builder_add (&profile_builder, "s", "RequireAuthorization");
+    g_variant_builder_add (&profile_builder, "v", g_variant_new_boolean(RTEST(val) ));
+    g_variant_builder_close(&profile_builder);
+  }
+
+  // AutoConnect
+
+  val = rb_hash_aref(options, ID2SYM(rb_intern("connect")));
+  if (val != Qnil){
+    g_variant_builder_open(&profile_builder, G_VARIANT_TYPE("{sv}"));
+    g_variant_builder_add (&profile_builder, "s", "AutoConnect");
+    g_variant_builder_add (&profile_builder, "v", g_variant_new_boolean(RTEST(val) ));
+    g_variant_builder_close(&profile_builder);
+  }
+
+  // ServiceRecord
+
+  val = rb_hash_aref(options, ID2SYM(rb_intern("record")));
+  if (val != Qnil){
+    g_variant_builder_open(&profile_builder, G_VARIANT_TYPE("{sv}"));
+    g_variant_builder_add (&profile_builder, "s", "ServiceRecord");
+    g_variant_builder_add (&profile_builder, "v",
+        g_variant_new_string(StringValueCStr(val) ));
+    g_variant_builder_close(&profile_builder);
+  }
+
+  // Version
+
+  val = rb_hash_aref(options, ID2SYM(rb_intern("version")));
+  if (val != Qnil){
+    g_variant_builder_open(&profile_builder, G_VARIANT_TYPE("{sv}"));
+    g_variant_builder_add (&profile_builder, "s", "Version");
+    g_variant_builder_add (&profile_builder, "v", g_variant_new_uint16(FIX2INT(val)));
+    g_variant_builder_close(&profile_builder);
+  }
+
+  // Features
+
+  val = rb_hash_aref(options, ID2SYM(rb_intern("features")));
+  if (val != Qnil){
+    g_variant_builder_open(&profile_builder, G_VARIANT_TYPE("{sv}"));
+    g_variant_builder_add (&profile_builder, "s", "Features");
+    g_variant_builder_add (&profile_builder, "v", g_variant_new_uint16(FIX2INT(val)));
+    g_variant_builder_close(&profile_builder);
+  }
+
+  g_variant_builder_close(&profile_builder);
+  profile = g_variant_builder_end(&profile_builder);
+
+  g_dbus_proxy_call_sync (proxy,
+        "RegisterProfile",
+        profile,
+        G_DBUS_CALL_FLAGS_NONE,
+        -1,
+        NULL,
+        &error);
+
+  if (error!=NULL){
+    return 0;
+  }
+
+  return 1;
+}
+
+
+// initialize our profile here. ------------------------------------------------
+
+static VALUE profile_initialize(VALUE self, VALUE path, VALUE uuid, VALUE options){
+  t_profile_data* data = NULL;
+  GError *error = NULL;
+  int ok;
+  const gchar * cpath = StringValueCStr(path);
+  Data_Get_Struct(self, t_profile_data, data);
+
+  // validate the path
+
+  if (!g_variant_is_object_path(cpath)) {
+    rb_raise(eProfileError, "invalid object path");
+    return Qnil;
+  }
+
+  data->loop = g_main_loop_new (NULL, FALSE);
+  data->running = FALSE;
+
+  data->introspection_data = g_dbus_node_info_new_for_xml (introspection_xml, NULL);
+  if (data->introspection_data==NULL){
+    rb_raise(eProfileError, "error generating introspection data");
+    return Qnil;
+  }
+
+  // connect to dbus system bus
+  data->conn = g_bus_get_sync(G_BUS_TYPE_SYSTEM, NULL, &error);
+  if (error!=NULL){
+    rb_raise(eProfileError, "error connecting to dbus");
+    return Qnil;
+  }
+
+  // obtain a proxy to bluez profile manager.
+
+  data->proxy = g_dbus_proxy_new_sync (data->conn,
+          G_DBUS_PROXY_FLAGS_NONE,
+          NULL,/* GDBusInterfaceInfo */
+          BLUEZ_BUS_NAME,/* name */
+          BLUEZ_BUS_PATH,/* object path */
+          BLUEZ_INTERFACE_PROFILEMANAGER1,/* interface */
+          NULL,/* GCancellable */
+          &error);
+
+  if (error!=NULL){
+    rb_raise(eProfileError, "error connecting to bluez profile manager");
+    return Qnil;
+  }
+
+  // register our profile object with dbus
+
+  data->id = register_object(self, data, cpath);
+
+  if (data->id==0){
+    rb_raise(eProfileError, "error registering profile object");
+    return Qnil;
+  }
+
+  // and register the profile with the profile manager.
+
+  ok = register_profile(path, uuid, options, data->proxy);
+
+  if (ok==0){
+    rb_raise(eProfileError, "error register profile with bluez");
+    return Qnil;
+  }
+
+  return self;
+}
+
+// run the event loop ----------------------------------------------------------
+
+static VALUE profile_run(VALUE self){
+  t_profile_data* data = NULL;
+  GMainContext *  context = g_main_context_default();
+  Data_Get_Struct(self, t_profile_data, data);
+  if (!data->running){
+    data->running = TRUE;
+    while(data->running){
+      g_main_context_iteration (context, FALSE);
+      rb_thread_schedule();
+    }
+  }
+  return self;
+}
+
+// stop the event loop ---------------------------------------------------------
+
+static VALUE profile_stop(VALUE self){
+  t_profile_data* data = NULL;
+  Data_Get_Struct(self, t_profile_data, data);
+  data->running = FALSE;
+  return self;
+}
+
+//=============================== ruby interface definition ====================
+
+void Init_profile() {
+
+  mBluez        = rb_define_module("Bluez");
+  cProfile      = rb_define_class_under(mBluez, "Profile", rb_cObject);
+  eProfileError = rb_define_class_under(cProfile, "Error",rb_eStandardError);
+
+  rb_define_const(cProfile, "Client", rb_str_new_cstr("client"));
+  rb_define_const(cProfile, "Server", rb_str_new_cstr("server"));
+
+  rb_define_alloc_func(cProfile, profile_alloc_data);
+  rb_define_method(cProfile, "initialize", profile_initialize, 3);
+  rb_define_method(cProfile, "run", profile_run, 0);
+  rb_define_method(cProfile, "stop", profile_stop, 0);
+}

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: bluez-profile
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- Clive Andrews
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-21 00:00:00.000000000 Z
+dependencies: []
+description: Create Custom Bluez Bluetooth Profiles
+email:
+- gems@realitybites.eu
+executables: []
+extensions:
+- ext/bluez/extconf.rb
+extra_rdoc_files:
+- README.md
+- LICENCE
+files:
+- LICENCE
+- README.md
+- ext/bluez/extconf.rb
+- ext/bluez/profile.c
+homepage: https://github.com/realbite/bluez-profile
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: binding to Bluez Profile API
+test_files: []