Interface PixelInfo

Common accessible values for all Pixel implementations.

interface PixelInfo {
    batteryLevel: number;
    colorway: "custom" | "clear" | "unknown" | "onyxBlack" | "hematiteGrey" | "midnightGalaxy" | "auroraSky";
    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" | "handling" | "rolling" | "crooked" | "onFace";
    rssi: number;
    systemId: string;
}

Implemented by

Properties

batteryLevel colorway currentFace currentFaceIndex dieType firmwareDate isCharging ledCount name pixelId rollState rssi systemId

Properties

Readonly batteryLevel

batteryLevel: number

The Pixel battery level (percentage).

Readonly colorway

colorway: "custom" | "clear" | "unknown" | "onyxBlack" | "hematiteGrey" | "midnightGalaxy" | "auroraSky"

The Pixel color.

Readonly currentFace

currentFace: number

The value of the die face that is currently facing up.

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.

Readonly currentFaceIndex

currentFaceIndex: number

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

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.

Readonly dieType

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

The Pixel die type.

Readonly firmwareDate

firmwareDate: Date

The Pixel firmware build date.

Readonly isCharging

isCharging: boolean

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

Readonly ledCount

ledCount: number

The number of LEDs of the Pixel.

Readonly name

name: string

The Pixels die name.

Readonly pixelId

pixelId: number

The unique Pixel id of the device.

Readonly rollState

rollState: "unknown" | "handling" | "rolling" | "crooked" | "onFace"

The Pixel roll state.

Readonly rssi

rssi: number

The last RSSI value measured by the Pixel.

Readonly systemId

systemId: string

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc