English | 简体中文

notepad_core

Flutter plugin for connect & operate on smart notepad

Usage

  • Scan notepad
  • Connect notepad
  • Claim notepad
  • Sync notepen pointer
  • Import offline memo
  • Get notepad info
  • Upgrade firmware
  • Handle notepad event

Scan notepad

Android/iOS

notepadConnector.scanResultStream.listen((result) {
  print('onScanResult $result');
});

notepadConnector.startScan();
// ...
notepadConnector.stopScan();

Web

var device = notepadConnector.requestDevice();
print('requestDevice $device');

Connect notepad

Connect to result, received from notepadConnector.scanResultStream

Parameter authToken is optional. [0x00, 0x00, 0x00, 0x01] will be used if missing

notepadConnector.connectionChangeHandler = _handleConnectionChange;

void _handleConnectionChange(NotepadClient client, NotepadConnectionState state) {
  print('_handleConnectionChange $client $state');
}

var authToken = null;
notepadConnector.connect(result, authToken);
// ...
notepadConnector.disconnect();

Claim notepad

Claim with authToken, the parameter of NotepadConnector#connect

await _notepadClient.claimAuth();
print('claimAuth success');
// ...
await _notepadClient.disclaimAuth();
print('disclaimAuth success');

Sync notepen pointer

NotepadClient#setMode

  • NotepadMode.Common

    Notepad saves only NotePenPointer with positive pressure & accurate timestamp, into offline memo

  • NotepadMode.Sync

    Notepad notify every NotePenPointer, positive or not, without timestamp, to connected mobile device

Notepad is always NotepadMode.Common (connected or disconnected), unless setMode after connected

await _notepadClient.setMode(NotepadMode.Sync);
print('setMode complete');

NotepadClientCallback#handlePointer

Receive NotePenPointers in NotepadMode.Sync

_notepadClient.callback = this;

@override
  void handlePointer(List<NotePenPointer> list) {
    print('handlePointer ${list.length}');
  }
}

Import offline memo

memos are saved during NotepadMode.Common. memo consists of NotePenPointers with positive pressure & accurate timestamp.

memos are saved in a FIFO queue. Usually we collect summary and loop to import each memo.

Collect summary

NotepadClient#getMemoSummary

Get memos' count, used space, .etc

var memoSummary = await _notepadClient.getMemoSummary();
print('getMemoSummary $memoSummary');

Import a single memo

NotepadClient#getMemoInfo

Get the first memo's info from the FIFO queue

var memoInfo = await _notepadClient.getMemoInfo();
print('getMemoInfo $memoInfo');

NotepadClient#importMemo

Import the first memo from the FIFO queue

await _notepadClient.importMemo((progress) => print('progress $progress'));

NotepadClient#deleteMemo

Delete the first memo from the FIFO queue

await _notepadClient.deleteMemo();
print('deleteMemo complete');

Get notepad info

Paint Size

print('Size: ${_notepadClient.getDeviceSize()}')

Device Name

var name = await _notepadClient.getDeviceName();
print('getDeviceName $name');

await _notepadClient.setDeviceName('name');
print('setDeviceName complete');

Battery Info

var batteryInfo = await _notepadClient.getBatteryInfo();
print('getBatteryInfo $batteryInfo');

Device Date

var timestamp = await _notepadClient.getDeviceDate();
print('getDeviceDate $date');

await _notepadClient.setDeviceDate(timestamp);
print('setDeviceDate complete');

Auto-Lock Time

var duration = await _notepadClient.getAutoLockTime();

await _notepadClient.setAutoLockTime(duration);
print('setAutoLockTime complete');

Upgrade firmware

Upgrade notepad firmware with *.srec file

await _notepadClient.upgrade(blob, version, (progress) {
  print("upgrade progress $progress");
});

Handle notepad event

  • KeyEvent
  • BatteryAlertEvent
  • ChargingStatusEvent
  • StorageAlertEvent
_notepadClient.callback = this;

@override
void handleEvent(NotepadEvent notepadEvent) {
  print('handleEvent $notepadEvent');
}

Libraries

FileRecord
ImageTransmission
Notepad
NotepadClient
NotepadConnector
NotepadType
Woodemi
WoodemiClient
models
notepad_core
utils