Class MPC

Represents a Pixels Multi Purpose Controller (MPC). Most of its methods require the instance to be connected to the MPC. Call the () method to initiate a connection.

Call addEventListener to get notified for rolls, connection and disconnection events and more.

Call addPropertyListener to get notified on property changes.

Hierarchy (view full)

Implements

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 blink connect disconnect emitPropertyEvent playAnim queryRssi removeEventListener removeMessageListener removePropertyListener rename reportRssi sendAndWaitForResponse sendAndWaitForTypedResponse sendMessage stopAnim sync updateInfo

Constructors

constructor

  • new MPC(session, info?): MPC

  • Instantiates a MPC.

    Parameters

    • session: PixelSession

      The session used to communicate with the MPC.

    • Optionalinfo: Partial<Pick<Readonly<{
          batteryLevel: number;
          colorway:
              | "unknown"
              | "onyxBlack"
              | "hematiteGrey"
              | "midnightGalaxy"
              | "auroraSky"
              | "clear"
              | "whiteAurora"
              | "custom";
          currentFace: number;
          currentFaceIndex: number;
          dieType:
              | "unknown"
              | "d4"
              | "d6"
              | "d8"
              | "d10"
              | "d00"
              | "d12"
              | "d20"
              | "d6pipped"
              | "d6fudge";
          firmwareDate: Date;
          isCharging: boolean;
          ledCount: number;
          name: string;
          pixelId: number;
          rollState:
              | "unknown"
              | "rolled"
              | "handling"
              | "rolling"
              | "crooked"
              | "onFace";
          rssi: number;
          systemId: string;
      }>, "pixelId" | "ledCount" | "firmwareDate">>

    Returns MPC

Properties

Protected Readonly_msgEvEmitter

_msgEvEmitter: EventEmitter

Protected Readonly_serializer

_serializer: MessageSerializer<
    | "rssi"
    | "none"
    | "whoAreYou"
    | "bulkSetup"
    | "bulkSetupAck"
    | "bulkData"
    | "bulkDataAck"
    | "transferSettings"
    | "transferSettingsAck"
    | "transferSettingsFinished"
    | "debugLog"
    | "playAnimation"
    | "stopAnimation"
    | "requestSettings"
    | "blink"
    | "blinkAck"
    | "requestRssi"
    | "notifyUser"
    | "notifyUserAck"
    | "programDefaultParameters"
    | "programDefaultParametersFinished"
    | "setName"
    | "setNameAck"
    | "requestTemperature"
    | "temperature"
    | "iAmAMPC"
    | "synchronizeTime">

ReadonlyisNotifier

isNotifier = true

Readonlytype

type = "mpc"

Device type is Pixels MPC.

StaticMutablePropsList

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

Accessors

batteryLevel

  • get batteryLevel(): number

  • Gets the MPC battery level (percentage).

    Returns number

    Remarks

    This value is automatically updated when the die is connected.

colorway

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

  • Always return "unknown".

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

currentFace

  • get currentFace(): number

  • Always return "0".

    Returns number

currentFaceIndex

  • get currentFaceIndex(): number

  • Always return "0".

    Returns number

dieType

  • get dieType():
        | "unknown"
        | "d4"
        | "d6"
        | "d8"
        | "d10"
        | "d00"
        | "d12"
        | "d20"
        | "d6pipped"
        | "d6fudge"

  • Always return "unknown".

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

firmwareDate

  • get firmwareDate(): Date

  • Gets the MPC firmware build date.

    Returns Date

isCharging

  • get isCharging(): boolean

  • Gets whether the MPC battery is charging or not. Returns 'true' if fully charged but still on charger.

    Returns boolean

    Remarks

    This value is automatically updated when the die is connected.

ledCount

  • get ledCount(): number

  • Gets the number of LEDs for the MPC, may be 0 until connected to device.

    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

name

  • get name(): string

  • Gets the MPC name, may be empty until connected to device.

    Returns string

pixelId

  • get pixelId(): number

  • Gets the unique Pixel id of the MPC, may be 0 until connected.

    Returns number

rollState

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

  • Always return "unknown".

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

rssi

  • get rssi(): number

  • Gets the last RSSI value notified by the MPC.

    Returns number

    Remarks

    Call () to automatically update the RSSI value.

ProtectedsessionDeviceName

  • get sessionDeviceName(): undefined | string

  • Returns undefined | string

status

  • get status(): PixelStatus

  • Gets the Pixel last known connection status.

    Returns PixelStatus

systemId

  • get systemId(): string

  • Gets the unique id assigned by the system to the MPC Bluetooth peripheral.

    Returns string

Methods

Protected_emitEvent

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

  • Type Parameters

    • K extends
          | "statusChanged"
          | "messageReceived"
          | "messageSend"
          | "battery"

    Parameters

    Returns void

Protected_internalDeserializeMessage

Protected_internalDispose

Protected_internalSendAndWaitForResponse

  • _internalSendAndWaitForResponse(msgOrTypeToSend, responseType, timeoutMs?): Promise<
        | "rssi"
        | "none"
        | "whoAreYou"
        | "bulkSetup"
        | "bulkSetupAck"
        | "bulkData"
        | "bulkDataAck"
        | "transferSettings"
        | "transferSettingsAck"
        | "transferSettingsFinished"
        | "debugLog"
        | "playAnimation"
        | "stopAnimation"
        | "requestSettings"
        | "blink"
        | "blinkAck"
        | "requestRssi"
        | "notifyUser"
        | "notifyUserAck"
        | "programDefaultParameters"
        | "programDefaultParametersFinished"
        | "setName"
        | "setNameAck"
        | "requestTemperature"
        | "temperature"
        | PixelMessage
        | "iAmAMPC"
        | "synchronizeTime">

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

    Parameters

    • msgOrTypeToSend:
          | "rssi"
          | "none"
          | "whoAreYou"
          | "bulkSetup"
          | "bulkSetupAck"
          | "bulkData"
          | "bulkDataAck"
          | "transferSettings"
          | "transferSettingsAck"
          | "transferSettingsFinished"
          | "debugLog"
          | "playAnimation"
          | "stopAnimation"
          | "requestSettings"
          | "blink"
          | "blinkAck"
          | "requestRssi"
          | "notifyUser"
          | "notifyUserAck"
          | "programDefaultParameters"
          | "programDefaultParametersFinished"
          | "setName"
          | "setNameAck"
          | "requestTemperature"
          | "temperature"
          | PixelMessage
          | "iAmAMPC"
          | "synchronizeTime"

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

    • responseType:
          | "rssi"
          | "none"
          | "whoAreYou"
          | "bulkSetup"
          | "bulkSetupAck"
          | "bulkData"
          | "bulkDataAck"
          | "transferSettings"
          | "transferSettingsAck"
          | "transferSettingsFinished"
          | "debugLog"
          | "playAnimation"
          | "stopAnimation"
          | "requestSettings"
          | "blink"
          | "blinkAck"
          | "requestRssi"
          | "notifyUser"
          | "notifyUserAck"
          | "programDefaultParameters"
          | "programDefaultParametersFinished"
          | "setName"
          | "setNameAck"
          | "requestTemperature"
          | "temperature"
          | "iAmAMPC"
          | "synchronizeTime"

      Expected response type.

    • OptionaltimeoutMs: number

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

    Returns Promise<
        | "rssi"
        | "none"
        | "whoAreYou"
        | "bulkSetup"
        | "bulkSetupAck"
        | "bulkData"
        | "bulkDataAck"
        | "transferSettings"
        | "transferSettingsAck"
        | "transferSettingsFinished"
        | "debugLog"
        | "playAnimation"
        | "stopAnimation"
        | "requestSettings"
        | "blink"
        | "blinkAck"
        | "requestRssi"
        | "notifyUser"
        | "notifyUserAck"
        | "programDefaultParameters"
        | "programDefaultParametersFinished"
        | "setName"
        | "setNameAck"
        | "requestTemperature"
        | "temperature"
        | PixelMessage
        | "iAmAMPC"
        | "synchronizeTime">

    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:
          | "rssi"
          | "none"
          | "whoAreYou"
          | "bulkSetup"
          | "bulkSetupAck"
          | "bulkData"
          | "bulkDataAck"
          | "transferSettings"
          | "transferSettingsAck"
          | "transferSettingsFinished"
          | "debugLog"
          | "playAnimation"
          | "stopAnimation"
          | "requestSettings"
          | "blink"
          | "blinkAck"
          | "requestRssi"
          | "notifyUser"
          | "notifyUserAck"
          | "programDefaultParameters"
          | "programDefaultParametersFinished"
          | "setName"
          | "setNameAck"
          | "requestTemperature"
          | "temperature"
          | PixelMessage
          | "iAmAMPC"
          | "synchronizeTime"

      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:
          | "rssi"
          | "none"
          | "whoAreYou"
          | "bulkSetup"
          | "bulkSetupAck"
          | "bulkData"
          | "bulkDataAck"
          | "transferSettings"
          | "transferSettingsAck"
          | "transferSettingsFinished"
          | "debugLog"
          | "playAnimation"
          | "stopAnimation"
          | "requestSettings"
          | "blink"
          | "blinkAck"
          | "requestRssi"
          | "notifyUser"
          | "notifyUserAck"
          | "programDefaultParameters"
          | "programDefaultParametersFinished"
          | "setName"
          | "setNameAck"
          | "requestTemperature"
          | "temperature"
          | PixelMessage
          | "iAmAMPC"
          | "synchronizeTime"

      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_internalSetup

  • _internalSetup(): Promise<void>

  • Returns Promise<void>

Protected_internalWaitForMessage

  • _internalWaitForMessage(expectedMsgType, timeoutMs?): Promise<
        | "rssi"
        | "none"
        | "whoAreYou"
        | "bulkSetup"
        | "bulkSetupAck"
        | "bulkData"
        | "bulkDataAck"
        | "transferSettings"
        | "transferSettingsAck"
        | "transferSettingsFinished"
        | "debugLog"
        | "playAnimation"
        | "stopAnimation"
        | "requestSettings"
        | "blink"
        | "blinkAck"
        | "requestRssi"
        | "notifyUser"
        | "notifyUserAck"
        | "programDefaultParameters"
        | "programDefaultParametersFinished"
        | "setName"
        | "setNameAck"
        | "requestTemperature"
        | "temperature"
        | PixelMessage
        | "iAmAMPC"
        | "synchronizeTime">

  • Waits for a message from the Pixel.

    Parameters

    • expectedMsgType:
          | "rssi"
          | "none"
          | "whoAreYou"
          | "bulkSetup"
          | "bulkSetupAck"
          | "bulkData"
          | "bulkDataAck"
          | "transferSettings"
          | "transferSettingsAck"
          | "transferSettingsFinished"
          | "debugLog"
          | "playAnimation"
          | "stopAnimation"
          | "requestSettings"
          | "blink"
          | "blinkAck"
          | "requestRssi"
          | "notifyUser"
          | "notifyUserAck"
          | "programDefaultParameters"
          | "programDefaultParametersFinished"
          | "setName"
          | "setNameAck"
          | "requestTemperature"
          | "temperature"
          | "iAmAMPC"
          | "synchronizeTime"

      Type of the message to expect.

    • OptionaltimeoutMs: number

      Timeout before aborting the wait.

    Returns Promise<
        | "rssi"
        | "none"
        | "whoAreYou"
        | "bulkSetup"
        | "bulkSetupAck"
        | "bulkData"
        | "bulkDataAck"
        | "transferSettings"
        | "transferSettingsAck"
        | "transferSettingsFinished"
        | "debugLog"
        | "playAnimation"
        | "stopAnimation"
        | "requestSettings"
        | "blink"
        | "blinkAck"
        | "requestRssi"
        | "notifyUser"
        | "notifyUserAck"
        | "programDefaultParameters"
        | "programDefaultParametersFinished"
        | "setName"
        | "setNameAck"
        | "requestTemperature"
        | "temperature"
        | PixelMessage
        | "iAmAMPC"
        | "synchronizeTime">

    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
          | "statusChanged"
          | "messageReceived"
          | "messageSend"
          | "battery"

    Parameters

    • type: K

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

    • listener: EventReceiver<MPCEventMap[K]>

      The callback function.

    Returns void

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:
          | "rssi"
          | "none"
          | "whoAreYou"
          | "bulkSetup"
          | "bulkSetupAck"
          | "bulkData"
          | "bulkDataAck"
          | "transferSettings"
          | "transferSettingsAck"
          | "transferSettingsFinished"
          | "debugLog"
          | "playAnimation"
          | "stopAnimation"
          | "requestSettings"
          | "blink"
          | "blinkAck"
          | "requestRssi"
          | "notifyUser"
          | "notifyUserAck"
          | "programDefaultParameters"
          | "programDefaultParametersFinished"
          | "setName"
          | "setNameAck"
          | "requestTemperature"
          | "temperature"
          | "iAmAMPC"
          | "synchronizeTime"

      The type of message to watch for.

    • listener: ((this: PixelConnect<PixelConnectMutableProps, PixelInfoWithStatus, string, PixelConnectEventMap>, message:
          | "rssi"
          | "none"
          | "whoAreYou"
          | "bulkSetup"
          | "bulkSetupAck"
          | "bulkData"
          | "bulkDataAck"
          | "transferSettings"
          | "transferSettingsAck"
          | "transferSettingsFinished"
          | "debugLog"
          | "playAnimation"
          | "stopAnimation"
          | "requestSettings"
          | "blink"
          | "blinkAck"
          | "requestRssi"
          | "notifyUser"
          | "notifyUserAck"
          | "programDefaultParameters"
          | "programDefaultParametersFinished"
          | "setName"
          | "setNameAck"
          | "requestTemperature"
          | "temperature"
          | PixelMessage
          | "iAmAMPC"
          | "synchronizeTime") => void)

      The callback function.

        • (this, message): void

        • Parameters

          • this: PixelConnect<PixelConnectMutableProps, PixelInfoWithStatus, string, PixelConnectEventMap>
          • message:
                | "rssi"
                | "none"
                | "whoAreYou"
                | "bulkSetup"
                | "bulkSetupAck"
                | "bulkData"
                | "bulkDataAck"
                | "transferSettings"
                | "transferSettingsAck"
                | "transferSettingsFinished"
                | "debugLog"
                | "playAnimation"
                | "stopAnimation"
                | "requestSettings"
                | "blink"
                | "blinkAck"
                | "requestRssi"
                | "notifyUser"
                | "notifyUserAck"
                | "programDefaultParameters"
                | "programDefaultParametersFinished"
                | "setName"
                | "setNameAck"
                | "requestTemperature"
                | "temperature"
                | PixelMessage
                | "iAmAMPC"
                | "synchronizeTime"

          Returns void

    Returns void

addPropertyListener

  • addPropertyListener<K>(propertyName, listener): void

  • Adds the given listener function for the specified property.

    Type Parameters

    • K extends
          | "name"
          | "status"
          | "systemId"
          | "pixelId"
          | "ledCount"
          | "colorway"
          | "dieType"
          | "firmwareDate"
          | "rssi"
          | "batteryLevel"
          | "isCharging"
          | "rollState"
          | "currentFace"
          | "currentFaceIndex"

    Parameters

    Returns void

blink

  • blink(color, opt?): Promise<void>

  • Requests the MPC to blink and wait for a confirmation.

    Parameters

    • color: Color

      Blink color.

    • Optionalopt: {
          count?: number;
          duration?: number;
          faceMask?: number;
          fade?: number;
          loopCount?: number;
      }
      • Optionalcount?: number

        Number of blinks.

      • Optionalduration?: number

        Total duration of the animation in milliseconds.

      • OptionalfaceMask?: number

        Select which faces to light up.

      • Optionalfade?: number

        Amount of in and out fading, 0: sharp transition, 1: maximum fading.

      • OptionalloopCount?: number

        How many times to loop the animation.

    Returns Promise<void>

    A promise that resolves once the die has confirmed receiving the message.

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
          | "name"
          | "status"
          | "systemId"
          | "pixelId"
          | "ledCount"
          | "colorway"
          | "dieType"
          | "firmwareDate"
          | "rssi"
          | "batteryLevel"
          | "isCharging"
          | "rollState"
          | "currentFace"
          | "currentFaceIndex"

    Parameters

    • propertyName: K

      Event name.

    Returns void

playAnim

  • playAnim(animIndex, delay?, param0?, param1?): Promise<void>

  • Parameters

    • animIndex: number
    • Optionaldelay: number
    • Optionalparam0: number
    • Optionalparam1: number

    Returns Promise<void>

queryRssi

  • queryRssi(): Promise<number>

  • Asynchronously gets the MPC RSSI value.

    Returns Promise<number>

    A promise revolving to a negative number representing the RSSI value.

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
          | "statusChanged"
          | "messageReceived"
          | "messageSend"
          | "battery"

    Parameters

    • type: K

      A case-sensitive string representing the event type.

    • listener: EventReceiver<MPCEventMap[K]>

      The callback function to unregister.

    Returns void

removeMessageListener

  • removeMessageListener(msgType, listener): void

  • Unregisters a listener from receiving raw messages of a given type.

    Parameters

    • msgType:
          | "rssi"
          | "none"
          | "whoAreYou"
          | "bulkSetup"
          | "bulkSetupAck"
          | "bulkData"
          | "bulkDataAck"
          | "transferSettings"
          | "transferSettingsAck"
          | "transferSettingsFinished"
          | "debugLog"
          | "playAnimation"
          | "stopAnimation"
          | "requestSettings"
          | "blink"
          | "blinkAck"
          | "requestRssi"
          | "notifyUser"
          | "notifyUserAck"
          | "programDefaultParameters"
          | "programDefaultParametersFinished"
          | "setName"
          | "setNameAck"
          | "requestTemperature"
          | "temperature"
          | "iAmAMPC"
          | "synchronizeTime"

      The type of message to watch for.

    • listener: ((this: PixelConnect<PixelConnectMutableProps, PixelInfoWithStatus, string, PixelConnectEventMap>, msg:
          | "rssi"
          | "none"
          | "whoAreYou"
          | "bulkSetup"
          | "bulkSetupAck"
          | "bulkData"
          | "bulkDataAck"
          | "transferSettings"
          | "transferSettingsAck"
          | "transferSettingsFinished"
          | "debugLog"
          | "playAnimation"
          | "stopAnimation"
          | "requestSettings"
          | "blink"
          | "blinkAck"
          | "requestRssi"
          | "notifyUser"
          | "notifyUserAck"
          | "programDefaultParameters"
          | "programDefaultParametersFinished"
          | "setName"
          | "setNameAck"
          | "requestTemperature"
          | "temperature"
          | PixelMessage
          | "iAmAMPC"
          | "synchronizeTime") => void)

      The callback function to unregister.

        • (this, msg): void

        • Parameters

          • this: PixelConnect<PixelConnectMutableProps, PixelInfoWithStatus, string, PixelConnectEventMap>
          • msg:
                | "rssi"
                | "none"
                | "whoAreYou"
                | "bulkSetup"
                | "bulkSetupAck"
                | "bulkData"
                | "bulkDataAck"
                | "transferSettings"
                | "transferSettingsAck"
                | "transferSettingsFinished"
                | "debugLog"
                | "playAnimation"
                | "stopAnimation"
                | "requestSettings"
                | "blink"
                | "blinkAck"
                | "requestRssi"
                | "notifyUser"
                | "notifyUserAck"
                | "programDefaultParameters"
                | "programDefaultParametersFinished"
                | "setName"
                | "setNameAck"
                | "requestTemperature"
                | "temperature"
                | PixelMessage
                | "iAmAMPC"
                | "synchronizeTime"

          Returns void

    Returns void

removePropertyListener

  • removePropertyListener<K>(propertyName, listener): void

  • Removes the given listener function for the specified property.

    Type Parameters

    • K extends
          | "name"
          | "status"
          | "systemId"
          | "pixelId"
          | "ledCount"
          | "colorway"
          | "dieType"
          | "firmwareDate"
          | "rssi"
          | "batteryLevel"
          | "isCharging"
          | "rollState"
          | "currentFace"
          | "currentFaceIndex"

    Parameters

    Returns void

rename

  • rename(name): Promise<void>

  • Requests the MPC to change its name.

    Parameters

    • name: string

      New name to assign to the MPC. Must have at least one character.

    Returns Promise<void>

    A promise that resolves once the die has confirmed being renamed.

reportRssi

  • reportRssi(activate?, minInterval?): Promise<void>

  • Requests the MPC to regularly send its measured RSSI value.

    Parameters

    • Optionalactivate: boolean

      Whether to turn or turn off this feature.

    • OptionalminInterval: number

      The minimum time interval in milliseconds between two RSSI updates.

    Returns Promise<void>

    A promise that resolves once the message has been send.

sendAndWaitForResponse

  • sendAndWaitForResponse(msgOrTypeToSend, responseType, timeoutMs?): Promise<MPCMessages.MPCMessageOrType>

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

    Parameters

    • msgOrTypeToSend: MPCMessages.MPCMessageOrType

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

    • responseType:
          | "rssi"
          | "none"
          | "whoAreYou"
          | "bulkSetup"
          | "bulkSetupAck"
          | "bulkData"
          | "bulkDataAck"
          | "transferSettings"
          | "transferSettingsAck"
          | "transferSettingsFinished"
          | "debugLog"
          | "playAnimation"
          | "stopAnimation"
          | "requestSettings"
          | "blink"
          | "blinkAck"
          | "requestRssi"
          | "notifyUser"
          | "notifyUserAck"
          | "programDefaultParameters"
          | "programDefaultParametersFinished"
          | "setName"
          | "setNameAck"
          | "requestTemperature"
          | "temperature"
          | "iAmAMPC"
          | "synchronizeTime"

      Expected response type.

    • OptionaltimeoutMs: number

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

    Returns Promise<MPCMessages.MPCMessageOrType>

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

sendAndWaitForTypedResponse

  • sendAndWaitForTypedResponse<T>(msgOrTypeToSend, responseType, timeoutMs?): Promise<T>

  • Sends a message to the MPC and wait for a specific response which is returned casted to the expected type.

    Type Parameters

    • T extends PixelMessage

    Parameters

    • msgOrTypeToSend: MPCMessages.MPCMessageOrType

      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.

sendMessage

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

  • Sends a message to the MPC.

    Parameters

    • msgOrType: MPCMessages.MPCMessageOrType

      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.

stopAnim

  • stopAnim(animIndex): Promise<void>

  • Parameters

    • animIndex: number

    Returns Promise<void>

sync

  • sync(targetTime, referenceTime, param0?, param1?): Promise<void>

  • Parameters

    • targetTime: number
    • referenceTime: number
    • Optionalparam0: number
    • Optionalparam1: number

    Returns Promise<void>

updateInfo

  • updateInfo(info): void

  • Update MPC info from an external source such as scanning data.

    Parameters

    • info: Partial<Omit<Readonly<{
          batteryLevel: number;
          colorway:
              | "unknown"
              | "onyxBlack"
              | "hematiteGrey"
              | "midnightGalaxy"
              | "auroraSky"
              | "clear"
              | "whiteAurora"
              | "custom";
          currentFace: number;
          currentFaceIndex: number;
          dieType:
              | "unknown"
              | "d4"
              | "d6"
              | "d8"
              | "d10"
              | "d00"
              | "d12"
              | "d20"
              | "d6pipped"
              | "d6fudge";
          firmwareDate: Date;
          isCharging: boolean;
          ledCount: number;
          name: string;
          pixelId: number;
          rollState:
              | "unknown"
              | "rolled"
              | "handling"
              | "rolling"
              | "crooked"
              | "onFace";
          rssi: number;
          systemId: string;
      }>,
          | "systemId"
          | "colorway"
          | "dieType"
          | "rollState"
          | "currentFace"
          | "currentFaceIndex">>

      The updated info.

    Returns void

    Remarks

    The info will be updated only if the die is disconnected. Roll state and face index are updated only if both are provided.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods