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

Properties

_connStatusCb? _lastConnStatus _systemId

Accessors

lastConnectionStatus pixelName systemId

Methods

_notifyConnectionEvent connect disconnect setConnectionEventListener subscribe writeValue

Constructors

constructor

new PixelSession(systemId): 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).
Returns PixelSession
- Defined in packages/pixels-core-connect/src/PixelSession.ts:38

Properties

`Protected` `Optional` _connStatusCb

_connStatusCb?: ((ev) => void)

Type declaration

- (ev): void
- Parameters
  - ev: PixelSessionConnectionEvent
  Returns void

`Private` _lastConnStatus

_lastConnStatus: PixelSessionConnectionStatus

`Protected` `Readonly` _systemId

_systemId: string

Accessors

lastConnectionStatus

get lastConnectionStatus(): PixelSessionConnectionStatus
Gets the last known connection status.

Returns PixelSessionConnectionStatus
- Defined in packages/pixels-core-connect/src/PixelSession.ts:55

`Abstract` pixelName

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

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

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:44

Methods

`Protected` _notifyConnectionEvent

_notifyConnectionEvent(connectionStatus): void
Parameters
- connectionStatus: PixelSessionConnectionStatus
Returns void
- Defined in packages/pixels-core-connect/src/PixelSession.ts:95

`Abstract` connect

connect(): Promise<void>
Connects to the Pixel.

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

`Abstract` disconnect

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

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

setConnectionEventListener

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

`Abstract` subscribe

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

`Abstract` writeValue

writeValue(data, withoutResponse?, timeoutMs?): Promise<void>
Sends data to Pixel using the "write" characteristic
Parameters
- data: ArrayBuffer
  The raw data to send to the Pixel.
- Optional withoutResponse: boolean
  Whether or not to request the device to acknowledge having received the data.
- Optional timeoutMs: 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:89

Generated using TypeDoc