Implement Proximity Detection (Near/Far) with Voyager Focus UC/5200 UC and BT600 dongle

lcollins — Fri, 02 Sep 2016 13:32:28 +0000

Keywords:

proximity near far SDK API integration 5200 uc focus voyager bt600

Greetings!

The Plantronics SDK feature for receiving proximity events when headset is Near or Far from PC can still be used with the new line of products based on BT600 dongle (Voyager Focus UC, Voyager 5200 UC).

**Full sample code for this article located here**: /system/files/FocusProximityExample.zip
(You must be logged in to download the file).

You can register for Proximity with these devices using the latest SDK version 3.8.51454.38364, located here: http://developer.plantronics.com/windows

You need to register for DeviceListener HeadsetStateChanged events, like this:

m_deviceListenerEvents.onHeadsetStateChanged += m_deviceListenerEvents_onHeadsetStateChanged;

Then you register to receive proximity:

m_hostCommandExt.EnableProximity(true); // enable proximity reporting for device
m_hostCommandExt.RequestProximity();    // request to receive asyncrounous near/far proximity event to HeadsetStateChanged event handler.

When you handle the HeadsetStateChanged events you can see if you are near or far:
(Note, there are a couple of edge cases for the older legacy wireless products where you need to re-register for proximity on InRange and ProximityDisabled, these do not apply to BT600).

        private static void m_deviceListenerEvents_onHeadsetStateChanged(COMDeviceListenerEventArgs args)
        {
            switch (args.HeadsetStateChange)
            {
                case DeviceHeadsetStateChange.HeadsetStateChange_Near:
                    Console.WriteLine(">>Headset NEAR (via deviceListener event)");
                    break;
                case DeviceHeadsetStateChange.HeadsetStateChange_Far:
                    Console.WriteLine(">>Headset FAR (via deviceListener event)");
                    // this is NOT working. for now use workaround in m_deviceComEvents_onDataReceived below.
                    break;
                case DeviceHeadsetStateChange.HeadsetStateChange_ProximityDisabled:
                    // Immediately re-enable proximity
                    RegisterForProximity(true);
                    break;
                case DeviceHeadsetStateChange.HeadsetStateChange_InRange:
                    // Immediately re-enable proximity
                    RegisterForProximity(true);
                    break;
            }
        }

Finally, there is a known issue with the current SDK version that we need to workaround to get the "Far" event. (the "Far" event is not currently reported via DeviceListener, expected to be implemented in later SDK release 3.9).

For the workaround register to receive "raw" headset data events:

            m_deviceComEvents = m_activeDevice as ICOMDeviceEvents_Event;
            m_deviceComEvents.onDataReceived += m_deviceComEvents_onDataReceived;

Then when you receive raw data event, use the code below to work out when the device is "Far":

        private static string byteArrayToString(byte[] p)
        {
            StringBuilder b = new StringBuilder();
            foreach (byte x in p)
                b.Append(x.ToString("X2"));
            return b.ToString();
        }

        private static void m_deviceComEvents_onDataReceived(ref object report)
        {
            byte[] reportbuf = (byte[])report;
            string datareporthex = byteArrayToString(reportbuf);

            // use raw device data to implement proximity Far event
            string command = datareporthex.Substring(18, 4);
            switch (command)
            {
                case "0806":
                    string nearfar = datareporthex.Substring(26, 2);
                    if (nearfar == "00")    // this workaround is required with 3.8 for now as Far is not done in Spokes SDK (will be in 3.9)
                    {
                        Console.WriteLine(">>Headset FAR (via raw device data event)");
                    }
                    break;
            }
        }

Here is a picture of the code in action:

focus proximity example.png

That's it! Have fun with proximity
Lewis.

**Full sample code for this article located here**: /system/files/FocusProximityExample.zip

Using Plantronics SDK from Java

lcollins — Thu, 05 Nov 2015 12:40:30 +0000

Keywords:

Java plantronics SDK integration REST Service API

*Update 22nd Jan 2016*: Since the SDK version 3.7.x, you can now optionally use https:// port 32018 in addition to http:// on port 32017! (however for https you may need to manually deploy the self-signed certificate if using Firefox or Java).

Sample code:
Download this sample code as a ZIP

String tmpResult =
    RESTConvenienceClass.SendRESTCommand(
    "http://127.0.0.1:32017/Spokes/DeviceServices/Attach?uid=0123456789"
);

This code requires the convenience function SendRESTCommand (available in the sample code ZIP).

0123456789 is a magic uid which tells the REST Service API to attach to the "primary" Plantronics device (primary device is settable via the Plantronics Hub user interface, in the case you have more than one Plantroncis device attached to your PC).

Now we can examine the tmpResult variable to see if the attach was a success.

int pos = tmpResult.indexOf("\"Result\":\"");
if (pos>-1)
{
    tmpResult = tmpResult.substring(pos+10);
    pos = tmpResult.indexOf("\"");
    if (pos>-1)
    {
        tmpResult = tmpResult.substring(0, pos);
        System.out.println("Session id is: " + tmpResult);
        sessionid = tmpResult;
    }
}

This code is extracting the sessionid from the HTTP response. We need that later for some of the other REST Service API commands. Note, the HTTP response is in fact JSON, so it would be better to parse with a JSON parser, but I haven't adopted a suitable JSON parser yet...

After a short delay we can go ahead an register a REST Service API plugin. The plugin is needed for some of the call control commands.

try
{
    Thread.sleep(250);
}
catch (InterruptedException ex)
{
    Logger.getLogger(PlantronicsRESTDemo.class.getName()).log(Level.SEVERE, null, ex);
}                                  
if (sessionid.length()>0)
{
    RESTConvenienceClass.SendRESTCommand(
        "http://127.0.0.1:32017/Spokes/SessionManager/Register?name=My%20Java%20Plugin"
    );               
    pluginRegistered = true;
}

Now we are able to poll for device events using further REST Service API commands, like this:
(Note: the sessid and plugin_name need to match what we registered earlier).
The contents of the responses we get back tell us lots of information, such as when user has answered a call with headset, mutes a call, takes headset off, etc.

RESTConvenienceClass.SendRESTCommand(
    "http://127.0.0.1:32017/Spokes/DeviceServices/Events?sess="
        + sessid
        + "&queue=0"
)
RESTConvenienceClass.SendRESTCommand(
    "http://127.0.0.1:32017/Spokes/CallServices/Events"
);
RESTConvenienceClass.SendRESTCommand(
    "http://127.0.0.1:32017/Spokes/CallServices/SessionManagerCallEvents?name="
        + plugin_name
);

Finally we can control the headset by telling it when we are going on a call, for example:
An incoming call (pass an integer callid, used to refer to this call during its lifecycle, and pass an optional caller name for Plantronics' display device products):

callid = callid + 1;
caller_name = "Bob%20Smith";
RESTConvenienceClass.SendRESTCommand(
    "http://127.0.0.1:32017/Spokes/CallServices/IncomingCall?name=My%20Java%20Plugin&callID=%7B%22Id%22%3A%22"
        + callid
        + "%22%7D&contact=%7B%22Name%22%3A%22"
        + caller_name
        + "%22%7D&tones=Unknown&route=ToHeadset"
);

End the call:

RESTConvenienceClass.SendRESTCommand(
    "http://127.0.0.1:32017/Spokes/CallServices/TerminateCall?name=My%20Java%20Plugin&callID=%7B%22Id%22%3A%22"
        + callid
        + "%22%7D"
);

For more examples and to see a complete Java implementation, download the sample code ZIP.

Here is a screeshot of the sample code in action running under NetBeans IDE:

false

Have fun!

Plantronics Developer Connection - integration

Implement Proximity Detection (Near/Far) with Voyager Focus UC/5200 UC and BT600 dongle

focus proximity example.png

Using Plantronics SDK from Java