Class PixelSession`Abstract`

Represents a session with a Pixel die. This class is used to abstract the underlying platform used to connect to Pixels.

Index

Constructors

constructor

new PixelSession(systemId: string, name?: string): PixelSession
Instantiates a session with a Pixel. No attempt is made to connect to the die at this point.
Parameters
- systemId: string
  The peripheral system id (as assigned by the OS).
- Optionalname: string
Returns PixelSession
- Defined in packages/pixels-core-connect/src/PixelSession.ts:56

Properties

`Protected` `Optional`_connStatusCb

_connStatusCb?: (ev: PixelSessionConnectionEvent) => void

`Protected` `Readonly`_systemId

_systemId: string

Accessors

lastConnectionStatus

get lastConnectionStatus(): | "connecting"
| "connected"
| "failedToConnect"
| "ready"
| "disconnecting"
| "disconnected"
Gets the last known connection status.

Returns
    | "connecting"
    | "connected"
    | "failedToConnect"
    | "ready"
    | "disconnecting"
    | "disconnected"
- Defined in packages/pixels-core-connect/src/PixelSession.ts:76

pixelName

get pixelName(): string | undefined
Gets the Pixel name.

Returns string | undefined
Remarks
It may be undefined until connected.
- Defined in packages/pixels-core-connect/src/PixelSession.ts:71

systemId

get systemId(): string
Gets the peripheral system id (as assigned by the OS).

Returns string
- Defined in packages/pixels-core-connect/src/PixelSession.ts:63

Methods

`Protected`_notifyConnectionEvent

_notifyConnectionEvent(
    status:
        | "connecting"
        | "connected"
        | "failedToConnect"
        | "ready"
        | "disconnecting"
        | "disconnected",
    reason?:
        | "unknown"
        | "success"
        | "canceled"
        | "notSupported"
        | "timeout"
        | "linkLoss"
        | "bluetoothOff"
        | "host"
        | "peripheral",
): void
Parameters
- status:
      | "connecting"
      | "connected"
      | "failedToConnect"
      | "ready"
      | "disconnecting"
      | "disconnected"
- reason:
      | "unknown"
      | "success"
      | "canceled"
      | "notSupported"
      | "timeout"
      | "linkLoss"
      | "bluetoothOff"
      | "host"
      | "peripheral" = "success"
Returns void
- Defined in packages/pixels-core-connect/src/PixelSession.ts:119

`Protected`_setName

_setName(name: string): void
Parameters
- name: string
Returns void
- Defined in packages/pixels-core-connect/src/PixelSession.ts:133

`Abstract`connect

connect(timeoutMs: number): Promise<void>
Connects to the Pixel.
Parameters
- timeoutMs: number
Returns Promise<void>
- Defined in packages/pixels-core-connect/src/PixelSession.ts:94

`Abstract`disconnect

disconnect(): Promise<void>
Disconnects from the Pixel.

Returns Promise<void>
- Defined in packages/pixels-core-connect/src/PixelSession.ts:97

`Abstract`dispose

dispose(): void
Release resources used by the session object.

Returns void
- Defined in packages/pixels-core-connect/src/PixelSession.ts:91

setConnectionEventListener

setConnectionEventListener(
connectionStatusListener?: (ev: PixelSessionConnectionEvent) => void,
): void
Sets the function to be called when the Pixel connection status changes.
Parameters
- OptionalconnectionStatusListener: (ev: PixelSessionConnectionEvent) => void
  The function called when the Pixel connection status changes.
Returns void
- Defined in packages/pixels-core-connect/src/PixelSession.ts:84

`Abstract`subscribe

subscribe(listener: (dataView: DataView) => void): Promise<() => void>
Subscribes to the "notify" characteristic and returns unsubscribe function.
Parameters
- listener: (dataView: DataView) => void
  The function to be called when the Pixel connection status changes.
Returns Promise<() => void>
- Defined in packages/pixels-core-connect/src/PixelSession.ts:103

`Abstract`writeValue

writeValue(
    data: ArrayBuffer,
    withoutResponse?: boolean,
    timeoutMs?: number,
): Promise<void>
Sends data to Pixel using the "write" characteristic
Parameters
- data: ArrayBuffer
  The raw data to send to the Pixel.
- OptionalwithoutResponse: boolean
  Whether or not to request the device to acknowledge having received the data.
- OptionaltimeoutMs: number
  The timeout in milliseconds before throwing an error when waiting for the device to acknowledgement.
Returns Promise<void>
- Defined in packages/pixels-core-connect/src/PixelSession.ts:113

Class PixelSessionAbstract

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PixelSession

Properties

Protected Optional_connStatusCb

Protected Readonly_systemId

Accessors

lastConnectionStatus

Returns | "connecting" | "connected" | "failedToConnect" | "ready" | "disconnecting" | "disconnected"

pixelName

Returns string | undefined

Remarks

systemId

Returns string

Methods

Protected_notifyConnectionEvent

Parameters

Returns void

Protected_setName

Parameters

Returns void

Abstractconnect

Parameters

Returns Promise<void>

Abstractdisconnect

Returns Promise<void>

Abstractdispose

Returns void

setConnectionEventListener

Parameters

Returns void

Abstractsubscribe

Parameters

Returns Promise<() => void>

AbstractwriteValue

Parameters

Returns Promise<void>

Settings

On This Page

Class PixelSession`Abstract`

`Protected` `Optional`_connStatusCb

`Protected` `Readonly`_systemId

Returns
| "connecting"
| "connected"
| "failedToConnect"
| "ready"
| "disconnecting"
| "disconnected"

`Protected`_notifyConnectionEvent

`Protected`_setName

`Abstract`connect

`Abstract`disconnect

`Abstract`dispose

`Abstract`subscribe

`Abstract`writeValue