Documentation
    Preparing search index...

    Module @systemic-games/pixels-core-connect

    Pixels Core Connect

    Platform agnostic classes and functions to communicate with Pixels dice.

    Find the latest published version on NPM.

    If this is your first visit to the Pixels software documentation you may want to head first to our documentation entry point here.

    This package doesn't provide Bluetooth access. For web support see *@systemic-games/pixels-web-connect and for React Native see *@systemic-games/react-native-pixels-connect.

    This package is using decorators (experimentalDecorators enabled in tsconfig) to tag how Pixel messages classes should be serialized.

    See the module's export documentation here.

    Documentation generated with TypeDoc.

    MIT


    Made with Example TypeScript Package.

    Message

    ChargerBatteryStateValues
    DiePowerOperationValues
    DieRunModeValues
    MessageTypeValues
    PixelBatteryControllerModeValues
    PixelBatteryControllerStateValues
    PixelBatteryStateValues
    PixelRollStateValues
    StoreValueResultValues
    TelemetryRequestModeValues
    TransferInstantAnimationsSetAckTypeValues
    BatteryLevel
    BlinkId
    BulkData
    BulkDataAck
    BulkSetup
    CustomDesignAndColorNameChunk
    DebugLog
    DieInfoChunk
    DieNameChunk
    Discharge
    IAmADie
    LegacyIAmADie
    NotifyUser
    NotifyUserAck
    PlayInstantAnimation
    PlayProfileAnimation
    PowerOperation
    RemoteAction
    RequestRssi
    RequestTelemetry
    RollState
    Rssi
    SetBatteryControllerMode
    SetDesignAndColor
    SetName
    SettingsInfoChunk
    StatusInfoChunk
    StoreValue
    StoreValueAck
    Telemetry
    Temperature
    TransferAnimationSet
    TransferAnimationSetAck
    TransferInstantAnimationSet
    TransferInstantAnimationSetAck
    TransferTest
    VersionInfoChunk
    ChargerBatteryState
    DiePowerOperation
    DieRunMode
    MessageOrType
    MessageType
    PixelBatteryControllerMode
    PixelBatteryControllerState
    PixelBatteryState
    PixelRollState
    StoreValueResult
    TelemetryRequestMode
    TransferInstantAnimationsSetAckType

    Other

    ChargerMessages
    MPCMessages
    PixelConnectEventMap
    Constants
    PixelsNamePrefixes
    serializer
    getDefaultPixelsDeviceName
    getPixelIdFromName
    getPixelsBootloaderAdvertisedName
    isPixelsBootloaderName
    isPixelsDeviceName
    toFullUuid

    Pixels

    Charger
    MPC
    Pixel
    PixelConnect
    PixelConnectCancelledError
    PixelConnectError
    PixelConnectIdMismatchError
    PixelConnectTimeoutError
    PixelEmptyNameError
    PixelError
    PixelIncompatibleMessageError
    PixelInfoNotifier
    PixelSession
    PixelTransferCompletedTimeoutError
    PixelTransferError
    PixelTransferInProgressError
    PixelTransferInvalidDataError
    PixelTransferOutOfMemoryError
    PixelWaitForMessageDisconnectError
    PixelWaitForMessageTimeoutError
    PixelSessionConnectionEvent
    BatteryEvent
    ChargerEventMap
    ChargerMutableProps
    ChargerOwnMutableProps
    DataTransferProgress
    MPCEventMap
    MPCMutableProps
    MPCOwnMutableProps
    PixelConnectMutableProps
    PixelConnectOwnMutableProps
    PixelEventMap
    PixelInfo
    PixelInfoNotifierMutableProps
    PixelInfoWithStatus
    PixelMutableProps
    PixelOwnMutableProps
    PixelsConnectUuids
    PixelSessionConnectionEventReason
    PixelSessionConnectionStatus
    PixelStatus
    RollEvent
    UserMessageEvent
    PixelsBluetoothIds
    repeatConnect