godice

Pure Dart library for GoDice smart dice. It implements the GoDice BLE protocol and leaves the Bluetooth stack up to you through a small GoDiceTransport interface, so it works with any BLE package (and in plain dart run programs).

For a ready-made Flutter transport see godice_universal_ble.

Protocol

GoDice use the Nordic UART Service:

Dice advertise as GoDice_<id>_<colour>_<firmware>, e.g. GoDice_1A2B3C_R_v03.

Commands (GoDiceCommands):

Notifications (GoDiceMessage.parse):

The xyz bytes are a signed accelerometer vector. GoDiceShells holds the reference vector for every face of the D6, D20 and D24 shells plus the transforms for D10, D10X, D4, D8 and D12, and picks the nearest face.

Usage

import 'package:godice/godice.dart';

final die = GoDice(myTransport, dieType: DieType.d20, name: 'GoDice_1A2B3C_R_v03');
await die.connect();

die.rollStarts.listen((_) => print('rolling...'));
die.rolls.listen((roll) => print('rolled ${roll.value}'));
die.positions.listen((p) => print('${p.kind.name}: ${p.value} ${p.xyz}'));

print(await die.getBatteryLevel());   // 0-100
print(await die.getColor());          // DiceColor.red
await die.setLeds(RgbColor.blue);
await die.pulseLed(color: RgbColor.red, pulseCount: 3, onTime: 20, offTime: 20);
die.dieType = DieType.d10x;           // moved the die to a D10X shell

Writing a transport

class MyTransport implements GoDiceTransport {
  // connect(): connect, discover services, subscribe to
  //   GoDiceProtocol.notifyCharacteristicUuid and push every value on
  //   `notifications` (a broadcast stream).
  // write(data): write to GoDiceProtocol.writeCharacteristicUuid.
  // connectionState: broadcast stream, true on connect / false on drop.
  // disconnect() / dispose() / isConnected.
}