Documentation
    Preparing search index...

    Interface UsePixelValueNamesMap

    Pixel value names map for usePixelEvent function. Maps the value name with the corresponding data type.

    interface UsePixelValueNamesMap {
        battery: BatteryEvent;
        roll: RollEvent;
        rollFace: Pick<RollEvent, "face">;
        rssi: number;
        telemetry: Telemetry;
        temperature: { batteryTemperature: number; mcuTemperature: number };
    }
    Index

    Properties

    battery roll rollFace rssi telemetry temperature

    Properties

    battery: BatteryEvent

    Updates with the battery level and charging status.

    roll: RollEvent

    Updates with the roll state and face on any roll event but not more often than specified by the refresh interval argument, except when there is a roll result (i.e. state === 'onFace') in which case it updates immediately.

    No value is returned until a roll event occurs.

    rollFace: Pick<RollEvent, "face">

    Updates with the result of a roll.

    • The value is an object with the face number rather than just a number so rolling the same face will trigger a state change nonetheless.
    • No value is returned until a roll is made.
    rssi: number

    Updates with the received signal strength indicator (RSSI) in dBm.

    telemetry: Telemetry

    Updates with the telemetry data.

    temperature: { batteryTemperature: number; mcuTemperature: number }

    Updates with the temperature in Celsius.

    Settings

    Member Visibility

    On This Page

    Properties