Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add cordovarduino serial plugin #952

Merged
merged 3 commits into from
Jan 20, 2017
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ import { Push } from './plugins/push';
import { SafariViewController } from './plugins/safari-view-controller';
import { Screenshot } from './plugins/screenshot';
import { SecureStorage } from './plugins/securestorage';
import { Serial } from './plugins/serial';
import { Shake } from './plugins/shake';
import { Sim } from './plugins/sim';
import { SMS } from './plugins/sms';
Expand Down Expand Up @@ -199,6 +200,7 @@ export * from './plugins/safari-view-controller';
export * from './plugins/screen-orientation';
export * from './plugins/screenshot';
export * from './plugins/securestorage';
export * from './plugins/serial';
export * from './plugins/shake';
export * from './plugins/sim';
export * from './plugins/sms';
Expand Down Expand Up @@ -308,6 +310,7 @@ window['IonicNative'] = {
SafariViewController,
Screenshot,
SecureStorage,
Serial,
Shake,
Sim,
SMS,
Expand Down
2 changes: 1 addition & 1 deletion src/plugins/background-geolocation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export interface BackgroundGeolocationResponse {
* altitude if available, in meters above the WGS 84 reference ellipsoid.
*/
altitude: number;

/**
* accuracy of the altitude if available.
*/
Expand Down
111 changes: 111 additions & 0 deletions src/plugins/serial.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
import { Plugin, Cordova } from './plugin';
import { Observable } from 'rxjs/Observable';

declare var serial: any;

export interface SerialPermissionOptions {
vid: string;
pid: string;
driver: string;
}

export interface SerialOpenOptions {
baudRate: number;
}

/**
* @name Serial
* @description
* This plugin provides functions for working with Serial connections
*
* @usage
*
* ```
* import { Serial } from 'ionic-native';
*
* Serial.requestPermission({
* vid: '0403',
* pid: '6001',
* driver: 'FtdiSerialDriver'
* }).then(() => {
* Serial.open({
* baudRate: 38400
* }).then(() => {
* console.log('Serial connection opened');
* });
* }).catch((error: any) => console.log(error));
*
* ```
*/
@Plugin({
pluginName: 'Serial',
plugin: 'cordovarduino', // npm package name, example: cordova-plugin-camera
pluginRef: 'serial', // the variable reference to call the plugin, example: navigator.geolocation
repo: 'https://github.com/xseignard/cordovarduino', // the github repository URL for the plugin
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove the comments in the 3 lines above

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed these, thank you for catching that!

platforms: ['Android']
})
export class Serial {

/**
* Request permission to connect to a serial device
*
* @param options {SerialPermissionOptions} Options used to request serial permissions
* @return {Promise<any>} Returns a promise that resolves when permissions are granted
*/
@Cordova()
static requestPermission(options: SerialPermissionOptions): Promise<any> { return; }

/**
* Open connection to a serial device
*
* @param options {SerialOpenOptions} Options used to open serial connection
* @return {Promise<any>} Returns a promise that resolves when the serial connection is opened
*/
@Cordova()
static open(options: SerialOpenOptions): Promise<any> { return; }

/**
* Write to a serial connection
*
* @param data {any} data to write to the serial connection
* @return {Promise<any>} Returns a promise that resolves when the write is complete
*/
@Cordova()
static write(data: any): Promise<any> { return; }

/**
* Write hex to a serial connection
*
* @param data {any} data to write to the serial connection
* @return {Promise<any>} Returns a promise that resolves when the write is complete
*/
@Cordova()
static writeHex(data: any): Promise<any> { return; }

/**
* Read from a serial connection
*
* @return {Promise<any>} Returns a promise that resolves with data read from the serial connection
*/
@Cordova()
static read(): Promise<any> { return; }

/**
* Watch the incoming data from the serial connection. Clear the watch by unsubscribing from the observable
*
* @returns {Observable<any>} Observable returns an observable that you can subscribe to
*/
@Cordova({
observable: true
})
static registerReadCallback(): Observable<any> { return; }

/**
* Close the serial connection
*
* @return {Promise<any>} Returns a promise that resolves when the serial connection is closed
*/
@Cordova()
static close(): Promise<any> { return; }

}