NeoSmartpen / Windows-SDK2.0

Neo smartpen SDK 2.0 for Windows Platform
GNU General Public License v3.0
21 stars 10 forks source link

Neo smartpen SDK for Windows Platform

Windows SDK

Windows SDK for Windows. This open-source library allows you to integrate the Neo smartpen - Neo smartpen N2 and M1 - into your Windows program.

About Neo smartpen

The Neo smartpen is designed to seamlessly integrate the real and digital worlds by transforming what you write on paper - everything from sketches and designs to business meeting notes - to your iOS, Android and Windows devices. It works in tandem with N notebooks, powered by NeoLAB Convergence’s patented Ncode™ technology and the accompanying application, Neo Notes. Find out more at www.neosmartpen.com

About Ncode™: service development guide

‘Natural Handwriting’ technology based on Ncode™(Microscopic data patterns containing various types of data) is a handwriting stroke recovery technology that digitizes paper coordinates obtained by optical pen devices such as Neo smartpen. The coordinates then can be used to store handwriting stroke information, analyzed to extract meaning based on user preferences and serve as the basis for many other types of services.

Click the link below to view a beginners guide to Ncode technology. https://github.com/NeoSmartpen/Documentations/blob/master/Ncode™ Service Development Getting Started Guide v1.01.pdf

Requirements

Dependencies

API References

SDK API references page : References

Getting started (Basic)

Notice

SDK handle data and commucation with peer device in other thread. So if you want data get from pen to appear in UI, than you have to execute in UI thread.

Create GenericBluetoothPenClient and PenController instance

// create PenController instance.
// PenController control all pen event method
var controller = new PenController();

// Create GenericBluetoothPenClient instance. and bind PenController.
// GenericBluetoothPenClient is implementation of bluetooth function.
var client = new GenericBluetoothPenClient(controller);

Find Bluetooth Devices

You can find bluetooth device using below methods. And get PenInformation object that has bluetooth device information.

Find device
List<PenInformation> penList = await client.FindDevices();
Using LE Advertisement Watcher
// bluetooth watcher event
client.onStopSearch += onStopSearch;
client.onUpdatePenController += onUpdatePenController;
client.onAddPenController += onAddPenController;

// start watcher
client.StartLEAdvertisementWatcher();

// Event that is called when a device is added by the watcher
private void onAddPenController(IPenClient sender, PenInformation args)
{
}

// Event that is called when a device is updated
private void onUpdatePenController(IPenClient sender, PenUpdateInformation args)
{
}

// Event that is called when the watcher operation has been stopped
private void onStopSearch(IPenClient sender, Windows.Devices.Bluetooth.BluetoothError args)
{
}

Connect with device

// penInfomation is PenInformation class object what can be obtained from find device method
bool result = await client.Connect(penInfomation);

After Connection is established.

// add event in init method
controller.Connected += connected;
controller.PasswordRequested += passwordRequested;
controller.Authenticated += authenticated;

// It is called when connection is established ( You cannot use function on your device without authentication )
private void connected(IPenClient sender, ConnectedEventArgs args)
{
    Debug.WriteLine($"Mac : {args.MacAddress}\r\nName : {args.DeviceName}\r\nSubName : {args.SubName}\r\nFirmware Version : {args.FirmwareVersion}\r\nProtocol Version : {args.ProtocolVersion}");
}

// If your device is locked, it is called to input password.
private void passwordRequested(IPenClient sender, PasswordRequestedEventArgs args)
{
    Debug.WriteLine($"Retry Count : {args.RetryCount}, ResetCount :  {args.ResetCount }");
    controller.InputPassword(password);
}

// If your pen is not locked, or authentication is passed, it will be called.
// When it is called, You can use all function on your device.
private void authenticated(IPenClient sender, object args)
{
}

Handling a handwriting data from peer device

// add event in init method
controller.DotReceived += dotReceived;

// Identifier of note(paper) (it is consist of section and owner, note)
int section = 1;
int owner = 1;
int note = 102;

// Requests to set your note type.
controller.AddAvailableNote(section, owner, note);

// event that is called when writing data is received
private void dotReceived(IPenClient sender, DotReceivedEventArgs args)
{
// TODO : You should implements code using coordinate data.
}

Querying list of offline data in Smartpen's storage

// add event in init method
controller.OfflineDataListReceived += offlineDataListReceived;

// Request offline data list
controller.RequestOfflineDataList();

// Event method to receive offline data list
private void offlineDataListReceived(IPenClient sender, OfflineDataListReceivedEventArgs args)
{
}

Downloading offline data in Smartpen's storage

// add event in init method
controller.OfflineDataDownloadStarted += offlineDataDownloadStarted;
controller.OfflineStrokeReceived += offlineStrokeReceived;
controller.OfflineDownloadFinished += offlineDownloadFinished;

// it is invoked when begins downloading offline data
private void offlineDataDownloadStarted(IPenClient sender, object args)
{
}

// it is invoked when it obtained offline data ( it can be called several times )
private void offlineStrokeReceived(IPenClient sender, OfflineStrokeReceivedEventArgs args)
{
}

// it is invoked when finished downloading
private void offlineDownloadFinished(IPenClient sender, SimpleResultEventArgs args)
{
}

LICENSE

Copyright©2017 by NeoLAB Convergence, Inc. All page content is property of NeoLAB Convergence Inc. https://neolab.net

GPL License v3 - for non-commercial purpose

For non-commercial use, follow the terms of the GNU General Public License.

GPL License v3 is a free software: you can run, copy, redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the program. If not, see https://www.gnu.org/licenses/.

Commercial license - for commercial purpose

For commercial use, it is not necessary or required to open up your source code. Technical support from NeoLAB Convergence, inc is available upon your request.

Please contact our support team via email for the terms and conditions of this license.

Opensource Library

Please refer to the details of the open source library used below.

1. SharpZipLib (https://github.com/icsharpcode/SharpZipLib)

This software is now released under the MIT License. Please see issue #103 for more information on the relicensing effort.

Previous versions were released under the GNU General Public License, version 2 with an exception which allowed linking with non-GPL programs.


Feel free to leave any comment or feedback here