C++ Pixels Library For Windows
Enable communications with Pixels dice using Bluetooth Low Energy.
Loading...
Searching...
No Matches
Systemic::Pixels Namespace Reference

A collection of C++ classes and types to scan for and connect to Pixels dice. More...

Namespaces

namespace  PixelBleUuids
 Bluetooth UUIDs related to Pixels peripherals.
 

Classes

class  Pixel
 Represents a Pixels die. More...
 
struct  PixelDelegate
 Interface for a class that handles Pixel events. More...
 
class  PixelInfo
 Common accessible values between Pixel advertised data and a connected Pixel. More...
 
class  PixelScanner
 Represents a Bluetooth scanner for Pixels dice. More...
 
class  ScannedPixel
 Data periodically emitted by a Pixel when not connected to a device. More...
 
struct  ScannedPixelData
 Data for ScannedPixel class. More...
 

Typedefs

using bluetooth_address_t = Systemic::BluetoothLE::bluetooth_address_t
 Type for a Bluetooth address.
 
using pixel_id_t = uint32_t
 Type for a Pixel Id.
 

Enumerations

enum class  PixelStatus {
  Disconnected , Connecting , Identifying , Ready ,
  Disconnecting
}
 The different possible connection statuses of a Pixel.
 
enum class  PixelDesignAndColor : uint8_t {
  Unknown , Generic , V3Orange , V4BlackClear ,
  V4WhiteClear , V5Grey , V5White , V5Black ,
  V5Gold , OnyxBlack , HematiteGrey , MidnightGalaxy ,
  AuroraSky
}
 Available combinations of Pixel designs and colors.
 
enum class  PixelRollState : uint8_t {
  Unknown , OnFace , Handling , Rolling ,
  Crooked
}
 Pixel roll states. More...
 
enum class  PixelBatteryState : uint8_t {
  Ok , Low , Charging , Done ,
  BadCharging , Error
}
 The different possible battery charging states. More...
 
enum class  DieType {
  D20 , D12 , D10 , D8 ,
  D6 , D6Pipped , D6Fudge , D4
}
 The different types of dice.
 

Detailed Description

A collection of C++ classes and types to scan for and connect to Pixels dice.

Enumeration Type Documentation

◆ PixelBatteryState

enum class Systemic::Pixels::PixelBatteryState : uint8_t
strong

The different possible battery charging states.

Enumerator
Ok 

Battery looks fine, nothing is happening.

Low 

Battery level is low, notify user they should recharge.

Charging 

Battery is currently recharging.

Done 

Battery is full and finished charging.

BadCharging 

Coil voltage is bad, die is probably positioned incorrectly. Note that currently this state is triggered during transition between charging and not charging...

Error 

Charge state doesn't make sense (charging but no coil voltage detected for instance).

◆ PixelRollState

enum class Systemic::Pixels::PixelRollState : uint8_t
strong

Pixel roll states.

Enumerator
Unknown 

The Pixel roll state could not be determined.

OnFace 

The Pixel is resting in a position with a face up.

Handling 

The Pixel is being handled.

Rolling 

The Pixel is rolling.

Crooked 

The Pixel is resting in a crooked position.