Class NordicBleDevice

Hierarchy (View Summary)

BleDevice
- NordicBleDevice
  - EspruinoBleDevice

Index

Constructors

constructor

new NordicBleDevice(
device: BluetoothDevice,
opts?: Io.Bluetooth.Opts,
): NordicBleDevice
Parameters
- device: BluetoothDevice
- opts: Io.Bluetooth.Opts = {}
Returns NordicBleDevice
Overrides BleDevice.constructor

Properties

codec

codec: Codec

gatt

gatt: undefined | BluetoothRemoteGATTServer

rx

rx: undefined | BluetoothRemoteGATTCharacteristic

rxBuffer

rxBuffer: StringReceiveBuffer

states

states: Flow.StateMachine.WithEvents<
    Readonly<
        Readonly<
            {
                closed: "connecting";
                connected: string[];
                connecting: string[];
                ready: "connecting";
            },
        >,
    >,
>

tx

tx: undefined | BluetoothRemoteGATTCharacteristic

txBuffer

txBuffer: StringWriteBuffer

verboseLogging

verboseLogging: boolean = false

Accessors

isClosed

get isClosed(): boolean
Returns boolean
Inherited from BleDevice.isClosed

isConnected

get isConnected(): boolean
Returns boolean
Inherited from BleDevice.isConnected

isDisposed

get isDisposed(): boolean
Returns boolean
Inherited from BleDevice.isDisposed

Methods

addEventListener

addEventListener<
    K extends
        keyof IoEvents<
            Readonly<
                Readonly<
                    {
                        closed: "connecting";
                        connected: string[];
                        connecting: string[];
                        ready: "connecting";
                    },
                >,
            >,
        >,
>(
    name: K,
    listener: (
        event: IoEvents<
            Readonly<
                Readonly<
                    {
                        closed: "connecting";
                        connected: string[];
                        connecting: string[];
                        ready: "connecting";
                    },
                >,
            >,
        >[K],
        sender: SimpleEventEmitter<
            IoEvents<
                Readonly<
                    Readonly<
                        {
                            closed: "connecting";
                            connected: string[];
                            connecting: string[];
                            ready: "connecting";
                        },
                    >,
                >,
            >,
        >,
    ) => void,
): void
Adds event listener.
Type Parameters
- Kextendskeyof IoEvents<
      Readonly<
          Readonly<
              {
                  closed: "connecting";
                  connected: string[];
                  connecting: string[];
                  ready: "connecting";
              },
          >,
      >,
  >
  Events
Parameters
- name: K
  Event name
- listener: (
      event: IoEvents<
          Readonly<
              Readonly<
                  {
                      closed: "connecting";
                      connected: string[];
                      connecting: string[];
                      ready: "connecting";
                  },
              >,
          >,
      >[K],
      sender: SimpleEventEmitter<
          IoEvents<
              Readonly<
                  Readonly<
                      {
                          closed: "connecting";
                          connected: string[];
                          connecting: string[];
                          ready: "connecting";
                      },
                  >,
              >,
          >,
      >,
  ) => void
  Event handler
Returns void
Throws
Error if emitter is disposed

Inherited from BleDevice.addEventListener

connect

connect(): Promise<void>
Returns Promise<void>
Inherited from BleDevice.connect

disconnect

disconnect(): void
Returns void
Inherited from BleDevice.disconnect

dispose

dispose(): void
Returns void
Inherited from BleDevice.dispose

`Protected`fireEvent

fireEvent<
    K extends
        keyof IoEvents<
            Readonly<
                Readonly<
                    {
                        closed: "connecting";
                        connected: string[];
                        connecting: string[];
                        ready: "connecting";
                    },
                >,
            >,
        >,
>(
    type: K,
    args: IoEvents<
        Readonly<
            Readonly<
                {
                    closed: "connecting";
                    connected: string[];
                    connecting: string[];
                    ready: "connecting";
                },
            >,
        >,
    >[K],
): void
Fire event
Type Parameters
- Kextendskeyof IoEvents<
      Readonly<
          Readonly<
              {
                  closed: "connecting";
                  connected: string[];
                  connecting: string[];
                  ready: "connecting";
              },
          >,
      >,
  >
Parameters
- type: K
  Type of event
- args: IoEvents<
      Readonly<
          Readonly<
              {
                  closed: "connecting";
                  connected: string[];
                  connecting: string[];
                  ready: "connecting";
              },
          >,
      >,
  >[K]
  Arguments for event
Returns void
Inherited from BleDevice.fireEvent

`Protected`log

log(m: string): void
Parameters
- m: string
Returns void
Inherited from BleDevice.log

removeEventListener

removeEventListener<
    K extends
        keyof IoEvents<
            Readonly<
                Readonly<
                    {
                        closed: "connecting";
                        connected: string[];
                        connecting: string[];
                        ready: "connecting";
                    },
                >,
            >,
        >,
>(
    type: K,
    listener: (
        event: IoEvents<
            Readonly<
                Readonly<
                    {
                        closed: "connecting";
                        connected: string[];
                        connecting: string[];
                        ready: "connecting";
                    },
                >,
            >,
        >[K],
        sender: SimpleEventEmitter<
            IoEvents<
                Readonly<
                    Readonly<
                        {
                            closed: "connecting";
                            connected: string[];
                            connecting: string[];
                            ready: "connecting";
                        },
                    >,
                >,
            >,
        >,
    ) => void,
): void
Remove event listener
Type Parameters
- Kextendskeyof IoEvents<
      Readonly<
          Readonly<
              {
                  closed: "connecting";
                  connected: string[];
                  connecting: string[];
                  ready: "connecting";
              },
          >,
      >,
  >
Parameters
- type: K
- listener: (
      event: IoEvents<
          Readonly<
              Readonly<
                  {
                      closed: "connecting";
                      connected: string[];
                      connecting: string[];
                      ready: "connecting";
                  },
              >,
          >,
      >[K],
      sender: SimpleEventEmitter<
          IoEvents<
              Readonly<
                  Readonly<
                      {
                          closed: "connecting";
                          connected: string[];
                          connecting: string[];
                          ready: "connecting";
                      },
                  >,
              >,
          >,
      >,
  ) => void
Returns void
Inherited from BleDevice.removeEventListener

`Protected`verbose

verbose(m: string): void
Parameters
- m: string
Returns void
Inherited from BleDevice.verbose

`Protected`warn

warn(m: unknown): void
Parameters
- m: unknown
Returns void
Inherited from BleDevice.warn

write

write(txt: string): void
Parameters
- txt: string
Returns void
Inherited from BleDevice.write

Class NordicBleDevice

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NordicBleDevice

Properties

codec

gatt

rx

rxBuffer

states

tx

txBuffer

verboseLogging

Accessors

isClosed

Returns boolean

isConnected

Returns boolean

isDisposed

Returns boolean

Methods

addEventListener

Type Parameters

Parameters

Returns void

Throws

connect

Returns Promise<void>

disconnect

Returns void

dispose

Returns void

ProtectedfireEvent

Type Parameters

Parameters

Returns void

Protectedlog

Parameters

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

Protectedverbose

Parameters

Returns void

Protectedwarn

Parameters

Returns void

write

Parameters

Returns void

Settings

On This Page

`Protected`fireEvent

`Protected`log

`Protected`verbose

`Protected`warn