first API sketch - Githubissues

OpenEarable / open_earable_flutter

MIT License

4 stars 1 forks source link

first API sketch #1

Closed TobiasRoeddiger closed 11 months ago

TobiasRoeddiger commented 1 year ago

create all primary interfaces for open earable flutter library. required features:

sensor configurations (defined by id)
receive data (IMU; pressure, temp)
set rgb led
receive push button events
control audio (play/pause/stop)

TobiasRoeddiger commented 1 year ago

take inspiration from: https://github.com/cph-cachet/flutter-plugins/tree/master/packages/esense_flutter

o-bagge commented 1 year ago

OpenEarable
- bleManager
- bool connected
- DiscoveredDevice connectedDevice
- Stream scanStream (Stream of scanned devices)
- void startScan()
  - Scans available devices and initialises scanStream
- void connectToDevice(DiscoveredDevice device)
  - connects to specified device
- void write(Uuid serviceId, Uuid characteristicId, List value)
- Stream\<List\> subscribe(Uuid serviceId, Uuid characteristicId)
- Future\<List\> read(Uuid serviceId, Uuid characteristicId)
- sensorManager
- void writeSensorConfig(OpenEarableSensorConfig sensorConfig)
  - OpenEarableSensorConfig(int sensorId, double samplingRate, int latency)
- List\ byteList (sensor config as byte list)
- Stream\<List\
  > subscribeToSensorData(int sensorId)
  - returns stream of raw data of specific sensor
- void disposeSensorDataController(int sensorId)
- void disposeAllSensorDataControllers()
- Stream getBatteryLevelStream()
- Stream getButtonStateStream()
- rgbLed
- void setLEDstate(int state)
- audioPlayer
- void writeWAVState(int state, int size, String name)
- Future\ readDeviceIdentifier()
- Future\ readDeviceGeneration()