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

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

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

_msgEvEmitter _serializer isNotifier type MutablePropsList

Accessors

batteryLevel colorway currentFace currentFaceIndex dieType firmwareDate isCharging ledCount logger logMessages logMessagesSerializedData name pixelId rollState rssi sessionDeviceName status systemId

Methods

_emitEvent _internalDeserializeMessage _internalDispose _internalSendAndWaitForResponse _internalSendAndWaitForTypedResponse _internalSendMessage _internalSetup _internalWaitForMessage _log _logArray _tagLogString _warn addEventListener addMessageListener addPropertyListener connect disconnect emitPropertyEvent removeEventListener removeMessageListener removePropertyListener

Constructors

Protectedconstructor

Properties

Protected Readonly_msgEvEmitter

_msgEvEmitter: EventEmitter

Protected Readonly_serializer

_serializer: MessageSerializer<MessageType>

ReadonlyisNotifier

isNotifier = true

Abstracttype

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

StaticMutablePropsList

MutablePropsList: readonly (
    | "name"
    | "systemId"
    | "pixelId"
    | "ledCount"
    | "colorway"
    | "dieType"
    | "firmwareDate"
    | "rssi"
    | "batteryLevel"
    | "isCharging"
    | "rollState"
    | "currentFace"
    | "currentFaceIndex")[]

Accessors

AbstractbatteryLevel

  • get batteryLevel(): number

  • The Pixel battery level (percentage).

    Returns number

Abstractcolorway

  • get colorway():
        | "unknown"
        | "onyxBlack"
        | "hematiteGrey"
        | "midnightGalaxy"
        | "auroraSky"
        | "clear"
        | "whiteAurora"
        | "custom"

  • The Pixel color.

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

AbstractcurrentFace

  • 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.

AbstractcurrentFaceIndex

  • 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.

AbstractdieType

  • 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"

AbstractfirmwareDate

  • get firmwareDate(): Date

  • The Pixel firmware build date.

    Returns Date

AbstractisCharging

  • get isCharging(): boolean

  • Whether the Pixel battery is charging or not. Set to 'true' if fully charged but still on charger.

    Returns boolean

AbstractledCount

  • get ledCount(): number

  • The number of LEDs of the Pixel.

    Returns number

logger

  • get logger(): undefined | null | ((msg: string) => void)

  • Set logger to use by this instance.

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

  • set logger(logger): void

  • Parameters

    • logger: undefined | null | ((msg: string) => void)

    Returns void

logMessages

  • get logMessages(): boolean

  • Toggle logging information about each send and received message.

    Returns boolean

  • set logMessages(enabled): void

  • Parameters

    • enabled: boolean

    Returns void

logMessagesSerializedData

  • get logMessagesSerializedData(): boolean

  • Toggle logging the serialized (binary) data for each send and received message.

    Returns boolean

  • set logMessagesSerializedData(enabled): void

  • Parameters

    • enabled: boolean

    Returns void

Abstractname

  • get name(): string

  • The Pixels die name.

    Returns string

AbstractpixelId

  • get pixelId(): number

  • The unique Pixel id of the device.

    Returns number

AbstractrollState

  • get rollState():
        | "unknown"
        | "rolled"
        | "handling"
        | "rolling"
        | "crooked"
        | "onFace"

  • The Pixel roll state.

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

Abstractrssi

  • get rssi(): number

  • The last RSSI value measured by the Pixel.

    Returns number

ProtectedsessionDeviceName

  • get sessionDeviceName(): undefined | string

  • Returns undefined | string

status

  • get status(): PixelStatus

  • Gets the Pixel last known connection status.

    Returns PixelStatus

AbstractsystemId

  • get systemId(): string

  • The unique id assigned by the system to the Pixel Bluetooth peripheral.

    Returns string

Methods

Protected_emitEvent

  • _emitEvent<K>(type, ev): void

  • Type Parameters

    • K extends string

    Parameters

    Returns void

Protected Abstract_internalDeserializeMessage

  • _internalDeserializeMessage(dataView): MessageType | PixelMessage

  • Parameters

    • dataView: DataView

    Returns MessageType | PixelMessage

Protected Abstract_internalDispose

  • _internalDispose(): void

  • Returns void

Protected_internalSendAndWaitForResponse

  • _internalSendAndWaitForResponse(msgOrTypeToSend, responseType, timeoutMs?): Promise<MessageType | PixelMessage>

  • Sends a message to the Pixel and wait for a specific response.

    Parameters

    • msgOrTypeToSend: MessageType | PixelMessage

      Message with the data to send or just a message type.

    • responseType: MessageType

      Expected response type.

    • OptionaltimeoutMs: number

      Timeout in mill-seconds before aborting waiting for the response.

    Returns Promise<MessageType | PixelMessage>

    A promise resolving to the response in the form of a message type or a message object.

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: MessageType | PixelMessage

      Message with the data to send or just a message type.

    • responseType: (new () => T)

      Expected response class type.

        • new (): T

        • Returns T

    • OptionaltimeoutMs: number

    Returns Promise<T>

    A promise resolving to a message object of the expected type.

Protected_internalSendMessage

  • _internalSendMessage(msgOrType, withoutAck?): Promise<void>

  • Sends a message to the Pixel.

    Parameters

    • msgOrType: MessageType | PixelMessage

      Message with the data to send or just a message type.

    • OptionalwithoutAck: boolean

      Whether to request a confirmation that the message was received.

    Returns Promise<void>

    A promise that resolves once the message has been send.

Protected Abstract_internalSetup

  • _internalSetup(): Promise<void>

  • Returns Promise<void>

Protected_internalWaitForMessage

  • _internalWaitForMessage(expectedMsgType, timeoutMs?): Promise<MessageType | PixelMessage>

  • Waits for a message from the Pixel.

    Parameters

    • expectedMsgType: MessageType

      Type of the message to expect.

    • OptionaltimeoutMs: number

      Timeout before aborting the wait.

    Returns Promise<MessageType | PixelMessage>

    A promise with the received message of the expected type.

Protected_log

  • _log(msg): void

  • Parameters

    • msg: unknown

    Returns void

Protected_logArray

  • _logArray(arr): void

  • Parameters

    • arr: ArrayBuffer

    Returns void

Protected_tagLogString

  • _tagLogString(str): string

  • Parameters

    • str: string

    Returns string

Protected_warn

  • _warn(msg): void

  • Parameters

    • msg: unknown

    Returns void

addEventListener

  • addEventListener<K>(type, listener): void

  • Registers a listener function that will be called when the specified event is raised. See PixelEventMap for the list of events and their associated data.

    Type Parameters

    • K extends string

    Parameters

    • type: K

      A case-sensitive string representing the event type to listen for.

    • listener: EventReceiver<EventMap[K]>

      The callback function.

    Returns void

addMessageListener

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

connect

disconnect

ProtectedemitPropertyEvent

  • 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

removeEventListener

  • removeEventListener<K>(type, listener): void

  • Unregisters a listener from receiving events identified by the given event name. See PixelEventMap for the list of events and their associated data.

    Type Parameters

    • K extends string

    Parameters

    • type: K

      A case-sensitive string representing the event type.

    • listener: EventReceiver<EventMap[K]>

      The callback function to unregister.

    Returns void

removeMessageListener

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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods