Documentation
    Preparing search index...

    Module @systemic-games/react-native-pixels-connect

    React Native Pixels Connect

    This is the Pixels package for React Native. It enables communications between Pixels dice and a React Native app using Bluetooth Low Energy. It has support for iOS and Android.

    Find the latest published version on NPM.

    Pixels are full of LEDs, smarts and no larger than regular dice, they can be customized to light up when and how you desire. Check our website for more information.

    Warning Before jumping into programming please make sure to read our Pixels developer's guide.

    Please open a ticket on GitHub if you're having any issue.

    npm install @systemic-games/react-native-pixels-connect
    
    import { PixelScanner, Pixel } from "@systemic-games/react-native-pixels-connect";

    // ...

    See the @systemic-games/pixels-react package.

    MIT


    Made with create-react-native-library

    Animation

    AnimationCategoryValues
    AnimationFlagsValues
    AnimationTypeValues
    AnimationBits
    AnimationCycle
    AnimationGradient
    AnimationGradientPattern
    AnimationKeyframed
    AnimationNoise
    AnimationNormals
    AnimationRainbow
    AnimationSequence
    AnimationSimple
    RgbKeyframe
    RgbTrack
    SimpleKeyframe
    Track
    AnimationPreset
    AnimationCategory
    AnimationFlags
    AnimationType
    NoiseColorOverrideType
    NormalsColorOverrideType
    AnimConstants

    Animation Instance

    AnimationInstance
    AnimationInstanceGradient
    AnimationInstanceGradientPattern
    AnimationInstanceKeyframed
    AnimationInstanceNoise
    AnimationInstanceNormals
    AnimationInstanceRainbow
    AnimationInstanceSequence
    AnimationInstanceSimple

    Animation Runtime Color Override type

    NoiseColorOverrideTypeValues
    NormalsColorOverrideTypeValues

    Color

    Color

    Face Utils

    facesMaskToValues
    getFaceMask

    Message

    ChargerBatteryStateValues
    DiePowerOperationValues
    DieRunModeValues
    MessageTypeValues
    PixelBatteryControllerModeValues
    PixelBatteryControllerStateValues
    PixelBatteryStateValues
    PixelColorwayValues
    PixelDieTypeValues
    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
    PixelColorway
    PixelDieType
    PixelRollState
    StoreValueResult
    TelemetryRequestMode
    TransferInstantAnimationsSetAckType

    Other

    ChargerMessages
    Color32Utils
    ColorUtils
    GammaUtils
    MPCMessages
    Profiles
    Serializable
    BluetoothLEError
    BluetoothNotAuthorizedError
    BluetoothUnavailableError
    CentralNotInitializedError
    ConnectError
    PixelScanner
    ScanAlreadyInProgressError
    ScanError
    ScannedBootloaderNotifier
    ScannedChargerNotifier
    ScannedMPCNotifier
    ScannedPixelNotifier
    ScanStartError
    UnknownPeripheralError
    VirtualDie
    NativeBluetoothLE
    PixelScannerOptions
    ScannedBootloader
    UsePixelValueNamesMap
    AdvertisementData
    BleBluetoothStateEvent
    BleCharacteristicValueChangedEvent
    BleConnectionEvent
    BleEvents
    BleScanResultEvent
    BluetoothState
    CentralEventMap
    Characteristic
    ConnectErrorType
    ConnectionEventReason
    ConnectionStatus
    Device
    ManufacturerData
    PeripheralCharacteristicValueChangedEvent
    PeripheralOrSystemId
    PixelConnectEventMap
    PixelScannerDispatchAction
    PixelScannerEventMap
    PixelScannerFilter
    PixelScannerListOperation
    PixelScannerStatus
    ScannedBootloaderNotifierMutableProps
    ScannedCharger
    ScannedChargerNotifierMutableProps
    ScannedDevice
    ScannedDeviceNotifier
    ScannedMPC
    ScannedMPCNotifierMutableProps
    ScannedPeripheral
    ScannedPixel
    ScannedPixelNotifierMutableProps
    ScanResult
    ScanStartErrorCode
    ScanStatus
    ScanStopReason
    ServiceData
    BluetoothLE
    Central
    Constants
    DiceUtils
    PixelsNamePrefixes
    ScannedDevicesRegistry
    serializer
    getCharger
    getDefaultPixelsDeviceName
    getFaceCount
    getFaceForLEDIndex
    getLEDCount
    getMPC
    getNativeErrorCode
    getPixel
    getPixelIdFromName
    getPixelOrThrow
    getPixelsBootloaderAdvertisedName
    getPixelsDevice
    getScannedDeviceNotifier
    getTopFace
    initBluetooth
    isPixelsBootloaderName
    isPixelsDeviceName
    requestPermissions
    toFullUuid
    updateScannedDeviceNotifier
    useBluetoothState
    useForceUpdate
    useMPCProp
    usePixel
    usePixelConnect
    usePixelEvent
    usePixelInfoProp
    usePixelProp
    usePixelScannerNotify
    usePixelStatus
    useScannedPixelNotifiers
    useScannedPixels

    Pixels

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

    Profile

    DataSet
    Profile
    Rule
    NameAndOrder
    getActionTypeDisplayName
    getAnimationTypeDisplayName
    getConditionTypeDisplayName

    Profile Action

    ActionTypeValues
    ActionMakeWebRequest
    ActionPlayAnimation
    ActionPlayAudioClip
    ActionSpeakText
    Action
    ActionType

    Profile Condition

    BatteryStateFlagsValues
    ConditionTypeValues
    ConnectionStateFlagsValues
    FaceCompareFlagsValues
    HelloGoodbyeFlagsValues
    ConditionBatteryState
    ConditionConnectionState
    ConditionCrooked
    ConditionFaceCompare
    ConditionHandling
    ConditionHelloGoodbye
    ConditionIdle
    ConditionRolled
    ConditionRolling
    Condition
    BatteryStateFlags
    ConditionType
    ConnectionStateFlags
    FaceCompareFlags
    HelloGoodbyeFlags