Class PixelConnect<MutableProps, Type, MessageType>`Abstract`

Abstract class that represents a connection to a Pixel device (die, charger, etc.).

Type Parameters

MutableProps extends PixelConnectMutableProps = PixelConnectMutableProps
Type extends PixelInfoWithStatus = PixelInfoWithStatus
MessageType extends string = string

Hierarchy (view full)

PixelInfoNotifier<MutableProps, Type>
- PixelConnect
  - Charger
  - Pixel

Constructors

`Protected`constructor

new PixelConnect<MutableProps, Type, MessageType>(serializer, session): PixelConnect<MutableProps, Type, MessageType>
Type Parameters
- MutableProps extends PixelConnectMutableProps = PixelConnectMutableProps
- Type extends PixelInfoWithStatus = PixelInfoWithStatus
- MessageType extends string = string
Parameters
- serializer: MessageSerializer<MessageType>
- session: PixelSession
Returns PixelConnect<MutableProps, Type, MessageType>
Overrides PixelInfoNotifier.constructor
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:121

Properties

`Protected` `Readonly`_msgEvEmitter

_msgEvEmitter: EventEmitter = ...

`Protected` `Readonly`_serializer

_serializer: MessageSerializer<MessageType>

`Readonly`isNotifier

isNotifier = true

`Abstract`type

type: "die" | "charger" | "bootloader"

`Static`MutablePropsList

Accessors

`Abstract`batteryLevel

get batteryLevel(): number
The Pixel battery level (percentage).

Returns number
Inherited from PixelInfoNotifier.batteryLevel
- Defined in packages/pixels-core-connect/src/PixelInfoNotifier.ts:67

`Abstract`colorway

get colorway():
    | "custom"
    | "clear"
    | "unknown"
    | "onyxBlack"
    | "hematiteGrey"
    | "midnightGalaxy"
    | "auroraSky"
    | "whiteAurora"
The Pixel color.

Returns
    | "custom"
    | "clear"
    | "unknown"
    | "onyxBlack"
    | "hematiteGrey"
    | "midnightGalaxy"
    | "auroraSky"
    | "whiteAurora"
Inherited from PixelInfoNotifier.colorway
- Defined in packages/pixels-core-connect/src/PixelInfoNotifier.ts:63

`Abstract`currentFace

get currentFace(): number
The value of the die face that is currently facing up.

Returns number
Remarks
- This value is always an integer number.
- D10 returns values ranging from 0 to 9 included.
- D00 returns 0, 10, 20, ..., 90.
- Fudge die returns +1, 0 and -1.
Inherited from PixelInfoNotifier.currentFace
- Defined in packages/pixels-core-connect/src/PixelInfoNotifier.ts:70

`Abstract`currentFaceIndex

get currentFaceIndex(): number

The 0-based index of the die face that is currently facing up.

Returns number

Remarks

Indices are continuous and follow the numerical order of the die faces values.

Example

A D20 die will have face indices ranging from 0 to 19.
Index 0 corresponds to face 1 and index 19 to face 20.

D10 and D00 share the same face indices but have different face values.
Index 0 corresponds to face 0 of both dice types.
Index 9 corresponds to face 9 for a D10 and to face 90 for a D00.

The fudge die returns the following indices:
- O and 5 for the "+" face .
- 1 and 4 for the "-" face.
- 2 and 3 for the "blank" face.

`Abstract`dieType

get dieType():
    | "unknown"
    | "d4"
    | "d6"
    | "d8"
    | "d10"
    | "d00"
    | "d12"
    | "d20"
    | "d6pipped"
    | "d6fudge"
The Pixel die type.

Returns
    | "unknown"
    | "d4"
    | "d6"
    | "d8"
    | "d10"
    | "d00"
    | "d12"
    | "d20"
    | "d6pipped"
    | "d6fudge"
Inherited from PixelInfoNotifier.dieType
- Defined in packages/pixels-core-connect/src/PixelInfoNotifier.ts:64

`Abstract`firmwareDate

get firmwareDate(): Date
The Pixel firmware build date.

Returns Date
Inherited from PixelInfoNotifier.firmwareDate
- Defined in packages/pixels-core-connect/src/PixelInfoNotifier.ts:65

`Abstract`isCharging

get isCharging(): boolean
Whether the Pixel battery is charging or not. Set to 'true' if fully charged but still on charger.

Returns boolean
Inherited from PixelInfoNotifier.isCharging
- Defined in packages/pixels-core-connect/src/PixelInfoNotifier.ts:68

`Abstract`ledCount

get ledCount(): number
The number of LEDs of the Pixel.

Returns number
Inherited from PixelInfoNotifier.ledCount
- Defined in packages/pixels-core-connect/src/PixelInfoNotifier.ts:62

logger

get logger(): undefined | null | ((msg: string) => void)
Set logger to use by this instance.

Returns undefined | null | ((msg: string) => void)
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:105
set logger(logger): void
Parameters
- logger: undefined | null | ((msg: string) => void)
Returns void
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:108

logMessages

get logMessages(): boolean
Toggle logging information about each send and received message.

Returns boolean
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:89
set logMessages(enabled): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:92

logMessagesSerializedData

get logMessagesSerializedData(): boolean
Toggle logging the serialized (binary) data for each send and received message.

Returns boolean
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:97
set logMessagesSerializedData(enabled): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:100

`Abstract`name

get name(): string
The Pixels die name.

Returns string
Inherited from PixelInfoNotifier.name
- Defined in packages/pixels-core-connect/src/PixelInfoNotifier.ts:61

`Abstract`pixelId

get pixelId(): number
The unique Pixel id of the device.

Returns number
Inherited from PixelInfoNotifier.pixelId
- Defined in packages/pixels-core-connect/src/PixelInfoNotifier.ts:60

`Abstract`rollState

get rollState():
    | "unknown"
    | "handling"
    | "rolling"
    | "crooked"
    | "rolled"
    | "onFace"
The Pixel roll state.

Returns
    | "unknown"
    | "handling"
    | "rolling"
    | "crooked"
    | "rolled"
    | "onFace"
Inherited from PixelInfoNotifier.rollState
- Defined in packages/pixels-core-connect/src/PixelInfoNotifier.ts:69

`Abstract`rssi

get rssi(): number
The last RSSI value measured by the Pixel.

Returns number
Inherited from PixelInfoNotifier.rssi
- Defined in packages/pixels-core-connect/src/PixelInfoNotifier.ts:66

`Protected`sessionDeviceName

get sessionDeviceName(): undefined | string
Returns undefined | string
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:117

status

get status(): PixelStatus
Gets the Pixel last known connection status.

Returns PixelStatus
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:113

`Abstract`systemId

get systemId(): string
The unique id assigned by the system to the Pixel Bluetooth peripheral.

Returns string
Inherited from PixelInfoNotifier.systemId
- Defined in packages/pixels-core-connect/src/PixelInfoNotifier.ts:59

Methods

`Protected`_internalConnect

_internalConnect(timeoutMs?): Promise<void>
Parameters
- timeoutMs: number = 0
Returns Promise<void>
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:184

`Protected` `Abstract`_internalDeserializeMessage

_internalDeserializeMessage(dataView): PixelMessage | MessageType
Parameters
- dataView: DataView
Returns PixelMessage | MessageType
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:180

`Protected`_internalDisconnect

_internalDisconnect(): Promise<void>
Immediately disconnects from the die.

Returns Promise<void>
A promise that resolves once the disconnect request has been processed.
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:258

`Protected` `Abstract`_internalDispose

_internalDispose(): void
Returns void
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:177

`Protected`_internalSendAndWaitForResponse

_internalSendAndWaitForResponse(msgOrTypeToSend, responseType, timeoutMs?): Promise<PixelMessage | MessageType>
Sends a message to the Pixel and wait for a specific response.
Parameters
- msgOrTypeToSend: PixelMessage | MessageType
  Message with the data to send or just a message type.
- responseType: MessageType
  Expected response type.
- timeoutMs: number = Constants.ackMessageTimeout
  Timeout in mill-seconds before aborting waiting for the response.
Returns Promise<PixelMessage | MessageType>
A promise resolving to the response in the form of a message type or a message object.
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:369

`Protected`_internalSendAndWaitForTypedResponse

_internalSendAndWaitForTypedResponse<T>(msgOrTypeToSend, responseType, timeoutMs?): Promise<T>
Sends a message to the Pixel and wait for a specific response which is returned casted to the expected type.
Type Parameters
- T extends PixelMessage
Parameters
- msgOrTypeToSend: PixelMessage | MessageType
  Message with the data to send or just a message type.
- responseType: (new () => T)
  Expected response class type.
  - - new (): T
    - Returns T
- timeoutMs: number = Constants.ackMessageTimeout
Returns Promise<T>
A promise resolving to a message object of the expected type.
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:390

`Protected`_internalSendMessage

_internalSendMessage(msgOrType, withoutAck?): Promise<void>
Sends a message to the Pixel.
Parameters
- msgOrType: PixelMessage | MessageType
  Message with the data to send or just a message type.
- withoutAck: boolean = false
  Whether to request a confirmation that the message was received.
Returns Promise<void>
A promise that resolves once the message has been send.
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:342

`Protected` `Abstract`_internalSetup

_internalSetup(): Promise<void>
Returns Promise<void>
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:179

`Protected`_internalWaitForMessage

_internalWaitForMessage(expectedMsgType, timeoutMs?): Promise<PixelMessage | MessageType>
Waits for a message from the Pixel.
Parameters
- expectedMsgType: MessageType
  Type of the message to expect.
- timeoutMs: number = Constants.ackMessageTimeout
  Timeout before aborting the wait.
Returns Promise<PixelMessage | MessageType>
A promise with the received message of the expected type.
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:295

`Protected`_log

_log(msg): void
Parameters
- msg: unknown
Returns void
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:422

`Protected`_logArray

_logArray(arr): void
Parameters
- arr: ArrayBuffer
Returns void
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:439

`Protected` `Abstract`_onStatusChanged

_onStatusChanged(ev): void
Parameters
- ev: Readonly<{
      lastStatus: PixelStatus;
      reason?:
          | "canceled"
          | "success"
          | "unknown"
          | "host"
          | "timeout"
          | "notSupported"
          | "linkLoss"
          | "bluetoothOff"
          | "peripheral";
      status: PixelStatus;
  }>
Returns void
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:178

`Protected`_tagLogString

_tagLogString(str): string
Parameters
- str: string
Returns string
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:416

`Protected`_warn

_warn(msg): void
Parameters
- msg: unknown
Returns void
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:430

addMessageListener

addMessageListener(msgType, listener): void
Registers a listener function that will be called on receiving raw messages of a given type from the Pixel.
Parameters
- msgType: MessageType
  The type of message to watch for.
- listener: ((this: PixelConnect<PixelConnectMutableProps, PixelInfoWithStatus, string>, message: PixelMessage | MessageType) => void)
  The callback function.
  - - (this, message): void
    - Parameters
      this: PixelConnect<PixelConnectMutableProps, PixelInfoWithStatus, string>
      message: PixelMessage | MessageType
      Returns void
Returns void
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:158

addPropertyListener

addPropertyListener<K>(propertyName, listener): void
Adds the given listener function for the specified property.
Type Parameters
- K extends string
Parameters
- propertyName: K
  The name of the property.
- listener: EventReceiver<Type>
  The callback function.
Returns void
Inherited from PixelInfoNotifier.addPropertyListener
- Defined in packages/pixels-core-connect/src/PixelInfoNotifier.ts:83

`Protected`emitPropertyEvent

emitPropertyEvent<K>(propertyName): void
Emit a Pixel event for the specified property. This function should be called by the concrete type whenever the a property's value changes.
Type Parameters
- K extends string
Parameters
- propertyName: K
  Event name.
Returns void
Inherited from PixelInfoNotifier.emitPropertyEvent
- Defined in packages/pixels-core-connect/src/PixelInfoNotifier.ts:108

removeMessageListener

removeMessageListener(msgType, listener): void
Unregisters a listener from receiving raw messages of a given type.
Parameters
- msgType: MessageType
  The type of message to watch for.
- listener: ((this: PixelConnect<PixelConnectMutableProps, PixelInfoWithStatus, string>, msg: PixelMessage | MessageType) => void)
  The callback function to unregister.
  - - (this, msg): void
    - Parameters
      this: PixelConnect<PixelConnectMutableProps, PixelInfoWithStatus, string>
      msg: PixelMessage | MessageType
      Returns void
Returns void
- Defined in packages/pixels-core-connect/src/PixelConnect.ts:170

removePropertyListener

removePropertyListener<K>(propertyName, listener): void
Removes the given listener function for the specified property.
Type Parameters
- K extends string
Parameters
- propertyName: K
  The name of the property.
- listener: EventReceiver<Type>
  The callback function to unregister.
Returns void
Inherited from PixelInfoNotifier.removePropertyListener
- Defined in packages/pixels-core-connect/src/PixelInfoNotifier.ts:95

Class PixelConnect<MutableProps, Type, MessageType>Abstract

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns PixelConnect<MutableProps, Type, MessageType>

Properties

Protected Readonly_msgEvEmitter

Protected Readonly_serializer

ReadonlyisNotifier

Abstracttype

StaticMutablePropsList

Accessors

AbstractbatteryLevel

Returns number

Abstractcolorway

Returns | "custom" | "clear" | "unknown" | "onyxBlack" | "hematiteGrey" | "midnightGalaxy" | "auroraSky" | "whiteAurora"

AbstractcurrentFace

Returns number

Remarks

AbstractcurrentFaceIndex

Returns number

Remarks

Example

AbstractdieType

Returns | "unknown" | "d4" | "d6" | "d8" | "d10" | "d00" | "d12" | "d20" | "d6pipped" | "d6fudge"

AbstractfirmwareDate

Returns Date

AbstractisCharging

Returns boolean

AbstractledCount

Returns number

logger

Returns undefined | null | ((msg: string) => void)

Parameters

Returns void

logMessages

Returns boolean

Parameters

Returns void

logMessagesSerializedData

Returns boolean

Parameters

Returns void

Abstractname

Returns string

AbstractpixelId

Returns number

AbstractrollState

Returns | "unknown" | "handling" | "rolling" | "crooked" | "rolled" | "onFace"

Abstractrssi

Returns number

ProtectedsessionDeviceName

Returns undefined | string

status

Returns PixelStatus

AbstractsystemId

Returns string

Methods

Protected_internalConnect

Parameters

Returns Promise<void>

Protected Abstract_internalDeserializeMessage

Parameters

Returns PixelMessage | MessageType

Protected_internalDisconnect

Returns Promise<void>

Protected Abstract_internalDispose

Returns void

Protected_internalSendAndWaitForResponse

Parameters

Returns Promise<PixelMessage | MessageType>

Protected_internalSendAndWaitForTypedResponse

Class PixelConnect<MutableProps, Type, MessageType>`Abstract`

`Protected`constructor

`Protected` `Readonly`_msgEvEmitter

`Protected` `Readonly`_serializer

`Readonly`isNotifier

`Abstract`type

`Static`MutablePropsList

`Abstract`batteryLevel

`Abstract`colorway

Returns
| "custom"
| "clear"
| "unknown"
| "onyxBlack"
| "hematiteGrey"
| "midnightGalaxy"
| "auroraSky"
| "whiteAurora"

`Abstract`currentFace

`Abstract`currentFaceIndex

`Abstract`dieType

Returns
| "unknown"
| "d4"
| "d6"
| "d8"
| "d10"
| "d00"
| "d12"
| "d20"
| "d6pipped"
| "d6fudge"

`Abstract`firmwareDate

`Abstract`isCharging

`Abstract`ledCount

`Abstract`name

`Abstract`pixelId

`Abstract`rollState

Returns
| "unknown"
| "handling"
| "rolling"
| "crooked"
| "rolled"
| "onFace"

`Abstract`rssi

`Protected`sessionDeviceName

`Abstract`systemId

`Protected`_internalConnect

`Protected` `Abstract`_internalDeserializeMessage

`Protected`_internalDisconnect

`Protected` `Abstract`_internalDispose

`Protected`_internalSendAndWaitForResponse

`Protected`_internalSendAndWaitForTypedResponse

`Protected`_internalSendMessage

`Protected` `Abstract`_internalSetup

`Protected`_internalWaitForMessage

`Protected`_log

`Protected`_logArray

`Protected` `Abstract`_onStatusChanged

`Protected`_tagLogString

`Protected`_warn

`Protected`emitPropertyEvent