Skip to content

README.md

Latest commit

 

History

History
111 lines (71 loc) · 3.22 KB

README.md

File metadata and controls

111 lines (71 loc) · 3.22 KB

🔌 beeping_flutter

Cross-platform Flutter plugin for the Beeping ultrasonic SDK (Android + iOS, dual Local/Cloud mode).

License status platform conventional commits

✨ What is beeping_flutter?

beeping_flutter is the official federated Flutter plugin that exposes the Beeping ultrasonic SDK (data transmission via inaudible 18–22 kHz audio signals) to Flutter apps.

It consumes the native SDKs directly:

…and exposes an idiomatic Dart API (BeepingClient) with two interoperable modes:

  • Local — on-device processing via the native C++ core (offline-capable)
  • Cloud — HTTP-based via beepbox-server (low-power devices)

See docs/PRODUCTO.md for the full product spec.

🚀 Installation

⚠️ This package is not yet published to pub.dev. See Phase 10 milestone (BEE-83 .. BEE-93) for current status.

Once published:

flutter pub add beeping_flutter

🎬 Quick start

import 'package:beeping_flutter/beeping_flutter.dart';

final client = BeepingClient.builder()
  .apiKey(const String.fromEnvironment('BEEPING_API_KEY'))
  .mode(BeepingMode.cloud)
  .build();

final sub = client.contacts.listen((contact) {
  debugPrint('Beep received: ${contact.payload}');
});

await client.send(payload: 'hello-world');

// later …
await sub.cancel();
await client.dispose();

See example/ for a runnable demo app with a debug console.

🧪 Testing & lint

flutter pub get
dart format --output=none --set-exit-if-changed .
flutter analyze
flutter test
flutter test integration_test/  # requires device or simulator

📚 Docs

🤝 Contributing

This repository follows the Beeping ecosystem conventions:

  • Conventional Commits (feat:, fix:, docs:, chore:, …)
  • Linear-issue IDs in every commit message (feat: BEE-87 add BeepingClient builder)
  • All work happens in milestone/<phase-slug> branches; PRs go to develop

See CLAUDE.md for full project conventions.

📄 License

Apache-2.0. See LICENSE.

Part of the Beeping ecosystem.