Class NordicBleDevice

Hierarchy (View Summary)

BleDevice
- NordicBleDevice
  - EspruinoBleDevice

Index

Accessors

isClosed

get isClosed(): boolean
Returns boolean
Inherited from BleDevice.isClosed
- Defined in io/src/ble-device.ts:105

isConnected

get isConnected(): boolean
Returns boolean
Inherited from BleDevice.isConnected
- Defined in io/src/ble-device.ts:101

isDisposed

get isDisposed(): boolean
Returns boolean
Inherited from BleDevice.isDisposed
- Defined in events/src/simple-event-emitter.ts:13

Constructors

constructor

new NordicBleDevice(
device: BluetoothDevice,
opts?: Bluetooth.Opts,
): NordicBleDevice
Parameters
- device: BluetoothDevice
- opts: Bluetooth.Opts = {}
Returns NordicBleDevice
Overrides BleDevice.constructor
- Defined in io/src/nordic-ble-device.ts:21

Methods

addEventListener

addEventListener<
    K extends
        keyof IoEvents<
            Readonly<
                {
                    closed: "connecting";
                    connected: readonly ["closed"];
                    connecting: readonly ["connected", "closed"];
                    ready: "connecting";
                },
            >,
        >,
>(
    name: K,
    listener: (
        event: IoEvents<
            Readonly<
                {
                    closed: "connecting";
                    connected: readonly ["closed"];
                    connecting: readonly ["connected", "closed"];
                    ready: "connecting";
                },
            >,
        >[K],
        sender: SimpleEventEmitter<
            IoEvents<
                Readonly<
                    {
                        closed: "connecting";
                        connected: readonly ["closed"];
                        connecting: readonly ["connected", "closed"];
                        ready: "connecting";
                    },
                >,
            >,
        >,
    ) => void,
): void
Adds event listener.
Type Parameters
- K extends keyof IoEvents<
      Readonly<
          {
              closed: "connecting";
              connected: readonly ["closed"];
              connecting: readonly ["connected", "closed"];
              ready: "connecting";
          },
      >,
  >
  Events
Parameters
- name: K
  Event name
- listener: (
      event: IoEvents<
          Readonly<
              {
                  closed: "connecting";
                  connected: readonly ["closed"];
                  connecting: readonly ["connected", "closed"];
                  ready: "connecting";
              },
          >,
      >[K],
      sender: SimpleEventEmitter<
          IoEvents<
              Readonly<
                  {
                      closed: "connecting";
                      connected: readonly ["closed"];
                      connecting: readonly ["connected", "closed"];
                      ready: "connecting";
                  },
              >,
          >,
      >,
  ) => void
  Event handler
Returns void
Throws
Error if emitter is disposed
Inherited from BleDevice.addEventListener
- Defined in events/src/simple-event-emitter.ts:39

connect

connect(): Promise<void>
Returns Promise<void>
Inherited from BleDevice.connect
- Defined in io/src/ble-device.ts:134

disconnect

disconnect(): void
Returns void
Inherited from BleDevice.disconnect
- Defined in io/src/ble-device.ts:129

dispose

dispose(): void
Returns void
Inherited from BleDevice.dispose
- Defined in events/src/simple-event-emitter.ts:8

`Protected`fireEvent

fireEvent<
    K extends
        keyof IoEvents<
            Readonly<
                {
                    closed: "connecting";
                    connected: readonly ["closed"];
                    connecting: readonly ["connected", "closed"];
                    ready: "connecting";
                },
            >,
        >,
>(
    type: K,
    args: IoEvents<
        Readonly<
            {
                closed: "connecting";
                connected: readonly ["closed"];
                connecting: readonly ["connected", "closed"];
                ready: "connecting";
            },
        >,
    >[K],
): void
Fire event
Type Parameters
- K extends keyof IoEvents<
      Readonly<
          {
              closed: "connecting";
              connected: readonly ["closed"];
              connecting: readonly ["connected", "closed"];
              ready: "connecting";
          },
      >,
  >
Parameters
- type: K
  Type of event
- args: IoEvents<
      Readonly<
          {
              closed: "connecting";
              connected: readonly ["closed"];
              connecting: readonly ["connected", "closed"];
              ready: "connecting";
          },
      >,
  >[K]
  Arguments for event
Returns void
Inherited from BleDevice.fireEvent
- Defined in events/src/simple-event-emitter.ts:23

`Protected`log

log(m: string): void
Parameters
- m: string
Returns void
Inherited from BleDevice.log
- Defined in io/src/ble-device.ts:206

removeEventListener

removeEventListener<
    K extends
        keyof IoEvents<
            Readonly<
                {
                    closed: "connecting";
                    connected: readonly ["closed"];
                    connecting: readonly ["connected", "closed"];
                    ready: "connecting";
                },
            >,
        >,
>(
    type: K,
    listener: (
        event: IoEvents<
            Readonly<
                {
                    closed: "connecting";
                    connected: readonly ["closed"];
                    connecting: readonly ["connected", "closed"];
                    ready: "connecting";
                },
            >,
        >[K],
        sender: SimpleEventEmitter<
            IoEvents<
                Readonly<
                    {
                        closed: "connecting";
                        connected: readonly ["closed"];
                        connecting: readonly ["connected", "closed"];
                        ready: "connecting";
                    },
                >,
            >,
        >,
    ) => void,
): void
Remove event listener
Type Parameters
- K extends keyof IoEvents<
      Readonly<
          {
              closed: "connecting";
              connected: readonly ["closed"];
              connecting: readonly ["connected", "closed"];
              ready: "connecting";
          },
      >,
  >
Parameters
- type: K
- listener: (
      event: IoEvents<
          Readonly<
              {
                  closed: "connecting";
                  connected: readonly ["closed"];
                  connecting: readonly ["connected", "closed"];
                  ready: "connecting";
              },
          >,
      >[K],
      sender: SimpleEventEmitter<
          IoEvents<
              Readonly<
                  {
                      closed: "connecting";
                      connected: readonly ["closed"];
                      connecting: readonly ["connected", "closed"];
                      ready: "connecting";
                  },
              >,
          >,
      >,
  ) => void
Returns void
Inherited from BleDevice.removeEventListener
- Defined in events/src/simple-event-emitter.ts:55

`Protected`verbose

verbose(m: string): void
Parameters
- m: string
Returns void
Inherited from BleDevice.verbose
- Defined in io/src/ble-device.ts:202

`Protected`warn

warn(m: unknown): void
Parameters
- m: unknown
Returns void
Inherited from BleDevice.warn
- Defined in io/src/ble-device.ts:210

write

write(txt: string): void
Parameters
- txt: string
Returns void
Inherited from BleDevice.write
- Defined in io/src/ble-device.ts:109

Properties

codec

codec: Codec

gatt

gatt: BluetoothRemoteGATTServer | undefined

rx

rx: BluetoothRemoteGATTCharacteristic | undefined

rxBuffer

rxBuffer: StringReceiveBuffer

states

states: StateMachineWithEvents<
    Readonly<
        {
            closed: "connecting";
            connected: readonly ["closed"];
            connecting: readonly ["connected", "closed"];
            ready: "connecting";
        },
    >,
>

tx

tx: BluetoothRemoteGATTCharacteristic | undefined

txBuffer

txBuffer: StringWriteBuffer

verboseLogging

verboseLogging: boolean = false

Class NordicBleDevice

Hierarchy (View Summary)

Index

Accessors

Constructors

Methods

Properties

Accessors

isClosed

Returns boolean

isConnected

Returns boolean

isDisposed

Returns boolean

Constructors

constructor

Parameters

Returns NordicBleDevice

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

Properties

codec

gatt

rx

rxBuffer

states

tx

txBuffer

verboseLogging

Settings

On This Page

`Protected`fireEvent

`Protected`log

`Protected`verbose

`Protected`warn