Class ScannedPixelNotifier<MutableProps, Type>

Readonly isScannedPixelNotifier

Static ExtendedMutablePropsList

address

• get address(): number

• Returns number

batteryLevel

• get batteryLevel(): number

• The Pixel battery level (percentage).

  Returns number

colorway

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

• The Pixel color.

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

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.

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

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"

firmwareDate

• get firmwareDate(): Date

• The Pixel firmware build date.

  Returns Date

isCharging

• get isCharging(): boolean

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

  Returns boolean

ledCount

• get ledCount(): number

• The number of LEDs of the Pixel.

  Returns number

name

• get name(): string

• The Pixels die name.

  Returns string

pixelId

• get pixelId(): number

• The unique Pixel id of the device.

  Returns number

rollState

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

• The Pixel roll state.

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

rssi

• get rssi(): number

• The last RSSI value measured by the Pixel.

  Returns number

systemId

• get systemId(): string

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

  Returns string

timestamp

• get timestamp(): Date

• Returns Date

updateProperties

• updateProperties(props): void

• Update the mutable properties and raise the corresponding events.

  Parameters

  • props: Partial<ScannedPixelNotifierMutableProps>

    The new values for the properties to update.

  Returns void

Static findInstance

• findInstance(pixelId): undefined | ScannedPixelNotifier<ScannedPixelNotifierMutableProps, ScannedPixel>

• Parameters

  • pixelId: number

  Returns undefined | ScannedPixelNotifier<ScannedPixelNotifierMutableProps, ScannedPixel>

Static getInstance

• getInstance(scannedPixel): ScannedPixelNotifier<ScannedPixelNotifierMutableProps, ScannedPixel>

• Parameters

  • scannedPixel: ScannedPixel

  Returns ScannedPixelNotifier<ScannedPixelNotifierMutableProps, ScannedPixel>