usb-serial-plugin

This plugin can be used for reading data from other device over the usb channel

Install

npm install usb-serial-plugin
npx cap sync

API

connectedDevices()
openSerial(...)
closeSerial()
readSerial()
writeSerial(...)
addListener('log', ...)
addListener('connected', ...)
addListener('attached', ...)
addListener('detached', ...)
addListener('data', ...)
addListener('error', ...)
Interfaces

connectedDevices()

connectedDevices() => Promise<{ devices: []; }>

Returns: Promise<{ devices: []; }>

openSerial(...)

openSerial(options: UsbSerialOptions) => Promise<void>

Param	Type
`options`	`UsbSerialOptions`

closeSerial()

closeSerial() => Promise<void>

readSerial()

readSerial() => Promise<{ data: string; }>

Returns: Promise<{ data: string; }>

writeSerial(...)

writeSerial(options: { data: string; }) => Promise<void>

Param	Type
`options`	`{ data: string; }`

addListener('log', ...)

addListener(eventName: 'log', listenerFunc: (data: { text: string; tag: string; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Param	Type
`eventName`	`'log'`
`listenerFunc`	`(data: { text: string; tag: string; }) => void`

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('connected', ...)

addListener(eventName: 'connected', listenerFunc: (data: UsbSerialDevice) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Param	Type
`eventName`	`'connected'`
`listenerFunc`	`(data: UsbSerialDevice) => void`

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('attached', ...)

addListener(eventName: 'attached', listenerFunc: (data: UsbSerialDevice) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Param	Type
`eventName`	`'attached'`
`listenerFunc`	`(data: UsbSerialDevice) => void`

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('detached', ...)

addListener(eventName: 'detached', listenerFunc: (data: UsbSerialDevice) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Param	Type
`eventName`	`'detached'`
`listenerFunc`	`(data: UsbSerialDevice) => void`

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('data', ...)

addListener(eventName: 'data', listenerFunc: (data: { data: string; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Param	Type
`eventName`	`'data'`
`listenerFunc`	`(data: { data: string; }) => void`

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('error', ...)

addListener(eventName: 'error', listenerFunc: (data: { error: string; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Param	Type
`eventName`	`'error'`
`listenerFunc`	`(data: { error: string; }) => void`

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Interfaces

UsbSerialOptions

Prop	Type
`deviceId`	`number`
`portNum`	`number`
`baudRate`	`number`
`dataBits`	`number`
`stopBits`	`number`
`parity`	`number`
`dtr`	`boolean`
`rts`	`boolean`

PluginListenerHandle

Prop	Type
`remove`	`() => Promise<void>`

UsbSerialDevice

Prop	Type
`pid`	`number`
`vid`	`number`
`did`	`number`

icedleon / capacitor-plugin-usb-serial Goto Github PK

capacitor-plugin-usb-serial's Introduction

usb-serial-plugin

Install

API

connectedDevices()

openSerial(...)

closeSerial()

readSerial()

writeSerial(...)

addListener('log', ...)

addListener('connected', ...)

addListener('attached', ...)

addListener('detached', ...)

addListener('data', ...)

addListener('error', ...)

Interfaces

UsbSerialOptions

PluginListenerHandle

UsbSerialDevice

capacitor-plugin-usb-serial's People

Contributors

Recommend Projects

Recommend Topics

Recommend Org