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.

Foreword

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.

Installation

npm install @systemic-games/react-native-pixels-connect

Usage

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

// ...

React Hooks

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

License

MIT

Made with create-react-native-library

Animation

AnimationBits AnimationCycle AnimationGradient AnimationGradientPattern AnimationKeyframed AnimationNoise AnimationNormals AnimationRainbow AnimationSequence AnimationSimple RgbKeyframe RgbTrack SimpleKeyframe Track AnimationPreset AnimConstants

Animation Instance

AnimationInstance AnimationInstanceGradient AnimationInstanceGradientPattern AnimationInstanceKeyframed AnimationInstanceNoise AnimationInstanceNormals AnimationInstanceRainbow AnimationInstanceSequence AnimationInstanceSimple

Color

Color

Face Utils

facesMaskToValues getFaceMask

Message

MessageTypeValues PixelBatteryControllerModeValues PixelBatteryControllerStateValues PixelBatteryStateValues PixelColorwayValues PixelDieTypeValues PixelPowerOperationValues PixelRollStateValues StoreValueResultValues TelemetryRequestModeValues TransferInstantAnimationsSetAckTypeValues BatteryLevel Blink 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 TransferTestAnimationSet TransferTestAnimationSetAck VersionInfoChunk MessageOrType MessageType PixelBatteryControllerMode PixelBatteryControllerState PixelBatteryState PixelColorway PixelDieType PixelRollState StoreValueResult TelemetryRequestMode TransferInstantAnimationsSetAckType

Other

ActionType ActionTypeValues AnimationCategory AnimationCategoryValues AnimationFlags AnimationFlagsValues AnimationType AnimationTypeValues BatteryStateFlags BatteryStateFlagsValues ConditionType ConditionTypeValues ConnectionStateFlags ConnectionStateFlagsValues FaceCompareFlags FaceCompareFlagsValues HelloGoodbyeFlags HelloGoodbyeFlagsValues NoiseColorOverrideType NoiseColorOverrideTypeValues NormalsColorOverrideType NormalsColorOverrideTypeValues ChargerMessages Color32Utils ColorUtils GammaUtils Profiles Serializable BluetoothLEError BluetoothNotAuthorizedError BluetoothUnavailableError CentralNotInitializedError ConnectError PixelScanner ScanAlreadyInProgressError ScanError ScannedBootloaderNotifier ScannedChargerNotifier ScannedPixelNotifier ScanStartError UnknownPeripheralError VirtualDie NativeBluetoothLE PixelScannerOptions ScannedBootloader UsePixelValueNamesMap AdvertisementData BleBluetoothStateEvent BleCharacteristicValueChangedEvent BleConnectionEvent BleEvents BleScanResultEvent BluetoothState CentralEventMap Characteristic ConnectErrorType ConnectionEventReason ConnectionStatus Device ManufacturerData PeripheralCharacteristicValueChangedEvent PeripheralOrSystemId PixelScannerDispatchAction PixelScannerEventMap PixelScannerFilter PixelScannerListOperation PixelScannerStatus PixelStatusEvent ScannedBootloaderNotifierMutableProps ScannedCharger ScannedChargerNotifierMutableProps ScannedDevice ScannedPeripheral ScannedPixel ScannedPixelNotifierMutableProps ScanResult ScanStartErrorCode ScanStatus ScanStopReason ServiceData BluetoothLE Central Constants DiceUtils PixelsNamePrefixes serializer getCharger getDefaultPixelsDeviceName getFaceCount getFaceForLEDIndex getLEDCount getNativeErrorCode getPixel getPixelIdFromName getPixelOrThrow getPixelsBootloaderAdvertisedName getTopFace initBluetooth isPixelsBootloaderName isPixelsDeviceName requestPermissions toFullUuid useBluetoothState useForceUpdate usePixel usePixelConnect usePixelEvent usePixelInfoProp usePixelProp usePixelScannerNotify usePixelStatus useScannedPixelNotifiers useScannedPixels

Pixels

Charger 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 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

ActionMakeWebRequest ActionPlayAnimation ActionPlayAudioClip ActionSpeakText Action

Profile Condition

ConditionBatteryState ConditionConnectionState ConditionCrooked ConditionFaceCompare ConditionHandling ConditionHelloGoodbye ConditionIdle ConditionRolled ConditionRolling Condition

Other

ActionType

Re-exports ActionType

ActionTypeValues

Re-exports ActionTypeValues

AnimationCategory

Re-exports AnimationCategory

AnimationCategoryValues

Re-exports AnimationCategoryValues

AnimationFlags

Re-exports AnimationFlags

AnimationFlagsValues

Re-exports AnimationFlagsValues

AnimationType

Re-exports AnimationType

AnimationTypeValues

Re-exports AnimationTypeValues

BatteryStateFlags

Renames and re-exports BatteryFlags

BatteryStateFlagsValues

Renames and re-exports BatteryFlagsValues

ConditionType

Re-exports ConditionType

ConditionTypeValues

Re-exports ConditionTypeValues

ConnectionStateFlags

Renames and re-exports ConnectionFlags

ConnectionStateFlagsValues

Renames and re-exports ConnectionFlagsValues

FaceCompareFlags

Re-exports FaceCompareFlags

FaceCompareFlagsValues

Re-exports FaceCompareFlagsValues

HelloGoodbyeFlags

Re-exports HelloGoodbyeFlags

HelloGoodbyeFlagsValues

Re-exports HelloGoodbyeFlagsValues

NoiseColorOverrideType

Re-exports NoiseColorOverrideType

NoiseColorOverrideTypeValues

Re-exports NoiseColorOverrideTypeValues

NormalsColorOverrideType

Re-exports NormalsColorOverrideType

NormalsColorOverrideTypeValues

Re-exports NormalsColorOverrideTypeValues

Settings

Member Visibility

On This Page

React Native Pixels Connect
Other