@adeunis/capacitor-serial v1.0.2

capacitor-serial

Manage serial connections to Android devices for Capacitor projects.

NB: Does not work for Web or iOS.

Install

npm install @adeunis/capacitor-serial
npx cap sync

Basic usage

    //Connection
    Serial.requestSerialPermissions({vendorId: '1111', productId: '2222', driver: SerialDriverEnum.CDC_ACM_SERIAL_DRIVER})
    .then((permissionResponse) => {
        if (!permissionResponse.granted) {
            return Promise.reject('Permission refused');
        }
        return Promise.resolve();

    })
    .then(() => Serial.openConnection({baudRate: 115200}))
    .then(() => log.info('Serial connection opend'))
    .catch((error) => log.error(error));

    //Write
    Serial.write({data: 'my_message'})
        .then(() => log.info('Data sent'))
        .catch((error: SerialError ) => {
            log.error(`error : ${error}`);
        });
    
    
    //Read
    Serial.read({readRaw: false}).then((message) => log.info(message.data));

    //Read callback 
    Serial.registerReadCallback((message, error) => {
        if (message !== undefined && message !== null) {
            log.info(message.data);

        } else if (error !== undefined && error !== null) {
            log.error(`error : ${error}`);
        }
    })

    Serial.closeConnection().then(() => log.info('Serial connection closed'));

API

• requestSerialPermissions(...)
• openConnection(...)
• closeConnection()
• write(...)
• writeHexadecimal(...)
• read(...)
• registerReadCallback(...)
• unregisterReadCallback()
• registerReadRawCallback(...)
• unregisterReadRawCallback()
• Interfaces
• Type Aliases
• Enums

requestSerialPermissions(...)

requestSerialPermissions(parameters?: SerialPermissionsParameters | undefined) => Promise<SerialPermissions>

Request permissions to connect to a device over a serial connection

Returns: Promise<SerialPermissions>

openConnection(...)

openConnection(parameters: SerialConnectionParameters) => Promise<void>

Open a serial connection to a device

closeConnection()

closeConnection() => Promise<void>

Close the serial connection

write(...)

write(message: SerialMessage) => Promise<void>

Write a message to a serial connection

writeHexadecimal(...)

writeHexadecimal(message: SerialMessage) => Promise<void>

Write a hexadecimal message to a serial connection

read(...)

read(parameters: SerialReadParameters) => Promise<SerialMessage>

Read from a serial connection

Returns: Promise<SerialMessage>

registerReadCallback(...)

registerReadCallback(callback: SerialReadCallback) => Promise<string>

Register a callback to receive the incoming data from the serial connection

Returns: Promise<string>

unregisterReadCallback()

unregisterReadCallback() => Promise<void>

Unregister the read callback

registerReadRawCallback(...)

registerReadRawCallback(callback: SerialReadCallback) => Promise<string>

Register a callback to receive the incoming raw data from the serial connection

Returns: Promise<string>

unregisterReadRawCallback()

unregisterReadRawCallback() => Promise<void>

Unregister the read raw callback

Interfaces

SerialPermissions

SerialPermissionsParameters

SerialConnectionParameters

SerialMessage

SerialReadParameters

Type Aliases

SerialReadCallback

(message: SerialMessage, error?: SerialError): void

Enums

SerialDriverEnum

SerialError